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

   1 ;;; gnus-art.el --- article mode commands for Gnus
   2
   3 ;; Copyright (C) 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004,
   4 ;;   2005, 2006, 2007, 2008 Free Software Foundation, Inc.
   5
   6 ;; Author: Lars Magne Ingebrigtsen <larsi@gnus.org>
   7 ;; Keywords: news
   8
   9 ;; This file is part of GNU Emacs.
  10
  11 ;; GNU Emacs is free software: you can redistribute it and/or modify
  12 ;; it under the terms of the GNU General Public License as published by
  13 ;; the Free Software Foundation, either version 3 of the License, or
  14 ;; (at your option) any later version.
  15
  16 ;; GNU Emacs is distributed in the hope that it will be useful,
  17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19 ;; GNU General Public License for more details.
  20
  21 ;; You should have received a copy of the GNU General Public License
  22 ;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
  23
  24 ;;; Commentary:
  25
  26 ;;; Code:
  27
  28 ;; For Emacs < 22.2.
  29 (eval-and-compile
  30   (unless (fboundp 'declare-function) (defmacro declare-function (&rest r))))
  31 (eval-when-compile
  32   (require 'cl))
  33 (defvar tool-bar-map)
  34 (defvar w3m-minor-mode-map)
  35
  36 (require 'gnus)
  37 ;; Avoid the "Recursive load suspected" error in Emacs 21.1.
  38 (eval-and-compile
  39   (let ((recursive-load-depth-limit 100))
  40     (require 'gnus-sum)))
  41 (require 'gnus-spec)
  42 (require 'gnus-int)
  43 (require 'gnus-win)
  44 (require 'mm-bodies)
  45 (require 'mail-parse)
  46 (require 'mm-decode)
  47 (require 'mm-view)
  48 (require 'wid-edit)
  49 (require 'mm-uu)
  50 (require 'message)
  51
  52 (autoload 'gnus-msg-mail "gnus-msg" nil t)
  53 (autoload 'gnus-button-mailto "gnus-msg")
  54 (autoload 'gnus-button-reply "gnus-msg" nil t)
  55 (autoload 'parse-time-string "parse-time" nil nil)
  56 (autoload 'ansi-color-apply-on-region "ansi-color")
  57 (autoload 'mm-url-insert-file-contents-external "mm-url")
  58 (autoload 'mm-extern-cache-contents "mm-extern")
  59
  60 (defgroup gnus-article nil
  61   "Article display."
  62   :link '(custom-manual "(gnus)Article Buffer")
  63   :group 'gnus)
  64
  65 (defgroup gnus-article-treat nil
  66   "Treating article parts."
  67   :link '(custom-manual "(gnus)Article Hiding")
  68   :group 'gnus-article)
  69
  70 (defgroup gnus-article-hiding nil
  71   "Hiding article parts."
  72   :link '(custom-manual "(gnus)Article Hiding")
  73   :group 'gnus-article)
  74
  75 (defgroup gnus-article-highlight nil
  76   "Article highlighting."
  77   :link '(custom-manual "(gnus)Article Highlighting")
  78   :group 'gnus-article
  79   :group 'gnus-visual)
  80
  81 (defgroup gnus-article-signature nil
  82   "Article signatures."
  83   :link '(custom-manual "(gnus)Article Signature")
  84   :group 'gnus-article)
  85
  86 (defgroup gnus-article-headers nil
  87   "Article headers."
  88   :link '(custom-manual "(gnus)Hiding Headers")
  89   :group 'gnus-article)
  90
  91 (defgroup gnus-article-washing nil
  92   "Special commands on articles."
  93   :link '(custom-manual "(gnus)Article Washing")
  94   :group 'gnus-article)
  95
  96 (defgroup gnus-article-emphasis nil
  97   "Fontisizing articles."
  98   :link '(custom-manual "(gnus)Article Fontisizing")
  99   :group 'gnus-article)
 100
 101 (defgroup gnus-article-saving nil
 102   "Saving articles."
 103   :link '(custom-manual "(gnus)Saving Articles")
 104   :group 'gnus-article)
 105
 106 (defgroup gnus-article-mime nil
 107   "Worshiping the MIME wonder."
 108   :link '(custom-manual "(gnus)Using MIME")
 109   :group 'gnus-article)
 110
 111 (defgroup gnus-article-buttons nil
 112   "Pushable buttons in the article buffer."
 113   :link '(custom-manual "(gnus)Article Buttons")
 114   :group 'gnus-article)
 115
 116 (defgroup gnus-article-various nil
 117   "Other article options."
 118   :link '(custom-manual "(gnus)Misc Article")
 119   :group 'gnus-article)
 120
 121 (defcustom gnus-ignored-headers
 122   (mapcar
 123    (lambda (header)
 124      (concat "^" header ":"))
 125    '("Path" "Expires" "Date-Received" "References" "Xref" "Lines"
 126      "Relay-Version" "Message-ID" "Approved" "Sender" "Received"
 127      "X-UIDL" "MIME-Version" "Return-Path" "In-Reply-To"
 128      "Content-Type" "Content-Transfer-Encoding" "X-WebTV-Signature"
 129      "X-MimeOLE" "X-MSMail-Priority" "X-Priority" "X-Loop"
 130      "X-Authentication-Warning" "X-MIME-Autoconverted" "X-Face"
 131      "X-Attribution" "X-Originating-IP" "Delivered-To"
 132      "NNTP-[-A-Za-z]+" "Distribution" "X-no-archive" "X-Trace"
 133      "X-Complaints-To" "X-NNTP-Posting-Host" "X-Orig.*"
 134      "Abuse-Reports-To" "Cache-Post-Path" "X-Article-Creation-Date"
 135      "X-Poster" "X-Mail2News-Path" "X-Server-Date" "X-Cache"
 136      "Originator" "X-Problems-To" "X-Auth-User" "X-Post-Time"
 137      "X-Admin" "X-UID" "Resent-[-A-Za-z]+" "X-Mailing-List"
 138      "Precedence" "Original-[-A-Za-z]+" "X-filename" "X-Orcpt"
 139      "Old-Received" "X-Pgp" "X-Auth" "X-From-Line"
 140      "X-Gnus-Article-Number" "X-Majordomo" "X-Url" "X-Sender"
 141      "MBOX-Line" "Priority" "X400-[-A-Za-z]+"
 142      "Status" "X-Gnus-Mail-Source" "Cancel-Lock"
 143      "X-FTN" "X-EXP32-SerialNo" "Encoding" "Importance"
 144      "Autoforwarded" "Original-Encoded-Information-Types" "X-Ya-Pop3"
 145      "X-Face-Version" "X-Vms-To" "X-ML-NAME" "X-ML-COUNT"
 146      "Mailing-List" "X-finfo" "X-md5sum" "X-md5sum-Origin"
 147      "X-Sun-Charset" "X-Accept-Language" "X-Envelope-Sender"
 148      "List-[A-Za-z]+" "X-Listprocessor-Version"
 149      "X-Received" "X-Distribute" "X-Sequence" "X-Juno-Line-Breaks"
 150      "X-Notes-Item" "X-MS-TNEF-Correlator" "x-uunet-gateway"
 151      "X-Received" "Content-length" "X-precedence"
 152      "X-Authenticated-User" "X-Comment" "X-Report" "X-Abuse-Info"
 153      "X-HTTP-Proxy" "X-Mydeja-Info" "X-Copyright" "X-No-Markup"
 154      "X-Abuse-Info" "X-From_" "X-Accept-Language" "Errors-To"
 155      "X-BeenThere" "X-Mailman-Version" "List-Help" "List-Post"
 156      "List-Subscribe" "List-Id" "List-Unsubscribe" "List-Archive"
 157      "X-Content-length" "X-Posting-Agent" "Original-Received"
 158      "X-Request-PGP" "X-Fingerprint" "X-WRIEnvto" "X-WRIEnvfrom"
 159      "X-Virus-Scanned" "X-Delivery-Agent" "Posted-Date" "X-Gateway"
 160      "X-Local-Origin" "X-Local-Destination" "X-UserInfo1"
 161      "X-Received-Date" "X-Hashcash" "Face" "X-DMCA-Notifications"
 162      "X-Abuse-and-DMCA-Info" "X-Postfilter" "X-Gpg-.*" "X-Disclaimer"
 163      "Envelope-To" "X-Spam-Score" "System-Type" "X-Injected-Via-Gmane"
 164      "X-Gmane-NNTP-Posting-Host" "Jabber-ID" "Archived-At"
 165      "Envelope-Sender" "Envelope-Recipients"))
 166   "*All headers that start with this regexp will be hidden.
 167 This variable can also be a list of regexps of headers to be ignored.
 168 If `gnus-visible-headers' is non-nil, this variable will be ignored."
 169   :type '(choice :custom-show nil
 170                  regexp
 171                  (repeat regexp))
 172   :group 'gnus-article-hiding)
 173
 174 (defcustom gnus-visible-headers
 175   "^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:"
 176   "*All headers that do not match this regexp will be hidden.
 177 This variable can also be a list of regexp of headers to remain visible.
 178 If this variable is non-nil, `gnus-ignored-headers' will be ignored."
 179   :type '(choice
 180           (repeat :value-to-internal (lambda (widget value)
 181                                        (custom-split-regexp-maybe value))
 182                   :match (lambda (widget value)
 183                            (or (stringp value)
 184                                (widget-editable-list-match widget value)))
 185                   regexp)
 186           (const :tag "Use gnus-ignored-headers" nil)
 187           regexp)
 188   :group 'gnus-article-hiding)
 189
 190 (defcustom gnus-sorted-header-list
 191   '("^From:" "^Subject:" "^Summary:" "^Keywords:" "^Newsgroups:"
 192     "^Followup-To:" "^To:" "^Cc:" "^Date:" "^Organization:")
 193   "*This variable is a list of regular expressions.
 194 If it is non-nil, headers that match the regular expressions will
 195 be placed first in the article buffer in the sequence specified by
 196 this list."
 197   :type '(repeat regexp)
 198   :group 'gnus-article-hiding)
 199
 200 (defcustom gnus-boring-article-headers '(empty followup-to reply-to)
 201   "Headers that are only to be displayed if they have interesting data.
 202 Possible values in this list are:
 203
 204   'empty       Headers with no content.
 205   'newsgroups  Newsgroup identical to Gnus group.
 206   'to-address  To identical to To-address.
 207   'to-list     To identical to To-list.
 208   'cc-list     CC identical to To-list.
 209   'followup-to Followup-to identical to Newsgroups.
 210   'reply-to    Reply-to identical to From.
 211   'date        Date less than four days old.
 212   'long-to     To and/or Cc longer than 1024 characters.
 213   'many-to     Multiple To and/or Cc."
 214   :type '(set (const :tag "Headers with no content." empty)
 215               (const :tag "Newsgroups identical to Gnus group." newsgroups)
 216               (const :tag "To identical to To-address." to-address)
 217               (const :tag "To identical to To-list." to-list)
 218               (const :tag "CC identical to To-list." cc-list)
 219               (const :tag "Followup-to identical to Newsgroups." followup-to)
 220               (const :tag "Reply-to identical to From." reply-to)
 221               (const :tag "Date less than four days old." date)
 222               (const :tag "To and/or Cc longer than 1024 characters." long-to)
 223               (const :tag "Multiple To and/or Cc headers." many-to))
 224   :group 'gnus-article-hiding)
 225
 226 (defcustom gnus-article-skip-boring nil
 227   "Skip over text that is not worth reading.
 228 By default, if you set this t, then Gnus will display citations and
 229 signatures, but will never scroll down to show you a page consisting
 230 only of boring text.  Boring text is controlled by
 231 `gnus-article-boring-faces'."
 232   :version "22.1"
 233   :type 'boolean
 234   :group 'gnus-article-hiding)
 235
 236 (defcustom gnus-signature-separator '("^-- $" "^-- *$")
 237   "Regexp matching signature separator.
 238 This can also be a list of regexps.  In that case, it will be checked
 239 from head to tail looking for a separator.  Searches will be done from
 240 the end of the buffer."
 241   :type '(choice :format "%{%t%}: %[Value Menu%]\n%v"
 242                  (regexp)
 243                  (repeat :tag "List of regexp" regexp))
 244   :group 'gnus-article-signature)
 245
 246 (defcustom gnus-signature-limit nil
 247   "Provide a limit to what is considered a signature.
 248 If it is a number, no signature may not be longer (in characters) than
 249 that number.  If it is a floating point number, no signature may be
 250 longer (in lines) than that number.  If it is a function, the function
 251 will be called without any parameters, and if it returns nil, there is
 252 no signature in the buffer.  If it is a string, it will be used as a
 253 regexp.  If it matches, the text in question is not a signature.
 254
 255 This can also be a list of the above values."
 256   :type '(choice (const nil)
 257                  (integer :value 200)
 258                  (number :value 4.0)
 259                  function
 260                  (regexp :value ".*"))
 261   :group 'gnus-article-signature)
 262
 263 (defcustom gnus-hidden-properties '(invisible t intangible t)
 264   "Property list to use for hiding text."
 265   :type 'sexp
 266   :group 'gnus-article-hiding)
 267
 268 ;; Fixme: This isn't the right thing for mixed graphical and non-graphical
 269 ;; frames in a session.
 270 (defcustom gnus-article-x-face-command
 271   (if (featurep 'xemacs)
 272       (if (or (gnus-image-type-available-p 'xface)
 273               (gnus-image-type-available-p 'pbm))
 274           'gnus-display-x-face-in-from
 275         "{ echo '/* Width=48, Height=48 */'; uncompface; } | icontopbm | ee -")
 276     (if (gnus-image-type-available-p 'pbm)
 277         'gnus-display-x-face-in-from
 278       "{ echo '/* Width=48, Height=48 */'; uncompface; } | icontopbm | \
 279 display -"))
 280   "*String or function to be executed to display an X-Face header.
 281 If it is a string, the command will be executed in a sub-shell
 282 asynchronously.  The compressed face will be piped to this command."
 283   :type `(choice string
 284                  (function-item gnus-display-x-face-in-from)
 285                  function)
 286   :version "21.1"
 287   :group 'gnus-picon
 288   :group 'gnus-article-washing)
 289
 290 (defcustom gnus-article-x-face-too-ugly nil
 291   "Regexp matching posters whose face shouldn't be shown automatically."
 292   :type '(choice regexp (const nil))
 293   :group 'gnus-article-washing)
 294
 295 (defcustom gnus-article-banner-alist nil
 296   "Banner alist for stripping.
 297 For example,
 298      ((egroups . \"^[ \\t\\n]*-------------------+\\\\( \\\\(e\\\\|Yahoo! \\\\)Groups Sponsor -+\\\\)?....\\n\\\\(.+\\n\\\\)+\"))"
 299   :version "21.1"
 300   :type '(repeat (cons symbol regexp))
 301   :group 'gnus-article-washing)
 302
 303 (gnus-define-group-parameter
 304  banner
 305  :variable-document
 306  "Alist of regexps (to match group names) and banner."
 307  :variable-group gnus-article-washing
 308  :parameter-type
 309  '(choice :tag "Banner"
 310           :value nil
 311           (const :tag "Remove signature" signature)
 312           (symbol :tag "Item in `gnus-article-banner-alist'" none)
 313           regexp
 314           (const :tag "None" nil))
 315  :parameter-document
 316  "If non-nil, specify how to remove `banners' from articles.
 317
 318 Symbol `signature' means to remove signatures delimited by
 319 `gnus-signature-separator'.  Any other symbol is used to look up a
 320 regular expression to match the banner in `gnus-article-banner-alist'.
 321 A string is used as a regular expression to match the banner
 322 directly.")
 323
 324 (defcustom gnus-article-address-banner-alist nil
 325   "Alist of mail addresses and banners.
 326 Each element has the form (ADDRESS . BANNER), where ADDRESS is a regexp
 327 to match a mail address in the From: header, BANNER is one of a symbol
 328 `signature', an item in `gnus-article-banner-alist', a regexp and nil.
 329 If ADDRESS matches author's mail address, it will remove things like
 330 advertisements.  For example:
 331
 332 \((\"@yoo-hoo\\\\.co\\\\.jp\\\\'\" . \"\\n_+\\nDo You Yoo-hoo!\\\\?\\n.*\\n.*\\n\"))
 333 "
 334   :type '(repeat
 335           (cons
 336            (regexp :tag "Address")
 337            (choice :tag "Banner" :value nil
 338                    (const :tag "Remove signature" signature)
 339                    (symbol :tag "Item in `gnus-article-banner-alist'" none)
 340                    regexp
 341                    (const :tag "None" nil))))
 342   :version "22.1"
 343   :group 'gnus-article-washing)
 344
 345 (defmacro gnus-emphasis-custom-with-format (&rest body)
 346   `(let ((format "\
 347 \\(\\s-\\|^\\|\\=\\|[-\"]\\|\\s(\\)\\(%s\\(\\w+\\(\\s-+\\w+\\)*[.,]?\\)%s\\)\
 348 \\(\\([-,.;:!?\"]\\|\\s)\\)+\\s-\\|[?!.]\\s-\\|\\s)\\|\\s-\\)"))
 349      ,@body))
 350
 351 (defun gnus-emphasis-custom-value-to-external (value)
 352   (gnus-emphasis-custom-with-format
 353    (if (consp (car value))
 354        (list (format format (car (car value)) (cdr (car value)))
 355              2
 356              (if (nth 1 value) 2 3)
 357              (nth 2 value))
 358      value)))
 359
 360 (defun gnus-emphasis-custom-value-to-internal (value)
 361   (gnus-emphasis-custom-with-format
 362    (let ((regexp (concat "\\`"
 363                          (format (regexp-quote format)
 364                                  "\\([^()]+\\)" "\\([^()]+\\)")
 365                          "\\'"))
 366          pattern)
 367      (if (string-match regexp (setq pattern (car value)))
 368          (list (cons (match-string 1 pattern) (match-string 2 pattern))
 369                (= (nth 2 value) 2)
 370                (nth 3 value))
 371        value))))
 372
 373 (defcustom gnus-emphasis-alist
 374   (let ((types
 375          '(("\\*" "\\*" bold nil 2)
 376            ("_" "_" underline)
 377            ("/" "/" italic)
 378            ("_/" "/_" underline-italic)
 379            ("_\\*" "\\*_" underline-bold)
 380            ("\\*/" "/\\*" bold-italic)
 381            ("_\\*/" "/\\*_" underline-bold-italic))))
 382     (nconc
 383      (gnus-emphasis-custom-with-format
 384       (mapcar (lambda (spec)
 385                 (list (format format (car spec) (cadr spec))
 386                       (or (nth 3 spec) 2)
 387                       (or (nth 4 spec) 3)
 388                       (intern (format "gnus-emphasis-%s" (nth 2 spec)))))
 389               types))
 390      '(;; I've never seen anyone use this strikethru convention whereas I've
 391        ;; several times seen it triggered by normal text.  --Stef
 392        ;; Miles suggests that this form is sometimes used but for italics,
 393        ;; so maybe we should map it to `italic'.
 394        ;; ("\\(\\s-\\|^\\)\\(-\\(\\(\\w\\|-[^-]\\)+\\)-\\)\\(\\s-\\|[?!.,;]\\)"
 395        ;; 2 3 gnus-emphasis-strikethru)
 396        ("\\(\\s-\\|^\\)\\(_\\(\\(\\w\\|_[^_]\\)+\\)_\\)\\(\\s-\\|[?!.,;]\\)"
 397         2 3 gnus-emphasis-underline))))
 398   "*Alist that says how to fontify certain phrases.
 399 Each item looks like this:
 400
 401   (\"_\\\\(\\\\w+\\\\)_\" 0 1 'underline)
 402
 403 The first element is a regular expression to be matched.  The second
 404 is a number that says what regular expression grouping used to find
 405 the entire emphasized word.  The third is a number that says what
 406 regexp grouping should be displayed and highlighted.  The fourth
 407 is the face used for highlighting."
 408   :type
 409   '(repeat
 410     (menu-choice
 411      :format "%[Customizing Style%]\n%v"
 412      :indent 2
 413      (group :tag "Default"
 414             :value ("" 0 0 default)
 415             :value-create
 416             (lambda (widget)
 417               (let ((value (widget-get
 418                             (cadr (widget-get (widget-get widget :parent)
 419                                               :args))
 420                             :value)))
 421                 (if (not (eq (nth 2 value) 'default))
 422                     (widget-put
 423                      widget
 424                      :value
 425                      (gnus-emphasis-custom-value-to-external value))))
 426               (widget-group-value-create widget))
 427             regexp
 428             (integer :format "Match group: %v")
 429             (integer :format "Emphasize group: %v")
 430             face)
 431      (group :tag "Simple"
 432             :value (("_" . "_") nil default)
 433             (cons :format "%v"
 434                   (regexp :format "Start regexp: %v")
 435                   (regexp :format "End regexp: %v"))
 436             (boolean :format "Show start and end patterns: %[%v%]\n"
 437                      :on " On " :off " Off ")
 438             face)))
 439   :get (lambda (symbol)
 440          (mapcar 'gnus-emphasis-custom-value-to-internal
 441                  (default-value symbol)))
 442   :set (lambda (symbol value)
 443          (set-default symbol (mapcar 'gnus-emphasis-custom-value-to-external
 444                                      value)))
 445   :group 'gnus-article-emphasis)
 446
 447 (defcustom gnus-emphasize-whitespace-regexp "^[ \t]+\\|[ \t]*\n"
 448   "A regexp to describe whitespace which should not be emphasized.
 449 Typical values are \"^[ \\t]+\\\\|[ \\t]*\\n\" and \"[ \\t]+\\\\|[ \\t]*\\n\".
 450 The former avoids underlining of leading and trailing whitespace,
 451 and the latter avoids underlining any whitespace at all."
 452   :version "21.1"
 453   :group 'gnus-article-emphasis
 454   :type 'regexp)
 455
 456 (defface gnus-emphasis-bold '((t (:bold t)))
 457   "Face used for displaying strong emphasized text (*word*)."
 458   :group 'gnus-article-emphasis)
 459
 460 (defface gnus-emphasis-italic '((t (:italic t)))
 461   "Face used for displaying italic emphasized text (/word/)."
 462   :group 'gnus-article-emphasis)
 463
 464 (defface gnus-emphasis-underline '((t (:underline t)))
 465   "Face used for displaying underlined emphasized text (_word_)."
 466   :group 'gnus-article-emphasis)
 467
 468 (defface gnus-emphasis-underline-bold '((t (:bold t :underline t)))
 469   "Face used for displaying underlined bold emphasized text (_*word*_)."
 470   :group 'gnus-article-emphasis)
 471
 472 (defface gnus-emphasis-underline-italic '((t (:italic t :underline t)))
 473   "Face used for displaying underlined italic emphasized text (_/word/_)."
 474   :group 'gnus-article-emphasis)
 475
 476 (defface gnus-emphasis-bold-italic '((t (:bold t :italic t)))
 477   "Face used for displaying bold italic emphasized text (/*word*/)."
 478   :group 'gnus-article-emphasis)
 479
 480 (defface gnus-emphasis-underline-bold-italic
 481   '((t (:bold t :italic t :underline t)))
 482   "Face used for displaying underlined bold italic emphasized text.
 483 Example: (_/*word*/_)."
 484   :group 'gnus-article-emphasis)
 485
 486 (defface gnus-emphasis-strikethru (if (featurep 'xemacs)
 487                                       '((t (:strikethru t)))
 488                                     '((t (:strike-through t))))
 489   "Face used for displaying strike-through text (-word-)."
 490   :group 'gnus-article-emphasis)
 491
 492 (defface gnus-emphasis-highlight-words
 493   '((t (:background "black" :foreground "yellow")))
 494   "Face used for displaying highlighted words."
 495   :group 'gnus-article-emphasis)
 496
 497 (defcustom gnus-article-time-format "%a, %d %b %Y %T %Z"
 498   "Format for display of Date headers in article bodies.
 499 See `format-time-string' for the possible values.
 500
 501 The variable can also be function, which should return a complete Date
 502 header.  The function is called with one argument, the time, which can
 503 be fed to `format-time-string'."
 504   :type '(choice string function)
 505   :link '(custom-manual "(gnus)Article Date")
 506   :group 'gnus-article-washing)
 507
 508 (defcustom gnus-save-all-headers t
 509   "*If non-nil, don't remove any headers before saving.
 510 This will be overridden by the `:headers' property that the symbol of
 511 the saver function, which is specified by `gnus-default-article-saver',
 512 might have."
 513   :group 'gnus-article-saving
 514   :type 'boolean)
 515
 516 (defcustom gnus-prompt-before-saving 'always
 517   "*This variable says how much prompting is to be done when saving articles.
 518 If it is nil, no prompting will be done, and the articles will be
 519 saved to the default files.  If this variable is `always', each and
 520 every article that is saved will be preceded by a prompt, even when
 521 saving large batches of articles.  If this variable is neither nil not
 522 `always', there the user will be prompted once for a file name for
 523 each invocation of the saving commands."
 524   :group 'gnus-article-saving
 525   :type '(choice (item always)
 526                  (item :tag "never" nil)
 527                  (sexp :tag "once" :format "%t\n" :value t)))
 528
 529 (defcustom gnus-saved-headers gnus-visible-headers
 530   "Headers to keep if `gnus-save-all-headers' is nil.
 531 If `gnus-save-all-headers' is non-nil, this variable will be ignored.
 532 If that variable is nil, however, all headers that match this regexp
 533 will be kept while the rest will be deleted before saving.  This and
 534 `gnus-save-all-headers' will be overridden by the `:headers' property
 535 that the symbol of the saver function, which is specified by
 536 `gnus-default-article-saver', might have."
 537   :group 'gnus-article-saving
 538   :type 'regexp)
 539
 540 (defcustom gnus-default-article-saver 'gnus-summary-save-in-rmail
 541   "A function to save articles in your favourite format.
 542 The function will be called by way of the `gnus-summary-save-article'
 543 command, and friends such as `gnus-summary-save-article-rmail'.
 544
 545 Gnus provides the following functions:
 546
 547 * gnus-summary-save-in-rmail (Rmail format)
 548 * gnus-summary-save-in-mail (Unix mail format)
 549 * gnus-summary-save-in-folder (MH folder)
 550 * gnus-summary-save-in-file (article format)
 551 * gnus-summary-save-body-in-file (article body)
 552 * gnus-summary-save-in-vm (use VM's folder format)
 553 * gnus-summary-write-to-file (article format -- overwrite)
 554 * gnus-summary-write-body-to-file (article body -- overwrite)
 555 * gnus-summary-save-in-pipe (article format)
 556
 557 The symbol of each function may have the following properties:
 558
 559 * :decode
 560 The value non-nil means save decoded articles.  This is meaningful
 561 only with `gnus-summary-save-in-file', `gnus-summary-save-body-in-file',
 562 `gnus-summary-write-to-file', `gnus-summary-write-body-to-file', and
 563 `gnus-summary-save-in-pipe'.
 564
 565 * :function
 566 The value specifies an alternative function which appends, not
 567 overwrites, articles to a file.  This implies that when saving many
 568 articles at a time, `gnus-prompt-before-saving' is bound to t and all
 569 articles are saved in a single file.  This is meaningful only with
 570 `gnus-summary-write-to-file' and `gnus-summary-write-body-to-file'.
 571
 572 * :headers
 573 The value specifies the symbol of a variable of which the value
 574 specifies headers to be saved.  If it is omitted,
 575 `gnus-save-all-headers' and `gnus-saved-headers' control what
 576 headers should be saved."
 577   :group 'gnus-article-saving
 578   :type '(radio (function-item gnus-summary-save-in-rmail)
 579                 (function-item gnus-summary-save-in-mail)
 580                 (function-item gnus-summary-save-in-folder)
 581                 (function-item gnus-summary-save-in-file)
 582                 (function-item gnus-summary-save-body-in-file)
 583                 (function-item gnus-summary-save-in-vm)
 584                 (function-item gnus-summary-write-to-file)
 585                 (function-item gnus-summary-write-body-to-file)
 586                 (function-item gnus-summary-save-in-pipe)
 587                 (function)))
 588
 589 (defcustom gnus-article-save-coding-system
 590   (or (and (mm-coding-system-p 'utf-8) 'utf-8)
 591       (and (mm-coding-system-p 'iso-2022-7bit) 'iso-2022-7bit)
 592       (and (mm-coding-system-p 'emacs-mule) 'emacs-mule)
 593       (and (mm-coding-system-p 'escape-quoted) 'escape-quoted))
 594   "Coding system used to save decoded articles to a file.
 595
 596 The recommended coding systems are `utf-8', `iso-2022-7bit' and so on,
 597 which can safely encode any characters in text.  This is used by the
 598 commands including:
 599
 600 * gnus-summary-save-article-file
 601 * gnus-summary-save-article-body-file
 602 * gnus-summary-write-article-file
 603 * gnus-summary-write-article-body-file
 604
 605 and the functions to which you may set `gnus-default-article-saver':
 606
 607 * gnus-summary-save-in-file
 608 * gnus-summary-save-body-in-file
 609 * gnus-summary-write-to-file
 610 * gnus-summary-write-body-to-file
 611
 612 Those commands and functions save just text displayed in the article
 613 buffer to a file if the value of this variable is non-nil.  Note that
 614 buttonized MIME parts will be lost in a saved file in that case.
 615 Otherwise, raw articles will be saved."
 616   :group 'gnus-article-saving
 617   :type `(choice
 618           :format "%{%t%}:\n %[Value Menu%] %v"
 619           (const :tag "Save raw articles" nil)
 620           ,@(delq nil
 621                   (mapcar
 622                    (lambda (arg) (if (mm-coding-system-p (nth 3 arg)) arg))
 623                    '((const :tag "UTF-8" utf-8)
 624                      (const :tag "iso-2022-7bit" iso-2022-7bit)
 625                      (const :tag "Emacs internal" emacs-mule)
 626                      (const :tag "escape-quoted" escape-quoted))))
 627           (symbol :tag "Coding system")))
 628
 629 (defcustom gnus-rmail-save-name 'gnus-plain-save-name
 630   "A function generating a file name to save articles in Rmail format.
 631 The function is called with NEWSGROUP, HEADERS, and optional LAST-FILE."
 632   :group 'gnus-article-saving
 633   :type 'function)
 634
 635 (defcustom gnus-mail-save-name 'gnus-plain-save-name
 636   "A function generating a file name to save articles in Unix mail format.
 637 The function is called with NEWSGROUP, HEADERS, and optional LAST-FILE."
 638   :group 'gnus-article-saving
 639   :type 'function)
 640
 641 (defcustom gnus-folder-save-name 'gnus-folder-save-name
 642   "A function generating a file name to save articles in MH folder.
 643 The function is called with NEWSGROUP, HEADERS, and optional LAST-FOLDER."
 644   :group 'gnus-article-saving
 645   :type 'function)
 646
 647 (defcustom gnus-file-save-name 'gnus-numeric-save-name
 648   "A function generating a file name to save articles in article format.
 649 The function is called with NEWSGROUP, HEADERS, and optional
 650 LAST-FILE."
 651   :group 'gnus-article-saving
 652   :type 'function)
 653
 654 (defcustom gnus-split-methods
 655   '((gnus-article-archive-name)
 656     (gnus-article-nndoc-name))
 657   "*Variable used to suggest where articles are to be saved.
 658 For instance, if you would like to save articles related to Gnus in
 659 the file \"gnus-stuff\", and articles related to VM in \"vm-stuff\",
 660 you could set this variable to something like:
 661
 662  '((\"^Subject:.*gnus\\|^Newsgroups:.*gnus\" \"gnus-stuff\")
 663    (\"^Subject:.*vm\\|^Xref:.*vm\" \"vm-stuff\"))
 664
 665 This variable is an alist where the key is the match and the
 666 value is a list of possible files to save in if the match is
 667 non-nil.
 668
 669 If the match is a string, it is used as a regexp match on the
 670 article.  If the match is a symbol, that symbol will be funcalled
 671 from the buffer of the article to be saved with the newsgroup as the
 672 parameter.  If it is a list, it will be evaled in the same buffer.
 673
 674 If this form or function returns a string, this string will be used as a
 675 possible file name; and if it returns a non-nil list, that list will be
 676 used as possible file names."
 677   :group 'gnus-article-saving
 678   :type '(repeat (choice (list :value (fun) function)
 679                          (cons :value ("" "") regexp (repeat string))
 680                          (sexp :value nil))))
 681
 682 (defcustom gnus-page-delimiter "^\^L"
 683   "*Regexp describing what to use as article page delimiters.
 684 The default value is \"^\^L\", which is a form linefeed at the
 685 beginning of a line."
 686   :type 'regexp
 687   :group 'gnus-article-various)
 688
 689 (defcustom gnus-article-mode-line-format "Gnus: %g [%w] %S%m"
 690   "*The format specification for the article mode line.
 691 See `gnus-summary-mode-line-format' for a closer description.
 692
 693 The following additional specs are available:
 694
 695 %w  The article washing status.
 696 %m  The number of MIME parts in the article."
 697   :type 'string
 698   :group 'gnus-article-various)
 699
 700 (defcustom gnus-article-mode-hook nil
 701   "*A hook for Gnus article mode."
 702   :type 'hook
 703   :group 'gnus-article-various)
 704
 705 (when (featurep 'xemacs)
 706   ;; Extracted from gnus-xmas-define in order to preserve user settings
 707   (when (fboundp 'turn-off-scroll-in-place)
 708     (add-hook 'gnus-article-mode-hook 'turn-off-scroll-in-place))
 709   ;; Extracted from gnus-xmas-redefine in order to preserve user settings
 710   (add-hook 'gnus-article-mode-hook 'gnus-xmas-article-menu-add))
 711
 712 (defcustom gnus-article-menu-hook nil
 713   "*Hook run after the creation of the article mode menu."
 714   :type 'hook
 715   :group 'gnus-article-various)
 716
 717 (defcustom gnus-article-prepare-hook nil
 718   "*A hook called after an article has been prepared in the article buffer."
 719   :type 'hook
 720   :group 'gnus-article-various)
 721
 722 (defcustom gnus-copy-article-ignored-headers nil
 723   "List of headers to be removed when copying an article.
 724 Each element is a regular expression."
 725   :version "23.1" ;; No Gnus
 726   :type '(repeat regexp)
 727   :group 'gnus-article-various)
 728
 729 (make-obsolete-variable 'gnus-article-hide-pgp-hook
 730                         "This variable is obsolete in Gnus 5.10.")
 731
 732 (defface gnus-button
 733   '((t (:weight bold)))
 734   "Face used for highlighting a button in the article buffer."
 735   :group 'gnus-article-buttons)
 736
 737 (defcustom gnus-article-button-face 'gnus-button
 738   "Face used for highlighting buttons in the article buffer.
 739
 740 An article button is a piece of text that you can activate by pressing
 741 `RET' or `mouse-2' above it."
 742   :type 'face
 743   :group 'gnus-article-buttons)
 744
 745 (defcustom gnus-article-mouse-face 'highlight
 746   "Face used for mouse highlighting in the article buffer.
 747
 748 Article buttons will be displayed in this face when the cursor is
 749 above them."
 750   :type 'face
 751   :group 'gnus-article-buttons)
 752
 753 (defcustom gnus-signature-face 'gnus-signature
 754   "Face used for highlighting a signature in the article buffer.
 755 Obsolete; use the face `gnus-signature' for customizations instead."
 756   :type 'face
 757   :group 'gnus-article-highlight
 758   :group 'gnus-article-signature)
 759
 760 (defface gnus-signature
 761   '((t
 762      (:italic t)))
 763   "Face used for highlighting a signature in the article buffer."
 764   :group 'gnus-article-highlight
 765   :group 'gnus-article-signature)
 766 ;; backward-compatibility alias
 767 (put 'gnus-signature-face 'face-alias 'gnus-signature)
 768
 769 (defface gnus-header-from
 770   '((((class color)
 771       (background dark))
 772      (:foreground "PaleGreen1"))
 773     (((class color)
 774       (background light))
 775      (:foreground "red3"))
 776     (t
 777      (:italic t)))
 778   "Face used for displaying from headers."
 779   :group 'gnus-article-headers
 780   :group 'gnus-article-highlight)
 781 ;; backward-compatibility alias
 782 (put 'gnus-header-from-face 'face-alias 'gnus-header-from)
 783
 784 (defface gnus-header-subject
 785   '((((class color)
 786       (background dark))
 787      (:foreground "SeaGreen1"))
 788     (((class color)
 789       (background light))
 790      (:foreground "red4"))
 791     (t
 792      (:bold t :italic t)))
 793   "Face used for displaying subject headers."
 794   :group 'gnus-article-headers
 795   :group 'gnus-article-highlight)
 796 ;; backward-compatibility alias
 797 (put 'gnus-header-subject-face 'face-alias 'gnus-header-subject)
 798
 799 (defface gnus-header-newsgroups
 800   '((((class color)
 801       (background dark))
 802      (:foreground "yellow" :italic t))
 803     (((class color)
 804       (background light))
 805      (:foreground "MidnightBlue" :italic t))
 806     (t
 807      (:italic t)))
 808   "Face used for displaying newsgroups headers.
 809 In the default setup this face is only used for crossposted
 810 articles."
 811   :group 'gnus-article-headers
 812   :group 'gnus-article-highlight)
 813 ;; backward-compatibility alias
 814 (put 'gnus-header-newsgroups-face 'face-alias 'gnus-header-newsgroups)
 815
 816 (defface gnus-header-name
 817   '((((class color)
 818       (background dark))
 819      (:foreground "SpringGreen2"))
 820     (((class color)
 821       (background light))
 822      (:foreground "maroon"))
 823     (t
 824      (:bold t)))
 825   "Face used for displaying header names."
 826   :group 'gnus-article-headers
 827   :group 'gnus-article-highlight)
 828 ;; backward-compatibility alias
 829 (put 'gnus-header-name-face 'face-alias 'gnus-header-name)
 830
 831 (defface gnus-header-content
 832   '((((class color)
 833       (background dark))
 834      (:foreground "SpringGreen1" :italic t))
 835     (((class color)
 836       (background light))
 837      (:foreground "indianred4" :italic t))
 838     (t
 839      (:italic t)))  "Face used for displaying header content."
 840   :group 'gnus-article-headers
 841   :group 'gnus-article-highlight)
 842 ;; backward-compatibility alias
 843 (put 'gnus-header-content-face 'face-alias 'gnus-header-content)
 844
 845 (defcustom gnus-header-face-alist
 846   '(("From" nil gnus-header-from)
 847     ("Subject" nil gnus-header-subject)
 848     ("Newsgroups:.*," nil gnus-header-newsgroups)
 849     ("" gnus-header-name gnus-header-content))
 850   "*Controls highlighting of article headers.
 851
 852 An alist of the form (HEADER NAME CONTENT).
 853
 854 HEADER is a regular expression which should match the name of a
 855 header and NAME and CONTENT are either face names or nil.
 856
 857 The name of each header field will be displayed using the face
 858 specified by the first element in the list where HEADER matches
 859 the header name and NAME is non-nil.  Similarly, the content will
 860 be displayed by the first non-nil matching CONTENT face."
 861   :group 'gnus-article-headers
 862   :group 'gnus-article-highlight
 863   :type '(repeat (list (regexp :tag "Header")
 864                        (choice :tag "Name"
 865                                (item :tag "skip" nil)
 866                                (face :value default))
 867                        (choice :tag "Content"
 868                                (item :tag "skip" nil)
 869                                (face :value default)))))
 870
 871 (defcustom gnus-face-properties-alist (if (featurep 'xemacs)
 872                                           '((xface . (:face gnus-x-face)))
 873                                         '((pbm . (:face gnus-x-face))
 874                                           (png . nil)))
 875   "Alist of image types and properties applied to Face and X-Face images.
 876 Here are examples:
 877
 878 ;; Specify the altitude of Face images in the From header.
 879 \(setq gnus-face-properties-alist
 880       '((pbm . (:face gnus-x-face :ascent 80))
 881         (png . (:ascent 80))))
 882
 883 ;; Show Face images as pressed buttons.
 884 \(setq gnus-face-properties-alist
 885       '((pbm . (:face gnus-x-face :relief -2))
 886         (png . (:relief -2))))
 887
 888 See the manual for the valid properties for various image types.
 889 Currently, `pbm' is used for X-Face images and `png' is used for Face
 890 images in Emacs.  Only the `:face' property is effective on the `xface'
 891 image type in XEmacs if it is built with the libcompface library."
 892   :version "23.1" ;; No Gnus
 893   :group 'gnus-article-headers
 894   :type '(repeat (cons :format "%v" (symbol :tag "Image type") plist)))
 895
 896 (defcustom gnus-article-decode-hook
 897   '(article-decode-charset article-decode-encoded-words
 898                            article-decode-group-name article-decode-idna-rhs)
 899   "*Hook run to decode charsets in articles."
 900   :group 'gnus-article-headers
 901   :type 'hook)
 902
 903 (defcustom gnus-display-mime-function 'gnus-display-mime
 904   "Function to display MIME articles."
 905   :group 'gnus-article-mime
 906   :type 'function)
 907
 908 (defvar gnus-decode-header-function 'mail-decode-encoded-word-region
 909   "Function used to decode headers.")
 910
 911 (defvar gnus-decode-address-function 'mail-decode-encoded-address-region
 912   "Function used to decode addresses.")
 913
 914 (defvar gnus-article-dumbquotes-map
 915   '(("\200" "EUR")
 916     ("\202" ",")
 917     ("\203" "f")
 918     ("\204" ",,")
 919     ("\205" "...")
 920     ("\213" "<")
 921     ("\214" "OE")
 922     ("\221" "`")
 923     ("\222" "'")
 924     ("\223" "``")
 925     ("\224" "\"")
 926     ("\225" "*")
 927     ("\226" "-")
 928     ("\227" "--")
 929     ("\230" "~")
 930     ("\231" "(TM)")
 931     ("\233" ">")
 932     ("\234" "oe")
 933     ("\264" "'"))
 934   "Table for MS-to-Latin1 translation.")
 935
 936 (defcustom gnus-ignored-mime-types nil
 937   "List of MIME types that should be ignored by Gnus."
 938   :version "21.1"
 939   :group 'gnus-article-mime
 940   :type '(repeat regexp))
 941
 942 (defcustom gnus-unbuttonized-mime-types '(".*/.*")
 943   "List of MIME types that should not be given buttons when rendered inline.
 944 See also `gnus-buttonized-mime-types' which may override this variable.
 945 This variable is only used when `gnus-inhibit-mime-unbuttonizing' is nil."
 946   :version "21.1"
 947   :group 'gnus-article-mime
 948   :type '(repeat regexp))
 949
 950 (defcustom gnus-buttonized-mime-types nil
 951   "List of MIME types that should be given buttons when rendered inline.
 952 If set, this variable overrides `gnus-unbuttonized-mime-types'.
 953 To see e.g. security buttons you could set this to
 954 `(\"multipart/signed\")'.  You could also add \"multipart/alternative\" to
 955 this list to display radio buttons that allow you to choose one of two
 956 media types those mails include.  See also `mm-discouraged-alternatives'.
 957 This variable is only used when `gnus-inhibit-mime-unbuttonizing' is nil."
 958   :version "22.1"
 959   :group 'gnus-article-mime
 960   :type '(repeat regexp))
 961
 962 (defcustom gnus-inhibit-mime-unbuttonizing nil
 963   "If non-nil, all MIME parts get buttons.
 964 When nil (the default value), then some MIME parts do not get buttons,
 965 as described by the variables `gnus-buttonized-mime-types' and
 966 `gnus-unbuttonized-mime-types'."
 967   :version "22.1"
 968   :group 'gnus-article-mime
 969   :type 'boolean)
 970
 971 (defcustom gnus-body-boundary-delimiter "_"
 972   "String used to delimit header and body.
 973 This variable is used by `gnus-article-treat-body-boundary' which can
 974 be controlled by `gnus-treat-body-boundary'."
 975   :version "22.1"
 976   :group 'gnus-article-various
 977   :type '(choice (item :tag "None" :value nil)
 978                  string))
 979
 980 (defcustom gnus-picon-databases '("/usr/lib/picon" "/usr/local/faces"
 981                                   "/usr/share/picons")
 982   "Defines the location of the faces database.
 983 For information on obtaining this database of pretty pictures, please
 984 see http://www.cs.indiana.edu/picons/ftp/index.html"
 985   :version "22.1"
 986   :type '(repeat directory)
 987   :link '(url-link :tag "download"
 988                    "http://www.cs.indiana.edu/picons/ftp/index.html")
 989   :link '(custom-manual "(gnus)Picons")
 990   :group 'gnus-picon)
 991
 992 (defun gnus-picons-installed-p ()
 993   "Say whether picons are installed on your machine."
 994   (let ((installed nil))
 995     (dolist (database gnus-picon-databases)
 996       (when (file-exists-p database)
 997         (setq installed t)))
 998     installed))
 999
1000 (defcustom gnus-article-mime-part-function nil
1001   "Function called with a MIME handle as the argument.
1002 This is meant for people who want to do something automatic based
1003 on parts -- for instance, adding Vcard info to a database."
1004   :group 'gnus-article-mime
1005   :type '(choice (const nil)
1006                  function))
1007
1008 (defcustom gnus-mime-multipart-functions nil
1009   "An alist of MIME types to functions to display them."
1010   :version "21.1"
1011   :group 'gnus-article-mime
1012   :type '(repeat (cons :format "%v" (string :tag "MIME type") function)))
1013
1014 (defcustom gnus-article-date-lapsed-new-header nil
1015   "Whether the X-Sent and Date headers can coexist.
1016 When using `gnus-treat-date-lapsed', the \"X-Sent:\" header will
1017 either replace the old \"Date:\" header (if this variable is nil), or
1018 be added below it (otherwise)."
1019   :version "21.1"
1020   :group 'gnus-article-headers
1021   :type 'boolean)
1022
1023 (defcustom gnus-article-mime-match-handle-function 'undisplayed-alternative
1024   "Function called with a MIME handle as the argument.
1025 This is meant for people who want to view first matched part.
1026 For `undisplayed-alternative' (default), the first undisplayed
1027 part or alternative part is used.  For `undisplayed', the first
1028 undisplayed part is used.  For a function, the first part which
1029 the function return t is used.  For nil, the first part is
1030 used."
1031   :version "21.1"
1032   :group 'gnus-article-mime
1033   :type '(choice
1034           (item :tag "first" :value nil)
1035           (item :tag "undisplayed" :value undisplayed)
1036           (item :tag "undisplayed or alternative"
1037                 :value undisplayed-alternative)
1038           (function)))
1039
1040 (defcustom gnus-mime-action-alist
1041   '(("save to file" . gnus-mime-save-part)
1042     ("save and strip" . gnus-mime-save-part-and-strip)
1043     ("replace with file" . gnus-mime-replace-part)
1044     ("delete part" . gnus-mime-delete-part)
1045     ("display as text" . gnus-mime-inline-part)
1046     ("view the part" . gnus-mime-view-part)
1047     ("pipe to command" . gnus-mime-pipe-part)
1048     ("toggle display" . gnus-article-press-button)
1049     ("toggle display" . gnus-article-view-part-as-charset)
1050     ("view as type" . gnus-mime-view-part-as-type)
1051     ("view internally" . gnus-mime-view-part-internally)
1052     ("view externally" . gnus-mime-view-part-externally))
1053   "An alist of actions that run on the MIME attachment."
1054   :group 'gnus-article-mime
1055   :type '(repeat (cons (string :tag "name")
1056                        (function))))
1057
1058 (defcustom gnus-auto-select-part 1
1059   "Advance to next MIME part when deleting or stripping parts.
1060
1061 When 0, point will be placed on the same part as before.  When
1062 positive (negative), move point forward (backwards) this many
1063 parts.  When nil, redisplay article."
1064   :version "23.1" ;; No Gnus
1065   :group 'gnus-article-mime
1066   :type '(choice (const nil :tag "Redisplay article.")
1067                  (const 1 :tag "Next part.")
1068                  (const 0 :tag "Current part.")
1069                  integer))
1070
1071 ;;;
1072 ;;; The treatment variables
1073 ;;;
1074
1075 (defvar gnus-part-display-hook nil
1076   "Hook called on parts that are to receive treatment.")
1077
1078 (defvar gnus-article-treat-custom
1079   '(choice (const :tag "Off" nil)
1080            (const :tag "On" t)
1081            (const :tag "Header" head)
1082            (const :tag "First" first)
1083            (const :tag "Last" last)
1084            (integer :tag "Less")
1085            (repeat :tag "Groups" regexp)
1086            (sexp :tag "Predicate")))
1087
1088 (defvar gnus-article-treat-head-custom
1089   '(choice (const :tag "Off" nil)
1090            (const :tag "Header" head)))
1091
1092 (defvar gnus-article-treat-types '("text/plain" "text/x-verbatim"
1093                                    "text/x-patch")
1094   "Parts to treat.")
1095
1096 (defvar gnus-inhibit-treatment nil
1097   "Whether to inhibit treatment.")
1098
1099 (defcustom gnus-treat-highlight-signature '(or t (typep "text/x-vcard"))
1100   "Highlight the signature.
1101 Valid values are nil, t, `head', `first', `last', an integer or a
1102 predicate.  See Info node `(gnus)Customizing Articles'."
1103   :group 'gnus-article-treat
1104   :link '(custom-manual "(gnus)Customizing Articles")
1105   :type gnus-article-treat-custom)
1106 (put 'gnus-treat-highlight-signature 'highlight t)
1107
1108 (defcustom gnus-treat-buttonize 100000
1109   "Add buttons.
1110 Valid values are nil, t, `head', `first', `last', an integer or a
1111 predicate.  See Info node `(gnus)Customizing Articles'."
1112   :group 'gnus-article-treat
1113   :link '(custom-manual "(gnus)Customizing Articles")
1114   :type gnus-article-treat-custom)
1115 (put 'gnus-treat-buttonize 'highlight t)
1116
1117 (defcustom gnus-treat-buttonize-head 'head
1118   "Add buttons to the head.
1119 Valid values are nil, t, `head', `first', `last', an integer or a
1120 predicate.  See Info node `(gnus)Customizing Articles'."
1121   :group 'gnus-article-treat
1122   :link '(custom-manual "(gnus)Customizing Articles")
1123   :type gnus-article-treat-head-custom)
1124 (put 'gnus-treat-buttonize-head 'highlight t)
1125
1126 (defcustom gnus-treat-emphasize 50000
1127   "Emphasize text.
1128 Valid values are nil, t, `head', `first', `last', an integer or a
1129 predicate.  See Info node `(gnus)Customizing Articles'."
1130   :group 'gnus-article-treat
1131   :link '(custom-manual "(gnus)Customizing Articles")
1132   :type gnus-article-treat-custom)
1133 (put 'gnus-treat-emphasize 'highlight t)
1134
1135 (defcustom gnus-treat-strip-cr nil
1136   "Remove carriage returns.
1137 Valid values are nil, t, `head', `first', `last', an integer or a
1138 predicate.  See Info node `(gnus)Customizing Articles'."
1139   :version "22.1"
1140   :group 'gnus-article-treat
1141   :link '(custom-manual "(gnus)Customizing Articles")
1142   :type gnus-article-treat-custom)
1143
1144 (defcustom gnus-treat-unsplit-urls nil
1145   "Remove newlines from within URLs.
1146 Valid values are nil, t, `head', `first', `last', an integer or a
1147 predicate.  See Info node `(gnus)Customizing Articles'."
1148   :version "22.1"
1149   :group 'gnus-article-treat
1150   :link '(custom-manual "(gnus)Customizing Articles")
1151   :type gnus-article-treat-custom)
1152
1153 (defcustom gnus-treat-leading-whitespace nil
1154   "Remove leading whitespace in headers.
1155 Valid values are nil, t, `head', `first', `last', an integer or a
1156 predicate.  See Info node `(gnus)Customizing Articles'."
1157   :version "22.1"
1158   :group 'gnus-article-treat
1159   :link '(custom-manual "(gnus)Customizing Articles")
1160   :type gnus-article-treat-custom)
1161
1162 (defcustom gnus-treat-hide-headers 'head
1163   "Hide headers.
1164 Valid values are nil, t, `head', `first', `last', an integer or a
1165 predicate.  See Info node `(gnus)Customizing Articles'."
1166   :group 'gnus-article-treat
1167   :link '(custom-manual "(gnus)Customizing Articles")
1168   :type gnus-article-treat-head-custom)
1169
1170 (defcustom gnus-treat-hide-boring-headers nil
1171   "Hide boring headers.
1172 Valid values are nil, t, `head', `first', `last', an integer or a
1173 predicate.  See Info node `(gnus)Customizing Articles'."
1174   :group 'gnus-article-treat
1175   :link '(custom-manual "(gnus)Customizing Articles")
1176   :type gnus-article-treat-head-custom)
1177
1178 (defcustom gnus-treat-hide-signature nil
1179   "Hide the signature.
1180 Valid values are nil, t, `head', `first', `last', an integer or a
1181 predicate.  See Info node `(gnus)Customizing Articles'."
1182   :group 'gnus-article-treat
1183   :link '(custom-manual "(gnus)Customizing Articles")
1184   :type gnus-article-treat-custom)
1185
1186 (defcustom gnus-treat-fill-article nil
1187   "Fill the article.
1188 Valid values are nil, t, `head', `first', `last', an integer or a
1189 predicate.  See Info node `(gnus)Customizing Articles'."
1190   :group 'gnus-article-treat
1191   :link '(custom-manual "(gnus)Customizing Articles")
1192   :type gnus-article-treat-custom)
1193
1194 (defcustom gnus-treat-hide-citation nil
1195   "Hide cited text.
1196 Valid values are nil, t, `head', `first', `last', an integer or a
1197 predicate.  See Info node `(gnus)Customizing Articles'."
1198   :group 'gnus-article-treat
1199   :link '(custom-manual "(gnus)Customizing Articles")
1200   :type gnus-article-treat-custom)
1201
1202 (defcustom gnus-treat-hide-citation-maybe nil
1203   "Hide cited text.
1204 Valid values are nil, t, `head', `first', `last', an integer or a
1205 predicate.  See Info node `(gnus)Customizing Articles'."
1206   :group 'gnus-article-treat
1207   :link '(custom-manual "(gnus)Customizing Articles")
1208   :type gnus-article-treat-custom)
1209
1210 (defcustom gnus-treat-strip-list-identifiers 'head
1211   "Strip list identifiers from `gnus-list-identifiers`.
1212 Valid values are nil, t, `head', `first', `last', an integer or a
1213 predicate.  See Info node `(gnus)Customizing Articles'."
1214   :version "21.1"
1215   :group 'gnus-article-treat
1216   :link '(custom-manual "(gnus)Customizing Articles")
1217   :type gnus-article-treat-custom)
1218
1219 (make-obsolete-variable 'gnus-treat-strip-pgp
1220                         "This option is obsolete in Gnus 5.10.")
1221
1222 (defcustom gnus-treat-strip-pem nil
1223   "Strip PEM signatures.
1224 Valid values are nil, t, `head', `first', `last', an integer or a
1225 predicate.  See Info node `(gnus)Customizing Articles'."
1226   :group 'gnus-article-treat
1227   :link '(custom-manual "(gnus)Customizing Articles")
1228   :type gnus-article-treat-custom)
1229
1230 (defcustom gnus-treat-strip-banner t
1231   "Strip banners from articles.
1232 The banner to be stripped is specified in the `banner' group parameter.
1233 Valid values are nil, t, `head', `first', `last', an integer or a
1234 predicate.  See Info node `(gnus)Customizing Articles'."
1235   :group 'gnus-article-treat
1236   :link '(custom-manual "(gnus)Customizing Articles")
1237   :type gnus-article-treat-custom)
1238
1239 (defcustom gnus-treat-highlight-headers 'head
1240   "Highlight the headers.
1241 Valid values are nil, t, `head', `first', `last', an integer or a
1242 predicate.  See Info node `(gnus)Customizing Articles'."
1243   :group 'gnus-article-treat
1244   :link '(custom-manual "(gnus)Customizing Articles")
1245   :type gnus-article-treat-head-custom)
1246 (put 'gnus-treat-highlight-headers 'highlight t)
1247
1248 (defcustom gnus-treat-highlight-citation t
1249   "Highlight cited text.
1250 Valid values are nil, t, `head', `first', `last', an integer or a
1251 predicate.  See Info node `(gnus)Customizing Articles'."
1252   :group 'gnus-article-treat
1253   :link '(custom-manual "(gnus)Customizing Articles")
1254   :type gnus-article-treat-custom)
1255 (put 'gnus-treat-highlight-citation 'highlight t)
1256
1257 (defcustom gnus-treat-date-ut nil
1258   "Display the Date in UT (GMT).
1259 Valid values are nil, t, `head', `first', `last', an integer or a
1260 predicate.  See Info node `(gnus)Customizing Articles'."
1261   :group 'gnus-article-treat
1262   :link '(custom-manual "(gnus)Customizing Articles")
1263   :type gnus-article-treat-head-custom)
1264
1265 (defcustom gnus-treat-date-local nil
1266   "Display the Date in the local timezone.
1267 Valid values are nil, t, `head', `first', `last', an integer or a
1268 predicate.  See Info node `(gnus)Customizing Articles'."
1269   :group 'gnus-article-treat
1270   :link '(custom-manual "(gnus)Customizing Articles")
1271   :type gnus-article-treat-head-custom)
1272
1273 (defcustom gnus-treat-date-english nil
1274   "Display the Date in a format that can be read aloud in English.
1275 Valid values are nil, t, `head', `first', `last', an integer or a
1276 predicate.  See Info node `(gnus)Customizing Articles'."
1277   :version "22.1"
1278   :group 'gnus-article-treat
1279   :link '(custom-manual "(gnus)Customizing Articles")
1280   :type gnus-article-treat-head-custom)
1281
1282 (defcustom gnus-treat-date-lapsed nil
1283   "Display the Date header in a way that says how much time has elapsed.
1284 Valid values are nil, t, `head', `first', `last', an integer or a
1285 predicate.  See Info node `(gnus)Customizing Articles'."
1286   :group 'gnus-article-treat
1287   :link '(custom-manual "(gnus)Customizing Articles")
1288   :type gnus-article-treat-head-custom)
1289
1290 (defcustom gnus-treat-date-original nil
1291   "Display the date in the original timezone.
1292 Valid values are nil, t, `head', `first', `last', an integer or a
1293 predicate.  See Info node `(gnus)Customizing Articles'."
1294   :group 'gnus-article-treat
1295   :link '(custom-manual "(gnus)Customizing Articles")
1296   :type gnus-article-treat-head-custom)
1297
1298 (defcustom gnus-treat-date-iso8601 nil
1299   "Display the date in the ISO8601 format.
1300 Valid values are nil, t, `head', `first', `last', an integer or a
1301 predicate.  See Info node `(gnus)Customizing Articles'."
1302   :version "21.1"
1303   :group 'gnus-article-treat
1304   :link '(custom-manual "(gnus)Customizing Articles")
1305   :type gnus-article-treat-head-custom)
1306
1307 (defcustom gnus-treat-date-user-defined nil
1308   "Display the date in a user-defined format.
1309 The format is defined by the `gnus-article-time-format' variable.
1310 Valid values are nil, t, `head', `first', `last', an integer or a
1311 predicate.  See Info node `(gnus)Customizing Articles'."
1312   :group 'gnus-article-treat
1313   :link '(custom-manual "(gnus)Customizing Articles")
1314   :type gnus-article-treat-head-custom)
1315
1316 (defcustom gnus-treat-strip-headers-in-body t
1317   "Strip the X-No-Archive header line from the beginning of the body.
1318 Valid values are nil, t, `head', `first', `last', an integer or a
1319 predicate.  See Info node `(gnus)Customizing Articles'."
1320   :version "21.1"
1321   :group 'gnus-article-treat
1322   :link '(custom-manual "(gnus)Customizing Articles")
1323   :type gnus-article-treat-custom)
1324
1325 (defcustom gnus-treat-strip-trailing-blank-lines nil
1326   "Strip trailing blank lines.
1327 Valid values are nil, t, `head', `first', `last', an integer or a
1328 predicate.  See Info node `(gnus)Customizing Articles'.
1329
1330 When set to t, it also strips trailing blanks in all MIME parts.
1331 Consider to use `last' instead."
1332   :group 'gnus-article-treat
1333   :link '(custom-manual "(gnus)Customizing Articles")
1334   :type gnus-article-treat-custom)
1335
1336 (defcustom gnus-treat-strip-leading-blank-lines nil
1337   "Strip leading blank lines.
1338 Valid values are nil, t, `head', `first', `last', an integer or a
1339 predicate.  See Info node `(gnus)Customizing Articles'.
1340
1341 When set to t, it also strips trailing blanks in all MIME parts."
1342   :group 'gnus-article-treat
1343   :link '(custom-manual "(gnus)Customizing Articles")
1344   :type gnus-article-treat-custom)
1345
1346 (defcustom gnus-treat-strip-multiple-blank-lines nil
1347   "Strip multiple blank lines.
1348 Valid values are nil, t, `head', `first', `last', an integer or a
1349 predicate.  See Info node `(gnus)Customizing Articles'."
1350   :group 'gnus-article-treat
1351   :link '(custom-manual "(gnus)Customizing Articles")
1352   :type gnus-article-treat-custom)
1353
1354 (defcustom gnus-treat-unfold-headers 'head
1355   "Unfold folded header lines.
1356 Valid values are nil, t, `head', `first', `last', an integer or a
1357 predicate.  See Info node `(gnus)Customizing Articles'."
1358   :version "22.1"
1359   :group 'gnus-article-treat
1360   :link '(custom-manual "(gnus)Customizing Articles")
1361   :type gnus-article-treat-custom)
1362
1363 (defcustom gnus-article-unfold-long-headers nil
1364   "If non-nil, allow unfolding headers even if the header is long.
1365 If it is a regexp, only long headers matching this regexp are unfolded.
1366 If it is t, all long headers are unfolded.
1367
1368 This variable has no effect if `gnus-treat-unfold-headers' is nil."
1369   :version "23.1" ;; No Gnus
1370   :group 'gnus-article-treat
1371   :type '(choice (const nil)
1372                  (const :tag "all" t)
1373                  (regexp)))
1374
1375 (defcustom gnus-treat-fold-headers nil
1376   "Fold headers.
1377 Valid values are nil, t, `head', `first', `last', an integer or a
1378 predicate.  See Info node `(gnus)Customizing Articles'."
1379   :version "22.1"
1380   :group 'gnus-article-treat
1381   :link '(custom-manual "(gnus)Customizing Articles")
1382   :type gnus-article-treat-custom)
1383
1384 (defcustom gnus-treat-fold-newsgroups 'head
1385   "Fold the Newsgroups and Followup-To headers.
1386 Valid values are nil, t, `head', `first', `last', an integer or a
1387 predicate.  See Info node `(gnus)Customizing Articles'."
1388   :version "22.1"
1389   :group 'gnus-article-treat
1390   :link '(custom-manual "(gnus)Customizing Articles")
1391   :type gnus-article-treat-custom)
1392
1393 (defcustom gnus-treat-overstrike t
1394   "Treat overstrike highlighting.
1395 Valid values are nil, t, `head', `first', `last', an integer or a
1396 predicate.  See Info node `(gnus)Customizing Articles'."
1397   :group 'gnus-article-treat
1398   :link '(custom-manual "(gnus)Customizing Articles")
1399   :type gnus-article-treat-custom)
1400 (put 'gnus-treat-overstrike 'highlight t)
1401
1402 (defcustom gnus-treat-ansi-sequences (if (locate-library "ansi-color") t)
1403   "Treat ANSI SGR control sequences.
1404 Valid values are nil, t, `head', `first', `last', an integer or a
1405 predicate.  See Info node `(gnus)Customizing Articles'."
1406   :group 'gnus-article-treat
1407   :link '(custom-manual "(gnus)Customizing Articles")
1408   :type gnus-article-treat-custom)
1409
1410 (make-obsolete-variable 'gnus-treat-display-xface
1411                         'gnus-treat-display-x-face)
1412
1413 (defcustom gnus-treat-display-x-face
1414   (and (not noninteractive)
1415        (gnus-image-type-available-p 'xbm)
1416        (if (featurep 'xemacs)
1417            (featurep 'xface)
1418          (and (string-match "^0x" (shell-command-to-string "uncompface"))
1419               (executable-find "icontopbm")))
1420        'head)
1421   "Display X-Face headers.
1422 Valid values are nil and `head'.
1423 See Info node `(gnus)Customizing Articles' and Info node
1424 `(gnus)X-Face' for details."
1425   :group 'gnus-article-treat
1426   :version "21.1"
1427   :link '(custom-manual "(gnus)Customizing Articles")
1428   :link '(custom-manual "(gnus)X-Face")
1429   :type gnus-article-treat-head-custom
1430   :set (lambda (symbol value)
1431          (set-default
1432           symbol
1433           (cond ((or (boundp symbol) (get symbol 'saved-value))
1434                  value)
1435                 ((boundp 'gnus-treat-display-xface)
1436                  (message "\
1437 ** gnus-treat-display-xface is an obsolete variable;\
1438  use gnus-treat-display-x-face instead")
1439                  (default-value 'gnus-treat-display-xface))
1440                 ((get 'gnus-treat-display-xface 'saved-value)
1441                  (message "\
1442 ** gnus-treat-display-xface is an obsolete variable;\
1443  use gnus-treat-display-x-face instead")
1444                  (eval (car (get 'gnus-treat-display-xface 'saved-value))))
1445                 (t
1446                  value)))))
1447 (put 'gnus-treat-display-x-face 'highlight t)
1448
1449 (defcustom gnus-treat-display-face
1450   (and (not noninteractive)
1451        (gnus-image-type-available-p 'png)
1452        'head)
1453   "Display Face headers.
1454 Valid values are nil, t, `head', `first', `last', an integer or a
1455 predicate.  See Info node `(gnus)Customizing Articles' and Info
1456 node `(gnus)X-Face' for details."
1457   :group 'gnus-article-treat
1458   :version "22.1"
1459   :link '(custom-manual "(gnus)Customizing Articles")
1460   :link '(custom-manual "(gnus)X-Face")
1461   :type gnus-article-treat-head-custom)
1462 (put 'gnus-treat-display-face 'highlight t)
1463
1464 (defcustom gnus-treat-display-smileys (gnus-image-type-available-p 'xpm)
1465   "Display smileys.
1466 Valid values are nil, t, `head', `first', `last', an integer or a
1467 predicate.  See Info node `(gnus)Customizing Articles' and Info
1468 node `(gnus)Smileys' for details."
1469   :group 'gnus-article-treat
1470   :version "21.1"
1471   :link '(custom-manual "(gnus)Customizing Articles")
1472   :link '(custom-manual "(gnus)Smileys")
1473   :type gnus-article-treat-custom)
1474 (put 'gnus-treat-display-smileys 'highlight t)
1475
1476 (defcustom gnus-treat-from-picon
1477   (if (and (gnus-image-type-available-p 'xpm)
1478            (gnus-picons-installed-p))
1479       'head nil)
1480   "Display picons in the From header.
1481 Valid values are nil, t, `head', `first', `last', an integer or a
1482 predicate.  See Info node `(gnus)Customizing Articles' and Info
1483 node `(gnus)Picons' for details."
1484   :version "22.1"
1485   :group 'gnus-article-treat
1486   :group 'gnus-picon
1487   :link '(custom-manual "(gnus)Customizing Articles")
1488   :link '(custom-manual "(gnus)Picons")
1489   :type gnus-article-treat-head-custom)
1490 (put 'gnus-treat-from-picon 'highlight t)
1491
1492 (defcustom gnus-treat-mail-picon
1493   (if (and (gnus-image-type-available-p 'xpm)
1494            (gnus-picons-installed-p))
1495       'head nil)
1496   "Display picons in To and Cc headers.
1497 Valid values are nil, t, `head', `first', `last', an integer or a
1498 predicate.  See Info node `(gnus)Customizing Articles' and Info
1499 node `(gnus)Picons' for details."
1500   :version "22.1"
1501   :group 'gnus-article-treat
1502   :group 'gnus-picon
1503   :link '(custom-manual "(gnus)Customizing Articles")
1504   :link '(custom-manual "(gnus)Picons")
1505   :type gnus-article-treat-head-custom)
1506 (put 'gnus-treat-mail-picon 'highlight t)
1507
1508 (defcustom gnus-treat-newsgroups-picon
1509   (if (and (gnus-image-type-available-p 'xpm)
1510            (gnus-picons-installed-p))
1511       'head nil)
1512   "Display picons in the Newsgroups and Followup-To headers.
1513 Valid values are nil, t, `head', `first', `last', an integer or a
1514 predicate.  See Info node `(gnus)Customizing Articles' and Info
1515 node `(gnus)Picons' for details."
1516   :version "22.1"
1517   :group 'gnus-article-treat
1518   :group 'gnus-picon
1519   :link '(custom-manual "(gnus)Customizing Articles")
1520   :link '(custom-manual "(gnus)Picons")
1521   :type gnus-article-treat-head-custom)
1522 (put 'gnus-treat-newsgroups-picon 'highlight t)
1523
1524 (defcustom gnus-treat-body-boundary
1525   (if (or gnus-treat-newsgroups-picon
1526           gnus-treat-mail-picon
1527           gnus-treat-from-picon)
1528       ;; If there's much decoration, the user might prefer a boundery.
1529       'head
1530     nil)
1531   "Draw a boundary at the end of the headers.
1532 Valid values are nil and `head'.
1533 See Info node `(gnus)Customizing Articles' for details."
1534   :version "22.1"
1535   :group 'gnus-article-treat
1536   :link '(custom-manual "(gnus)Customizing Articles")
1537   :type gnus-article-treat-head-custom)
1538
1539 (defcustom gnus-treat-capitalize-sentences nil
1540   "Capitalize sentence-starting words.
1541 Valid values are nil, t, `head', `first', `last', an integer or a
1542 predicate.  See Info node `(gnus)Customizing Articles'."
1543   :version "21.1"
1544   :group 'gnus-article-treat
1545   :link '(custom-manual "(gnus)Customizing Articles")
1546   :type gnus-article-treat-custom)
1547
1548 (defcustom gnus-treat-wash-html nil
1549   "Format as HTML.
1550 Valid values are nil, t, `head', `first', `last', an integer or a
1551 predicate.  See Info node `(gnus)Customizing Articles'."
1552   :version "22.1"
1553   :group 'gnus-article-treat
1554   :link '(custom-manual "(gnus)Customizing Articles")
1555   :type gnus-article-treat-custom)
1556
1557 (defcustom gnus-treat-fill-long-lines nil
1558   "Fill long lines.
1559 Valid values are nil, t, `head', `first', `last', an integer or a
1560 predicate.  See Info node `(gnus)Customizing Articles'."
1561   :group 'gnus-article-treat
1562   :link '(custom-manual "(gnus)Customizing Articles")
1563   :type gnus-article-treat-custom)
1564
1565 (defcustom gnus-treat-play-sounds nil
1566   "Play sounds.
1567 Valid values are nil, t, `head', `first', `last', an integer or a
1568 predicate.  See Info node `(gnus)Customizing Articles'."
1569   :version "21.1"
1570   :group 'gnus-article-treat
1571   :link '(custom-manual "(gnus)Customizing Articles")
1572   :type gnus-article-treat-custom)
1573
1574 (defcustom gnus-treat-translate nil
1575   "Translate articles from one language to another.
1576 Valid values are nil, t, `head', `first', `last', an integer or a
1577 predicate.  See Info node `(gnus)Customizing Articles'."
1578   :version "21.1"
1579   :group 'gnus-article-treat
1580   :link '(custom-manual "(gnus)Customizing Articles")
1581   :type gnus-article-treat-custom)
1582
1583 (defcustom gnus-treat-x-pgp-sig nil
1584   "Verify X-PGP-Sig.
1585 To automatically treat X-PGP-Sig, set it to head.
1586 Valid values are nil, t, `head', `first', `last', an integer or a
1587 predicate.  See Info node `(gnus)Customizing Articles'."
1588   :version "22.1"
1589   :group 'gnus-article-treat
1590   :group 'mime-security
1591   :link '(custom-manual "(gnus)Customizing Articles")
1592   :type gnus-article-treat-custom)
1593
1594 (defvar gnus-article-encrypt-protocol-alist
1595   '(("PGP" . mml2015-self-encrypt)))
1596
1597 ;; Set to nil if more than one protocol added to
1598 ;; gnus-article-encrypt-protocol-alist.
1599 (defcustom gnus-article-encrypt-protocol "PGP"
1600   "The protocol used for encrypt articles.
1601 It is a string, such as \"PGP\". If nil, ask user."
1602   :version "22.1"
1603   :type 'string
1604   :group 'mime-security)
1605
1606 (defvar gnus-article-wash-function nil
1607   "Function used for converting HTML into text.")
1608
1609 (defcustom gnus-use-idna (and (condition-case nil (require 'idna) (file-error))
1610                               (mm-coding-system-p 'utf-8)
1611                               (executable-find idna-program))
1612   "Whether IDNA decoding of headers is used when viewing messages.
1613 This requires GNU Libidn, and by default only enabled if it is found."
1614   :version "22.1"
1615   :group 'gnus-article-headers
1616   :type 'boolean)
1617
1618 (defcustom gnus-article-over-scroll nil
1619   "If non-nil, allow scrolling the article buffer even when there no more text."
1620   :version "22.1"
1621   :group 'gnus-article
1622   :type 'boolean)
1623
1624 ;;; Internal variables
1625
1626 (defvar gnus-english-month-names
1627   '("January" "February" "March" "April" "May" "June" "July" "August"
1628     "September" "October" "November" "December"))
1629
1630 (defvar article-goto-body-goes-to-point-min-p nil)
1631 (defvar gnus-article-wash-types nil)
1632 (defvar gnus-article-emphasis-alist nil)
1633 (defvar gnus-article-image-alist nil)
1634
1635 (defvar gnus-article-mime-handle-alist-1 nil)
1636 (defvar gnus-treatment-function-alist
1637   '((gnus-treat-x-pgp-sig gnus-article-verify-x-pgp-sig)
1638     (gnus-treat-strip-banner gnus-article-strip-banner)
1639     (gnus-treat-strip-headers-in-body gnus-article-strip-headers-in-body)
1640     (gnus-treat-highlight-signature gnus-article-highlight-signature)
1641     (gnus-treat-buttonize gnus-article-add-buttons)
1642     (gnus-treat-fill-article gnus-article-fill-cited-article)
1643     (gnus-treat-fill-long-lines gnus-article-fill-long-lines)
1644     (gnus-treat-strip-cr gnus-article-remove-cr)
1645     (gnus-treat-unsplit-urls gnus-article-unsplit-urls)
1646     (gnus-treat-date-ut gnus-article-date-ut)
1647     (gnus-treat-date-local gnus-article-date-local)
1648     (gnus-treat-date-english gnus-article-date-english)
1649     (gnus-treat-date-original gnus-article-date-original)
1650     (gnus-treat-date-user-defined gnus-article-date-user)
1651     (gnus-treat-date-iso8601 gnus-article-date-iso8601)
1652     (gnus-treat-date-lapsed gnus-article-date-lapsed)
1653     (gnus-treat-display-x-face gnus-article-display-x-face)
1654     (gnus-treat-display-face gnus-article-display-face)
1655     (gnus-treat-hide-headers gnus-article-maybe-hide-headers)
1656     (gnus-treat-hide-boring-headers gnus-article-hide-boring-headers)
1657     (gnus-treat-hide-signature gnus-article-hide-signature)
1658     (gnus-treat-strip-list-identifiers gnus-article-hide-list-identifiers)
1659     (gnus-treat-leading-whitespace gnus-article-remove-leading-whitespace)
1660     (gnus-treat-strip-pem gnus-article-hide-pem)
1661     (gnus-treat-from-picon gnus-treat-from-picon)
1662     (gnus-treat-mail-picon gnus-treat-mail-picon)
1663     (gnus-treat-newsgroups-picon gnus-treat-newsgroups-picon)
1664     (gnus-treat-highlight-headers gnus-article-highlight-headers)
1665     (gnus-treat-highlight-signature gnus-article-highlight-signature)
1666     (gnus-treat-strip-trailing-blank-lines
1667      gnus-article-remove-trailing-blank-lines)
1668     (gnus-treat-strip-leading-blank-lines
1669      gnus-article-strip-leading-blank-lines)
1670     (gnus-treat-strip-multiple-blank-lines
1671      gnus-article-strip-multiple-blank-lines)
1672     (gnus-treat-overstrike gnus-article-treat-overstrike)
1673     (gnus-treat-ansi-sequences gnus-article-treat-ansi-sequences)
1674     (gnus-treat-unfold-headers gnus-article-treat-unfold-headers)
1675     (gnus-treat-fold-newsgroups gnus-article-treat-fold-newsgroups)
1676     (gnus-treat-fold-headers gnus-article-treat-fold-headers)
1677     (gnus-treat-buttonize-head gnus-article-add-buttons-to-head)
1678     (gnus-treat-display-smileys gnus-treat-smiley)
1679     (gnus-treat-capitalize-sentences gnus-article-capitalize-sentences)
1680     (gnus-treat-wash-html gnus-article-wash-html)
1681     (gnus-treat-emphasize gnus-article-emphasize)
1682     (gnus-treat-hide-citation gnus-article-hide-citation)
1683     (gnus-treat-hide-citation-maybe gnus-article-hide-citation-maybe)
1684     (gnus-treat-highlight-citation gnus-article-highlight-citation)
1685     (gnus-treat-body-boundary gnus-article-treat-body-boundary)
1686     (gnus-treat-play-sounds gnus-earcon-display)))
1687
1688 (defvar gnus-article-mime-handle-alist nil)
1689 (defvar article-lapsed-timer nil)
1690 (defvar gnus-article-current-summary nil)
1691
1692 (defvar gnus-article-mode-syntax-table
1693   (let ((table (copy-syntax-table text-mode-syntax-table)))
1694     ;; This causes the citation match run O(2^n).
1695     ;; (modify-syntax-entry ?- "w" table)
1696     (modify-syntax-entry ?> ")<" table)
1697     (modify-syntax-entry ?< "(>" table)
1698     ;; make M-. in article buffers work for `foo' strings
1699     (modify-syntax-entry ?' " " table)
1700     (modify-syntax-entry ?` " " table)
1701     table)
1702   "Syntax table used in article mode buffers.
1703 Initialized from `text-mode-syntax-table.")
1704
1705 (defvar gnus-save-article-buffer nil)
1706
1707 (defvar gnus-number-of-articles-to-be-saved nil)
1708
1709 (defvar gnus-inhibit-hiding nil)
1710
1711 (defvar gnus-article-edit-mode nil)
1712
1713 ;;; Macros for dealing with the article buffer.
1714
1715 (defmacro gnus-with-article-headers (&rest forms)
1716   `(with-current-buffer gnus-article-buffer
1717      (save-restriction
1718        (let ((inhibit-read-only t)
1719              (inhibit-point-motion-hooks t)
1720              (case-fold-search t))
1721          (article-narrow-to-head)
1722          ,@forms))))
1723
1724 (put 'gnus-with-article-headers 'lisp-indent-function 0)
1725 (put 'gnus-with-article-headers 'edebug-form-spec '(body))
1726
1727 (defmacro gnus-with-article-buffer (&rest forms)
1728   `(with-current-buffer gnus-article-buffer
1729      (let ((inhibit-read-only t))
1730        ,@forms)))
1731
1732 (put 'gnus-with-article-buffer 'lisp-indent-function 0)
1733 (put 'gnus-with-article-buffer 'edebug-form-spec '(body))
1734
1735 (defun gnus-article-goto-header (header)
1736   "Go to HEADER, which is a regular expression."
1737   (re-search-forward (concat "^\\(" header "\\):") nil t))
1738
1739 (defsubst gnus-article-hide-text (b e props)
1740   "Set text PROPS on the B to E region, extending `intangible' 1 past B."
1741   (gnus-add-text-properties-when 'article-type nil b e props)
1742   (when (memq 'intangible props)
1743     (put-text-property
1744      (max (1- b) (point-min))
1745      b 'intangible (cddr (memq 'intangible props)))))
1746
1747 (defsubst gnus-article-unhide-text (b e)
1748   "Remove hidden text properties from region between B and E."
1749   (remove-text-properties b e gnus-hidden-properties)
1750   (when (memq 'intangible gnus-hidden-properties)
1751     (put-text-property (max (1- b) (point-min))
1752                        b 'intangible nil)))
1753
1754 (defun gnus-article-hide-text-type (b e type)
1755   "Hide text of TYPE between B and E."
1756   (gnus-add-wash-type type)
1757   (gnus-article-hide-text
1758    b e (cons 'article-type (cons type gnus-hidden-properties))))
1759
1760 (defun gnus-article-unhide-text-type (b e type)
1761   "Unhide text of TYPE between B and E."
1762   (gnus-delete-wash-type type)
1763   (remove-text-properties
1764    b e (cons 'article-type (cons type gnus-hidden-properties)))
1765   (when (memq 'intangible gnus-hidden-properties)
1766     (put-text-property (max (1- b) (point-min))
1767                        b 'intangible nil)))
1768
1769 (defun gnus-article-hide-text-of-type (type)
1770   "Hide text of TYPE in the current buffer."
1771   (save-excursion
1772     (let ((b (point-min))
1773           (e (point-max)))
1774       (while (setq b (text-property-any b e 'article-type type))
1775         (add-text-properties b (incf b) gnus-hidden-properties)))))
1776
1777 (defun gnus-article-delete-text-of-type (type)
1778   "Delete text of TYPE in the current buffer."
1779   (save-excursion
1780     (let ((b (point-min)))
1781       (if (eq type 'multipart)
1782           ;; Remove MIME buttons associated with multipart/alternative parts.
1783           (progn
1784             (goto-char b)
1785             (while (if (get-text-property (point) 'gnus-part)
1786                        (setq b (point))
1787                      (when (setq b (next-single-property-change (point)
1788                                                                 'gnus-part))
1789                        (goto-char b)
1790                        t))
1791               (end-of-line)
1792               (skip-chars-forward "\n")
1793               (when (eq (get-text-property b 'article-type) 'multipart)
1794                 (delete-region b (point)))))
1795         (while (setq b (text-property-any b (point-max) 'article-type type))
1796           (delete-region
1797            b (or (text-property-not-all b (point-max) 'article-type type)
1798                  (point-max))))))))
1799
1800 (defun gnus-article-delete-invisible-text ()
1801   "Delete all invisible text in the current buffer."
1802   (save-excursion
1803     (let ((b (point-min)))
1804       (while (setq b (text-property-any b (point-max) 'invisible t))
1805         (delete-region
1806          b (or (text-property-not-all b (point-max) 'invisible t)
1807                (point-max)))))))
1808
1809 (defun gnus-article-text-type-exists-p (type)
1810   "Say whether any text of type TYPE exists in the buffer."
1811   (text-property-any (point-min) (point-max) 'article-type type))
1812
1813 (defsubst gnus-article-header-rank ()
1814   "Give the rank of the string HEADER as given by `gnus-sorted-header-list'."
1815   (let ((list gnus-sorted-header-list)
1816         (i 1))
1817     (while list
1818       (if (looking-at (car list))
1819           (setq list nil)
1820         (setq list (cdr list))
1821         (incf i)))
1822       i))
1823
1824 (defun article-hide-headers (&optional arg delete)
1825   "Hide unwanted headers and possibly sort them as well."
1826   (interactive)
1827   ;; This function might be inhibited.
1828   (unless gnus-inhibit-hiding
1829     (let ((inhibit-read-only t)
1830           (case-fold-search t)
1831           (max (1+ (length gnus-sorted-header-list)))
1832           (inhibit-point-motion-hooks t)
1833           (cur (current-buffer))
1834           ignored visible beg)
1835       (save-excursion
1836         ;; `gnus-ignored-headers' and `gnus-visible-headers' may be
1837         ;; group parameters, so we should go to the summary buffer.
1838         (when (prog1
1839                   (condition-case nil
1840                       (progn (set-buffer gnus-summary-buffer) t)
1841                     (error nil))
1842                 (setq ignored (when (not gnus-visible-headers)
1843                                 (cond ((stringp gnus-ignored-headers)
1844                                        gnus-ignored-headers)
1845                                       ((listp gnus-ignored-headers)
1846                                        (mapconcat 'identity
1847                                                   gnus-ignored-headers
1848                                                   "\\|"))))
1849                       visible (cond ((stringp gnus-visible-headers)
1850                                      gnus-visible-headers)
1851                                     ((and gnus-visible-headers
1852                                           (listp gnus-visible-headers))
1853                                      (mapconcat 'identity
1854                                                 gnus-visible-headers
1855                                                 "\\|")))))
1856           (set-buffer cur))
1857         (save-restriction
1858           ;; First we narrow to just the headers.
1859           (article-narrow-to-head)
1860           ;; Hide any "From " lines at the beginning of (mail) articles.
1861           (while (looking-at "From ")
1862             (forward-line 1))
1863           (unless (bobp)
1864             (delete-region (point-min) (point)))
1865           ;; Then treat the rest of the header lines.
1866           ;; Then we use the two regular expressions
1867           ;; `gnus-ignored-headers' and `gnus-visible-headers' to
1868           ;; select which header lines is to remain visible in the
1869           ;; article buffer.
1870           (while (re-search-forward "^[^ \t:]*:" nil t)
1871             (beginning-of-line)
1872             ;; Mark the rank of the header.
1873             (put-text-property
1874              (point) (1+ (point)) 'message-rank
1875              (if (or (and visible (looking-at visible))
1876                      (and ignored
1877                           (not (looking-at ignored))))
1878                  (gnus-article-header-rank)
1879                (+ 2 max)))
1880             (forward-line 1))
1881           (message-sort-headers-1)
1882           (when (setq beg (text-property-any
1883                            (point-min) (point-max) 'message-rank (+ 2 max)))
1884             ;; We delete the unwanted headers.
1885             (gnus-add-wash-type 'headers)
1886             (add-text-properties (point-min) (+ 5 (point-min))
1887                                  '(article-type headers dummy-invisible t))
1888             (delete-region beg (point-max))))))))
1889
1890 (defun article-hide-boring-headers (&optional arg)
1891   "Toggle hiding of headers that aren't very interesting.
1892 If given a negative prefix, always show; if given a positive prefix,
1893 always hide."
1894   (interactive (gnus-article-hidden-arg))
1895   (when (and (not (gnus-article-check-hidden-text 'boring-headers arg))
1896              (not gnus-show-all-headers))
1897     (save-excursion
1898       (save-restriction
1899         (let ((inhibit-read-only t)
1900               (inhibit-point-motion-hooks t))
1901           (article-narrow-to-head)
1902           (dolist (elem gnus-boring-article-headers)
1903             (goto-char (point-min))
1904             (cond
1905              ;; Hide empty headers.
1906              ((eq elem 'empty)
1907               (while (re-search-forward "^[^: \t]+:[ \t]*\n[^ \t]" nil t)
1908                 (forward-line -1)
1909                 (gnus-article-hide-text-type
1910                  (point-at-bol)
1911                  (progn
1912                    (end-of-line)
1913                    (if (re-search-forward "^[^ \t]" nil t)
1914                        (match-beginning 0)
1915                      (point-max)))
1916                  'boring-headers)))
1917              ;; Hide boring Newsgroups header.
1918              ((eq elem 'newsgroups)
1919               (when (gnus-string-equal
1920                      (gnus-fetch-field "newsgroups")
1921                      (gnus-group-real-name
1922                       (if (boundp 'gnus-newsgroup-name)
1923                           gnus-newsgroup-name
1924                         "")))
1925                 (gnus-article-hide-header "newsgroups")))
1926              ((eq elem 'to-address)
1927               (let ((to (message-fetch-field "to"))
1928                     (to-address
1929                      (gnus-parameter-to-address
1930                       (if (boundp 'gnus-newsgroup-name)
1931                           gnus-newsgroup-name ""))))
1932                 (when (and to to-address
1933                            (ignore-errors
1934                              (gnus-string-equal
1935                               ;; only one address in To
1936                               (nth 1 (mail-extract-address-components to))
1937                               to-address)))
1938                   (gnus-article-hide-header "to"))))
1939              ((eq elem 'to-list)
1940               (let ((to (message-fetch-field "to"))
1941                     (to-list
1942                      (gnus-parameter-to-list
1943                       (if (boundp 'gnus-newsgroup-name)
1944                           gnus-newsgroup-name ""))))
1945                 (when (and to to-list
1946                            (ignore-errors
1947                              (gnus-string-equal
1948                               ;; only one address in To
1949                               (nth 1 (mail-extract-address-components to))
1950                               to-list)))
1951                   (gnus-article-hide-header "to"))))
1952              ((eq elem 'cc-list)
1953               (let ((cc (message-fetch-field "cc"))
1954                     (to-list
1955                      (gnus-parameter-to-list
1956                       (if (boundp 'gnus-newsgroup-name)
1957                           gnus-newsgroup-name ""))))
1958                 (when (and cc to-list
1959                            (ignore-errors
1960                              (gnus-string-equal
1961                               ;; only one address in CC
1962                               (nth 1 (mail-extract-address-components cc))
1963                               to-list)))
1964                   (gnus-article-hide-header "cc"))))
1965              ((eq elem 'followup-to)
1966               (when (gnus-string-equal
1967                      (message-fetch-field "followup-to")
1968                      (message-fetch-field "newsgroups"))
1969                 (gnus-article-hide-header "followup-to")))
1970              ((eq elem 'reply-to)
1971               (if (gnus-group-find-parameter
1972                    gnus-newsgroup-name 'broken-reply-to)
1973                   (gnus-article-hide-header "reply-to")
1974                 (let ((from (message-fetch-field "from"))
1975                       (reply-to (message-fetch-field "reply-to")))
1976                   (when
1977                       (and
1978                        from reply-to
1979                        (ignore-errors
1980                          (equal
1981                           (sort (mapcar
1982                                  (lambda (x) (downcase (cadr x)))
1983                                  (mail-extract-address-components from t))
1984                                 'string<)
1985                           (sort (mapcar
1986                                  (lambda (x) (downcase (cadr x)))
1987                                  (mail-extract-address-components reply-to t))
1988                                 'string<))))
1989                     (gnus-article-hide-header "reply-to")))))
1990              ((eq elem 'date)
1991               (let ((date (with-current-buffer gnus-original-article-buffer
1992                             ;; If date in `gnus-article-buffer' is localized
1993                             ;; (`gnus-treat-date-user-defined'),
1994                             ;; `days-between' might fail.
1995                             (message-fetch-field "date"))))
1996                 (when (and date
1997                            (< (days-between (current-time-string) date)
1998                               4))
1999                   (gnus-article-hide-header "date"))))
2000              ((eq elem 'long-to)
2001               (let ((to (message-fetch-field "to"))
2002                     (cc (message-fetch-field "cc")))
2003                 (when (> (length to) 1024)
2004                   (gnus-article-hide-header "to"))
2005                 (when (> (length cc) 1024)
2006                   (gnus-article-hide-header "cc"))))
2007              ((eq elem 'many-to)
2008               (let ((to-count 0)
2009                     (cc-count 0))
2010                 (goto-char (point-min))
2011                 (while (re-search-forward "^to:" nil t)
2012                   (setq to-count (1+ to-count)))
2013                 (when (> to-count 1)
2014                   (while (> to-count 0)
2015                     (goto-char (point-min))
2016                     (save-restriction
2017                       (re-search-forward "^to:" nil nil to-count)
2018                       (forward-line -1)
2019                       (narrow-to-region (point) (point-max))
2020                       (gnus-article-hide-header "to"))
2021                     (setq to-count (1- to-count))))
2022                 (goto-char (point-min))
2023                 (while (re-search-forward "^cc:" nil t)
2024                   (setq cc-count (1+ cc-count)))
2025                 (when (> cc-count 1)
2026                   (while (> cc-count 0)
2027                     (goto-char (point-min))
2028                     (save-restriction
2029                       (re-search-forward "^cc:" nil nil cc-count)
2030                       (forward-line -1)
2031                       (narrow-to-region (point) (point-max))
2032                       (gnus-article-hide-header "cc"))
2033                     (setq cc-count (1- cc-count)))))))))))))
2034
2035 (defun gnus-article-hide-header (header)
2036   (save-excursion
2037     (goto-char (point-min))
2038     (when (re-search-forward (concat "^" header ":") nil t)
2039       (gnus-article-hide-text-type
2040        (point-at-bol)
2041        (progn
2042          (end-of-line)
2043          (if (re-search-forward "^[^ \t]" nil t)
2044              (match-beginning 0)
2045            (point-max)))
2046        'boring-headers))))
2047
2048 (defvar gnus-article-normalized-header-length 40
2049   "Length of normalized headers.")
2050
2051 (defun article-normalize-headers ()
2052   "Make all header lines 40 characters long."
2053   (interactive)
2054   (let ((inhibit-read-only t)
2055         column)
2056     (save-excursion
2057       (save-restriction
2058         (article-narrow-to-head)
2059         (while (not (eobp))
2060           (cond
2061            ((< (setq column (- (point-at-eol) (point)))
2062                gnus-article-normalized-header-length)
2063             (end-of-line)
2064             (insert (make-string
2065                      (- gnus-article-normalized-header-length column)
2066                      ? )))
2067            ((> column gnus-article-normalized-header-length)
2068             (gnus-put-text-property
2069              (progn
2070                (forward-char gnus-article-normalized-header-length)
2071                (point))
2072              (point-at-eol)
2073              'invisible t))
2074            (t
2075             ;; Do nothing.
2076             ))
2077           (forward-line 1))))))
2078
2079 (defun article-treat-dumbquotes ()
2080   "Translate M****s*** sm*rtq**t*s and other symbols into proper text.
2081 Note that this function guesses whether a character is a sm*rtq**t* or
2082 not, so it should only be used interactively.
2083
2084 Sm*rtq**t*s are M****s***'s unilateral extension to the
2085 iso-8859-1 character map in an attempt to provide more quoting
2086 characters.  If you see something like \\222 or \\264 where
2087 you're expecting some kind of apostrophe or quotation mark, then
2088 try this wash."
2089   (interactive)
2090   (article-translate-strings gnus-article-dumbquotes-map))
2091
2092 (defun article-translate-characters (from to)
2093   "Translate all characters in the body of the article according to FROM and TO.
2094 FROM is a string of characters to translate from; to is a string of
2095 characters to translate to."
2096   (save-excursion
2097     (when (article-goto-body)
2098       (let ((inhibit-read-only t)
2099             (x (make-string 225 ?x))
2100             (i -1))
2101         (while (< (incf i) (length x))
2102           (aset x i i))
2103         (setq i 0)
2104         (while (< i (length from))
2105           (aset x (aref from i) (aref to i))
2106           (incf i))
2107         (translate-region (point) (point-max) x)))))
2108
2109 (defun article-translate-strings (map)
2110   "Translate all string in the body of the article according to MAP.
2111 MAP is an alist where the elements are on the form (\"from\" \"to\")."
2112   (save-excursion
2113     (when (article-goto-body)
2114       (let ((inhibit-read-only t))
2115         (dolist (elem map)
2116           (save-excursion
2117             (while (search-forward (car elem) nil t)
2118               (replace-match (cadr elem)))))))))
2119
2120 (defun article-treat-overstrike ()
2121   "Translate overstrikes into bold text."
2122   (interactive)
2123   (save-excursion
2124     (when (article-goto-body)
2125       (let ((inhibit-read-only t))
2126         (while (search-forward "\b" nil t)
2127           (let ((next (char-after))
2128                 (previous (char-after (- (point) 2))))
2129             ;; We do the boldification/underlining by hiding the
2130             ;; overstrikes and putting the proper text property
2131             ;; on the letters.
2132             (cond
2133              ((eq next previous)
2134               (gnus-article-hide-text-type (- (point) 2) (point) 'overstrike)
2135               (put-text-property (point) (1+ (point)) 'face 'bold))
2136              ((eq next ?_)
2137               (gnus-article-hide-text-type
2138                (1- (point)) (1+ (point)) 'overstrike)
2139               (put-text-property
2140                (- (point) 2) (1- (point)) 'face 'underline))
2141              ((eq previous ?_)
2142               (gnus-article-hide-text-type (- (point) 2) (point) 'overstrike)
2143               (put-text-property
2144                (point) (1+ (point)) 'face 'underline)))))))))
2145
2146 (defun article-treat-ansi-sequences ()
2147   "Translate ANSI SGR control sequences into overlays or extents."
2148   (interactive)
2149   (save-excursion
2150     (when (article-goto-body)
2151       (let ((inhibit-read-only t))
2152         (ansi-color-apply-on-region (point) (point-max))))))
2153
2154 (defun gnus-article-treat-unfold-headers ()
2155   "Unfold folded message headers.
2156 Only the headers that fit into the current window width will be
2157 unfolded."
2158   (interactive)
2159   (gnus-with-article-headers
2160     (let (length)
2161       (while (not (eobp))
2162         (save-restriction
2163           (mail-header-narrow-to-field)
2164           (let* ((header (buffer-string))
2165                  (unfoldable
2166                   (or (equal gnus-article-unfold-long-headers t)
2167                       (and (stringp gnus-article-unfold-long-headers)
2168                            (string-match gnus-article-unfold-long-headers header)))))
2169             (with-temp-buffer
2170               (insert header)
2171               (goto-char (point-min))
2172               (while (re-search-forward "\n[\t ]" nil t)
2173                 (replace-match " " t t)))
2174             (setq length (- (point-max) (point-min) 1))
2175             (when (or unfoldable
2176                       (< length (window-width)))
2177               (while (re-search-forward "\n[\t ]" nil t)
2178                 (replace-match " " t t))))
2179           (goto-char (point-max)))))))
2180
2181 (defun gnus-article-treat-fold-headers ()
2182   "Fold message headers."
2183   (interactive)
2184   (gnus-with-article-headers
2185     (while (not (eobp))
2186       (save-restriction
2187         (mail-header-narrow-to-field)
2188         (mail-header-fold-field)
2189         (goto-char (point-max))))))
2190
2191 (defun gnus-treat-smiley ()
2192   "Toggle display of textual emoticons (\"smileys\") as small graphical icons."
2193   (interactive)
2194   (gnus-with-article-buffer
2195     (if (memq 'smiley gnus-article-wash-types)
2196         (gnus-delete-images 'smiley)
2197       (article-goto-body)
2198       (let ((images (smiley-region (point) (point-max))))
2199         (when images
2200           (gnus-add-wash-type 'smiley)
2201           (dolist (image images)
2202             (gnus-add-image 'smiley image)))))))
2203
2204 (defun gnus-article-remove-images ()
2205   "Remove all images from the article buffer."
2206   (interactive)
2207   (gnus-with-article-buffer
2208     (dolist (elem gnus-article-image-alist)
2209       (gnus-delete-images (car elem)))))
2210
2211 (defun gnus-article-treat-fold-newsgroups ()
2212   "Unfold folded message headers.
2213 Only the headers that fit into the current window width will be
2214 unfolded."
2215   (interactive)
2216   (gnus-with-article-headers
2217     (while (gnus-article-goto-header "newsgroups\\|followup-to")
2218       (save-restriction
2219         (mail-header-narrow-to-field)
2220         (while (re-search-forward ", *" nil t)
2221           (replace-match ", " t t))
2222         (mail-header-fold-field)
2223         (goto-char (point-max))))))
2224
2225 (defcustom gnus-article-truncate-lines (default-value 'truncate-lines)
2226   "Value of `truncate-lines' in Gnus Article buffer.
2227 Valid values are nil, t, `head', `first', `last', an integer or a
2228 predicate.  See Info node `(gnus)Customizing Articles'."
2229   :version "23.1" ;; No Gnus
2230   :group 'gnus-article
2231   ;; :link '(custom-manual "(gnus)Customizing Articles")
2232   :type 'boolean)
2233
2234 (defun gnus-article-toggle-truncate-lines (&optional arg)
2235   "Toggle whether to fold or truncate long lines in article the buffer.
2236 If ARG is non-nil and not a number, toggle
2237 `gnus-article-truncate-lines' too.  If ARG is a number, truncate
2238 long lines if and only if arg is positive."
2239   (interactive "P")
2240   (cond
2241    ((and (numberp arg) (> arg 0))
2242     (setq gnus-article-truncate-lines t))
2243    ((numberp arg)
2244     (setq gnus-article-truncate-lines nil))
2245    (arg
2246     (setq gnus-article-truncate-lines
2247           (not gnus-article-truncate-lines))))
2248   (gnus-with-article-buffer
2249     (cond
2250      ((and (numberp arg) (> arg 0))
2251       (setq truncate-lines nil))
2252      ((numberp arg)
2253       (setq truncate-lines t)))
2254     ;; In versions of Emacs 22 (CVS) before 2006-05-26,
2255     ;; `toggle-truncate-lines' needs an argument.
2256     (toggle-truncate-lines)))
2257
2258 (defun gnus-article-treat-body-boundary ()
2259   "Place a boundary line at the end of the headers."
2260   (interactive)
2261   (when (and gnus-body-boundary-delimiter
2262              (> (length gnus-body-boundary-delimiter) 0))
2263     (gnus-with-article-headers
2264       (goto-char (point-max))
2265       (let ((start (point)))
2266         (insert "X-Boundary: ")
2267         (gnus-add-text-properties start (point) '(invisible t intangible t))
2268         (insert (let (str)
2269                   (while (>= (1- (window-width)) (length str))
2270                     (setq str (concat str gnus-body-boundary-delimiter)))
2271                   (substring str 0 (1- (window-width))))
2272                 "\n")
2273         (gnus-put-text-property start (point) 'gnus-decoration 'header)))))
2274
2275 (defun article-fill-long-lines ()
2276   "Fill lines that are wider than the window width."
2277   (interactive)
2278   (save-excursion
2279     (let ((inhibit-read-only t)
2280           (width (window-width (get-buffer-window (current-buffer)))))
2281       (save-restriction
2282         (article-goto-body)
2283         (let ((adaptive-fill-mode nil)) ;Why?  -sm
2284           (while (not (eobp))
2285             (end-of-line)
2286             (when (>= (current-column) (min fill-column width))
2287               (narrow-to-region (min (1+ (point)) (point-max))
2288                                 (point-at-bol))
2289               (let ((goback (point-marker)))
2290                 (fill-paragraph nil)
2291                 (goto-char (marker-position goback)))
2292               (widen))
2293             (forward-line 1)))))))
2294
2295 (defun article-capitalize-sentences ()
2296   "Capitalize the first word in each sentence."
2297   (interactive)
2298   (save-excursion
2299     (let ((inhibit-read-only t)
2300           (paragraph-start "^[\n\^L]"))
2301       (article-goto-body)
2302       (while (not (eobp))
2303         (capitalize-word 1)
2304         (forward-sentence)))))
2305
2306 (defun article-remove-cr ()
2307   "Remove trailing CRs and then translate remaining CRs into LFs."
2308   (interactive)
2309   (save-excursion
2310     (let ((inhibit-read-only t))
2311       (goto-char (point-min))
2312       (while (re-search-forward "\r+$" nil t)
2313         (replace-match "" t t))
2314       (goto-char (point-min))
2315       (while (search-forward "\r" nil t)
2316         (replace-match "\n" t t)))))
2317
2318 (defun article-remove-trailing-blank-lines ()
2319   "Remove all trailing blank lines from the article."
2320   (interactive)
2321   (save-excursion
2322     (let ((inhibit-read-only t))
2323       (goto-char (point-max))
2324       (delete-region
2325        (point)
2326        (progn
2327          (while (and (not (bobp))
2328                      (looking-at "^[ \t]*$")
2329                      (not (gnus-annotation-in-region-p
2330                            (point) (point-at-eol))))
2331            (forward-line -1))
2332          (forward-line 1)
2333          (point))))))
2334
2335 (defvar gnus-face-properties-alist)
2336
2337 (defun article-display-face (&optional force)
2338   "Display any Face headers in the header."
2339   (interactive (list 'force))
2340   (let ((wash-face-p buffer-read-only))
2341     (gnus-with-article-headers
2342       ;; When displaying parts, this function can be called several times on
2343       ;; the same article, without any intended toggle semantic (as typing `W
2344       ;; D d' would have). So face deletion must occur only when we come from
2345       ;; an interactive command, that is when the *Article* buffer is
2346       ;; read-only.
2347       (if (and wash-face-p (memq 'face gnus-article-wash-types))
2348           (gnus-delete-images 'face)
2349         (let ((from (message-fetch-field "from"))
2350               face faces)
2351           (save-current-buffer
2352             (when (and wash-face-p
2353                        (gnus-buffer-live-p gnus-original-article-buffer)
2354                        (not (re-search-forward "^Face:[\t ]*" nil t)))
2355               (set-buffer gnus-original-article-buffer))
2356             (save-restriction
2357               (mail-narrow-to-head)
2358               (when (or force
2359                         ;; Check whether this face is censored.
2360                         (not (and gnus-article-x-face-too-ugly
2361                                   (or from
2362                                       (setq from (message-fetch-field "from")))
2363                                   (string-match gnus-article-x-face-too-ugly
2364                                                 from))))
2365                 (while (gnus-article-goto-header "Face")
2366                   (push (mail-header-field-value) faces)))))
2367           (when faces
2368             (goto-char (point-min))
2369             (let (png image)
2370               (unless (setq from (gnus-article-goto-header "from"))
2371                 (insert "From:")
2372                 (setq from (point))
2373                 (insert " [no `from' set]\n"))
2374               (while faces
2375                 (when (setq png (gnus-convert-face-to-png (pop faces)))
2376                   (setq image
2377                         (apply 'gnus-create-image png 'png t
2378                                (cdr (assq 'png gnus-face-properties-alist))))
2379                   (goto-char from)
2380                   (gnus-add-wash-type 'face)
2381                   (gnus-add-image 'face image)
2382                   (gnus-put-image image nil 'face))))))))))
2383
2384 (defun article-display-x-face (&optional force)
2385   "Look for an X-Face header and display it if present."
2386   (interactive (list 'force))
2387   (let ((wash-face-p buffer-read-only)) ;; When type `W f'
2388     (gnus-with-article-headers
2389       ;; Delete the old process, if any.
2390       (when (process-status "article-x-face")
2391         (delete-process "article-x-face"))
2392       ;; See the comment in `article-display-face'.
2393       (if (and wash-face-p (memq 'xface gnus-article-wash-types))
2394           ;; We have already displayed X-Faces, so we remove them
2395           ;; instead.
2396           (gnus-delete-images 'xface)
2397         ;; Display X-Faces.
2398         (let ((from (message-fetch-field "from"))
2399               x-faces face)
2400           (save-current-buffer
2401             (when (and wash-face-p
2402                        (gnus-buffer-live-p gnus-original-article-buffer)
2403                        (not (re-search-forward "^X-Face:[\t ]*" nil t)))
2404               ;; If type `W f', use gnus-original-article-buffer,
2405               ;; otherwise use the current buffer because displaying
2406               ;; RFC822 parts calls this function too.
2407               (set-buffer gnus-original-article-buffer))
2408             (save-restriction
2409               (mail-narrow-to-head)
2410               (and gnus-article-x-face-command
2411                    (or force
2412                        ;; Check whether this face is censored.
2413                        (not (and gnus-article-x-face-too-ugly
2414                                  (or from
2415                                      (setq from (message-fetch-field "from")))
2416                                  (string-match gnus-article-x-face-too-ugly
2417                                                from))))
2418                    (while (gnus-article-goto-header "X-Face")
2419                      (push (mail-header-field-value) x-faces)))))
2420           (when x-faces
2421             ;; We display the face.
2422             (cond ((functionp gnus-article-x-face-command)
2423                    ;; The command is a lisp function, so we call it.
2424                    (mapc gnus-article-x-face-command x-faces))
2425                   ((stringp gnus-article-x-face-command)
2426                    ;; The command is a string, so we interpret the command
2427                    ;; as a, well, command, and fork it off.
2428                    (let ((process-connection-type nil))
2429                      (gnus-set-process-query-on-exit-flag
2430                       (start-process
2431                        "article-x-face" nil shell-file-name
2432                        shell-command-switch gnus-article-x-face-command)
2433                       nil)
2434                      ;; Sending multiple EOFs to xv doesn't work,
2435                      ;; so we only do a single external face.
2436                      (with-temp-buffer
2437                        (insert (car x-faces))
2438                        (process-send-region "article-x-face"
2439                                             (point-min) (point-max)))
2440                      (process-send-eof "article-x-face")))
2441                   (t
2442                    (error "`%s' set to `%s' is not a function"
2443                           gnus-article-x-face-command
2444                           'gnus-article-x-face-command)))))))))
2445
2446 (defun article-decode-mime-words ()
2447   "Decode all MIME-encoded words in the article."
2448   (interactive)
2449   (gnus-with-article-buffer
2450     (let ((inhibit-point-motion-hooks t)
2451           (mail-parse-charset gnus-newsgroup-charset)
2452           (mail-parse-ignored-charsets
2453            (with-current-buffer gnus-summary-buffer
2454              gnus-newsgroup-ignored-charsets)))
2455       (mail-decode-encoded-word-region (point-min) (point-max)))))
2456
2457 (defun article-decode-charset (&optional prompt)
2458   "Decode charset-encoded text in the article.
2459 If PROMPT (the prefix), prompt for a coding system to use."
2460   (interactive "P")
2461   (let ((inhibit-point-motion-hooks t) (case-fold-search t)
2462         (inhibit-read-only t)
2463         (mail-parse-charset gnus-newsgroup-charset)
2464         (mail-parse-ignored-charsets
2465          (save-excursion (condition-case nil
2466                              (set-buffer gnus-summary-buffer)
2467                            (error))
2468                          gnus-newsgroup-ignored-charsets))
2469         ct cte ctl charset format)
2470     (save-excursion
2471       (save-restriction
2472         (article-narrow-to-head)
2473         (setq ct (message-fetch-field "Content-Type" t)
2474               cte (message-fetch-field "Content-Transfer-Encoding" t)
2475               ctl (and ct (mail-header-parse-content-type ct))
2476               charset (cond
2477                        (prompt
2478                         (mm-read-coding-system "Charset to decode: "))
2479                        (ctl
2480                         (mail-content-type-get ctl 'charset)))
2481               format (and ctl (mail-content-type-get ctl 'format)))
2482         (when cte
2483           (setq cte (mail-header-strip cte)))
2484         (if (and ctl (not (string-match "/" (car ctl))))
2485             (setq ctl nil))
2486         (goto-char (point-max)))
2487       (forward-line 1)
2488       (save-restriction
2489         (narrow-to-region (point) (point-max))
2490         (when (and (eq mail-parse-charset 'gnus-decoded)
2491                    (eq (mm-body-7-or-8) '8bit))
2492           ;; The text code could have been decoded.
2493           (setq charset mail-parse-charset))
2494         (when (and (or (not ctl)
2495                        (equal (car ctl) "text/plain"))
2496                    (not format)) ;; article with format will decode later.
2497           (mm-decode-body
2498            charset (and cte (intern (downcase
2499                                      (gnus-strip-whitespace cte))))
2500            (car ctl)))))))
2501
2502 (defun article-decode-encoded-words ()
2503   "Remove encoded-word encoding from headers."
2504   (let ((inhibit-point-motion-hooks t)
2505         (mail-parse-charset gnus-newsgroup-charset)
2506         (mail-parse-ignored-charsets
2507          (save-excursion (condition-case nil
2508                              (set-buffer gnus-summary-buffer)
2509                            (error))
2510                          gnus-newsgroup-ignored-charsets))
2511         (inhibit-read-only t)
2512         end start)
2513     (goto-char (point-min))
2514     (when (search-forward "\n\n" nil 'move)
2515       (forward-line -1))
2516     (setq end (point))
2517     (while (not (bobp))
2518       (while (progn
2519                (forward-line -1)
2520                (and (not (bobp))
2521                     (memq (char-after) '(?\t ? )))))
2522       (setq start (point))
2523       (if (looking-at "\
2524 \\(?:Resent-\\)?\\(?:From\\|Cc\\|To\\|Bcc\\|\\(?:In-\\)?Reply-To\\|Sender\
2525 \\|Mail-Followup-To\\|Mail-Copies-To\\|Approved\\):")
2526           (funcall gnus-decode-address-function start end)
2527         (funcall gnus-decode-header-function start end))
2528       (goto-char (setq end start)))))
2529
2530 (defun article-decode-group-name ()
2531   "Decode group names in Newsgroups, Followup-To and Xref headers."
2532   (let ((inhibit-point-motion-hooks t)
2533         (inhibit-read-only t)
2534         (method (gnus-find-method-for-group gnus-newsgroup-name))
2535         regexp)
2536     (when (and (or gnus-group-name-charset-method-alist
2537                    gnus-group-name-charset-group-alist)
2538                (gnus-buffer-live-p gnus-original-article-buffer))
2539       (save-restriction
2540         (article-narrow-to-head)
2541         (dolist (header '("Newsgroups" "Followup-To" "Xref"))
2542           (with-current-buffer gnus-original-article-buffer
2543             (goto-char (point-min)))
2544           (setq regexp (concat "^" header
2545                                ":\\([^\n]*\\(?:\n[\t ]+[^\n]+\\)*\\)\n"))
2546           (while (re-search-forward regexp nil t)
2547             (replace-match (save-match-data
2548                              (gnus-decode-newsgroups
2549                               ;; XXX how to use data in article buffer?
2550                               (with-current-buffer gnus-original-article-buffer
2551                                 (re-search-forward regexp nil t)
2552                                 (match-string 1))
2553                               gnus-newsgroup-name method))
2554                            t t nil 1))
2555           (goto-char (point-min)))))))
2556
2557 (autoload 'idna-to-unicode "idna")
2558
2559 (defun article-decode-idna-rhs ()
2560   "Decode IDNA strings in RHS in various headers in current buffer.
2561 The following headers are decoded: From:, To:, Cc:, Reply-To:,
2562 Mail-Reply-To: and Mail-Followup-To:."
2563   (when gnus-use-idna
2564     (save-restriction
2565       (let ((inhibit-point-motion-hooks t)
2566             (inhibit-read-only t))
2567         (article-narrow-to-head)
2568         (goto-char (point-min))
2569         (while (re-search-forward "@[^ \t\n\r,>]*\\(xn--[-A-Za-z0-9.]*\\)[ \t\n\r,>]" nil t)
2570           (let (ace unicode)
2571             (when (save-match-data
2572                     (and (setq ace (match-string 1))
2573                          (save-excursion
2574                            (and (re-search-backward "^[^ \t]" nil t)
2575                                 (looking-at "From\\|To\\|Cc\\|Reply-To\\|Mail-Reply-To\\|Mail-Followup-To")))
2576                          (setq unicode (idna-to-unicode ace))))
2577               (unless (string= ace unicode)
2578                 (replace-match unicode nil nil nil 1)))))))))
2579
2580 (defun article-de-quoted-unreadable (&optional force read-charset)
2581   "Translate a quoted-printable-encoded article.
2582 If FORCE, decode the article whether it is marked as quoted-printable
2583 or not.
2584 If READ-CHARSET, ask for a coding system."
2585   (interactive (list 'force current-prefix-arg))
2586   (save-excursion
2587     (let ((inhibit-read-only t) type charset)
2588       (if (gnus-buffer-live-p gnus-original-article-buffer)
2589           (with-current-buffer gnus-original-article-buffer
2590             (setq type
2591                   (gnus-fetch-field "content-transfer-encoding"))
2592             (let* ((ct (gnus-fetch-field "content-type"))
2593                    (ctl (and ct (mail-header-parse-content-type ct))))
2594               (setq charset (and ctl
2595                                  (mail-content-type-get ctl 'charset)))
2596               (if (stringp charset)
2597                   (setq charset (intern (downcase charset)))))))
2598       (if read-charset
2599           (setq charset (mm-read-coding-system "Charset: " charset)))
2600       (unless charset
2601         (setq charset gnus-newsgroup-charset))
2602       (when (or force
2603                 (and type (let ((case-fold-search t))
2604                             (string-match "quoted-printable" type))))
2605         (article-goto-body)
2606         (quoted-printable-decode-region
2607          (point) (point-max) (mm-charset-to-coding-system charset))))))
2608
2609 (defun article-de-base64-unreadable (&optional force read-charset)
2610   "Translate a base64 article.
2611 If FORCE, decode the article whether it is marked as base64 not.
2612 If READ-CHARSET, ask for a coding system."
2613   (interactive (list 'force current-prefix-arg))
2614   (save-excursion
2615     (let ((inhibit-read-only t) type charset)
2616       (if (gnus-buffer-live-p gnus-original-article-buffer)
2617           (with-current-buffer gnus-original-article-buffer
2618             (setq type
2619                   (gnus-fetch-field "content-transfer-encoding"))
2620             (let* ((ct (gnus-fetch-field "content-type"))
2621                    (ctl (and ct (mail-header-parse-content-type ct))))
2622               (setq charset (and ctl
2623                                  (mail-content-type-get ctl 'charset)))
2624               (if (stringp charset)
2625                   (setq charset (intern (downcase charset)))))))
2626       (if read-charset
2627           (setq charset (mm-read-coding-system "Charset: " charset)))
2628       (unless charset
2629         (setq charset gnus-newsgroup-charset))
2630       (when (or force
2631                 (and type (let ((case-fold-search t))
2632                             (string-match "base64" type))))
2633         (article-goto-body)
2634         (save-restriction
2635           (narrow-to-region (point) (point-max))
2636           (base64-decode-region (point-min) (point-max))
2637           (mm-decode-coding-region
2638            (point-min) (point-max) (mm-charset-to-coding-system charset)))))))
2639
2640 (eval-when-compile
2641   (require 'rfc1843))
2642
2643 (defun article-decode-HZ ()
2644   "Translate a HZ-encoded article."
2645   (interactive)
2646   (require 'rfc1843)
2647   (save-excursion
2648     (let ((inhibit-read-only t))
2649       (rfc1843-decode-region (point-min) (point-max)))))
2650
2651 (defun article-unsplit-urls ()
2652   "Remove the newlines that some other mailers insert into URLs."
2653   (interactive)
2654   (save-excursion
2655     (let ((inhibit-read-only t))
2656       (goto-char (point-min))
2657       (while (re-search-forward
2658               "\\(\\(https?\\|ftp\\)://\\S-+\\) *\n\\(\\S-+\\)" nil t)
2659         (replace-match "\\1\\3" t)))
2660     (when (interactive-p)
2661       (gnus-treat-article nil))))
2662
2663
2664 (defun article-wash-html (&optional read-charset)
2665   "Format an HTML article.
2666 If READ-CHARSET, ask for a coding system.  If it is a number, the
2667 charset defined in `gnus-summary-show-article-charset-alist' is used."
2668   (interactive "P")
2669   (save-excursion
2670     (let ((inhibit-read-only t)
2671           charset)
2672       (if read-charset
2673           (if (or (and (numberp read-charset)
2674                        (setq charset
2675                              (cdr
2676                               (assq read-charset
2677                                     gnus-summary-show-article-charset-alist))))
2678                   (setq charset (mm-read-coding-system "Charset: ")))
2679               (let ((gnus-summary-show-article-charset-alist
2680                      (list (cons 1 charset))))
2681                 (with-current-buffer gnus-summary-buffer
2682                   (gnus-summary-show-article 1)))
2683             (error "No charset is given"))
2684         (when (gnus-buffer-live-p gnus-original-article-buffer)
2685           (with-current-buffer gnus-original-article-buffer
2686             (let* ((ct (gnus-fetch-field "content-type"))
2687                    (ctl (and ct (mail-header-parse-content-type ct))))
2688               (setq charset (and ctl
2689                                  (mail-content-type-get ctl 'charset)))
2690               (when (stringp charset)
2691                 (setq charset (intern (downcase charset)))))))
2692         (unless charset
2693           (setq charset gnus-newsgroup-charset)))
2694       (article-goto-body)
2695       (save-window-excursion
2696         (save-restriction
2697           (narrow-to-region (point) (point-max))
2698           (let* ((func (or gnus-article-wash-function mm-text-html-renderer))
2699                  (entry (assq func mm-text-html-washer-alist)))
2700             (when entry
2701               (setq func (cdr entry)))
2702             (cond
2703              ((functionp func)
2704               (funcall func))
2705              (t
2706               (apply (car func) (cdr func))))))))))
2707
2708 ;; External.
2709 (declare-function w3-region "ext:w3-display" (st nd))
2710
2711 (defun gnus-article-wash-html-with-w3 ()
2712   "Wash the current buffer with w3."
2713   (mm-setup-w3)
2714   (let ((w3-strict-width (window-width))
2715         (url-standalone-mode t)
2716         (url-gateway-unplugged t)
2717         (w3-honor-stylesheets nil))
2718     (condition-case ()
2719         (w3-region (point-min) (point-max))
2720       (error))))
2721
2722 ;; External.
2723 (declare-function w3m-region "ext:w3m" (start end &optional url charset))
2724
2725 (defun gnus-article-wash-html-with-w3m ()
2726   "Wash the current buffer with emacs-w3m."
2727   (mm-setup-w3m)
2728   (let ((w3m-safe-url-regexp mm-w3m-safe-url-regexp)
2729         w3m-force-redisplay)
2730     (w3m-region (point-min) (point-max)))
2731   (when (and mm-inline-text-html-with-w3m-keymap
2732              (boundp 'w3m-minor-mode-map)
2733              w3m-minor-mode-map)
2734     (add-text-properties
2735      (point-min) (point-max)
2736      (list 'keymap w3m-minor-mode-map
2737            ;; Put the mark meaning this part was rendered by emacs-w3m.
2738            'mm-inline-text-html-with-w3m t))))
2739
2740 (defvar charset) ;; Bound by `article-wash-html'.
2741
2742 (defun gnus-article-wash-html-with-w3m-standalone ()
2743   "Wash the current buffer with w3m."
2744   (if (mm-w3m-standalone-supports-m17n-p)
2745       (progn
2746         (unless (mm-coding-system-p charset) ;; Bound by `article-wash-html'.
2747           ;; The default.
2748           (setq charset 'iso-8859-1))
2749         (let ((coding-system-for-write charset)
2750               (coding-system-for-read charset))
2751           (call-process-region
2752            (point-min) (point-max)
2753            "w3m" t t nil "-dump" "-T" "text/html"
2754            "-I" (symbol-name charset) "-O" (symbol-name charset))))
2755     (mm-inline-wash-with-stdin nil "w3m" "-dump" "-T" "text/html")))
2756
2757 (defvar gnus-article-browse-html-temp-list nil
2758   "List of temporary files created by `gnus-article-browse-html-parts'.
2759 Internal variable.")
2760
2761 (defcustom gnus-article-browse-delete-temp 'ask
2762   "What to do with temporary files from `gnus-article-browse-html-parts'.
2763 If nil, don't delete temporary files.  If it is t, delete them on
2764 exit from the summary buffer.  If it is the symbol `file', query
2765 on each file, if it is `ask' ask once when exiting from the
2766 summary buffer."
2767   :group 'gnus-article
2768   :version "23.1" ;; No Gnus
2769   :type '(choice (const :tag "Don't delete" nil)
2770                  (const :tag "Don't ask" t)
2771                  (const :tag "Ask" ask)
2772                  (const :tag "Ask for each file" file)))
2773
2774 ;; Cf. mm-postponed-undisplay-list / mm-destroy-postponed-undisplay-list.
2775
2776 (defun gnus-article-browse-delete-temp-files (&optional how)
2777   "Delete temp-files created by `gnus-article-browse-html-parts'."
2778   (when (and gnus-article-browse-html-temp-list
2779              (or how
2780                  (setq how gnus-article-browse-delete-temp)))
2781     (when (and (eq how 'ask)
2782                (gnus-y-or-n-p (format
2783                                "Delete all %s temporary HTML file(s)? "
2784                                (length gnus-article-browse-html-temp-list)))
2785                (setq how t)))
2786     (dolist (file gnus-article-browse-html-temp-list)
2787       (when (and (file-exists-p file)
2788                  (or (eq how t)
2789                      ;; `how' is neither `nil', `ask' nor `t' (i.e. `file'):
2790                      (gnus-y-or-n-p
2791                       (format "Delete temporary HTML file `%s'? " file))))
2792         (delete-file file)))
2793     ;; Also remove file from the list when not deleted or if file doesn't
2794     ;; exist anymore.
2795     (setq gnus-article-browse-html-temp-list nil))
2796   gnus-article-browse-html-temp-list)
2797
2798 (defun gnus-article-browse-html-parts (list &optional header)
2799   "View all \"text/html\" parts from LIST.
2800 Recurse into multiparts.  The optional HEADER that should be a decoded
2801 message header will be added to the bodies of the \"text/html\" parts."
2802   ;; Internal function used by `gnus-article-browse-html-article'.
2803   (let (type file charset tmp-file showed)
2804     ;; Find and show the html-parts.
2805     (dolist (handle list)
2806       ;; If HTML, show it:
2807       (cond ((not (listp handle)))
2808             ((or (equal (car (setq type (mm-handle-type handle))) "text/html")
2809                  (and (equal (car type) "message/external-body")
2810                       (or header
2811                           (setq file (or (mail-content-type-get type 'name)
2812                                          (mail-content-type-get
2813                                           (mm-handle-disposition handle)
2814                                           'filename))))
2815                       (or (mm-handle-cache handle)
2816                           (condition-case code
2817                               (progn (mm-extern-cache-contents handle) t)
2818                             (error
2819                              (gnus-message 3 "%s" (error-message-string code))
2820                              (when (>= gnus-verbose 3) (sit-for 2))
2821                              nil)))
2822                       (progn
2823                         (setq handle (mm-handle-cache handle)
2824                               type (mm-handle-type handle))
2825                         (equal (car type) "text/html"))))
2826              (when (or (setq charset (mail-content-type-get type 'charset))
2827                        header
2828                        (not file))
2829                (setq tmp-file (mm-make-temp-file
2830                                ;; Do we need to care for 8.3 filenames?
2831                                "mm-" nil ".html")))
2832              ;; Add a meta html tag to specify charset and a header.
2833              (cond
2834               (header
2835                (let (title eheader body hcharset coding)
2836                  (with-temp-buffer
2837                    (mm-enable-multibyte)
2838                    (setq case-fold-search t)
2839                    (insert header "\n")
2840                    (setq title (message-fetch-field "subject"))
2841                    (goto-char (point-min))
2842                    (while (re-search-forward "\\(<\\)\\|\\(>\\)\\|&" nil t)
2843                      (replace-match (cond ((match-beginning 1) "&lt;")
2844                                           ((match-beginning 2) "&gt;")
2845                                           (t "&amp;"))))
2846                    (goto-char (point-min))
2847                    (insert "<pre>\n")
2848                    (goto-char (point-max))
2849                    (insert "</pre>\n<hr>\n")
2850                    ;; We have to examine charset one by one since
2851                    ;; charset specified in parts might be different.
2852                    (if (eq charset 'gnus-decoded)
2853                        (setq charset 'utf-8
2854                              eheader (mm-encode-coding-string (buffer-string)
2855                                                               charset)
2856                              title (when title
2857                                      (mm-encode-coding-string title charset))
2858                              body (mm-encode-coding-string (mm-get-part handle)
2859                                                            charset))
2860                      (setq hcharset (mm-find-mime-charset-region (point-min)
2861                                                                  (point-max)))
2862                      (cond ((= (length hcharset) 1)
2863                             (setq hcharset (car hcharset)
2864                                   coding (mm-charset-to-coding-system
2865                                           hcharset)))
2866                            ((> (length hcharset) 1)
2867                             (setq hcharset 'utf-8
2868                                   coding hcharset)))
2869                      (if coding
2870                          (if charset
2871                              (progn
2872                                (setq body
2873                                      (mm-charset-to-coding-system charset))
2874                                (if (eq coding body)
2875                                    (setq eheader (mm-encode-coding-string
2876                                                   (buffer-string) coding)
2877                                          title (when title
2878                                                  (mm-encode-coding-string
2879                                                   title coding))
2880                                          body (mm-get-part handle))
2881                                  (setq charset 'utf-8
2882                                        eheader (mm-encode-coding-string
2883                                                 (buffer-string) charset)
2884                                        title (when title
2885                                                (mm-encode-coding-string
2886                                                 title charset))
2887                                        body (mm-encode-coding-string
2888                                              (mm-decode-coding-string
2889                                               (mm-get-part handle) body)
2890                                              charset))))
2891                            (setq charset hcharset
2892                                  eheader (mm-encode-coding-string
2893                                           (buffer-string) coding)
2894                                  title (when title
2895                                          (mm-encode-coding-string
2896                                           title coding))
2897                                  body (mm-get-part handle)))
2898                        (setq eheader (mm-string-as-unibyte (buffer-string))
2899                              body (mm-get-part handle))))
2900                    (erase-buffer)
2901                    (mm-disable-multibyte)
2902                    (insert body)
2903                    (when charset
2904                      (mm-add-meta-html-tag handle charset))
2905                    (when title
2906                      (goto-char (point-min))
2907                      (unless (search-forward "<title>" nil t)
2908                        (re-search-forward "<head>\\s-*" nil t)
2909                        (insert "<title>" title "</title>\n")))
2910                    (goto-char (point-min))
2911                    (or (re-search-forward
2912                         "<body\\(?:\\s-+[^>]+\\|\\s-*\\)>\\s-*" nil t)
2913                        (re-search-forward
2914                         "</head\\(?:\\s-+[^>]+\\|\\s-*\\)>\\s-*" nil t))
2915                    (insert eheader)
2916                    (mm-write-region (point-min) (point-max)
2917                                     tmp-file nil nil nil 'binary t))))
2918               (charset
2919                (mm-with-unibyte-buffer
2920                  (insert (if (eq charset 'gnus-decoded)
2921                              (mm-encode-coding-string
2922                               (mm-get-part handle)
2923                               (setq charset 'utf-8))
2924                            (mm-get-part handle)))
2925                  (if (or (mm-add-meta-html-tag handle charset)
2926                          (not file))
2927                      (mm-write-region (point-min) (point-max)
2928                                       tmp-file nil nil nil 'binary t)
2929                    (setq tmp-file nil))))
2930               (tmp-file
2931                (mm-save-part-to-file handle tmp-file)))
2932              (when tmp-file
2933                (add-to-list 'gnus-article-browse-html-temp-list tmp-file))
2934              (add-hook 'gnus-summary-prepare-exit-hook
2935                        'gnus-article-browse-delete-temp-files)
2936              (add-hook 'gnus-exit-gnus-hook
2937                        (lambda  ()
2938                          (gnus-article-browse-delete-temp-files t)))
2939              ;; FIXME: Warn if there's an <img> tag?
2940              (browse-url-of-file (or tmp-file (expand-file-name file)))
2941              (setq showed t))
2942             ;; If multipart, recurse
2943             ((equal (mm-handle-media-supertype handle) "multipart")
2944              (when (gnus-article-browse-html-parts handle header)
2945                (setq showed t)))
2946             ((equal (mm-handle-media-type handle) "message/rfc822")
2947              (mm-with-multibyte-buffer
2948                (mm-insert-part handle)
2949                (setq handle (mm-dissect-buffer t t))
2950                (when (and (bufferp (car handle))
2951                           (stringp (car (mm-handle-type handle))))
2952                  (setq handle (list handle)))
2953                (when header
2954                  (article-decode-encoded-words)
2955                  (let ((gnus-visible-headers
2956                         (or (get 'gnus-visible-headers 'standard-value)
2957                             gnus-visible-headers)))
2958                    (article-hide-headers))
2959                  (goto-char (point-min))
2960                  (search-forward "\n\n" nil 'move)
2961                  (skip-chars-backward "\t\n ")
2962                  (setq header (buffer-substring (point-min) (point)))))
2963              (when (prog1
2964                        (gnus-article-browse-html-parts handle header)
2965                      (mm-destroy-parts handle))
2966                (setq showed t)))))
2967     showed))
2968
2969 (defun gnus-article-browse-html-article (&optional arg)
2970   "View \"text/html\" parts of the current article with a WWW browser.
2971 The message header is added to the beginning of every html part unless
2972 the prefix argument ARG is given.
2973
2974 Warning: Spammers use links to images in HTML articles to verify
2975 whether you have read the message.  As
2976 `gnus-article-browse-html-article' passes the HTML content to the
2977 browser without eliminating these \"web bugs\" you should only
2978 use it for mails from trusted senders.
2979
2980 If you always want to display HTML parts in the browser, set
2981 `mm-text-html-renderer' to nil."
2982   ;; Cf. `mm-w3m-safe-url-regexp'
2983   (interactive "P")
2984   (if arg
2985       (gnus-summary-show-article)
2986     (let ((gnus-visible-headers (or (get 'gnus-visible-headers 'standard-value)
2987                                     gnus-visible-headers))
2988           ;; As we insert a <hr>, there's no need for the body boundary.
2989           (gnus-treat-body-boundary nil))
2990       (gnus-summary-show-article)))
2991   (with-current-buffer gnus-article-buffer
2992     (let ((header (unless arg
2993                     (save-restriction
2994                       (widen)
2995                       (buffer-substring-no-properties
2996                        (goto-char (point-min))
2997                        (if (search-forward "\n\n" nil t)
2998                            (match-beginning 0)
2999                          (goto-char (point-max))
3000                          (skip-chars-backward "\t\n ")
3001                          (point))))))
3002           parts)
3003       (set-buffer gnus-original-article-buffer)
3004       (setq parts (mm-dissect-buffer t t))
3005       ;; If singlepart, enforce a list.
3006       (when (and (bufferp (car parts))
3007                  (stringp (car (mm-handle-type parts))))
3008         (setq parts (list parts)))
3009       ;; Process the list
3010       (unless (gnus-article-browse-html-parts parts header)
3011         (gnus-error 3 "Mail doesn't contain a \"text/html\" part!"))
3012       (mm-destroy-parts parts)
3013       (unless arg
3014         (gnus-summary-show-article)))))
3015
3016 (defun article-hide-list-identifiers ()
3017   "Remove list identifies from the Subject header.
3018 The `gnus-list-identifiers' variable specifies what to do."
3019   (interactive)
3020   (let ((inhibit-point-motion-hooks t)
3021         (regexp (if (consp gnus-list-identifiers)
3022                     (mapconcat 'identity gnus-list-identifiers " *\\|")
3023                   gnus-list-identifiers))
3024         (inhibit-read-only t))
3025     (when regexp
3026       (save-excursion
3027         (save-restriction
3028           (article-narrow-to-head)
3029           (goto-char (point-min))
3030           (while (re-search-forward
3031                   (concat "^Subject: +\\(R[Ee]: +\\)*\\(" regexp " *\\)")
3032                   nil t)
3033             (delete-region (match-beginning 2) (match-end 0))
3034             (beginning-of-line))
3035           (when (re-search-forward
3036                  "^Subject: +\\(\\(R[Ee]: +\\)+\\)R[Ee]: +" nil t)
3037             (delete-region (match-beginning 1) (match-end 1))))))))
3038
3039 (defun article-hide-pem (&optional arg)
3040   "Toggle hiding of any PEM headers and signatures in the current article.
3041 If given a negative prefix, always show; if given a positive prefix,
3042 always hide."
3043   (interactive (gnus-article-hidden-arg))
3044   (unless (gnus-article-check-hidden-text 'pem arg)
3045     (save-excursion
3046       (let ((inhibit-read-only t) end)
3047         (goto-char (point-min))
3048         ;; Hide the horrendously ugly "header".
3049         (when (and (search-forward
3050                     "\n-----BEGIN PRIVACY-ENHANCED MESSAGE-----\n"
3051                     nil t)
3052                    (setq end (1+ (match-beginning 0))))
3053           (gnus-add-wash-type 'pem)
3054           (gnus-article-hide-text-type
3055            end
3056            (if (search-forward "\n\n" nil t)
3057                (match-end 0)
3058              (point-max))
3059            'pem)
3060           ;; Hide the trailer as well
3061           (when (search-forward "\n-----END PRIVACY-ENHANCED MESSAGE-----\n"
3062                                 nil t)
3063             (gnus-article-hide-text-type
3064              (match-beginning 0) (match-end 0) 'pem)))))))
3065
3066 (defun article-strip-banner ()
3067   "Strip the banners specified by the `banner' group parameter and by
3068 `gnus-article-address-banner-alist'."
3069   (interactive)
3070   (save-excursion
3071     (save-restriction
3072       (let ((inhibit-point-motion-hooks t))
3073         (when (gnus-parameter-banner gnus-newsgroup-name)
3074           (article-really-strip-banner
3075            (gnus-parameter-banner gnus-newsgroup-name)))
3076         (when gnus-article-address-banner-alist
3077           ;; Note that the From header is decoded here, so it is
3078           ;; required that the *-extract-address-components function
3079           ;; supports non-ASCII text.
3080           (let ((from (save-restriction
3081                         (widen)
3082                         (article-narrow-to-head)
3083                         (mail-fetch-field "from"))))
3084             (when (and from
3085                        (setq from
3086                              (cadr (funcall gnus-extract-address-components
3087                                             from))))
3088               (catch 'found
3089                 (dolist (pair gnus-article-address-banner-alist)
3090                   (when (string-match (car pair) from)
3091                     (throw 'found
3092                            (article-really-strip-banner (cdr pair)))))))))))))
3093
3094 (defun article-really-strip-banner (banner)
3095   "Strip the banner specified by the argument."
3096   (save-excursion
3097     (save-restriction
3098       (let ((inhibit-point-motion-hooks t)
3099             (gnus-signature-limit nil)
3100             (inhibit-read-only t))
3101         (article-goto-body)
3102         (cond
3103          ((eq banner 'signature)
3104           (when (gnus-article-narrow-to-signature)
3105             (widen)
3106             (forward-line -1)
3107             (delete-region (point) (point-max))))
3108          ((symbolp banner)
3109           (if (setq banner (cdr (assq banner gnus-article-banner-alist)))
3110               (while (re-search-forward banner nil t)
3111                 (delete-region (match-beginning 0) (match-end 0)))))
3112          ((stringp banner)
3113           (while (re-search-forward banner nil t)
3114             (delete-region (match-beginning 0) (match-end 0)))))))))
3115
3116 (defun article-babel ()
3117   "Translate article using an online translation service."
3118   (interactive)
3119   (require 'babel)
3120   (gnus-with-article-buffer
3121     (when (article-goto-body)
3122       (let* ((start (point))
3123              (end (point-max))
3124              (orig (buffer-substring start end))
3125              (trans (babel-as-string orig)))
3126         (save-restriction
3127           (narrow-to-region start end)
3128           (delete-region start end)
3129           (insert trans))))))
3130
3131 (defun article-hide-signature (&optional arg)
3132   "Hide the signature in the current article.
3133 If given a negative prefix, always show; if given a positive prefix,
3134 always hide."
3135   (interactive (gnus-article-hidden-arg))
3136   (unless (gnus-article-check-hidden-text 'signature arg)
3137     (save-excursion
3138       (save-restriction
3139         (let ((inhibit-read-only t))
3140           (when (gnus-article-narrow-to-signature)
3141             (gnus-article-hide-text-type
3142              (point-min) (point-max) 'signature))))))
3143   (gnus-set-mode-line 'article))
3144
3145 (defun article-strip-headers-in-body ()
3146   "Strip offensive headers from bodies."
3147   (interactive)
3148   (save-excursion
3149     (article-goto-body)
3150     (let ((case-fold-search t))
3151       (when (looking-at "x-no-archive:")
3152         (gnus-delete-line)))))
3153
3154 (defun article-strip-leading-blank-lines ()
3155   "Remove all blank lines from the beginning of the article."
3156   (interactive)
3157   (save-excursion
3158     (let ((inhibit-point-motion-hooks t)
3159           (inhibit-read-only t))
3160       (when (article-goto-body)
3161         (while (and (not (eobp))
3162                     (looking-at "[ \t]*$"))
3163           (gnus-delete-line))))))
3164
3165 (defun article-narrow-to-head ()
3166   "Narrow the buffer to the head of the message.
3167 Point is left at the beginning of the narrowed-to region."
3168   (narrow-to-region
3169    (goto-char (point-min))
3170    (if (search-forward "\n\n" nil 1)
3171        (1- (point))
3172      (point-max)))
3173   (goto-char (point-min)))
3174
3175 (defun article-goto-body ()
3176   "Place point at the start of the body."
3177   (goto-char (point-min))
3178   (cond
3179    ;; This variable is only bound when dealing with separate
3180    ;; MIME body parts.
3181    (article-goto-body-goes-to-point-min-p
3182     t)
3183    ((search-forward "\n\n" nil t)
3184     t)
3185    (t
3186     (goto-char (point-max))
3187     nil)))
3188
3189 (defun article-strip-multiple-blank-lines ()
3190   "Replace consecutive blank lines with one empty line."
3191   (interactive)
3192   (save-excursion
3193     (let ((inhibit-point-motion-hooks t)
3194           (inhibit-read-only t))
3195       ;; First make all blank lines empty.
3196       (article-goto-body)
3197       (while (re-search-forward "^[ \t]+$" nil t)
3198         (unless (gnus-annotation-in-region-p
3199                  (match-beginning 0) (match-end 0))
3200           (replace-match "" nil t)))
3201       ;; Then replace multiple empty lines with a single empty line.
3202       (article-goto-body)
3203       (while (re-search-forward "\n\n\\(\n+\\)" nil t)
3204         (unless (gnus-annotation-in-region-p
3205                  (match-beginning 0) (match-end 0))
3206           (delete-region (match-beginning 1) (match-end 1)))))))
3207
3208 (defun article-strip-leading-space ()
3209   "Remove all white space from the beginning of the lines in the article."
3210   (interactive)
3211   (save-excursion
3212     (let ((inhibit-point-motion-hooks t)
3213           (inhibit-read-only t))
3214       (article-goto-body)
3215       (while (re-search-forward "^[ \t]+" nil t)
3216         (replace-match "" t t)))))
3217
3218 (defun article-strip-trailing-space ()
3219   "Remove all white space from the end of the lines in the article."
3220   (interactive)
3221   (save-excursion
3222     (let ((inhibit-point-motion-hooks t)
3223           (inhibit-read-only t))
3224       (article-goto-body)
3225       (while (re-search-forward "[ \t]+$" nil t)
3226         (replace-match "" t t)))))
3227
3228 (defun article-strip-blank-lines ()
3229   "Strip leading, trailing and multiple blank lines."
3230   (interactive)
3231   (article-strip-leading-blank-lines)
3232   (article-remove-trailing-blank-lines)
3233   (article-strip-multiple-blank-lines))
3234
3235 (defun article-strip-all-blank-lines ()
3236   "Strip all blank lines."
3237   (interactive)
3238   (save-excursion
3239     (let ((inhibit-point-motion-hooks t)
3240           (inhibit-read-only t))
3241       (article-goto-body)
3242       (while (re-search-forward "^[ \t]*\n" nil t)
3243         (replace-match "" t t)))))
3244
3245 (defun gnus-article-narrow-to-signature ()
3246   "Narrow to the signature; return t if a signature is found, else nil."
3247   (let ((inhibit-point-motion-hooks t))
3248     (when (gnus-article-search-signature)
3249       (forward-line 1)
3250       ;; Check whether we have some limits to what we consider
3251       ;; to be a signature.
3252       (let ((limits (if (listp gnus-signature-limit) gnus-signature-limit
3253                       (list gnus-signature-limit)))
3254             limit limited)
3255         (while (setq limit (pop limits))
3256           (if (or (and (integerp limit)
3257                        (< (- (point-max) (point)) limit))
3258                   (and (floatp limit)
3259                        (< (count-lines (point) (point-max)) limit))
3260                   (and (functionp limit)
3261                        (funcall limit))
3262                   (and (stringp limit)
3263                        (not (re-search-forward limit nil t))))
3264               ()                        ; This limit did not succeed.
3265             (setq limited t
3266                   limits nil)))
3267         (unless limited
3268           (narrow-to-region (point) (point-max))
3269           t)))))
3270
3271 (defun gnus-article-search-signature ()
3272   "Search the current buffer for the signature separator.
3273 Put point at the beginning of the signature separator."
3274   (let ((cur (point)))
3275     (goto-char (point-max))
3276     (if (if (stringp gnus-signature-separator)
3277             (re-search-backward gnus-signature-separator nil t)
3278           (let ((seps gnus-signature-separator))
3279             (while (and seps
3280                         (not (re-search-backward (car seps) nil t)))
3281               (pop seps))
3282             seps))
3283         t
3284       (goto-char cur)
3285       nil)))
3286
3287 (defun gnus-article-hidden-arg ()
3288   "Return the current prefix arg as a number, or 0 if no prefix."
3289   (list (if current-prefix-arg
3290             (prefix-numeric-value current-prefix-arg)
3291           0)))
3292
3293 (defun gnus-article-check-hidden-text (type arg)
3294   "Return nil if hiding is necessary.
3295 Arg can be nil or a number.  nil and positive means hide, negative
3296 means show, 0 means toggle."
3297   (save-excursion
3298     (save-restriction
3299       (let ((hide (gnus-article-hidden-text-p type)))
3300         (cond
3301          ((or (null arg)
3302               (> arg 0))
3303           nil)
3304          ((< arg 0)
3305           (gnus-article-show-hidden-text type)
3306           t)
3307          (t
3308           (if (eq hide 'hidden)
3309               (progn
3310                 (gnus-article-show-hidden-text type)
3311                 t)
3312             nil)))))))
3313
3314 (defun gnus-article-hidden-text-p (type)
3315   "Say whether the current buffer contains hidden text of type TYPE."
3316   (let ((pos (text-property-any (point-min) (point-max) 'article-type type)))
3317     (while (and pos
3318                 (not (get-text-property pos 'invisible))
3319                 (not (get-text-property pos 'dummy-invisible)))
3320       (setq pos
3321             (text-property-any (1+ pos) (point-max) 'article-type type)))
3322     (if pos
3323         'hidden
3324       nil)))
3325
3326 (defun gnus-article-show-hidden-text (type &optional dummy)
3327   "Show all hidden text of type TYPE.
3328 Originally it is hide instead of DUMMY."
3329   (let ((inhibit-read-only t)
3330         (inhibit-point-motion-hooks t))
3331     (gnus-remove-text-properties-when
3332      'article-type type
3333      (point-min) (point-max)
3334      (cons 'article-type (cons type
3335                                gnus-hidden-properties)))
3336     (gnus-delete-wash-type type)))
3337
3338 (defconst article-time-units
3339   `((year . ,(* 365.25 24 60 60))
3340     (week . ,(* 7 24 60 60))
3341     (day . ,(* 24 60 60))
3342     (hour . ,(* 60 60))
3343     (minute . 60)
3344     (second . 1))
3345   "Mapping from time units to seconds.")
3346
3347 (defun gnus-article-forward-header ()
3348   "Move point to the start of the next header.
3349 If the current header is a continuation header, this can be several
3350 lines forward."
3351   (let ((ended nil))
3352     (while (not ended)
3353       (forward-line 1)
3354       (if (looking-at "[ \t]+[^ \t]")
3355           (forward-line 1)
3356         (setq ended t)))))
3357
3358 (defun article-date-ut (&optional type highlight)
3359   "Convert DATE date to universal time in the current article.
3360 If TYPE is `local', convert to local time; if it is `lapsed', output
3361 how much time has lapsed since DATE.  For `lapsed', the value of
3362 `gnus-article-date-lapsed-new-header' says whether the \"X-Sent:\" header
3363 should replace the \"Date:\" one, or should be added below it."
3364   (interactive (list 'ut t))
3365   (let* ((tdate-regexp "^Date:[ \t]\\|^X-Sent:[ \t]")
3366          (date-regexp (cond ((not gnus-article-date-lapsed-new-header)
3367                              tdate-regexp)
3368                             ((eq type 'lapsed)
3369                              "^X-Sent:[ \t]")
3370                             (article-lapsed-timer
3371                              "^Date:[ \t]")
3372                             (t
3373                              tdate-regexp)))
3374          (case-fold-search t)
3375          (inhibit-read-only t)
3376          (inhibit-point-motion-hooks t)
3377          pos date bface eface)
3378     (save-excursion
3379       (save-restriction
3380         (widen)
3381         (goto-char (point-min))
3382         (while (or (setq date (get-text-property (setq pos (point))
3383                                                  'original-date))
3384                    (when (setq pos (next-single-property-change
3385                                     (point) 'original-date))
3386                      (setq date (get-text-property pos 'original-date))
3387                      t))
3388           (narrow-to-region pos (or (text-property-any pos (point-max)
3389                                                        'original-date nil)
3390                                     (point-max)))
3391           (goto-char (point-min))
3392           (when (re-search-forward tdate-regexp nil t)
3393             (setq bface (get-text-property (point-at-bol) 'face)
3394                   eface (get-text-property (1- (point-at-eol)) 'face)))
3395           (goto-char (point-min))
3396           (setq pos nil)
3397           ;; Delete any old Date headers.
3398           (while (re-search-forward date-regexp nil t)
3399             (if pos
3400                 (delete-region (point-at-bol) (progn
3401                                                 (gnus-article-forward-header)
3402                                                 (point)))
3403               (delete-region (point-at-bol) (progn
3404                                               (gnus-article-forward-header)
3405                                               (forward-char -1)
3406                                               (point)))
3407               (setq pos (point))))
3408           (when (and (not pos)
3409                      (re-search-forward tdate-regexp nil t))
3410             (forward-line 1))
3411           (gnus-goto-char pos)
3412           (insert (article-make-date-line date (or type 'ut)))
3413           (unless pos
3414             (insert "\n")
3415             (forward-line -1))
3416           ;; Do highlighting.
3417           (beginning-of-line)
3418           (when (looking-at "\\([^:]+\\): *\\(.*\\)$")
3419             (put-text-property (match-beginning 1) (1+ (match-end 1))
3420                                'face bface)
3421             (put-text-property (match-beginning 2) (match-end 2)
3422                                'face eface))
3423           (put-text-property (point-min) (1- (point-max)) 'original-date date)
3424           (goto-char (point-max))
3425           (widen))))))
3426
3427 (defun article-make-date-line (date type)
3428   "Return a DATE line of TYPE."
3429   (unless (memq type '(local ut original user iso8601 lapsed english))
3430     (error "Unknown conversion type: %s" type))
3431   (condition-case ()
3432       (let ((time (date-to-time date)))
3433         (cond
3434          ;; Convert to the local timezone.
3435          ((eq type 'local)
3436           (concat "Date: " (message-make-date time)))
3437          ;; Convert to Universal Time.
3438          ((eq type 'ut)
3439           (concat "Date: "
3440                   (substring
3441                    (message-make-date
3442                     (let* ((e (parse-time-string date))
3443                            (tm (apply 'encode-time e))
3444                            (ms (car tm))
3445                            (ls (- (cadr tm) (car (current-time-zone time)))))
3446                       (cond ((< ls 0) (list (1- ms) (+ ls 65536)))
3447                             ((> ls 65535) (list (1+ ms) (- ls 65536)))
3448                             (t (list ms ls)))))
3449                    0 -5)
3450                   "UT"))
3451          ;; Get the original date from the article.
3452          ((eq type 'original)
3453           (concat "Date: " (if (string-match "\n+$" date)
3454                                (substring date 0 (match-beginning 0))
3455                              date)))
3456          ;; Let the user define the format.
3457          ((eq type 'user)
3458           (let ((format (or (condition-case nil
3459                                 (with-current-buffer gnus-summary-buffer
3460                                   gnus-article-time-format)
3461                               (error nil))
3462                             gnus-article-time-format)))
3463             (if (functionp format)
3464                 (funcall format time)
3465               (concat "Date: " (format-time-string format time)))))
3466          ;; ISO 8601.
3467          ((eq type 'iso8601)
3468           (let ((tz (car (current-time-zone time))))
3469             (concat
3470              "Date: "
3471              (format-time-string "%Y%m%dT%H%M%S" time)
3472              (format "%s%02d%02d"
3473                      (if (> tz 0) "+" "-") (/ (abs tz) 3600)
3474                      (/ (% (abs tz) 3600) 60)))))
3475          ;; Do an X-Sent lapsed format.
3476          ((eq type 'lapsed)
3477           ;; If the date is seriously mangled, the timezone functions are
3478           ;; liable to bug out, so we ignore all errors.
3479           (let* ((now (current-time))
3480                  (real-time (subtract-time now time))
3481                  (real-sec (and real-time
3482                                 (+ (* (float (car real-time)) 65536)
3483                                    (cadr real-time))))
3484                  (sec (and real-time (abs real-sec)))
3485                  num prev)
3486             (cond
3487              ((null real-time)
3488               "X-Sent: Unknown")
3489              ((zerop sec)
3490               "X-Sent: Now")
3491              (t
3492               (concat
3493                "X-Sent: "
3494                ;; This is a bit convoluted, but basically we go
3495                ;; through the time units for years, weeks, etc,
3496                ;; and divide things to see whether that results
3497                ;; in positive answers.
3498                (mapconcat
3499                 (lambda (unit)
3500                   (if (zerop (setq num (ffloor (/ sec (cdr unit)))))
3501                       ;; The (remaining) seconds are too few to
3502                       ;; be divided into this time unit.
3503                       ""
3504                     ;; It's big enough, so we output it.
3505                     (setq sec (- sec (* num (cdr unit))))
3506                     (prog1
3507                         (concat (if prev ", " "") (int-to-string
3508                                                    (floor num))
3509                                 " " (symbol-name (car unit))
3510                                 (if (> num 1) "s" ""))
3511                       (setq prev t))))
3512                 article-time-units "")
3513                ;; If dates are odd, then it might appear like the
3514                ;; article was sent in the future.
3515                (if (> real-sec 0)
3516                    " ago"
3517                  " in the future"))))))
3518          ;; Display the date in proper English
3519          ((eq type 'english)
3520           (let ((dtime (decode-time time)))
3521             (concat
3522              "Date: the "
3523              (number-to-string (nth 3 dtime))
3524              (let ((digit (% (nth 3 dtime) 10)))
3525                (cond
3526                 ((memq (nth 3 dtime) '(11 12 13)) "th")
3527                 ((= digit 1) "st")
3528                 ((= digit 2) "nd")
3529                 ((= digit 3) "rd")
3530                 (t "th")))
3531              " of "
3532              (nth (1- (nth 4 dtime)) gnus-english-month-names)
3533              " "
3534              (number-to-string (nth 5 dtime))
3535              " at "
3536              (format "%02d" (nth 2 dtime))
3537              ":"
3538              (format "%02d" (nth 1 dtime)))))))
3539     (error
3540      (format "Date: %s (from Gnus)" date))))
3541
3542 (defun article-date-local (&optional highlight)
3543   "Convert the current article date to the local timezone."
3544   (interactive (list t))
3545   (article-date-ut 'local highlight))
3546
3547 (defun article-date-english (&optional highlight)
3548   "Convert the current article date to something that is proper English."
3549   (interactive (list t))
3550   (article-date-ut 'english highlight))
3551
3552 (defun article-date-original (&optional highlight)
3553   "Convert the current article date to what it was originally.
3554 This is only useful if you have used some other date conversion
3555 function and want to see what the date was before converting."
3556   (interactive (list t))
3557   (article-date-ut 'original highlight))
3558
3559 (defun article-date-lapsed (&optional highlight)
3560   "Convert the current article date to time lapsed since it was sent."
3561   (interactive (list t))
3562   (article-date-ut 'lapsed highlight))
3563
3564 (defun article-update-date-lapsed ()
3565   "Function to be run from a timer to update the lapsed time line."
3566   (save-match-data
3567     (let (deactivate-mark)
3568       (save-excursion
3569         (ignore-errors
3570          (walk-windows
3571           (lambda (w)
3572             (set-buffer (window-buffer w))
3573             (when (eq major-mode 'gnus-article-mode)
3574               (let ((mark (point-marker)))
3575                 (goto-char (point-min))
3576                 (when (re-search-forward "^X-Sent:" nil t)
3577                   (article-date-lapsed t))
3578                 (goto-char (marker-position mark))
3579                 (move-marker mark nil))))
3580           nil 'visible))))))
3581
3582 (defun gnus-start-date-timer (&optional n)
3583   "Start a timer to update the X-Sent header in the article buffers.
3584 The numerical prefix says how frequently (in seconds) the function
3585 is to run."
3586   (interactive "p")
3587   (unless n
3588     (setq n 1))
3589   (gnus-stop-date-timer)
3590   (setq article-lapsed-timer
3591         (run-at-time 1 n 'article-update-date-lapsed)))
3592
3593 (defun gnus-stop-date-timer ()
3594   "Stop the X-Sent timer."
3595   (interactive)
3596   (when article-lapsed-timer
3597     (nnheader-cancel-timer article-lapsed-timer)
3598     (setq article-lapsed-timer nil)))
3599
3600 (defun article-date-user (&optional highlight)
3601   "Convert the current article date to the user-defined format.
3602 This format is defined by the `gnus-article-time-format' variable."
3603   (interactive (list t))
3604   (article-date-ut 'user highlight))
3605
3606 (defun article-date-iso8601 (&optional highlight)
3607   "Convert the current article date to ISO8601."
3608   (interactive (list t))
3609   (article-date-ut 'iso8601 highlight))
3610
3611 (defmacro gnus-article-save-original-date (&rest forms)
3612   "Save the original date as a text property and evaluate FORMS."
3613   `(let* ((case-fold-search t)
3614           (start (progn
3615                    (goto-char (point-min))
3616                    (when (and (re-search-forward "^date:[\t\n ]+" nil t)
3617                               (not (bolp)))
3618                      (match-end 0))))
3619           (date (when (and start
3620                            (re-search-forward "[\t ]*\n\\(?:[^\t ]\\|\\'\\)"
3621                                               nil t))
3622                   (buffer-substring-no-properties start
3623                                                   (match-beginning 0)))))
3624      (goto-char (point-max))
3625      (skip-chars-backward "\n")
3626      (put-text-property (point-min) (point) 'original-date date)
3627      ,@forms
3628      (goto-char (point-max))
3629      (skip-chars-backward "\n")
3630      (put-text-property (point-min) (point) 'original-date date)))
3631
3632 ;; (defun article-show-all ()
3633 ;;   "Show all hidden text in the article buffer."
3634 ;;   (interactive)
3635 ;;   (save-excursion
3636 ;;     (let ((inhibit-read-only t))
3637 ;;       (gnus-article-unhide-text (point-min) (point-max)))))
3638
3639 (defun article-remove-leading-whitespace ()
3640   "Remove excessive whitespace from all headers."
3641   (interactive)
3642   (save-excursion
3643     (save-restriction
3644       (let ((inhibit-read-only t))
3645         (article-narrow-to-head)
3646         (goto-char (point-min))
3647         (while (re-search-forward "^[^ :]+: \\([ \t]+\\)" nil t)
3648           (delete-region (match-beginning 1) (match-end 1)))))))
3649
3650 (defun article-emphasize (&optional arg)
3651   "Emphasize text according to `gnus-emphasis-alist'."
3652   (interactive (gnus-article-hidden-arg))
3653   (unless (gnus-article-check-hidden-text 'emphasis arg)
3654     (save-excursion
3655       (let ((alist (or
3656                     (condition-case nil
3657                         (with-current-buffer gnus-summary-buffer
3658                           gnus-article-emphasis-alist)
3659                       (error))
3660                     gnus-emphasis-alist))
3661             (inhibit-read-only t)
3662             (props (append '(article-type emphasis)
3663                            gnus-hidden-properties))
3664             regexp elem beg invisible visible face)
3665         (article-goto-body)
3666         (setq beg (point))
3667         (while (setq elem (pop alist))
3668           (goto-char beg)
3669           (setq regexp (car elem)
3670                 invisible (nth 1 elem)
3671                 visible (nth 2 elem)
3672                 face (nth 3 elem))
3673           (while (re-search-forward regexp nil t)
3674             (when (and (match-beginning visible) (match-beginning invisible))
3675               (gnus-article-hide-text
3676                (match-beginning invisible) (match-end invisible) props)
3677               (gnus-article-unhide-text-type
3678                (match-beginning visible) (match-end visible) 'emphasis)
3679               (gnus-put-overlay-excluding-newlines
3680                (match-beginning visible) (match-end visible) 'face face)
3681               (gnus-add-wash-type 'emphasis)
3682               (goto-char (match-end invisible)))))))))
3683
3684 (defun gnus-article-setup-highlight-words (&optional highlight-words)
3685   "Setup newsgroup emphasis alist."
3686   (unless gnus-article-emphasis-alist
3687     (let ((name (and gnus-newsgroup-name
3688                      (gnus-group-real-name gnus-newsgroup-name))))
3689       (make-local-variable 'gnus-article-emphasis-alist)
3690       (setq gnus-article-emphasis-alist
3691             (nconc
3692              (let ((alist gnus-group-highlight-words-alist) elem highlight)
3693                (while (setq elem (pop alist))
3694                  (when (and name (string-match (car elem) name))
3695                    (setq alist nil
3696                          highlight (copy-sequence (cdr elem)))))
3697                highlight)
3698              (copy-sequence highlight-words)
3699              (if gnus-newsgroup-name
3700                  (copy-sequence (gnus-group-find-parameter
3701                                  gnus-newsgroup-name 'highlight-words t)))
3702              gnus-emphasis-alist)))))
3703
3704 (defvar gnus-summary-article-menu)
3705 (defvar gnus-summary-post-menu)
3706
3707 ;;; Saving functions.
3708
3709 (defun gnus-article-save (save-buffer file &optional num)
3710   "Save the currently selected article."
3711   (when (or (get gnus-default-article-saver :headers)
3712             (not gnus-save-all-headers))
3713     ;; Remove headers according to `gnus-saved-headers' or the value
3714     ;; of the `:headers' property that the saver function might have.
3715     (let ((gnus-visible-headers
3716            (or (symbol-value (get gnus-default-article-saver :headers))
3717                gnus-saved-headers gnus-visible-headers))
3718           (gnus-article-buffer save-buffer))
3719       (with-current-buffer save-buffer
3720         (article-hide-headers 1 t))))
3721   (save-window-excursion
3722     (if (not gnus-default-article-saver)
3723         (error "No default saver is defined")
3724       ;; !!! Magic!  The saving functions all save
3725       ;; `gnus-save-article-buffer' (or so they think), but we
3726       ;; bind that variable to our save-buffer.
3727       (set-buffer gnus-article-buffer)
3728       (let* ((gnus-save-article-buffer save-buffer)
3729              (filename
3730               (cond
3731                ((not gnus-prompt-before-saving) 'default)
3732                ((eq gnus-prompt-before-saving 'always) nil)
3733                (t file)))
3734              (gnus-number-of-articles-to-be-saved
3735               (when (eq gnus-prompt-before-saving t)
3736                 num)))                  ; Magic
3737         (set-buffer gnus-article-current-summary)
3738         (funcall gnus-default-article-saver filename)))))
3739
3740 (defun gnus-read-save-file-name (prompt &optional filename
3741                                         function group headers variable
3742                                         dir-var)
3743   (let ((default-name
3744           (funcall function group headers (symbol-value variable)))
3745         result)
3746     (setq result
3747           (expand-file-name
3748            (cond
3749             ((eq filename 'default)
3750              default-name)
3751             ((eq filename t)
3752              default-name)
3753             (filename filename)
3754             (t
3755              (when (symbol-value dir-var)
3756                (setq default-name (expand-file-name
3757                                    (file-name-nondirectory default-name)
3758                                    (symbol-value dir-var))))
3759              (let* ((split-name (gnus-get-split-value gnus-split-methods))
3760                     (prompt
3761                      (format prompt
3762                              (if (and gnus-number-of-articles-to-be-saved
3763                                       (> gnus-number-of-articles-to-be-saved 1))
3764                                  (format "these %d articles"
3765                                          gnus-number-of-articles-to-be-saved)
3766                                "this article")))
3767                     (file
3768                      ;; Let the split methods have their say.
3769                      (cond
3770                       ;; No split name was found.
3771                       ((null split-name)
3772                        (read-file-name
3773                         (concat prompt " (default "
3774                                 (file-name-nondirectory default-name) "): ")
3775                         (file-name-directory default-name)
3776                         default-name))
3777                       ;; A single group name is returned.
3778                       ((stringp split-name)
3779                        (setq default-name
3780                              (funcall function split-name headers
3781                                       (symbol-value variable)))
3782                        (read-file-name
3783                         (concat prompt " (default "
3784                                 (file-name-nondirectory default-name) "): ")
3785                         (file-name-directory default-name)
3786                         default-name))
3787                       ;; A single split name was found
3788                       ((= 1 (length split-name))
3789                        (let* ((name (expand-file-name
3790                                      (car split-name)
3791                                      gnus-article-save-directory))
3792                               (dir (cond ((file-directory-p name)
3793                                           (file-name-as-directory name))
3794                                          ((file-exists-p name) name)
3795                                          (t gnus-article-save-directory))))
3796                          (read-file-name
3797                           (concat prompt " (default " name "): ")
3798                           dir name)))
3799                       ;; A list of splits was found.
3800                       (t
3801                        (setq split-name (nreverse split-name))
3802                        (let (result)
3803                          (let ((file-name-history
3804                                 (nconc split-name file-name-history)))
3805                            (setq result
3806                                  (expand-file-name
3807                                   (read-file-name
3808                                    (concat prompt " (`M-p' for defaults): ")
3809                                    gnus-article-save-directory
3810                                    (car split-name))
3811                                   gnus-article-save-directory)))
3812                          (car (push result file-name-history)))))))
3813                ;; Create the directory.
3814                (gnus-make-directory (file-name-directory file))
3815                ;; If we have read a directory, we append the default file name.
3816                (when (file-directory-p file)
3817                  (setq file (expand-file-name (file-name-nondirectory
3818                                                default-name)
3819                                               (file-name-as-directory file))))
3820                ;; Possibly translate some characters.
3821                (nnheader-translate-file-chars file))))))
3822     (gnus-make-directory (file-name-directory result))
3823     (when variable
3824       (set variable result))
3825     (when dir-var
3826       (set dir-var (file-name-directory result)))
3827     result))
3828
3829 (defun gnus-article-archive-name (group)
3830   "Return the first instance of an \"Archive-name\" in the current buffer."
3831   (let ((case-fold-search t))
3832     (when (re-search-forward "archive-name: *\\([^ \n\t]+\\)[ \t]*$" nil t)
3833       (nnheader-concat gnus-article-save-directory
3834                        (match-string 1)))))
3835
3836 (defun gnus-article-nndoc-name (group)
3837   "If GROUP is an nndoc group, return the name of the parent group."
3838   (when (eq (car (gnus-find-method-for-group group)) 'nndoc)
3839     (gnus-group-get-parameter group 'save-article-group)))
3840
3841 (defun gnus-summary-save-in-rmail (&optional filename)
3842   "Append this article to Rmail file.
3843 Optional argument FILENAME specifies file name.
3844 Directory to save to is default to `gnus-article-save-directory'."
3845   (setq filename (gnus-read-save-file-name
3846                   "Save %s in rmail file" filename
3847                   gnus-rmail-save-name gnus-newsgroup-name
3848                   gnus-current-headers 'gnus-newsgroup-last-rmail))
3849   (gnus-eval-in-buffer-window gnus-save-article-buffer
3850     (save-excursion
3851       (save-restriction
3852         (widen)
3853         (gnus-output-to-rmail filename))))
3854   filename)
3855
3856 (defun gnus-summary-save-in-mail (&optional filename)
3857   "Append this article to Unix mail file.
3858 Optional argument FILENAME specifies file name.
3859 Directory to save to is default to `gnus-article-save-directory'."
3860   (setq filename (gnus-read-save-file-name
3861                   "Save %s in Unix mail file" filename
3862                   gnus-mail-save-name gnus-newsgroup-name
3863                   gnus-current-headers 'gnus-newsgroup-last-mail))
3864   (gnus-eval-in-buffer-window gnus-save-article-buffer
3865     (save-excursion
3866       (save-restriction
3867         (widen)
3868         (if (and (file-readable-p filename)
3869                  (file-regular-p filename)
3870                  (mail-file-babyl-p filename))
3871             (rmail-output-to-rmail-file filename t)
3872           (gnus-output-to-mail filename)))))
3873   filename)
3874
3875 (put 'gnus-summary-save-in-file :decode t)
3876 (put 'gnus-summary-save-in-file :headers 'gnus-saved-headers)
3877 (defun gnus-summary-save-in-file (&optional filename overwrite)
3878   "Append this article to file.
3879 Optional argument FILENAME specifies file name.
3880 Directory to save to is default to `gnus-article-save-directory'."
3881   (setq filename (gnus-read-save-file-name
3882                   "Save %s in file" filename
3883                   gnus-file-save-name gnus-newsgroup-name
3884                   gnus-current-headers 'gnus-newsgroup-last-file))
3885   (gnus-eval-in-buffer-window gnus-save-article-buffer
3886     (save-excursion
3887       (save-restriction
3888         (widen)
3889         (when (and overwrite
3890                    (file-exists-p filename))
3891           (delete-file filename))
3892         (gnus-output-to-file filename))))
3893   filename)
3894
3895 (put 'gnus-summary-write-to-file :decode t)
3896 (put 'gnus-summary-write-to-file :function 'gnus-summary-save-in-file)
3897 (put 'gnus-summary-write-to-file :headers 'gnus-saved-headers)
3898 (defun gnus-summary-write-to-file (&optional filename)
3899   "Write this article to a file, overwriting it if the file exists.
3900 Optional argument FILENAME specifies file name.
3901 The directory to save in defaults to `gnus-article-save-directory'."
3902   (setq filename (gnus-read-save-file-name
3903                   "Save %s in file" filename
3904                   gnus-file-save-name gnus-newsgroup-name
3905                   gnus-current-headers nil 'gnus-newsgroup-last-directory))
3906   (gnus-summary-save-in-file filename t))
3907
3908 (put 'gnus-summary-save-body-in-file :decode t)
3909 (defun gnus-summary-save-body-in-file (&optional filename overwrite)
3910   "Append this article body to a file.
3911 Optional argument FILENAME specifies file name.
3912 The directory to save in defaults to `gnus-article-save-directory'."
3913   (setq filename (gnus-read-save-file-name
3914                   "Save %s body in file" filename
3915                   gnus-file-save-name gnus-newsgroup-name
3916                   gnus-current-headers 'gnus-newsgroup-last-file))
3917   (gnus-eval-in-buffer-window gnus-save-article-buffer
3918     (save-excursion
3919       (save-restriction
3920         (widen)
3921         (when (article-goto-body)
3922           (narrow-to-region (point) (point-max)))
3923         (when (and overwrite
3924                    (file-exists-p filename))
3925           (delete-file filename))
3926         (gnus-output-to-file filename))))
3927   filename)
3928
3929 (put 'gnus-summary-write-body-to-file :decode t)
3930 (put 'gnus-summary-write-body-to-file
3931      :function 'gnus-summary-save-body-in-file)
3932 (defun gnus-summary-write-body-to-file (&optional filename)
3933   "Write this article body to a file, overwriting it if the file exists.
3934 Optional argument FILENAME specifies file name.
3935 The directory to save in defaults to `gnus-article-save-directory'."
3936   (setq filename (gnus-read-save-file-name
3937                   "Save %s body in file" filename
3938                   gnus-file-save-name gnus-newsgroup-name
3939                   gnus-current-headers nil 'gnus-newsgroup-last-directory))
3940   (gnus-summary-save-body-in-file filename t))
3941
3942 (put 'gnus-summary-save-in-pipe :decode t)
3943 (put 'gnus-summary-save-in-pipe :headers 'gnus-saved-headers)
3944 (defun gnus-summary-save-in-pipe (&optional command)
3945   "Pipe this article to subprocess."
3946   (let ((default (or gnus-summary-pipe-output-default-command
3947                      gnus-last-shell-command)))
3948     (unless (stringp command)
3949       (setq command
3950             (if (and (eq command 'default) default)
3951                 default
3952               (gnus-read-shell-command
3953                (format
3954                 "Shell command on %s: "
3955                 (if (and gnus-number-of-articles-to-be-saved
3956                          (> gnus-number-of-articles-to-be-saved 1))
3957                     (format "these %d articles"
3958                             gnus-number-of-articles-to-be-saved)
3959                   "this article"))
3960                default))))
3961     (when (string-equal command "")
3962       (if default
3963           (setq command default)
3964         (error "A command is required"))))
3965   (gnus-eval-in-buffer-window gnus-save-article-buffer
3966     (save-restriction
3967       (widen)
3968       (shell-command-on-region (point-min) (point-max) command nil)))
3969   (setq gnus-summary-pipe-output-default-command command))
3970
3971 (defun gnus-summary-pipe-to-muttprint (&optional command)
3972   "Pipe this article to muttprint."
3973   (setq command (read-string
3974                  "Print using command: " gnus-summary-muttprint-program
3975                  nil gnus-summary-muttprint-program))
3976   (let ((gnus-last-shell-command gnus-last-shell-command))
3977     (gnus-summary-save-in-pipe command)
3978     (setq gnus-summary-muttprint-program gnus-last-shell-command)))
3979
3980 ;;; Article file names when saving.
3981
3982 (defun gnus-capitalize-newsgroup (newsgroup)
3983   "Capitalize NEWSGROUP name."
3984   (when (not (zerop (length newsgroup)))
3985     (concat (char-to-string (upcase (aref newsgroup 0)))
3986             (substring newsgroup 1))))
3987
3988 (defun gnus-Numeric-save-name (newsgroup headers &optional last-file)
3989   "Generate file name from NEWSGROUP, HEADERS, and optional LAST-FILE.
3990 If variable `gnus-use-long-file-name' is non-nil, it is ~/News/News.group/num.
3991 Otherwise, it is like ~/News/news/group/num."
3992   (let ((default
3993           (expand-file-name
3994            (concat (if (gnus-use-long-file-name 'not-save)
3995                        (gnus-capitalize-newsgroup newsgroup)
3996                      (gnus-newsgroup-directory-form newsgroup))
3997                    "/" (int-to-string (mail-header-number headers)))
3998            gnus-article-save-directory)))
3999     (if (and last-file
4000              (string-equal (file-name-directory default)
4001                            (file-name-directory last-file))
4002              (string-match "^[0-9]+$" (file-name-nondirectory last-file)))
4003         default
4004       (or last-file default))))
4005
4006 (defun gnus-numeric-save-name (newsgroup headers &optional last-file)
4007   "Generate file name from NEWSGROUP, HEADERS, and optional LAST-FILE.
4008 If variable `gnus-use-long-file-name' is non-nil, it is
4009 ~/News/news.group/num.  Otherwise, it is like ~/News/news/group/num."
4010   (let ((default
4011           (expand-file-name
4012            (concat (if (gnus-use-long-file-name 'not-save)
4013                        newsgroup
4014                      (gnus-newsgroup-directory-form newsgroup))
4015                    "/" (int-to-string (mail-header-number headers)))
4016            gnus-article-save-directory)))
4017     (if (and last-file
4018              (string-equal (file-name-directory default)
4019                            (file-name-directory last-file))
4020              (string-match "^[0-9]+$" (file-name-nondirectory last-file)))
4021         default
4022       (or last-file default))))
4023
4024 (defun gnus-plain-save-name (newsgroup headers &optional last-file)
4025   "Generate file name from NEWSGROUP, HEADERS, and optional LAST-FILE.
4026 If variable `gnus-use-long-file-name' is non-nil, it is
4027 ~/News/news.group.  Otherwise, it is like ~/News/news/group/news."
4028   (or last-file
4029       (expand-file-name
4030        (if (gnus-use-long-file-name 'not-save)
4031            newsgroup
4032          (file-relative-name
4033           (expand-file-name "news" (gnus-newsgroup-directory-form newsgroup))
4034           default-directory))
4035        gnus-article-save-directory)))
4036
4037 (defun gnus-sender-save-name (newsgroup headers &optional last-file)
4038   "Generate file name from sender."
4039   (let ((from (mail-header-from headers)))
4040     (expand-file-name
4041      (if (and from (string-match "\\([^ <]+\\)@" from))
4042          (match-string 1 from)
4043        "nobody")
4044      gnus-article-save-directory)))
4045
4046 (defun article-verify-x-pgp-sig ()
4047   "Verify X-PGP-Sig."
4048   ;; <ftp://ftp.isc.org/pub/pgpcontrol/FORMAT>
4049   (interactive)
4050   (if (gnus-buffer-live-p gnus-original-article-buffer)
4051       (let ((sig (with-current-buffer gnus-original-article-buffer
4052                    (gnus-fetch-field "X-PGP-Sig")))
4053             items info headers)
4054         (when (and sig
4055                    mml2015-use
4056                    (mml2015-clear-verify-function))
4057           (with-temp-buffer
4058             (insert-buffer-substring gnus-original-article-buffer)
4059             (setq items (split-string sig))
4060             (message-narrow-to-head)
4061             (let ((inhibit-point-motion-hooks t)
4062                   (case-fold-search t))
4063               ;; Don't verify multiple headers.
4064               (setq headers (mapconcat (lambda (header)
4065                                          (concat header ": "
4066                                                  (mail-fetch-field header)
4067                                                  "\n"))
4068                                        (split-string (nth 1 items) ",") "")))
4069             (delete-region (point-min) (point-max))
4070             (insert "-----BEGIN PGP SIGNED MESSAGE-----\n\n")
4071             (insert "X-Signed-Headers: " (nth 1 items) "\n")
4072             (insert headers)
4073             (widen)
4074             (forward-line)
4075             (while (not (eobp))
4076               (if (looking-at "^-")
4077                   (insert "- "))
4078               (forward-line))
4079             (insert "\n-----BEGIN PGP SIGNATURE-----\n")
4080             (insert "Version: " (car items) "\n\n")
4081             (insert (mapconcat 'identity (cddr items) "\n"))
4082             (insert "\n-----END PGP SIGNATURE-----\n")
4083             (let ((mm-security-handle (list (format "multipart/signed"))))
4084               (mml2015-clean-buffer)
4085               (let ((coding-system-for-write (or gnus-newsgroup-charset
4086                                                  'iso-8859-1)))
4087                 (funcall (mml2015-clear-verify-function)))
4088               (setq info
4089                     (or (mm-handle-multipart-ctl-parameter
4090                          mm-security-handle 'gnus-details)
4091                         (mm-handle-multipart-ctl-parameter
4092                          mm-security-handle 'gnus-info)))))
4093           (when info
4094             (let ((inhibit-read-only t) bface eface)
4095               (save-restriction
4096                 (message-narrow-to-head)
4097                 (goto-char (point-max))
4098                 (forward-line -1)
4099                 (setq bface (get-text-property (point-at-bol) 'face)
4100                       eface (get-text-property (1- (point-at-eol)) 'face))
4101                 (message-remove-header "X-Gnus-PGP-Verify")
4102                 (if (re-search-forward "^X-PGP-Sig:" nil t)
4103                     (forward-line)
4104                   (goto-char (point-max)))
4105                 (narrow-to-region (point) (point))
4106                 (insert "X-Gnus-PGP-Verify: " info "\n")
4107                 (goto-char (point-min))
4108                 (forward-line)
4109                 (while (not (eobp))
4110                   (if (not (looking-at "^[ \t]"))
4111                       (insert " "))
4112                   (forward-line))
4113                 ;; Do highlighting.
4114                 (goto-char (point-min))
4115                 (when (looking-at "\\([^:]+\\): *")
4116                   (put-text-property (match-beginning 1) (1+ (match-end 1))
4117                                      'face bface)
4118                   (put-text-property (match-end 0) (point-max)
4119                                      'face eface)))))))))
4120
4121 (defun article-verify-cancel-lock ()
4122   "Verify Cancel-Lock header."
4123   (interactive)
4124   (if (gnus-buffer-live-p gnus-original-article-buffer)
4125       (canlock-verify gnus-original-article-buffer)))
4126
4127 (eval-and-compile
4128   (mapc
4129    (lambda (func)
4130      (let (afunc gfunc)
4131        (if (consp func)
4132            (setq afunc (car func)
4133                  gfunc (cdr func))
4134          (setq afunc func
4135                gfunc (intern (format "gnus-%s" func))))
4136        (defalias gfunc
4137          (when (fboundp afunc)
4138            `(lambda (&optional interactive &rest args)
4139               ,(documentation afunc t)
4140               (interactive (list t))
4141               (with-current-buffer gnus-article-buffer
4142                 (if interactive
4143                     (call-interactively ',afunc)
4144                   (apply ',afunc args))))))))
4145    '(article-hide-headers
4146      article-verify-x-pgp-sig
4147      article-verify-cancel-lock
4148      article-hide-boring-headers
4149      article-treat-overstrike
4150      article-treat-ansi-sequences
4151      article-fill-long-lines
4152      article-capitalize-sentences
4153      article-remove-cr
4154      article-remove-leading-whitespace
4155      article-display-x-face
4156      article-display-face
4157      article-de-quoted-unreadable
4158      article-de-base64-unreadable
4159      article-decode-HZ
4160      article-wash-html
4161      article-unsplit-urls
4162      article-hide-list-identifiers
4163      article-strip-banner
4164      article-babel
4165      article-hide-pem
4166      article-hide-signature
4167      article-strip-headers-in-body
4168      article-remove-trailing-blank-lines
4169      article-strip-leading-blank-lines
4170      article-strip-multiple-blank-lines
4171      article-strip-leading-space
4172      article-strip-trailing-space
4173      article-strip-blank-lines
4174      article-strip-all-blank-lines
4175      article-date-local
4176      article-date-english
4177      article-date-iso8601
4178      article-date-original
4179      article-date-ut
4180      article-decode-mime-words
4181      article-decode-charset
4182      article-decode-encoded-words
4183      article-date-user
4184      article-date-lapsed
4185      article-emphasize
4186      article-treat-dumbquotes
4187      article-normalize-headers
4188      ;;(article-show-all . gnus-article-show-all-headers)
4189      )))
4190 \f
4191 ;;;
4192 ;;; Gnus article mode
4193 ;;;
4194
4195 (put 'gnus-article-mode 'mode-class 'special)
4196
4197 (set-keymap-parent gnus-article-mode-map widget-keymap)
4198
4199 (gnus-define-keys gnus-article-mode-map
4200   " " gnus-article-goto-next-page
4201   "\177" gnus-article-goto-prev-page
4202   [delete] gnus-article-goto-prev-page
4203   [backspace] gnus-article-goto-prev-page
4204   "\C-c^" gnus-article-refer-article
4205   "h" gnus-article-show-summary
4206   "s" gnus-article-show-summary
4207   "\C-c\C-m" gnus-article-mail
4208   "?" gnus-article-describe-briefly
4209   "e" gnus-summary-edit-article
4210   "<" beginning-of-buffer
4211   ">" end-of-buffer
4212   "\C-c\C-i" gnus-info-find-node
4213   "\C-c\C-b" gnus-bug
4214   "R" gnus-article-reply-with-original
4215   "F" gnus-article-followup-with-original
4216   "\C-hk" gnus-article-describe-key
4217   "\C-hc" gnus-article-describe-key-briefly
4218   "\C-hb" gnus-article-describe-bindings
4219
4220   "\C-d" gnus-article-read-summary-keys
4221   "\M-*" gnus-article-read-summary-keys
4222   "\M-#" gnus-article-read-summary-keys
4223   "\M-^" gnus-article-read-summary-keys
4224   "\M-g" gnus-article-read-summary-keys)
4225
4226 (substitute-key-definition
4227  'undefined 'gnus-article-read-summary-keys gnus-article-mode-map)
4228
4229 (gnus-define-keys (gnus-article-send-map "S" gnus-article-mode-map)
4230   "W" gnus-article-wide-reply-with-original)
4231 (if (featurep 'xemacs)
4232     (set-keymap-default-binding gnus-article-send-map
4233                                 'gnus-article-read-summary-send-keys)
4234   (define-key gnus-article-send-map [t] 'gnus-article-read-summary-send-keys))
4235
4236 (defun gnus-article-make-menu-bar ()
4237   (unless (boundp 'gnus-article-commands-menu)
4238     (gnus-summary-make-menu-bar))
4239   (gnus-turn-off-edit-menu 'article)
4240   (unless (boundp 'gnus-article-article-menu)
4241     (easy-menu-define
4242      gnus-article-article-menu gnus-article-mode-map ""
4243      '("Article"
4244        ["Scroll forwards" gnus-article-goto-next-page t]
4245        ["Scroll backwards" gnus-article-goto-prev-page t]
4246        ["Show summary" gnus-article-show-summary t]
4247        ["Fetch Message-ID at point" gnus-article-refer-article t]
4248        ["Mail to address at point" gnus-article-mail t]
4249        ["Send a bug report" gnus-bug t]))
4250
4251     (easy-menu-define
4252      gnus-article-treatment-menu gnus-article-mode-map ""
4253      ;; Fixme: this should use :active (and maybe :visible).
4254      '("Treatment"
4255        ["Hide headers" gnus-article-hide-headers t]
4256        ["Hide signature" gnus-article-hide-signature t]
4257        ["Hide citation" gnus-article-hide-citation t]
4258        ["Treat overstrike" gnus-article-treat-overstrike t]
4259        ["Treat ANSI sequences" gnus-article-treat-ansi-sequences t]
4260        ["Remove carriage return" gnus-article-remove-cr t]
4261        ["Remove leading whitespace" gnus-article-remove-leading-whitespace t]
4262        ["Remove quoted-unreadable" gnus-article-de-quoted-unreadable t]
4263        ["Remove base64" gnus-article-de-base64-unreadable t]
4264        ["Treat html" gnus-article-wash-html t]
4265        ["Remove newlines from within URLs" gnus-article-unsplit-urls t]
4266        ["Decode HZ" gnus-article-decode-HZ t]))
4267
4268     ;; Note "Commands" menu is defined in gnus-sum.el for consistency
4269
4270     ;; Note "Post" menu is defined in gnus-sum.el for consistency
4271
4272     (gnus-run-hooks 'gnus-article-menu-hook)))
4273
4274 (defun gnus-article-mode ()
4275   "Major mode for displaying an article.
4276
4277 All normal editing commands are switched off.
4278
4279 The following commands are available in addition to all summary mode
4280 commands:
4281 \\<gnus-article-mode-map>
4282 \\[gnus-article-next-page]\t Scroll the article one page forwards
4283 \\[gnus-article-prev-page]\t Scroll the article one page backwards
4284 \\[gnus-article-refer-article]\t Go to the article referred to by an article id near point
4285 \\[gnus-article-show-summary]\t Display the summary buffer
4286 \\[gnus-article-mail]\t Send a reply to the address near point
4287 \\[gnus-article-describe-briefly]\t Describe the current mode briefly
4288 \\[gnus-info-find-node]\t Go to the Gnus info node"
4289   (interactive)
4290   (kill-all-local-variables)
4291   (gnus-simplify-mode-line)
4292   (setq mode-name "Article")
4293   (setq major-mode 'gnus-article-mode)
4294   (make-local-variable 'minor-mode-alist)
4295   (use-local-map gnus-article-mode-map)
4296   (when (gnus-visual-p 'article-menu 'menu)
4297     (gnus-article-make-menu-bar)
4298     (when gnus-summary-tool-bar-map
4299       (set (make-local-variable 'tool-bar-map) gnus-summary-tool-bar-map)))
4300   (gnus-update-format-specifications nil 'article-mode)
4301   (set (make-local-variable 'page-delimiter) gnus-page-delimiter)
4302   (set (make-local-variable 'gnus-page-broken) nil)
4303   (make-local-variable 'gnus-button-marker-list)
4304   (make-local-variable 'gnus-article-current-summary)
4305   (make-local-variable 'gnus-article-mime-handles)
4306   (make-local-variable 'gnus-article-decoded-p)
4307   (make-local-variable 'gnus-article-mime-handle-alist)
4308   (make-local-variable 'gnus-article-wash-types)
4309   (make-local-variable 'gnus-article-image-alist)
4310   (make-local-variable 'gnus-article-charset)
4311   (make-local-variable 'gnus-article-ignored-charsets)
4312   ;; Prevent Emacs 22 from displaying non-break space with `nobreak-space'
4313   ;; face.
4314   (set (make-local-variable 'nobreak-char-display) nil)
4315   (setq cursor-in-non-selected-windows nil)
4316   (setq truncate-lines gnus-article-truncate-lines)
4317   (gnus-set-default-directory)
4318   (buffer-disable-undo)
4319   (setq buffer-read-only t
4320         show-trailing-whitespace nil)
4321   (set-syntax-table gnus-article-mode-syntax-table)
4322   (mm-enable-multibyte)
4323   (gnus-run-mode-hooks 'gnus-article-mode-hook))
4324
4325 (defvar gnus-button-marker-list nil
4326   "Regexp matching any of the regexps from `gnus-button-alist'.
4327 Internal variable.")
4328
4329 (defun gnus-article-setup-buffer ()
4330   "Initialize the article buffer."
4331   (let* ((name (if gnus-single-article-buffer "*Article*"
4332                  (concat "*Article " gnus-newsgroup-name "*")))
4333          (original
4334           (progn (string-match "\\*Article" name)
4335                  (concat " *Original Article"
4336                          (substring name (match-end 0))))))
4337     (setq gnus-article-buffer name)
4338     (setq gnus-original-article-buffer original)
4339     (setq gnus-article-mime-handle-alist nil)
4340     (with-current-buffer gnus-summary-buffer
4341       ;; This might be a variable local to the summary buffer.
4342       (unless gnus-single-article-buffer
4343         (setq gnus-article-buffer name)
4344         (setq gnus-original-article-buffer original)
4345         (gnus-set-global-variables)))
4346     (gnus-article-setup-highlight-words)
4347     ;; Init original article buffer.
4348     (with-current-buffer (gnus-get-buffer-create gnus-original-article-buffer)
4349       (mm-enable-multibyte)
4350       (setq major-mode 'gnus-original-article-mode)
4351       (make-local-variable 'gnus-original-article))
4352     (if (and (get-buffer name)
4353              (with-current-buffer name
4354                (if gnus-article-edit-mode
4355                    (if (y-or-n-p "Article mode edit in progress; discard? ")
4356                        (progn
4357                          (set-buffer-modified-p nil)
4358                          (gnus-kill-buffer name)
4359                          (message "")
4360                          nil)
4361                      (error "Action aborted"))
4362                  t)))
4363         (with-current-buffer name
4364           (set (make-local-variable 'gnus-article-edit-mode) nil)
4365           (when gnus-article-mime-handles
4366             (mm-destroy-parts gnus-article-mime-handles)
4367             (setq gnus-article-mime-handles nil))
4368           ;; Set it to nil in article-buffer!
4369           (setq gnus-article-mime-handle-alist nil)
4370           (buffer-disable-undo)
4371           (setq buffer-read-only t)
4372           ;; This list just keeps growing if we don't reset it.
4373           (setq gnus-button-marker-list nil)
4374           (unless (eq major-mode 'gnus-article-mode)
4375             (gnus-article-mode))
4376           (current-buffer))
4377       (with-current-buffer (gnus-get-buffer-create name)
4378         (gnus-article-mode)
4379         (make-local-variable 'gnus-summary-buffer)
4380         (setq gnus-summary-buffer
4381               (gnus-summary-buffer-name gnus-newsgroup-name))
4382         (gnus-summary-set-local-parameters gnus-newsgroup-name)
4383         (current-buffer)))))
4384
4385 ;; Set article window start at LINE, where LINE is the number of lines
4386 ;; from the head of the article.
4387 (defun gnus-article-set-window-start (&optional line)
4388   (let ((article-window (gnus-get-buffer-window gnus-article-buffer t)))
4389     (when article-window
4390       (set-window-start
4391        article-window
4392        (with-current-buffer gnus-article-buffer
4393          (goto-char (point-min))
4394          (if (not line)
4395              (point-min)
4396            (gnus-message 6 "Moved to bookmark")
4397            (search-forward "\n\n" nil t)
4398            (forward-line line)
4399            (point)))))))
4400
4401 (defun gnus-article-prepare (article &optional all-headers header)
4402   "Prepare ARTICLE in article mode buffer.
4403 ARTICLE should either be an article number or a Message-ID.
4404 If ARTICLE is an id, HEADER should be the article headers.
4405 If ALL-HEADERS is non-nil, no headers are hidden."
4406   (save-excursion
4407     ;; Make sure we start in a summary buffer.
4408     (unless (eq major-mode 'gnus-summary-mode)
4409       (set-buffer gnus-summary-buffer))
4410     (setq gnus-summary-buffer (current-buffer))
4411     (let* ((gnus-article (if header (mail-header-number header) article))
4412            (summary-buffer (current-buffer))
4413            (gnus-tmp-internal-hook gnus-article-internal-prepare-hook)
4414            (group gnus-newsgroup-name)
4415            result)
4416       (save-excursion
4417         (gnus-article-setup-buffer)
4418         (set-buffer gnus-article-buffer)
4419         ;; Deactivate active regions.
4420         (when (and (boundp 'transient-mark-mode)
4421                    transient-mark-mode)
4422           (setq mark-active nil))
4423         (if (not (setq result (let ((inhibit-read-only t))
4424                                 (gnus-request-article-this-buffer
4425                                  article group))))
4426             ;; There is no such article.
4427             (save-excursion
4428               (when (and (numberp article)
4429                          (not (memq article gnus-newsgroup-sparse)))
4430                 (setq gnus-article-current
4431                       (cons gnus-newsgroup-name article))
4432                 (set-buffer gnus-summary-buffer)
4433                 (setq gnus-current-article article)
4434                 (if (and (memq article gnus-newsgroup-undownloaded)
4435                          (not (gnus-online (gnus-find-method-for-group
4436                                             gnus-newsgroup-name))))
4437                     (progn
4438                       (gnus-summary-set-agent-mark article)
4439                       (message "Message marked for downloading"))
4440                   (gnus-summary-mark-article article gnus-canceled-mark)
4441                   (unless (memq article gnus-newsgroup-sparse)
4442                     (gnus-error 1 "No such article (may have expired or been canceled)")))))
4443           (if (or (eq result 'pseudo)
4444                   (eq result 'nneething))
4445               (progn
4446                 (with-current-buffer summary-buffer
4447                   (push article gnus-newsgroup-history)
4448                   (setq gnus-last-article gnus-current-article
4449                         gnus-current-article 0
4450                         gnus-current-headers nil
4451                         gnus-article-current nil)
4452                   (if (eq result 'nneething)
4453                       (gnus-configure-windows 'summary)
4454                     (gnus-configure-windows 'article))
4455                   (gnus-set-global-variables))
4456                 (let ((gnus-article-mime-handle-alist-1
4457                        gnus-article-mime-handle-alist))
4458                   (gnus-set-mode-line 'article)))
4459             ;; The result from the `request' was an actual article -
4460             ;; or at least some text that is now displayed in the
4461             ;; article buffer.
4462             (when (and (numberp article)
4463                        (not (eq article gnus-current-article)))
4464               ;; Seems like a new article has been selected.
4465               ;; `gnus-current-article' must be an article number.
4466               (with-current-buffer summary-buffer
4467                 (push article gnus-newsgroup-history)
4468                 (setq gnus-last-article gnus-current-article
4469                       gnus-current-article article
4470                       gnus-current-headers
4471                       (gnus-summary-article-header gnus-current-article)
4472                       gnus-article-current
4473                       (cons gnus-newsgroup-name gnus-current-article))
4474                 (unless (vectorp gnus-current-headers)
4475                   (setq gnus-current-headers nil))
4476                 (gnus-summary-goto-subject gnus-current-article)
4477                 (when (gnus-summary-show-thread)
4478                   ;; If the summary buffer really was folded, the
4479                   ;; previous goto may not actually have gone to
4480                   ;; the right article, but the thread root instead.
4481                   ;; So we go again.
4482                   (gnus-summary-goto-subject gnus-current-article))
4483                 (gnus-run-hooks 'gnus-mark-article-hook)
4484                 (gnus-set-mode-line 'summary)
4485                 (when (gnus-visual-p 'article-highlight 'highlight)
4486                   (gnus-run-hooks 'gnus-visual-mark-article-hook))
4487                 ;; Set the global newsgroup variables here.
4488                 (gnus-set-global-variables)
4489                 (setq gnus-have-all-headers
4490                       (or all-headers gnus-show-all-headers))))
4491             (save-excursion
4492               (gnus-configure-windows 'article))
4493             (when (or (numberp article)
4494                       (stringp article))
4495               (gnus-article-prepare-display)
4496               ;; Do page break.
4497               (goto-char (point-min))
4498               (when gnus-break-pages
4499                 (gnus-narrow-to-page)))
4500             (let ((gnus-article-mime-handle-alist-1
4501                    gnus-article-mime-handle-alist))
4502               (gnus-set-mode-line 'article))
4503             (article-goto-body)
4504             (unless (bobp)
4505               (forward-line -1))
4506             (set-window-point (get-buffer-window (current-buffer)) (point))
4507             (gnus-configure-windows 'article)
4508             t))))))
4509
4510 ;;;###autoload
4511 (defun gnus-article-prepare-display ()
4512   "Make the current buffer look like a nice article."
4513   ;; Hooks for getting information from the article.
4514   ;; This hook must be called before being narrowed.
4515   (let ((gnus-article-buffer (current-buffer))
4516         buffer-read-only
4517         (inhibit-read-only t))
4518     (unless (eq major-mode 'gnus-article-mode)
4519       (gnus-article-mode))
4520     (setq buffer-read-only nil
4521           gnus-article-wash-types nil
4522           gnus-article-image-alist nil)
4523     (gnus-run-hooks 'gnus-tmp-internal-hook)
4524     (when gnus-display-mime-function
4525       (funcall gnus-display-mime-function))
4526     (gnus-run-hooks 'gnus-article-prepare-hook)))
4527
4528 ;;;
4529 ;;; Gnus Sticky Article Mode
4530 ;;;
4531
4532 (define-derived-mode gnus-sticky-article-mode gnus-article-mode "StickyArticle"
4533   "Mode for sticky articles."
4534   ;; Release bindings that won't work.
4535   (substitute-key-definition 'gnus-article-read-summary-keys 'undefined
4536                              gnus-sticky-article-mode-map)
4537   (substitute-key-definition 'gnus-article-refer-article 'undefined
4538                              gnus-sticky-article-mode-map)
4539   (dolist (k '("e" "h" "s" "F" "R"))
4540     (define-key gnus-sticky-article-mode-map k nil))
4541   (define-key gnus-sticky-article-mode-map "k" 'gnus-kill-sticky-article-buffer)
4542   (define-key gnus-sticky-article-mode-map "q" 'bury-buffer)
4543   (define-key gnus-sticky-article-mode-map "\C-hc" 'describe-key-briefly)
4544   (define-key gnus-sticky-article-mode-map "\C-hk" 'describe-key))
4545
4546 (defun gnus-sticky-article (arg)
4547   "Make the current article sticky.
4548 If a prefix ARG is given, ask for a name for this sticky article buffer."
4549   (interactive "P")
4550   (gnus-summary-show-thread)
4551   (gnus-summary-select-article nil nil 'pseudo)
4552   (let (new-art-buf-name)
4553     (gnus-eval-in-buffer-window gnus-article-buffer
4554       (setq new-art-buf-name
4555             (concat
4556              "*Sticky Article: "
4557              (if arg
4558                  (read-from-minibuffer "Sticky article buffer name: ")
4559                (gnus-with-article-headers
4560                  (gnus-article-goto-header "subject")
4561                  (setq new-art-buf-name
4562                        (buffer-substring-no-properties
4563                         (line-beginning-position) (line-end-position)))
4564                  (goto-char (point-min))
4565                  (gnus-article-goto-header "from")
4566                  (setq new-art-buf-name
4567                        (concat
4568                         new-art-buf-name ", "
4569                         (buffer-substring-no-properties
4570                          (line-beginning-position) (line-end-position))))
4571                  (goto-char (point-min))
4572                  (gnus-article-goto-header "date")
4573                  (setq new-art-buf-name
4574                        (concat
4575                         new-art-buf-name ", "
4576                         (buffer-substring-no-properties
4577                          (line-beginning-position) (line-end-position))))))
4578              "*"))
4579       (if (and (gnus-buffer-live-p new-art-buf-name)
4580                (with-current-buffer new-art-buf-name
4581                  (eq major-mode 'gnus-sticky-article-mode)))
4582           (switch-to-buffer new-art-buf-name)
4583         (setq new-art-buf-name (rename-buffer new-art-buf-name t)))
4584       (gnus-sticky-article-mode))
4585     (setq gnus-article-buffer new-art-buf-name))
4586   (gnus-summary-recenter)
4587   (gnus-summary-position-point))
4588
4589 (defun gnus-kill-sticky-article-buffer (&optional buffer)
4590   "Kill the given sticky article BUFFER.
4591 If none is given, assume the current buffer and kill it if it has
4592 `gnus-sticky-article-mode'."
4593   (interactive)
4594   (unless buffer
4595     (setq buffer (current-buffer)))
4596   (with-current-buffer buffer
4597     (when (eq major-mode 'gnus-sticky-article-mode)
4598       (gnus-kill-buffer buffer))))
4599
4600 (defun gnus-kill-sticky-article-buffers (arg)
4601   "Kill all sticky article buffers.
4602 If a prefix ARG is given, ask for confirmation."
4603   (interactive "P")
4604   (dolist (buf (gnus-buffers))
4605     (with-current-buffer buf
4606       (when (eq major-mode 'gnus-sticky-article-mode)
4607         (if (not arg)
4608             (gnus-kill-buffer buf)
4609           (when (yes-or-no-p (concat "Kill buffer " (buffer-name buf) "? "))
4610             (gnus-kill-buffer buf)))))))
4611
4612 ;;;
4613 ;;; Gnus MIME viewing functions
4614 ;;;
4615
4616 (defvar gnus-mime-button-line-format "%{%([%p. %d%T]%)%}%e\n"
4617   "Format of the MIME buttons.
4618
4619 Valid specifiers include:
4620 %t  The MIME type
4621 %T  MIME type, along with additional info
4622 %n  The `name' parameter
4623 %d  The description, if any
4624 %l  The length of the encoded part
4625 %p  The part identifier number
4626 %e  Dots if the part isn't displayed
4627
4628 General format specifiers can also be used.  See Info node
4629 `(gnus)Formatting Variables'.")
4630
4631 (defvar gnus-mime-button-line-format-alist
4632   '((?t gnus-tmp-type ?s)
4633     (?T gnus-tmp-type-long ?s)
4634     (?n gnus-tmp-name ?s)
4635     (?d gnus-tmp-description ?s)
4636     (?p gnus-tmp-id ?s)
4637     (?l gnus-tmp-length ?d)
4638     (?e gnus-tmp-dots ?s)))
4639
4640 (defvar gnus-mime-button-commands
4641   '((gnus-article-press-button "\r" "Toggle Display")
4642     (gnus-mime-view-part "v" "View Interactively...")
4643     (gnus-mime-view-part-as-type "t" "View As Type...")
4644     (gnus-mime-view-part-as-charset "C" "View As charset...")
4645     (gnus-mime-save-part "o" "Save...")
4646     (gnus-mime-save-part-and-strip "\C-o" "Save and Strip")
4647     (gnus-mime-replace-part "r" "Replace part")
4648     (gnus-mime-delete-part "d" "Delete part")
4649     (gnus-mime-copy-part "c" "View As Text, In Other Buffer")
4650     (gnus-mime-inline-part "i" "View As Text, In This Buffer")
4651     (gnus-mime-view-part-internally "E" "View Internally") ;; Why `E'?
4652     (gnus-mime-view-part-externally "e" "View Externally")
4653     (gnus-mime-print-part "p" "Print")
4654     (gnus-mime-pipe-part "|" "Pipe To Command...")
4655     (gnus-mime-action-on-part "." "Take action on the part...")))
4656
4657 (defun gnus-article-mime-part-status ()
4658   (if gnus-article-mime-handle-alist-1
4659       (if (eq 1 (length gnus-article-mime-handle-alist-1))
4660           " (1 part)"
4661         (format " (%d parts)" (length gnus-article-mime-handle-alist-1)))
4662     ""))
4663
4664 (defvar gnus-mime-button-map
4665   (let ((map (make-sparse-keymap)))
4666     (define-key map gnus-mouse-2 'gnus-article-push-button)
4667     (define-key map gnus-down-mouse-3 'gnus-mime-button-menu)
4668     (dolist (c gnus-mime-button-commands)
4669       (define-key map (cadr c) (car c)))
4670     map))
4671
4672 (easy-menu-define
4673   gnus-mime-button-menu gnus-mime-button-map "MIME button menu."
4674   `("MIME Part"
4675     ,@(mapcar (lambda (c)
4676                 (vector (caddr c) (car c) :active t))
4677               gnus-mime-button-commands)))
4678
4679 (defun gnus-mime-button-menu (event prefix)
4680  "Construct a context-sensitive menu of MIME commands."
4681  (interactive "e\nP")
4682  (save-window-excursion
4683    (let ((pos (event-start event)))
4684      (select-window (posn-window pos))
4685      (goto-char (posn-point pos))
4686      (gnus-article-check-buffer)
4687      (popup-menu gnus-mime-button-menu nil prefix))))
4688
4689 (defun gnus-mime-view-all-parts (&optional handles)
4690   "View all the MIME parts."
4691   (interactive)
4692   (with-current-buffer gnus-article-buffer
4693     (let ((handles (or handles gnus-article-mime-handles))
4694           (mail-parse-charset gnus-newsgroup-charset)
4695           (mail-parse-ignored-charsets
4696            (with-current-buffer gnus-summary-buffer
4697              gnus-newsgroup-ignored-charsets)))
4698       (when handles
4699         (mm-remove-parts handles)
4700         (goto-char (point-min))
4701         (or (search-forward "\n\n") (goto-char (point-max)))
4702         (let ((inhibit-read-only t))
4703           (delete-region (point) (point-max))
4704           (mm-display-parts handles))))))
4705
4706 (defun gnus-article-jump-to-part (n)
4707   "Jump to MIME part N."
4708   (interactive "P")
4709   (pop-to-buffer gnus-article-buffer)
4710   ;; FIXME: why is it necessary?
4711   (sit-for 0)
4712   (let ((parts (length gnus-article-mime-handle-alist)))
4713     (or n (setq n
4714                 (string-to-number
4715                  (read-string ;; Emacs 21 doesn't have `read-number'.
4716                   (format "Jump to part (2..%s): " parts)))))
4717     (unless (and (integerp n) (<= n parts) (>= n 1))
4718       (setq n
4719             (progn
4720               (gnus-message 7 "Invalid part `%s', using %s instead."
4721                             n parts)
4722               parts)))
4723     (gnus-message 9 "Jumping to part %s." n)
4724     (cond ((>= gnus-auto-select-part 1)
4725            (while (and (<= n parts)
4726                        (not (gnus-article-goto-part n)))
4727              (setq n (1+ n))))
4728           ((< gnus-auto-select-part 0)
4729            (while (and (>= n 1)
4730                        (not (gnus-article-goto-part n)))
4731              (setq n (1- n))))
4732           (t
4733            (gnus-article-goto-part n)))))
4734
4735 (eval-when-compile
4736   (defsubst gnus-article-edit-part (handles &optional current-id)
4737     "Edit an article in order to delete a mime part.
4738 This function is exclusively used by `gnus-mime-save-part-and-strip'
4739 and `gnus-mime-delete-part', and not provided at run-time normally."
4740     (gnus-article-edit-article
4741      `(lambda ()
4742         (buffer-disable-undo)
4743         (erase-buffer)
4744         (let ((mail-parse-charset (or gnus-article-charset
4745                                       ',gnus-newsgroup-charset))
4746               (mail-parse-ignored-charsets
4747                (or gnus-article-ignored-charsets
4748                    ',gnus-newsgroup-ignored-charsets))
4749               (mbl mml-buffer-list))
4750           (setq mml-buffer-list nil)
4751           (insert-buffer-substring gnus-original-article-buffer)
4752           (mime-to-mml ',handles)
4753           (setq gnus-article-mime-handles nil)
4754           (let ((mbl1 mml-buffer-list))
4755             (setq mml-buffer-list mbl)
4756             (set (make-local-variable 'mml-buffer-list) mbl1))
4757           (gnus-make-local-hook 'kill-buffer-hook)
4758           (add-hook 'kill-buffer-hook 'mml-destroy-buffers t t)))
4759      `(lambda (no-highlight)
4760         (let ((mail-parse-charset (or gnus-article-charset
4761                                       ',gnus-newsgroup-charset))
4762               (message-options message-options)
4763               (message-options-set-recipient)
4764               (mail-parse-ignored-charsets
4765                (or gnus-article-ignored-charsets
4766                    ',gnus-newsgroup-ignored-charsets)))
4767           (mml-to-mime)
4768           (mml-destroy-buffers)
4769           (remove-hook 'kill-buffer-hook
4770                        'mml-destroy-buffers t)
4771           (kill-local-variable 'mml-buffer-list))
4772         (gnus-summary-edit-article-done
4773          ,(or (mail-header-references gnus-current-headers) "")
4774          ,(gnus-group-read-only-p)
4775          ,gnus-summary-buffer no-highlight))
4776      t)
4777     (gnus-article-edit-done)
4778     (gnus-summary-expand-window)
4779     (gnus-summary-show-article)
4780     (when (and current-id (integerp gnus-auto-select-part))
4781       (gnus-article-jump-to-part
4782        (if (text-property-any (point-min) (point-max)
4783                               'gnus-part (+ current-id gnus-auto-select-part))
4784            (+ current-id gnus-auto-select-part)
4785          (with-current-buffer gnus-article-buffer
4786            (length gnus-article-mime-handle-alist)))))))
4787
4788 (defun gnus-mime-replace-part (file)
4789   "Replace MIME part under point with an external body."
4790   ;; Useful if file has already been saved to disk
4791   (interactive
4792    (list
4793     (read-file-name "Replace MIME part with file: "
4794                     (or mm-default-directory default-directory)
4795                     nil nil)))
4796   (gnus-mime-save-part-and-strip file))
4797
4798 (defun gnus-mime-save-part-and-strip (&optional file)
4799   "Save the MIME part under point then replace it with an external body.
4800 If FILE is given, use it for the external part."
4801   (interactive)
4802   (gnus-article-check-buffer)
4803   (when (gnus-group-read-only-p)
4804     (error "The current group does not support deleting of parts"))
4805   (when (mm-complicated-handles gnus-article-mime-handles)
4806     (error "\
4807 The current article has a complicated MIME structure, giving up..."))
4808   (let* ((data (get-text-property (point) 'gnus-data))
4809          (id (get-text-property (point) 'gnus-part))
4810          param
4811          (handles gnus-article-mime-handles))
4812     (unless file
4813       (setq file
4814             (and data (mm-save-part data "Delete MIME part and save to: "))))
4815     (when file
4816       (with-current-buffer (mm-handle-buffer data)
4817         (erase-buffer)
4818         (insert "Content-Type: " (mm-handle-media-type data))
4819         (mml-insert-parameter-string (cdr (mm-handle-type data))
4820                                      '(charset))
4821         ;; Add a filename for the sake of saving the part again.
4822         (mml-insert-parameter
4823          (mail-header-encode-parameter "name" (file-name-nondirectory file)))
4824         (insert "\n")
4825         (insert "Content-ID: " (message-make-message-id) "\n")
4826         (insert "Content-Transfer-Encoding: binary\n")
4827         (insert "\n"))
4828       (setcdr data
4829               (cdr (mm-make-handle nil
4830                                    `("message/external-body"
4831                                      (access-type . "LOCAL-FILE")
4832                                      (name . ,file)))))
4833       ;; (set-buffer gnus-summary-buffer)
4834       (gnus-article-edit-part handles id))))
4835
4836 ;; A function like `gnus-summary-save-parts' (`X m', `<MIME> <Extract all
4837 ;; parts...>') but with stripping would be nice.
4838
4839 (defun gnus-mime-delete-part ()
4840   "Delete the MIME part under point.
4841 Replace it with some information about the removed part."
4842   (interactive)
4843   (gnus-article-check-buffer)
4844   (when (gnus-group-read-only-p)
4845     (error "The current group does not support deleting of parts"))
4846   (when (mm-complicated-handles gnus-article-mime-handles)
4847     (error "\
4848 The current article has a complicated MIME structure, giving up..."))
4849   (when (or gnus-expert-user
4850             (gnus-yes-or-no-p "\
4851 Deleting parts may malfunction or destroy the article; continue? "))
4852     (let* ((data (get-text-property (point) 'gnus-data))
4853            (id (get-text-property (point) 'gnus-part))
4854            (handles gnus-article-mime-handles)
4855            (none "(none)")
4856            (description
4857             (let ((desc (mm-handle-description data)))
4858               (when desc
4859                 (mail-decode-encoded-word-string desc))))
4860            (filename
4861             (or (mail-content-type-get (mm-handle-disposition data) 'filename)
4862                 none))
4863            (type (mm-handle-media-type data)))
4864       (unless data
4865         (error "No MIME part under point"))
4866       (with-current-buffer (mm-handle-buffer data)
4867         (let ((bsize (format "%s" (buffer-size))))
4868           (erase-buffer)
4869           (insert
4870            (concat
4871             ",----\n"
4872             "| The following attachment has been deleted:\n"
4873             "|\n"
4874             "| Type:           " type "\n"
4875             "| Filename:       " filename "\n"
4876             "| Size (encoded): " bsize " Byte\n"
4877             (when description
4878               (concat    "| Description:    " description "\n"))
4879             "`----\n"))
4880           (setcdr data
4881                   (cdr (mm-make-handle
4882                         nil `("text/plain") nil nil
4883                         (list "attachment")
4884                         (format "Deleted attachment (%s bytes)" bsize))))))
4885       ;; (set-buffer gnus-summary-buffer)
4886       (gnus-article-edit-part handles id))))
4887
4888 (defun gnus-mime-save-part ()
4889   "Save the MIME part under point."
4890   (interactive)
4891   (gnus-article-check-buffer)
4892   (let ((data (get-text-property (point) 'gnus-data)))
4893     (when data
4894       (mm-save-part data))))
4895
4896 (defun gnus-mime-pipe-part ()
4897   "Pipe the MIME part under point to a process."
4898   (interactive)
4899   (gnus-article-check-buffer)
4900   (let ((data (get-text-property (point) 'gnus-data)))
4901     (when data
4902       (mm-pipe-part data))))
4903
4904 (defun gnus-mime-view-part ()
4905   "Interactively choose a viewing method for the MIME part under point."
4906   (interactive)
4907   (gnus-article-check-buffer)
4908   (let ((data (get-text-property (point) 'gnus-data)))
4909     (when data
4910       (setq gnus-article-mime-handles
4911             (mm-merge-handles
4912              gnus-article-mime-handles (setq data (copy-sequence data))))
4913       (mm-interactively-view-part data))))
4914
4915 (defun gnus-mime-view-part-as-type-internal ()
4916   (gnus-article-check-buffer)
4917   (let* ((handle (get-text-property (point) 'gnus-data))
4918          (name (or
4919                 ;; Content-Type: foo/bar; name=...
4920                 (mail-content-type-get (mm-handle-type handle) 'name)
4921                 ;; Content-Disposition: attachment; filename=...
4922                 (cdr (assq 'filename (cdr (mm-handle-disposition handle))))))
4923          (def-type (and name (mm-default-file-encoding name))))
4924     (or (and def-type (cons def-type 0))
4925         (and handle
4926              (equal (mm-handle-media-supertype handle) "text")
4927              '("text/plain" . 0))
4928         '("application/octet-stream" . 0))))
4929
4930 (defun gnus-mime-view-part-as-type (&optional mime-type pred)
4931   "Choose a MIME media type, and view the part as such.
4932 If non-nil, PRED is a predicate to use during completion to limit the
4933 available media-types."
4934   (interactive)
4935   (unless mime-type
4936     (setq mime-type
4937           (let ((default (gnus-mime-view-part-as-type-internal)))
4938             (completing-read
4939              (format "View as MIME type (default %s): "
4940                      (car default))
4941              (mapcar #'list (mailcap-mime-types))
4942              pred nil nil nil
4943              (car default)))))
4944   (gnus-article-check-buffer)
4945   (let ((handle (get-text-property (point) 'gnus-data)))
4946     (when handle
4947       (when (equal (mm-handle-media-type handle) "message/external-body")
4948         (unless (mm-handle-cache handle)
4949           (mm-extern-cache-contents handle))
4950         (setq handle (mm-handle-cache handle)))
4951       (setq handle
4952             (mm-make-handle (mm-handle-buffer handle)
4953                             (cons mime-type (cdr (mm-handle-type handle)))
4954                             (mm-handle-encoding handle)
4955                             (mm-handle-undisplayer handle)
4956                             (mm-handle-disposition handle)
4957                             (mm-handle-description handle)
4958                             nil
4959                             (mm-handle-id handle)))
4960       (setq gnus-article-mime-handles
4961             (mm-merge-handles gnus-article-mime-handles handle))
4962       (when (mm-handle-displayed-p handle)
4963         (mm-remove-part handle))
4964       (gnus-mm-display-part handle))))
4965
4966 (defun gnus-mime-copy-part (&optional handle arg)
4967   "Put the MIME part under point into a new buffer.
4968 If `auto-compression-mode' is enabled, compressed files like .gz and .bz2
4969 are decompressed."
4970   (interactive (list nil current-prefix-arg))
4971   (gnus-article-check-buffer)
4972   (unless handle
4973     (setq handle (get-text-property (point) 'gnus-data)))
4974   (when handle
4975     (let ((filename (or (mail-content-type-get (mm-handle-type handle)
4976                                                'name)
4977                         (mail-content-type-get (mm-handle-disposition handle)
4978                                                'filename)))
4979           contents dont-decode charset coding-system)
4980       (mm-with-unibyte-buffer
4981         (mm-insert-part handle)
4982         (setq contents (or (condition-case nil
4983                                (mm-decompress-buffer filename nil 'sig)
4984                              (error
4985                               (setq dont-decode t)
4986                               nil))
4987                            (buffer-string))))
4988       (setq filename (cond (filename (file-name-nondirectory filename))
4989                            (dont-decode "*raw data*")
4990                            (t "*decoded*")))
4991       (cond
4992        (dont-decode)
4993        ((not arg)
4994         (unless (setq charset (mail-content-type-get
4995                                (mm-handle-type handle) 'charset))
4996           (unless (setq coding-system (mm-with-unibyte-buffer
4997                                         (insert contents)
4998                                         (mm-find-buffer-file-coding-system)))
4999             (setq charset gnus-newsgroup-charset))))
5000        ((numberp arg)
5001         (setq charset (or (cdr (assq arg
5002                                      gnus-summary-show-article-charset-alist))
5003                           (mm-read-coding-system "Charset: ")))))
5004       (switch-to-buffer (generate-new-buffer filename))
5005       (if (or coding-system
5006               (and charset
5007                    (setq coding-system (mm-charset-to-coding-system charset))
5008                    (not (eq charset 'ascii))))
5009           (progn
5010             (mm-enable-multibyte)
5011             (insert (mm-decode-coding-string contents coding-system))
5012             (setq buffer-file-coding-system
5013                   (if (boundp 'last-coding-system-used)
5014                       (symbol-value 'last-coding-system-used)
5015                     coding-system)))
5016         (mm-disable-multibyte)
5017         (insert contents)
5018         (setq buffer-file-coding-system mm-binary-coding-system))
5019       ;; We do it this way to make `normal-mode' set the appropriate mode.
5020       (unwind-protect
5021           (progn
5022             (setq buffer-file-name (expand-file-name filename))
5023             (normal-mode))
5024         (setq buffer-file-name nil))
5025       (goto-char (point-min)))))
5026
5027 (defun gnus-mime-print-part (&optional handle filename)
5028   "Print the MIME part under point."
5029   (interactive (list nil (ps-print-preprint current-prefix-arg)))
5030   (gnus-article-check-buffer)
5031   (let* ((handle (or handle (get-text-property (point) 'gnus-data)))
5032          (contents (and handle (mm-get-part handle)))
5033          (file (mm-make-temp-file (expand-file-name "mm." mm-tmp-directory)))
5034          (printer (mailcap-mime-info (mm-handle-media-type handle) "print")))
5035     (when contents
5036         (if printer
5037             (unwind-protect
5038                 (progn
5039                   (mm-save-part-to-file handle file)
5040                   (call-process shell-file-name nil
5041                                 (generate-new-buffer " *mm*")
5042                                 nil
5043                                 shell-command-switch
5044                                 (mm-mailcap-command
5045                                  printer file (mm-handle-type handle))))
5046               (delete-file file))
5047           (with-temp-buffer
5048             (insert contents)
5049             (gnus-print-buffer))
5050           (ps-despool filename)))))
5051
5052 (defun gnus-mime-inline-part (&optional handle arg)
5053   "Insert the MIME part under point into the current buffer.
5054 Compressed files like .gz and .bz2 are decompressed."
5055   (interactive (list nil current-prefix-arg))
5056   (gnus-article-check-buffer)
5057   (unless handle
5058     (setq handle (get-text-property (point) 'gnus-data)))
5059   (when handle
5060     (let ((b (point))
5061           (inhibit-read-only t)
5062           contents charset coding-system)
5063       (if (and (not arg) (mm-handle-undisplayer handle))
5064           (mm-remove-part handle)
5065         (mm-with-unibyte-buffer
5066           (mm-insert-part handle)
5067           (setq contents
5068                 (or (mm-decompress-buffer
5069                      (or (mail-content-type-get (mm-handle-type handle)
5070                                                 'name)
5071                          (mail-content-type-get (mm-handle-disposition handle)
5072                                                 'filename))
5073                      nil t)
5074                     (buffer-string))))
5075         (cond
5076          ((not arg)
5077           (unless (setq charset (mail-content-type-get
5078                                  (mm-handle-type handle) 'charset))
5079             (unless (setq coding-system
5080                           (mm-with-unibyte-buffer
5081                             (insert contents)
5082                             (mm-find-buffer-file-coding-system)))
5083               (setq charset gnus-newsgroup-charset))))
5084          ((numberp arg)
5085           (if (mm-handle-undisplayer handle)
5086               (mm-remove-part handle))
5087           (setq charset
5088                 (or (cdr (assq arg
5089                                gnus-summary-show-article-charset-alist))
5090                     (mm-read-coding-system "Charset: "))))
5091          (t
5092           (if (mm-handle-undisplayer handle)
5093               (mm-remove-part handle))))
5094         (forward-line 2)
5095         (mm-insert-inline
5096          handle
5097          (if (or coding-system
5098                  (and charset
5099                       (setq coding-system
5100                             (mm-charset-to-coding-system charset))
5101                       (not (eq coding-system 'ascii))))
5102              (mm-decode-coding-string contents coding-system)
5103            (mm-string-to-multibyte contents)))
5104         (goto-char b)))))
5105
5106 (defun gnus-mime-strip-charset-parameters (handle)
5107   "Strip charset parameters from HANDLE."
5108   (if (stringp (car handle))
5109       (mapc #'gnus-mime-strip-charset-parameters (cdr handle))
5110     (let* ((type (mm-handle-type (if (equal (mm-handle-media-type handle)
5111                                             "message/external-body")
5112                                      (progn
5113                                        (unless (mm-handle-cache handle)
5114                                          (mm-extern-cache-contents handle))
5115                                        (mm-handle-cache handle))
5116                                    handle)))
5117            (charset (assq 'charset (cdr type))))
5118       (when charset
5119         (delq charset type)))))
5120
5121 (defun gnus-mime-view-part-as-charset (&optional handle arg)
5122   "Insert the MIME part under point into the current buffer using the
5123 specified charset."
5124   (interactive (list nil current-prefix-arg))
5125   (gnus-article-check-buffer)
5126   (let ((handle (or handle (get-text-property (point) 'gnus-data)))
5127         (fun (get-text-property (point) 'gnus-callback))
5128         (gnus-newsgroup-ignored-charsets 'gnus-all)
5129         gnus-newsgroup-charset form preferred parts)
5130     (when handle
5131       (when (prog1
5132                 (and fun
5133                      (setq gnus-newsgroup-charset
5134                            (or (cdr (assq
5135                                      arg
5136                                      gnus-summary-show-article-charset-alist))
5137                                (mm-read-coding-system "Charset: "))))
5138               (if (mm-handle-undisplayer handle)
5139                   (mm-remove-part handle)))
5140         (gnus-mime-strip-charset-parameters handle)
5141         (when (and (consp (setq form (cdr-safe fun)))
5142                    (setq form (ignore-errors
5143                                 (assq 'gnus-mime-display-alternative form)))
5144                    (setq preferred (caddr form))
5145                    (progn
5146                      (when (eq (car preferred) 'quote)
5147                        (setq preferred (cadr preferred)))
5148                      (not (equal preferred
5149                                  (get-text-property (point) 'gnus-data))))
5150                    (setq parts (get-text-property (point) 'gnus-part))
5151                    (setq parts (cdr (assq parts
5152                                           gnus-article-mime-handle-alist)))
5153                    (equal (mm-handle-media-type parts) "multipart/alternative")
5154                    (setq parts (reverse (cdr parts))))
5155           (setcar (cddr form)
5156                   (list 'quote (or (cadr (member preferred parts))
5157                                    (car parts)))))
5158         (funcall fun handle)))))
5159
5160 (defun gnus-mime-view-part-externally (&optional handle)
5161   "View the MIME part under point with an external viewer."
5162   (interactive)
5163   (gnus-article-check-buffer)
5164   (let* ((handle (or handle (get-text-property (point) 'gnus-data)))
5165          (mm-user-display-methods nil)
5166          (mm-inlined-types nil)
5167          (mail-parse-charset gnus-newsgroup-charset)
5168          (mail-parse-ignored-charsets
5169           (with-current-buffer gnus-summary-buffer
5170             gnus-newsgroup-ignored-charsets))
5171          (type (mm-handle-media-type handle))
5172          (method (mailcap-mime-info type))
5173          (mm-enable-external t))
5174     (if (not (stringp method))
5175         (gnus-mime-view-part-as-type
5176          nil (lambda (types) (stringp (mailcap-mime-info (car types)))))
5177       (when handle
5178         (if (mm-handle-undisplayer handle)
5179             (mm-remove-part handle)
5180           (mm-display-part handle))))))
5181
5182 (defun gnus-mime-view-part-internally (&optional handle)
5183   "View the MIME part under point with an internal viewer.
5184 If no internal viewer is available, use an external viewer."
5185   (interactive)
5186   (gnus-article-check-buffer)
5187   (let* ((handle (or handle (get-text-property (point) 'gnus-data)))
5188          (mm-inlined-types '(".*"))
5189          (mm-inline-large-images t)
5190          (mail-parse-charset gnus-newsgroup-charset)
5191          (mail-parse-ignored-charsets
5192           (with-current-buffer gnus-summary-buffer
5193             gnus-newsgroup-ignored-charsets))
5194          (inhibit-read-only t))
5195     (if (not (mm-inlinable-p handle))
5196         (gnus-mime-view-part-as-type
5197          nil (lambda (types) (mm-inlinable-p handle (car types))))
5198       (when handle
5199         (if (mm-handle-undisplayer handle)
5200             (mm-remove-part handle)
5201           (mm-display-part handle))))))
5202
5203 (defun gnus-mime-action-on-part (&optional action)
5204   "Do something with the MIME attachment at \(point\)."
5205   (interactive
5206    (list (completing-read "Action: " gnus-mime-action-alist nil t)))
5207   (gnus-article-check-buffer)
5208   (let ((action-pair (assoc action gnus-mime-action-alist)))
5209     (if action-pair
5210         (funcall (cdr action-pair)))))
5211
5212 (defun gnus-article-part-wrapper (n function &optional no-handle interactive)
5213   "Call FUNCTION on MIME part N.
5214 Unless NO-HANDLE, call FUNCTION with N-th MIME handle as it's only argument.
5215 If INTERACTIVE, call FUNCTION interactivly."
5216   (let (window frame)
5217     ;; Check whether the article is displayed.
5218     (unless (and (gnus-buffer-live-p gnus-article-buffer)
5219                  (setq window (get-buffer-window gnus-article-buffer t))
5220                  (frame-visible-p (setq frame (window-frame window))))
5221       (error "No article is displayed"))
5222     (with-current-buffer gnus-article-buffer
5223       ;; Check whether the article displays the right contents.
5224       (unless (with-current-buffer gnus-summary-buffer
5225                 (eq gnus-current-article (gnus-summary-article-number)))
5226         (error "You should select the right article first"))
5227       (if n
5228           (setq n (prefix-numeric-value n))
5229         (let ((pt (point)))
5230           (setq n (or (get-text-property pt 'gnus-part)
5231                       (and (not (bobp))
5232                            (get-text-property (1- pt) 'gnus-part))
5233                       (get-text-property (prog2
5234                                              (forward-line 1)
5235                                              (point)
5236                                            (goto-char pt))
5237                                          'gnus-part)
5238                       (get-text-property
5239                        (or (and (setq pt (previous-single-property-change
5240                                           pt 'gnus-part))
5241                                 (1- pt))
5242                            (next-single-property-change (point) 'gnus-part)
5243                            (point))
5244                        'gnus-part)
5245                       1))))
5246       ;; Check whether the specified part exists.
5247       (when (> n (length gnus-article-mime-handle-alist))
5248         (error "No such part")))
5249     (unless
5250         (progn
5251           ;; To select the window is needed so that the cursor
5252           ;; might be visible on the MIME button.
5253           (select-window (prog1
5254                              window
5255                            (setq window (selected-window))
5256                            ;; Article may be displayed in the other frame.
5257                            (gnus-select-frame-set-input-focus
5258                             (prog1
5259                                 frame
5260                               (setq frame (selected-frame))))))
5261           (when (gnus-article-goto-part n)
5262             ;; We point the cursor and the arrow at the MIME button
5263             ;; when the `function' prompt the user for something.
5264             (let ((cursor-in-non-selected-windows t)
5265                   (overlay-arrow-string "=>")
5266                   (overlay-arrow-position (point-marker)))
5267               (unwind-protect
5268                   (cond
5269                    ((and no-handle interactive)
5270                     (call-interactively function))
5271                    (no-handle
5272                     (funcall function))
5273                    (interactive
5274                     (call-interactively
5275                      function
5276                      (cdr (assq n gnus-article-mime-handle-alist))))
5277                    (t
5278                     (funcall function
5279                              (cdr (assq n gnus-article-mime-handle-alist)))))
5280                 (set-marker overlay-arrow-position nil)
5281                 (unless gnus-auto-select-part
5282                   (gnus-select-frame-set-input-focus frame)
5283                   (select-window window))))
5284             t))
5285       (if gnus-inhibit-mime-unbuttonizing
5286           ;; This is the default though the program shouldn't reach here.
5287           (error "No such part")
5288         ;; The part which doesn't have the MIME button is selected.
5289         ;; So, we display all the buttons and redo it.
5290         (let ((gnus-inhibit-mime-unbuttonizing t))
5291           (gnus-summary-show-article)
5292           (gnus-article-part-wrapper n function no-handle))))))
5293
5294 (defun gnus-article-pipe-part (n)
5295   "Pipe MIME part N, which is the numerical prefix."
5296   (interactive "P")
5297   (gnus-article-part-wrapper n 'mm-pipe-part))
5298
5299 (defun gnus-article-save-part (n)
5300   "Save MIME part N, which is the numerical prefix."
5301   (interactive "P")
5302   (gnus-article-part-wrapper n 'mm-save-part))
5303
5304 (defun gnus-article-interactively-view-part (n)
5305   "View MIME part N interactively, which is the numerical prefix."
5306   (interactive "P")
5307   (gnus-article-part-wrapper n 'mm-interactively-view-part))
5308
5309 (defun gnus-article-copy-part (n)
5310   "Copy MIME part N, which is the numerical prefix."
5311   (interactive "P")
5312   (gnus-article-part-wrapper n 'gnus-mime-copy-part))
5313
5314 (defun gnus-article-view-part-as-charset (n)
5315   "View MIME part N using a specified charset.
5316 N is the numerical prefix."
5317   (interactive "P")
5318   (gnus-article-part-wrapper n 'gnus-mime-view-part-as-charset))
5319
5320 (defun gnus-article-view-part-externally (n)
5321   "View MIME part N externally, which is the numerical prefix."
5322   (interactive "P")
5323   (gnus-article-part-wrapper n 'gnus-mime-view-part-externally))
5324
5325 (defun gnus-article-inline-part (n)
5326   "Inline MIME part N, which is the numerical prefix."
5327   (interactive "P")
5328   (gnus-article-part-wrapper n 'gnus-mime-inline-part))
5329
5330 (defun gnus-article-save-part-and-strip (n)
5331   "Save MIME part N and replace it with an external body.
5332 N is the numerical prefix."
5333   (interactive "P")
5334   (gnus-article-part-wrapper n 'gnus-mime-save-part-and-strip t))
5335
5336 (defun gnus-article-replace-part (n)
5337   "Replace MIME part N with an external body.
5338 N is the numerical prefix."
5339   (interactive "P")
5340   (gnus-article-part-wrapper n 'gnus-mime-replace-part t t))
5341
5342 (defun gnus-article-delete-part (n)
5343   "Delete MIME part N and add some information about the removed part.
5344 N is the numerical prefix."
5345   (interactive "P")
5346   (gnus-article-part-wrapper n 'gnus-mime-delete-part t))
5347
5348 (defun gnus-article-view-part-as-type (n)
5349   "Choose a MIME media type, and view part N as such.
5350 N is the numerical prefix."
5351   (interactive "P")
5352   (gnus-article-part-wrapper n 'gnus-mime-view-part-as-type t))
5353
5354 (defun gnus-article-mime-match-handle-first (condition)
5355   (if condition
5356       (let (n)
5357         (dolist (ihandle gnus-article-mime-handle-alist)
5358           (if (and (cond
5359                     ((functionp condition)
5360                      (funcall condition (cdr ihandle)))
5361                     ((eq condition 'undisplayed)
5362                      (not (or (mm-handle-undisplayer (cdr ihandle))
5363                               (equal (mm-handle-media-type (cdr ihandle))
5364                                      "multipart/alternative"))))
5365                     ((eq condition 'undisplayed-alternative)
5366                      (not (mm-handle-undisplayer (cdr ihandle))))
5367                     (t t))
5368                    (gnus-article-goto-part (car ihandle))
5369                    (or (not n) (< (car ihandle) n)))
5370               (setq n (car ihandle))))
5371         (or n 1))
5372     1))
5373
5374 (defun gnus-article-view-part (&optional n)
5375   "View MIME part N, which is the numerical prefix."
5376   (interactive "P")
5377   (with-current-buffer gnus-article-buffer
5378     (or (numberp n) (setq n (gnus-article-mime-match-handle-first
5379                              gnus-article-mime-match-handle-function)))
5380     (when (> n (length gnus-article-mime-handle-alist))
5381       (error "No such part"))
5382     (let ((handle (cdr (assq n gnus-article-mime-handle-alist))))
5383       (when (gnus-article-goto-part n)
5384         (if (equal (car handle) "multipart/alternative")
5385             (gnus-article-press-button)
5386           (when (eq (gnus-mm-display-part handle) 'internal)
5387             (gnus-set-window-start)))))))
5388
5389 (defsubst gnus-article-mime-total-parts ()
5390   (if (bufferp (car gnus-article-mime-handles))
5391       1 ;; single part
5392     (1- (length gnus-article-mime-handles))))
5393
5394 (defun gnus-mm-display-part (handle)
5395   "Display HANDLE and fix MIME button."
5396   (let ((id (get-text-property (point) 'gnus-part))
5397         (point (point))
5398         (inhibit-read-only t))
5399     (forward-line 1)
5400     (prog1
5401         (let ((window (selected-window))
5402               (mail-parse-charset gnus-newsgroup-charset)
5403               (mail-parse-ignored-charsets
5404                (if (gnus-buffer-live-p gnus-summary-buffer)
5405                    (with-current-buffer gnus-summary-buffer
5406                      gnus-newsgroup-ignored-charsets)
5407                  nil)))
5408           (save-excursion
5409             (unwind-protect
5410                 (let ((win (gnus-get-buffer-window (current-buffer) t))
5411                       (beg (point)))
5412                   (when win
5413                     (select-window win))
5414                   (goto-char point)
5415                   (forward-line)
5416                   (if (mm-handle-displayed-p handle)
5417                       ;; This will remove the part.
5418                       (mm-display-part handle)
5419                     (save-restriction
5420                       (narrow-to-region (point)
5421                                         (if (eobp) (point) (1+ (point))))
5422                       (mm-display-part handle)
5423                       ;; We narrow to the part itself and
5424                       ;; then call the treatment functions.
5425                       (goto-char (point-min))
5426                       (forward-line 1)
5427                       (narrow-to-region (point) (point-max))
5428                       (gnus-treat-article
5429                        nil id
5430                        (gnus-article-mime-total-parts)
5431                        (mm-handle-media-type handle)))))
5432               (if (window-live-p window)
5433                   (select-window window)))))
5434       (goto-char point)
5435       (gnus-delete-line)
5436       (gnus-insert-mime-button
5437        handle id (list (mm-handle-displayed-p handle)))
5438       (goto-char point))))
5439
5440 (defun gnus-article-goto-part (n)
5441   "Go to MIME part N."
5442   (gnus-goto-char (text-property-any (point-min) (point-max) 'gnus-part n)))
5443
5444 (defun gnus-insert-mime-button (handle gnus-tmp-id &optional displayed)
5445   (let ((gnus-tmp-name
5446          (or (mail-content-type-get (mm-handle-type handle) 'name)
5447              (mail-content-type-get (mm-handle-disposition handle) 'filename)
5448              (mail-content-type-get (mm-handle-type handle) 'url)
5449              ""))
5450         (gnus-tmp-type (mm-handle-media-type handle))
5451         (gnus-tmp-description (or (mm-handle-description handle) ""))
5452         (gnus-tmp-dots
5453          (if (if displayed (car displayed)
5454                (mm-handle-displayed-p handle))
5455              "" "..."))
5456         (gnus-tmp-length (with-current-buffer (mm-handle-buffer handle)
5457                            (buffer-size)))
5458         gnus-tmp-type-long b e)
5459     (when (string-match ".*/" gnus-tmp-name)
5460       (setq gnus-tmp-name (replace-match "" t t gnus-tmp-name)))
5461     (setq gnus-tmp-type-long (concat gnus-tmp-type
5462                                      (and (not (equal gnus-tmp-name ""))
5463                                           (concat "; " gnus-tmp-name))))
5464     (unless (equal gnus-tmp-description "")
5465       (setq gnus-tmp-type-long (concat " --- " gnus-tmp-type-long)))
5466     (unless (bolp)
5467       (insert "\n"))
5468     (setq b (point))
5469     (gnus-eval-format
5470      gnus-mime-button-line-format gnus-mime-button-line-format-alist
5471      `(keymap ,gnus-mime-button-map
5472               gnus-callback gnus-mm-display-part
5473               gnus-part ,gnus-tmp-id
5474               article-type annotation
5475               gnus-data ,handle))
5476     (setq e (if (bolp)
5477                 ;; Exclude a newline.
5478                 (1- (point))
5479               (point)))
5480     (when gnus-article-button-face
5481       (gnus-overlay-put (gnus-make-overlay b e nil t)
5482                         'face gnus-article-button-face))
5483     (widget-convert-button
5484      'link b e
5485      :mime-handle handle
5486      :action 'gnus-widget-press-button
5487      :button-keymap gnus-mime-button-map
5488      :help-echo
5489      (lambda (widget/window &optional overlay pos)
5490        ;; Needed to properly clear the message due to a bug in
5491        ;; wid-edit (XEmacs only).
5492        (if (boundp 'help-echo-owns-message)
5493            (setq help-echo-owns-message t))
5494        (format
5495         "%S: %s the MIME part; %S: more options"
5496         (aref gnus-mouse-2 0)
5497         ;; XEmacs will get a single widget arg; Emacs 21 will get
5498         ;; window, overlay, position.
5499         (if (mm-handle-displayed-p
5500              (if overlay
5501                  (with-current-buffer (gnus-overlay-buffer overlay)
5502                    (widget-get (widget-at (gnus-overlay-start overlay))
5503                                :mime-handle))
5504                (widget-get widget/window :mime-handle)))
5505             "hide" "show")
5506         (aref gnus-down-mouse-3 0))))))
5507
5508 (defun gnus-widget-press-button (elems el)
5509   (goto-char (widget-get elems :from))
5510   (gnus-article-press-button))
5511
5512 (defvar gnus-displaying-mime nil)
5513
5514 (defun gnus-display-mime (&optional ihandles)
5515   "Display the MIME parts."
5516   (save-excursion
5517     (save-selected-window
5518       (let ((window (get-buffer-window gnus-article-buffer))
5519             (point (point)))
5520         (when window
5521           (select-window window)
5522           ;; We have to do this since selecting the window
5523           ;; may change the point.  So we set the window point.
5524           (set-window-point window point)))
5525       (let ((handles ihandles)
5526             (inhibit-read-only t)
5527             handle)
5528         (cond (handles)
5529               ((setq handles (mm-dissect-buffer nil gnus-article-loose-mime))
5530                (when gnus-article-emulate-mime
5531                  (mm-uu-dissect-text-parts handles)))
5532               (gnus-article-emulate-mime
5533                (setq handles (mm-uu-dissect))))
5534         (when (and (not ihandles)
5535                    (not gnus-displaying-mime))
5536           ;; Top-level call; we clean up.
5537           (when gnus-article-mime-handles
5538             (mm-destroy-parts gnus-article-mime-handles)
5539             (setq gnus-article-mime-handle-alist nil));; A trick.
5540           (setq gnus-article-mime-handles handles)
5541           ;; We allow users to glean info from the handles.
5542           (when gnus-article-mime-part-function
5543             (gnus-mime-part-function handles)))
5544         (if (and handles
5545                  (or (not (stringp (car handles)))
5546                      (cdr handles)))
5547             (progn
5548               (when (and (not ihandles)
5549                          (not gnus-displaying-mime))
5550                 ;; Clean up for mime parts.
5551                 (article-goto-body)
5552                 (delete-region (point) (point-max)))
5553               (let ((gnus-displaying-mime t))
5554                 (gnus-mime-display-part handles)))
5555           (save-restriction
5556             (article-goto-body)
5557             (narrow-to-region (point) (point-max))
5558             (gnus-treat-article nil 1 1)
5559             (widen)))
5560         (unless ihandles
5561           ;; Highlight the headers.
5562           (save-excursion
5563             (save-restriction
5564               (article-goto-body)
5565               (narrow-to-region (point-min) (point))
5566               (gnus-article-save-original-date
5567                (gnus-treat-article 'head)))))))
5568     ;; Cope with broken MIME messages.
5569     (goto-char (point-max))
5570     (unless (bolp)
5571       (insert "\n"))))
5572
5573 (defcustom gnus-mime-display-multipart-as-mixed nil
5574   "Display \"multipart\" parts as  \"multipart/mixed\".
5575
5576 If t, it overrides nil values of
5577 `gnus-mime-display-multipart-alternative-as-mixed' and
5578 `gnus-mime-display-multipart-related-as-mixed'."
5579   :group 'gnus-article-mime
5580   :type 'boolean)
5581
5582 (defcustom gnus-mime-display-multipart-alternative-as-mixed nil
5583   "Display \"multipart/alternative\" parts as  \"multipart/mixed\"."
5584   :version "22.1"
5585   :group 'gnus-article-mime
5586   :type 'boolean)
5587
5588 (defcustom gnus-mime-display-multipart-related-as-mixed nil
5589   "Display \"multipart/related\" parts as  \"multipart/mixed\".
5590
5591 If displaying \"text/html\" is discouraged \(see
5592 `mm-discouraged-alternatives'\) images or other material inside a
5593 \"multipart/related\" part might be overlooked when this variable is nil."
5594   :version "22.1"
5595   :group 'gnus-article-mime
5596   :type 'boolean)
5597
5598 (defun gnus-mime-display-part (handle)
5599   (cond
5600    ;; Maybe a broken MIME message.
5601    ((null handle))
5602    ;; Single part.
5603    ((not (stringp (car handle)))
5604     (gnus-mime-display-single handle))
5605    ;; User-defined multipart
5606    ((cdr (assoc (car handle) gnus-mime-multipart-functions))
5607     (funcall (cdr (assoc (car handle) gnus-mime-multipart-functions))
5608              handle))
5609    ;; multipart/alternative
5610    ((and (equal (car handle) "multipart/alternative")
5611          (not (or gnus-mime-display-multipart-as-mixed
5612                   gnus-mime-display-multipart-alternative-as-mixed)))
5613     (let ((id (1+ (length gnus-article-mime-handle-alist))))
5614       (push (cons id handle) gnus-article-mime-handle-alist)
5615       (gnus-mime-display-alternative (cdr handle) nil nil id)))
5616    ;; multipart/related
5617    ((and (equal (car handle) "multipart/related")
5618          (not (or gnus-mime-display-multipart-as-mixed
5619                   gnus-mime-display-multipart-related-as-mixed)))
5620     ;;;!!!We should find the start part, but we just default
5621     ;;;!!!to the first part.
5622     ;;(gnus-mime-display-part (cadr handle))
5623     ;;;!!! Most multipart/related is an HTML message plus images.
5624     ;;;!!! Unfortunately we are unable to let W3 display those
5625     ;;;!!! included images, so we just display it as a mixed multipart.
5626     ;;(gnus-mime-display-mixed (cdr handle))
5627     ;;;!!! No, w3 can display everything just fine.
5628     (gnus-mime-display-part (cadr handle)))
5629    ((equal (car handle) "multipart/signed")
5630     (gnus-add-wash-type 'signed)
5631     (gnus-mime-display-security handle))
5632    ((equal (car handle) "multipart/encrypted")
5633     (gnus-add-wash-type 'encrypted)
5634     (gnus-mime-display-security handle))
5635    ;; Other multiparts are handled like multipart/mixed.
5636    (t
5637     (gnus-mime-display-mixed (cdr handle)))))
5638
5639 (defun gnus-mime-part-function (handles)
5640   (if (stringp (car handles))
5641       (mapcar 'gnus-mime-part-function (cdr handles))
5642     (funcall gnus-article-mime-part-function handles)))
5643
5644 (defun gnus-mime-display-mixed (handles)
5645   (mapcar 'gnus-mime-display-part handles))
5646
5647 (defun gnus-mime-display-single (handle)
5648   (let ((type (mm-handle-media-type handle))
5649         (ignored gnus-ignored-mime-types)
5650         (not-attachment t)
5651         (move nil)
5652         display text)
5653     (catch 'ignored
5654       (progn
5655         (while ignored
5656           (when (string-match (pop ignored) type)
5657             (throw 'ignored nil)))
5658         (if (and (setq not-attachment
5659                        (and (not (mm-inline-override-p handle))
5660                             (or (not (mm-handle-disposition handle))
5661                                 (equal (car (mm-handle-disposition handle))
5662                                        "inline")
5663                                 (mm-attachment-override-p handle))))
5664                  (mm-automatic-display-p handle)
5665                  (or (and
5666                       (mm-inlinable-p handle)
5667                       (mm-inlined-p handle))
5668                      (mm-automatic-external-display-p type)))
5669             (setq display t)
5670           (when (equal (mm-handle-media-supertype handle) "text")
5671             (setq text t)))
5672         (let ((id (1+ (length gnus-article-mime-handle-alist)))
5673               beg)
5674           (push (cons id handle) gnus-article-mime-handle-alist)
5675           (when (and display
5676                      (equal (mm-handle-media-supertype handle) "message"))
5677             (insert-char
5678              ?\n
5679              (cond ((not (bolp)) 2)
5680                    ((or (bobp) (eq (char-before (1- (point))) ?\n)) 0)
5681                    (t 1))))
5682           (when (or (not display)
5683                     (not (gnus-unbuttonized-mime-type-p type)))
5684             (gnus-insert-mime-button
5685              handle id (list (or display (and not-attachment text))))
5686             (gnus-article-insert-newline)
5687             ;; Remember modify the number of forward lines.
5688             (setq move t))
5689           (setq beg (point))
5690           (cond
5691            (display
5692             (when move
5693               (forward-line -1)
5694               (setq beg (point)))
5695             (let ((mail-parse-charset gnus-newsgroup-charset)
5696                   (mail-parse-ignored-charsets
5697                    (save-excursion (condition-case ()
5698                                        (set-buffer gnus-summary-buffer)
5699                                      (error))
5700                                    gnus-newsgroup-ignored-charsets)))
5701               (mm-display-part handle t))
5702             (goto-char (point-max)))
5703            ((and text not-attachment)
5704             (when move
5705               (forward-line -1)
5706               (setq beg (point)))
5707             (gnus-article-insert-newline)
5708             (mm-insert-inline
5709              handle
5710              (let ((charset (or (mail-content-type-get (mm-handle-type handle)
5711                                                        'charset)
5712                                 (and (equal type "text/calendar") 'utf-8))))
5713                (cond ((not charset)
5714                       (mm-string-as-multibyte (mm-get-part handle)))
5715                      ((eq charset 'gnus-decoded)
5716                       (with-current-buffer (mm-handle-buffer handle)
5717                         (buffer-string)))
5718                      (t
5719                       (mm-decode-string (mm-get-part handle) charset)))))
5720             (goto-char (point-max))))
5721           ;; Do highlighting.
5722           (save-excursion
5723             (save-restriction
5724               (narrow-to-region beg (point))
5725               (if (eq handle gnus-article-mime-handles)
5726                   ;; The format=flowed case.
5727                   (gnus-treat-article nil 1 1 (mm-handle-media-type handle))
5728                 ;; Don't count signature parts that are never displayed.
5729                 ;; The part number should be re-calculated supposing this
5730                 ;; might be a message/rfc822 part.
5731                 (let (handles)
5732                   (dolist (part gnus-article-mime-handles)
5733                     (unless (or (stringp part)
5734                                 (equal (car (mm-handle-type part))
5735                                        "application/pgp-signature"))
5736                       (push part handles)))
5737                   (gnus-treat-article
5738                    nil (length (memq handle handles)) (length handles)
5739                    (mm-handle-media-type handle)))))))))))
5740
5741 (defun gnus-unbuttonized-mime-type-p (type)
5742   "Say whether TYPE is to be unbuttonized."
5743   (unless gnus-inhibit-mime-unbuttonizing
5744     (when (catch 'found
5745             (let ((types gnus-unbuttonized-mime-types))
5746               (while types
5747                 (when (string-match (pop types) type)
5748                   (throw 'found t)))))
5749       (not (catch 'found
5750              (let ((types gnus-buttonized-mime-types))
5751                (while types
5752                  (when (string-match (pop types) type)
5753                    (throw 'found t)))))))))
5754
5755 (defun gnus-article-insert-newline ()
5756   "Insert a newline, but mark it as undeletable."
5757   (gnus-put-text-property
5758    (point) (progn (insert "\n") (point)) 'gnus-undeletable t))
5759
5760 (defun gnus-mime-display-alternative (handles &optional preferred ibegend id)
5761   (let* ((preferred (or preferred (mm-preferred-alternative handles)))
5762          (ihandles handles)
5763          (point (point))
5764          handle (inhibit-read-only t) from props begend not-pref)
5765     (save-window-excursion
5766       (save-restriction
5767         (when ibegend
5768           (narrow-to-region (car ibegend)
5769                             (or (cdr ibegend)
5770                                 (progn
5771                                   (goto-char (car ibegend))
5772                                   (forward-line 2)
5773                                   (point))))
5774           (delete-region (point-min) (point-max))
5775           (mm-remove-parts handles))
5776         (setq begend (list (point-marker)))
5777         ;; Do the toggle.
5778         (unless (setq not-pref (cadr (member preferred ihandles)))
5779           (setq not-pref (car ihandles)))
5780         (when (or ibegend
5781                   (not preferred)
5782                   (not (gnus-unbuttonized-mime-type-p
5783                         "multipart/alternative")))
5784           (gnus-add-text-properties
5785            (setq from (point))
5786            (progn
5787              (insert (format "%d.  " id))
5788              (point))
5789            `(gnus-callback
5790              (lambda (handles)
5791                (unless ,(not ibegend)
5792                  (setq gnus-article-mime-handle-alist
5793                        ',gnus-article-mime-handle-alist))
5794                (gnus-mime-display-alternative
5795                 ',ihandles ',not-pref ',begend ,id))
5796              keymap ,gnus-mime-button-map
5797              ,gnus-mouse-face-prop ,gnus-article-mouse-face
5798              face ,gnus-article-button-face
5799              gnus-part ,id
5800              article-type multipart))
5801           (widget-convert-button 'link from (point)
5802                                  :action 'gnus-widget-press-button
5803                                  :button-keymap gnus-widget-button-keymap)
5804           ;; Do the handles
5805           (while (setq handle (pop handles))
5806             (gnus-add-text-properties
5807              (setq from (point))
5808              (progn
5809                (insert (format "(%c) %-18s"
5810                                (if (equal handle preferred) ?* ? )
5811                                (mm-handle-media-type handle)))
5812                (point))
5813              `(gnus-callback
5814                (lambda (handles)
5815                  (unless ,(not ibegend)
5816                    (setq gnus-article-mime-handle-alist
5817                          ',gnus-article-mime-handle-alist))
5818                  (gnus-mime-display-alternative
5819                   ',ihandles ',handle ',begend ,id))
5820                keymap ,gnus-mime-button-map
5821                ,gnus-mouse-face-prop ,gnus-article-mouse-face
5822                face ,gnus-article-button-face
5823                gnus-part ,id
5824                gnus-data ,handle))
5825             (widget-convert-button 'link from (point)
5826                                    :action 'gnus-widget-press-button
5827                                    :button-keymap gnus-widget-button-keymap)
5828             (insert "  "))
5829           (insert "\n\n"))
5830         (when preferred
5831           (if (stringp (car preferred))
5832               (gnus-display-mime preferred)
5833             (let ((mail-parse-charset gnus-newsgroup-charset)
5834                   (mail-parse-ignored-charsets
5835                    (with-current-buffer gnus-summary-buffer
5836                      gnus-newsgroup-ignored-charsets)))
5837               (mm-display-part preferred)
5838               ;; Do highlighting.
5839               (save-excursion
5840                 (save-restriction
5841                   (narrow-to-region (car begend) (point-max))
5842                   (gnus-treat-article
5843                    nil (length gnus-article-mime-handle-alist)
5844                    (gnus-article-mime-total-parts)
5845                    (mm-handle-media-type handle))))))
5846           (goto-char (point-max))
5847           (setcdr begend (point-marker)))))
5848     (when ibegend
5849       (goto-char point))))
5850
5851 (defconst gnus-article-wash-status-strings
5852   (let ((alist '((cite "c" "Possible hidden citation text"
5853                        " " "All citation text visible")
5854                  (headers "h" "Hidden headers"
5855                           " " "All headers visible.")
5856                  (pgp "p" "Encrypted or signed message status hidden"
5857                       " " "No hidden encryption nor digital signature status")
5858                  (signature "s" "Signature has been hidden"
5859                             " " "Signature is visible")
5860                  (overstrike "o" "Overstrike (^H) characters applied"
5861                              " " "No overstrike characters applied")
5862                  (emphasis "e" "/*_Emphasis_*/ characters applied"
5863                            " " "No /*_emphasis_*/ characters applied")))
5864         result)
5865     (dolist (entry alist result)
5866       (let ((key (nth 0 entry))
5867             (on (copy-sequence (nth 1 entry)))
5868             (on-help (nth 2 entry))
5869             (off (copy-sequence (nth 3 entry)))
5870             (off-help (nth 4 entry)))
5871         (put-text-property 0 1 'help-echo on-help on)
5872         (put-text-property 0 1 'help-echo off-help off)
5873         (push (list key on off) result))))
5874   "Alist of strings describing wash status in the mode line.
5875 Each entry has the form (KEY ON OF), where the KEY is a symbol
5876 representing the particular washing function, ON is the string to use
5877 in the article mode line when the washing function is active, and OFF
5878 is the string to use when it is inactive.")
5879
5880 (defun gnus-article-wash-status-entry (key value)
5881   (let ((entry (assoc key gnus-article-wash-status-strings)))
5882     (if value (nth 1 entry) (nth 2 entry))))
5883
5884 (defun gnus-article-wash-status ()
5885   "Return a string which display status of article washing."
5886   (with-current-buffer gnus-article-buffer
5887     (let ((cite (memq 'cite gnus-article-wash-types))
5888           (headers (memq 'headers gnus-article-wash-types))
5889           (boring (memq 'boring-headers gnus-article-wash-types))
5890           (pgp (memq 'pgp gnus-article-wash-types))
5891           (pem (memq 'pem gnus-article-wash-types))
5892           (signed (memq 'signed gnus-article-wash-types))
5893           (encrypted (memq 'encrypted gnus-article-wash-types))
5894           (signature (memq 'signature gnus-article-wash-types))
5895           (overstrike (memq 'overstrike gnus-article-wash-types))
5896           (emphasis (memq 'emphasis gnus-article-wash-types)))
5897       (concat
5898        (gnus-article-wash-status-entry 'cite cite)
5899        (gnus-article-wash-status-entry 'headers (or headers boring))
5900        (gnus-article-wash-status-entry 'pgp (or pgp pem signed encrypted))
5901        (gnus-article-wash-status-entry 'signature signature)
5902        (gnus-article-wash-status-entry 'overstrike overstrike)
5903        (gnus-article-wash-status-entry 'emphasis emphasis)))))
5904
5905 (defun gnus-add-wash-type (type)
5906   "Add a washing of TYPE to the current status."
5907   (add-to-list 'gnus-article-wash-types type))
5908
5909 (defun gnus-delete-wash-type (type)
5910   "Add a washing of TYPE to the current status."
5911   (setq gnus-article-wash-types (delq type gnus-article-wash-types)))
5912
5913 (defun gnus-add-image (category image)
5914   "Add IMAGE of CATEGORY to the list of displayed images."
5915   (let ((entry (assq category gnus-article-image-alist)))
5916     (unless entry
5917       (setq entry (list category))
5918       (push entry gnus-article-image-alist))
5919     (nconc entry (list image))))
5920
5921 (defun gnus-delete-images (category)
5922   "Delete all images in CATEGORY."
5923   (let ((entry (assq category gnus-article-image-alist)))
5924     (dolist (image (cdr entry))
5925       (gnus-remove-image image category))
5926     (setq gnus-article-image-alist (delq entry gnus-article-image-alist))
5927     (gnus-delete-wash-type category)))
5928
5929 (defalias 'gnus-article-hide-headers-if-wanted 'gnus-article-maybe-hide-headers)
5930
5931 (defun gnus-article-maybe-hide-headers ()
5932   "Hide unwanted headers if `gnus-have-all-headers' is nil.
5933 Provided for backwards compatibility."
5934   (when (and (or (not (gnus-buffer-live-p gnus-summary-buffer))
5935                  (not (with-current-buffer gnus-summary-buffer
5936                         gnus-have-all-headers)))
5937              (not gnus-inhibit-hiding))
5938     (gnus-article-hide-headers)))
5939
5940 ;;; Article savers.
5941
5942 (defun gnus-output-to-file (file-name)
5943   "Append the current article to a file named FILE-NAME.
5944 If `gnus-article-save-coding-system' is non-nil, it is used to encode
5945 text and used as the value of the coding cookie which is added to the
5946 top of a file.  Otherwise, this function saves a raw article without
5947 the coding cookie."
5948   (let* ((artbuf (current-buffer))
5949          (file-name-coding-system nnmail-pathname-coding-system)
5950          (coding gnus-article-save-coding-system)
5951          (coding-system-for-read (if coding
5952                                      nil ;; Rely on the coding cookie.
5953                                    mm-text-coding-system))
5954          (coding-system-for-write (or coding
5955                                       mm-text-coding-system-for-write
5956                                       mm-text-coding-system))
5957          (exists (file-exists-p file-name)))
5958     (with-temp-buffer
5959       (when exists
5960         (insert-file-contents file-name)
5961         (goto-char (point-min))
5962         ;; Remove the existing coding cookie.
5963         (when (looking-at "X-Gnus-Coding-System: .+\n\n")
5964           (delete-region (match-beginning 0) (match-end 0))))
5965       (goto-char (point-max))
5966       (insert-buffer-substring artbuf)
5967       ;; Append newline at end of the buffer as separator, and then
5968       ;; save it to file.
5969       (goto-char (point-max))
5970       (insert "\n")
5971       (when coding
5972         ;; If the coding system is not suitable to encode the text,
5973         ;; ask a user for a proper one.
5974         (when (fboundp 'select-safe-coding-system)
5975           (setq coding (coding-system-base
5976                         (save-window-excursion
5977                           (select-safe-coding-system (point-min) (point-max)
5978                                                      coding))))
5979           (setq coding-system-for-write
5980                 (or (cdr (assq coding '((mule-utf-8 . utf-8))))
5981                     coding)))
5982         (goto-char (point-min))
5983         ;; Add the coding cookie.
5984         (insert (format "X-Gnus-Coding-System: -*- coding: %s; -*-\n\n"
5985                         coding-system-for-write)))
5986       (if exists
5987           (progn
5988             (write-region (point-min) (point-max) file-name nil 'no-message)
5989             (message "Appended to %s" file-name))
5990         (write-region (point-min) (point-max) file-name))))
5991   t)
5992
5993 (defun gnus-narrow-to-page (&optional arg)
5994   "Narrow the article buffer to a page.
5995 If given a numerical ARG, move forward ARG pages."
5996   (interactive "P")
5997   (setq arg (if arg (prefix-numeric-value arg) 0))
5998   (with-current-buffer gnus-article-buffer
5999     (widen)
6000     ;; Remove any old next/prev buttons.
6001     (when (gnus-visual-p 'page-marker)
6002       (let ((inhibit-read-only t))
6003         (gnus-remove-text-with-property 'gnus-prev)
6004         (gnus-remove-text-with-property 'gnus-next)))
6005     (let (st nd pt)
6006       (when (save-excursion
6007               (cond ((< arg 0)
6008                      (if (re-search-backward page-delimiter nil 'move (abs arg))
6009                          (prog1
6010                              (setq nd (match-beginning 0)
6011                                    pt nd)
6012                            (when (re-search-backward page-delimiter nil t)
6013                              (setq st (match-end 0))))
6014                        (when (re-search-forward page-delimiter nil t)
6015                          (setq nd (match-beginning 0)
6016                                pt (point-min)))))
6017                     ((> arg 0)
6018                      (if (re-search-forward page-delimiter nil 'move arg)
6019                          (prog1
6020                              (setq st (match-end 0)
6021                                    pt st)
6022                            (when (re-search-forward page-delimiter nil t)
6023                              (setq nd (match-beginning 0))))
6024                        (when (re-search-backward page-delimiter nil t)
6025                          (setq st (match-end 0)
6026                                pt (point-max)))))
6027                     (t
6028                      (when (re-search-backward page-delimiter nil t)
6029                        (goto-char (setq st (match-end 0))))
6030                      (when (re-search-forward page-delimiter nil t)
6031                        (setq nd (match-beginning 0)))
6032                      (or st nd))))
6033         (setq gnus-page-broken t)
6034         (when pt (goto-char pt))
6035         (narrow-to-region (or st (point-min)) (or nd (point-max)))
6036         (when (gnus-visual-p 'page-marker)
6037           (save-excursion
6038             (when nd
6039               (goto-char nd)
6040               (gnus-insert-next-page-button))
6041             (when st
6042               (goto-char st)
6043               (gnus-insert-prev-page-button))))))))
6044
6045 ;; Article mode commands
6046
6047 (defun gnus-article-goto-next-page ()
6048   "Show the next page of the article."
6049   (interactive)
6050   (when (gnus-article-next-page)
6051     (goto-char (point-min))
6052     (gnus-article-read-summary-keys nil (gnus-character-to-event ?n))))
6053
6054
6055 (defun gnus-article-goto-prev-page ()
6056   "Show the previous page of the article."
6057   (interactive)
6058   (if (save-restriction (widen) (bobp)) ;; Real beginning-of-buffer?
6059       (gnus-article-read-summary-keys nil (gnus-character-to-event ?p))
6060     (gnus-article-prev-page nil)))
6061
6062 ;; This is cleaner but currently breaks `gnus-pick-mode':
6063 ;;
6064 ;; (defun gnus-article-goto-next-page ()
6065 ;;   "Show the next page of the article."
6066 ;;   (interactive)
6067 ;;   (gnus-eval-in-buffer-window gnus-summary-buffer
6068 ;;     (gnus-summary-next-page)))
6069 ;;
6070 ;; (defun gnus-article-goto-prev-page ()
6071 ;;   "Show the next page of the article."
6072 ;;   (interactive)
6073 ;;   (gnus-eval-in-buffer-window gnus-summary-buffer
6074 ;;     (gnus-summary-prev-page)))
6075
6076 (defun gnus-article-next-page (&optional lines)
6077   "Show the next page of the current article.
6078 If end of article, return non-nil.  Otherwise return nil.
6079 Argument LINES specifies lines to be scrolled up."
6080   (interactive "p")
6081   (move-to-window-line -1)
6082   (if (and (not (and gnus-article-over-scroll
6083                      (> (count-lines (window-start) (point-max))
6084                         (+ (or lines (1- (window-height)))
6085                            (or (and (boundp 'scroll-margin)
6086                                     (symbol-value 'scroll-margin))
6087                                0)))))
6088            (save-excursion
6089              (end-of-line)
6090              (and (pos-visible-in-window-p)     ;Not continuation line.
6091                   (>= (1+ (point)) (point-max))))) ;Allow for trailing newline.
6092       ;; Nothing in this page.
6093       (if (or (not gnus-page-broken)
6094               (save-excursion
6095                 (save-restriction
6096                   (widen)
6097                   (forward-line)
6098                   (eobp)))) ;Real end-of-buffer?
6099           (progn
6100             (when gnus-article-over-scroll
6101               (gnus-article-next-page-1 lines))
6102             t)                  ;Nothing more.
6103         (gnus-narrow-to-page 1)         ;Go to next page.
6104         nil)
6105     ;; More in this page.
6106     (gnus-article-next-page-1 lines)
6107     nil))
6108
6109 (defmacro gnus-article-beginning-of-window ()
6110   "Move point to the beginning of the window.
6111 In Emacs, the point is placed at the line number which `scroll-margin'
6112 specifies."
6113   (if (featurep 'xemacs)
6114       '(move-to-window-line 0)
6115     '(move-to-window-line
6116       (min (max 0 scroll-margin)
6117            (max 1 (- (window-height)
6118                      (if mode-line-format 1 0)
6119                      (if header-line-format 1 0)))))))
6120
6121 (defun gnus-article-next-page-1 (lines)
6122   (when (and (not (featurep 'xemacs))
6123              (numberp lines)
6124              (> lines 0)
6125              (numberp (symbol-value 'scroll-margin))
6126              (> (symbol-value 'scroll-margin) 0))
6127     ;; Protect against the bug that Emacs 21.x hangs up when scrolling up for
6128     ;; too many number of lines if `scroll-margin' is set as two or greater.
6129     (setq lines (min lines
6130                      (max 0 (- (count-lines (window-start) (point-max))
6131                                (symbol-value 'scroll-margin))))))
6132   (condition-case ()
6133       (let ((scroll-in-place nil))
6134         (scroll-up lines))
6135     (end-of-buffer
6136      ;; Long lines may cause an end-of-buffer error.
6137      (goto-char (point-max))))
6138   (gnus-article-beginning-of-window))
6139
6140 (defun gnus-article-prev-page (&optional lines)
6141   "Show previous page of current article.
6142 Argument LINES specifies lines to be scrolled down."
6143   (interactive "p")
6144   (move-to-window-line 0)
6145   (if (and gnus-page-broken
6146            (bobp)
6147            (not (save-restriction (widen) (bobp)))) ;Real beginning-of-buffer?
6148       (progn
6149         (gnus-narrow-to-page -1)        ;Go to previous page.
6150         (goto-char (point-max))
6151         (recenter (if gnus-article-over-scroll
6152                       (if lines
6153                           (max (+ lines (or (and (boundp 'scroll-margin)
6154                                                  (symbol-value 'scroll-margin))
6155                                             0))
6156                                3)
6157                         (- (window-height) 2))
6158                     -1)))
6159     (prog1
6160         (condition-case ()
6161             (let ((scroll-in-place nil))
6162               (scroll-down lines))
6163           (beginning-of-buffer
6164            (goto-char (point-min))))
6165       (gnus-article-beginning-of-window))))
6166
6167 (defun gnus-article-only-boring-p ()
6168   "Decide whether there is only boring text remaining in the article.
6169 Something \"interesting\" is a word of at least two letters that does
6170 not have a face in `gnus-article-boring-faces'."
6171   (when (and gnus-article-skip-boring
6172              (boundp 'gnus-article-boring-faces)
6173              (symbol-value 'gnus-article-boring-faces))
6174     (save-excursion
6175       (let ((inhibit-point-motion-hooks t))
6176         (catch 'only-boring
6177           (while (re-search-forward "\\b\\w\\w" nil t)
6178             (forward-char -1)
6179             (when (not (gnus-intersection
6180                         (gnus-faces-at (point))
6181                         (symbol-value 'gnus-article-boring-faces)))
6182               (throw 'only-boring nil)))
6183           (throw 'only-boring t))))))
6184
6185 (defun gnus-article-refer-article ()
6186   "Read article specified by message-id around point."
6187   (interactive)
6188   (save-excursion
6189     (re-search-backward "[ \t]\\|^" (point-at-bol) t)
6190     (re-search-forward "<?news:<?\\|<" (point-at-eol) t)
6191     (if (re-search-forward "[^@ ]+@[^ \t>]+" (point-at-eol) t)
6192         (let ((msg-id (concat "<" (match-string 0) ">")))
6193           (set-buffer gnus-summary-buffer)
6194           (gnus-summary-refer-article msg-id))
6195       (error "No references around point"))))
6196
6197 (defun gnus-article-show-summary ()
6198   "Reconfigure windows to show summary buffer."
6199   (interactive)
6200   (if (not (gnus-buffer-live-p gnus-summary-buffer))
6201       (error "There is no summary buffer for this article buffer")
6202     (gnus-article-set-globals)
6203     (gnus-configure-windows 'article)
6204     (gnus-summary-goto-subject gnus-current-article)
6205     (gnus-summary-position-point)))
6206
6207 (defun gnus-article-describe-briefly ()
6208   "Describe article mode commands briefly."
6209   (interactive)
6210   (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")))
6211
6212 (defun gnus-article-summary-command ()
6213   "Execute the last keystroke in the summary buffer."
6214   (interactive)
6215   (let ((obuf (current-buffer))
6216         (owin (current-window-configuration))
6217         func)
6218     (switch-to-buffer gnus-article-current-summary 'norecord)
6219     (setq func (lookup-key (current-local-map) (this-command-keys)))
6220     (call-interactively func)
6221     (set-buffer obuf)
6222     (set-window-configuration owin)
6223     (set-window-point (get-buffer-window (current-buffer)) (point))))
6224
6225 (defun gnus-article-summary-command-nosave ()
6226   "Execute the last keystroke in the summary buffer."
6227   (interactive)
6228   (let (func)
6229     (pop-to-buffer gnus-article-current-summary)
6230     (setq func (lookup-key (current-local-map) (this-command-keys)))
6231     (call-interactively func)))
6232
6233 (defun gnus-article-check-buffer ()
6234   "Beep if not in an article buffer."
6235   (unless (equal major-mode 'gnus-article-mode)
6236     (error "Command invoked outside of a Gnus article buffer")))
6237
6238 (defun gnus-article-read-summary-keys (&optional arg key not-restore-window)
6239   "Read a summary buffer key sequence and execute it from the article buffer."
6240   (interactive "P")
6241   (gnus-article-check-buffer)
6242   (let ((nosaves
6243          '("q" "Q"  "c" "r" "\C-c\C-f" "m"  "a" "f"
6244            "Zc" "ZC" "ZE" "ZQ" "ZZ" "Zn" "ZR" "ZG" "ZN" "ZP"
6245            "=" "^" "\M-^" "|"))
6246         (nosave-but-article
6247          '("A " "A<" "A>" "AM" "AP" "AR" "AT" "A\C-?" "A\M-\r" "A\r" "Ab" "Ae"
6248            "An" "Ap" [?A (meta return)] [?A delete]))
6249         (nosave-in-article
6250          '("AS" "\C-d"))
6251         (up-to-top
6252          '("n" "Gn" "p" "Gp"))
6253         keys new-sum-point)
6254     (with-current-buffer gnus-article-current-summary
6255       (let (gnus-pick-mode)
6256         (setq unread-command-events (nconc unread-command-events
6257                                            (list (or key last-command-event)))
6258               keys (if (featurep 'xemacs)
6259                        (events-to-keys (read-key-sequence nil t))
6260                      (read-key-sequence nil t)))))
6261
6262     (message "")
6263
6264     (cond
6265      ((eq (aref keys (1- (length keys))) ?\C-h)
6266       (gnus-article-describe-bindings (substring keys 0 -1)))
6267      ((or (member keys nosaves)
6268           (member keys nosave-but-article)
6269           (member keys nosave-in-article))
6270       (let (func)
6271         (save-window-excursion
6272           (pop-to-buffer gnus-article-current-summary)
6273           ;; We disable the pick minor mode commands.
6274           (let (gnus-pick-mode)
6275             (setq func (lookup-key (current-local-map) keys))))
6276         (if (or (not func)
6277                 (numberp func))
6278             (ding)
6279           (unless (member keys nosave-in-article)
6280             (set-buffer gnus-article-current-summary))
6281           (call-interactively func)
6282           (setq new-sum-point (point)))
6283         (when (member keys nosave-but-article)
6284           (pop-to-buffer gnus-article-buffer))))
6285      (t
6286       ;; These commands should restore window configuration.
6287       (let ((obuf (current-buffer))
6288             (owin (current-window-configuration))
6289             win func in-buffer selected new-sum-start new-sum-hscroll err)
6290         (cond (not-restore-window
6291                (pop-to-buffer gnus-article-current-summary)
6292                (setq win (selected-window)))
6293               ((setq win (get-buffer-window gnus-article-current-summary))
6294                (select-window win))
6295               (t
6296                (let ((summary-buffer gnus-article-current-summary))
6297                  (gnus-configure-windows 'article)
6298                  (unless (setq win (get-buffer-window summary-buffer 'visible))
6299                    (let ((gnus-buffer-configuration
6300                           '(article ((vertical 1.0
6301                                                (summary 0.25 point)
6302                                                (article 1.0))))))
6303                      (gnus-configure-windows 'article))
6304                    (setq win (get-buffer-window summary-buffer 'visible)))
6305                  (gnus-select-frame-set-input-focus (window-frame win))
6306                  (select-window win))))
6307         (setq in-buffer (current-buffer))
6308         ;; We disable the pick minor mode commands.
6309         (if (and (setq func (let (gnus-pick-mode)
6310                               (lookup-key (current-local-map) keys)))
6311                  (functionp func)
6312                  (condition-case code
6313                      (progn
6314                        (call-interactively func)
6315                        t)
6316                    (error
6317                     (setq err code)
6318                     nil)))
6319             (progn
6320               (when (eq win (selected-window))
6321                 (setq new-sum-point (point)
6322                       new-sum-start (window-start win)
6323                       new-sum-hscroll (window-hscroll win)))
6324               (when (or (eq in-buffer (current-buffer))
6325                         (when (eq obuf (current-buffer))
6326                           (set-buffer in-buffer)
6327                           t))
6328                 (setq selected (gnus-summary-select-article))
6329                 (set-buffer obuf)
6330                 (unless not-restore-window
6331                   (set-window-configuration owin))
6332                 (when (and (eq selected 'old)
6333                            new-sum-point)
6334                   (set-window-start (get-buffer-window (current-buffer))
6335                                     1)
6336                   (set-window-point (get-buffer-window (current-buffer))
6337                                     (if (article-goto-body)
6338                                         (1- (point))
6339                                       (point))))
6340                 (when (and (not not-restore-window)
6341                            new-sum-point
6342                            (with-current-buffer (window-buffer win)
6343                              (eq major-mode 'gnus-summary-mode)))
6344                   (set-window-point win new-sum-point)
6345                   (set-window-start win new-sum-start)
6346                   (set-window-hscroll win new-sum-hscroll))))
6347           (set-window-configuration owin)
6348           (if err
6349               (signal (car err) (cdr err))
6350             (ding))))))))
6351
6352 (defun gnus-article-read-summary-send-keys ()
6353   (interactive)
6354   (let ((unread-command-events (list (gnus-character-to-event ?S))))
6355     (gnus-article-read-summary-keys)))
6356
6357 (defun gnus-article-describe-key (key)
6358   "Display documentation of the function invoked by KEY.
6359 KEY is a string or a vector."
6360   (interactive (list (let ((cursor-in-echo-area t)) ;; better for XEmacs.
6361                        (read-key-sequence "Describe key: "))))
6362   (gnus-article-check-buffer)
6363   (if (memq (key-binding key t) '(gnus-article-read-summary-keys
6364                                   gnus-article-read-summary-send-keys))
6365       (with-current-buffer gnus-article-current-summary
6366         (setq unread-command-events
6367               (if (featurep 'xemacs)
6368                   (append key nil)
6369                 (mapcar (lambda (x) (if (and (integerp x) (>= x 128))
6370                                         (list 'meta (- x 128))
6371                                       x))
6372                         key)))
6373         (let ((cursor-in-echo-area t)
6374               gnus-pick-mode)
6375           (describe-key (read-key-sequence nil t))))
6376     (describe-key key)))
6377
6378 (defun gnus-article-describe-key-briefly (key &optional insert)
6379   "Display documentation of the function invoked by KEY.
6380 KEY is a string or a vector."
6381   (interactive (list (let ((cursor-in-echo-area t)) ;; better for XEmacs.
6382                        (read-key-sequence "Describe key: "))
6383                      current-prefix-arg))
6384   (gnus-article-check-buffer)
6385   (if (memq (key-binding key t) '(gnus-article-read-summary-keys
6386                                   gnus-article-read-summary-send-keys))
6387       (with-current-buffer gnus-article-current-summary
6388         (setq unread-command-events
6389               (if (featurep 'xemacs)
6390                   (append key nil)
6391                 (mapcar (lambda (x) (if (and (integerp x) (>= x 128))
6392                                         (list 'meta (- x 128))
6393                                       x))
6394                         key)))
6395         (let ((cursor-in-echo-area t)
6396               gnus-pick-mode)
6397           (describe-key-briefly (read-key-sequence nil t) insert)))
6398     (describe-key-briefly key insert)))
6399
6400 ;;`gnus-agent-mode' in gnus-agent.el will define it.
6401 (defvar gnus-agent-summary-mode)
6402 (defvar gnus-draft-mode)
6403
6404 (defun gnus-article-describe-bindings (&optional prefix)
6405   "Show a list of all defined keys, and their definitions.
6406 The optional argument PREFIX, if non-nil, should be a key sequence;
6407 then we display only bindings that start with that prefix."
6408   (interactive)
6409   (gnus-article-check-buffer)
6410   (let ((keymap (copy-keymap gnus-article-mode-map))
6411         (map (copy-keymap gnus-article-send-map))
6412         (sumkeys (where-is-internal 'gnus-article-read-summary-keys))
6413         agent draft)
6414     (define-key keymap "S" map)
6415     (define-key map [t] nil)
6416     (with-current-buffer gnus-article-current-summary
6417       (set-keymap-parent map (key-binding "S"))
6418       (let (key def gnus-pick-mode)
6419         (while sumkeys
6420           (setq key (pop sumkeys))
6421           (cond ((and (vectorp key) (= (length key) 1)
6422                       (consp (setq def (aref key 0)))
6423                       (numberp (car def)) (numberp (cdr def)))
6424                  (when (< (max (car def) (cdr def)) 128)
6425                    (setq sumkeys
6426                          (append (mapcar
6427                                   #'vector
6428                                   (nreverse (gnus-uncompress-range def)))
6429                                  sumkeys))))
6430                 ((setq def (key-binding key))
6431                  (unless (eq def 'undefined)
6432                    (define-key keymap key def))))))
6433       (when (boundp 'gnus-agent-summary-mode)
6434         (setq agent gnus-agent-summary-mode))
6435       (when (boundp 'gnus-draft-mode)
6436         (setq draft gnus-draft-mode)))
6437     (with-temp-buffer
6438       (use-local-map keymap)
6439       (set (make-local-variable 'gnus-agent-summary-mode) agent)
6440       (set (make-local-variable 'gnus-draft-mode) draft)
6441       (describe-bindings prefix))
6442     (let ((item `((lambda (prefix)
6443                     (with-current-buffer ,(current-buffer)
6444                       (gnus-article-describe-bindings prefix)))
6445                   ,prefix)))
6446       (with-current-buffer (if (fboundp 'help-buffer)
6447                                (let (help-xref-following) (help-buffer))
6448                              "*Help*") ;; Emacs 21
6449         (setq help-xref-stack-item item)))))
6450
6451 (defun gnus-article-reply-with-original (&optional wide)
6452   "Start composing a reply mail to the current message.
6453 The text in the region will be yanked.  If the region isn't active,
6454 the entire article will be yanked."
6455   (interactive)
6456   (let ((article (cdr gnus-article-current))
6457         contents)
6458     (if (not (gnus-region-active-p))
6459         (with-current-buffer gnus-summary-buffer
6460           (gnus-summary-reply (list (list article)) wide))
6461       (setq contents (buffer-substring (point) (mark t)))
6462       ;; Deactivate active regions.
6463       (when (and (boundp 'transient-mark-mode)
6464                  transient-mark-mode)
6465         (setq mark-active nil))
6466       (with-current-buffer gnus-summary-buffer
6467         (gnus-summary-reply
6468          (list (list article contents)) wide)))))
6469
6470 (defun gnus-article-wide-reply-with-original ()
6471   "Start composing a wide reply mail to the current message.
6472 The text in the region will be yanked.  If the region isn't active,
6473 the entire article will be yanked."
6474   (interactive)
6475   (gnus-article-reply-with-original t))
6476
6477 (defun gnus-article-followup-with-original ()
6478   "Compose a followup to the current article.
6479 The text in the region will be yanked.  If the region isn't active,
6480 the entire article will be yanked."
6481   (interactive)
6482   (let ((article (cdr gnus-article-current))
6483         contents)
6484       (if (not (gnus-region-active-p))
6485           (with-current-buffer gnus-summary-buffer
6486             (gnus-summary-followup (list (list article))))
6487         (setq contents (buffer-substring (point) (mark t)))
6488         ;; Deactivate active regions.
6489         (when (and (boundp 'transient-mark-mode)
6490                    transient-mark-mode)
6491           (setq mark-active nil))
6492         (with-current-buffer gnus-summary-buffer
6493           (gnus-summary-followup
6494            (list (list article contents)))))))
6495
6496 (defun gnus-article-hide (&optional arg force)
6497   "Hide all the gruft in the current article.
6498 This means that signatures, cited text and (some) headers will be
6499 hidden.
6500 If given a prefix, show the hidden text instead."
6501   (interactive (append (gnus-article-hidden-arg) (list 'force)))
6502   (gnus-article-hide-headers arg)
6503   (gnus-article-hide-list-identifiers arg)
6504   (gnus-article-hide-citation-maybe arg force)
6505   (gnus-article-hide-signature arg))
6506
6507 (defun gnus-article-maybe-highlight ()
6508   "Do some article highlighting if article highlighting is requested."
6509   (when (gnus-visual-p 'article-highlight 'highlight)
6510     (gnus-article-highlight-some)))
6511
6512 (defun gnus-check-group-server ()
6513   ;; Make sure the connection to the server is alive.
6514   (unless (gnus-server-opened
6515            (gnus-find-method-for-group gnus-newsgroup-name))
6516     (gnus-check-server (gnus-find-method-for-group gnus-newsgroup-name))
6517     (gnus-request-group gnus-newsgroup-name t)))
6518
6519 (eval-when-compile
6520   (autoload 'nneething-get-file-name "nneething"))
6521
6522 (defun gnus-request-article-this-buffer (article group)
6523   "Get an article and insert it into this buffer."
6524   (let (do-update-line sparse-header)
6525     (prog1
6526         (save-excursion
6527           (erase-buffer)
6528           (gnus-kill-all-overlays)
6529           (setq group (or group gnus-newsgroup-name))
6530
6531           ;; Using `gnus-request-article' directly will insert the article into
6532           ;; `nntp-server-buffer' - so we'll save some time by not having to
6533           ;; copy it from the server buffer into the article buffer.
6534
6535           ;; We only request an article by message-id when we do not have the
6536           ;; headers for it, so we'll have to get those.
6537           (when (stringp article)
6538             (gnus-read-header article))
6539
6540           ;; If the article number is negative, that means that this article
6541           ;; doesn't belong in this newsgroup (possibly), so we find its
6542           ;; message-id and request it by id instead of number.
6543           (when (and (numberp article)
6544                      gnus-summary-buffer
6545                      (get-buffer gnus-summary-buffer)
6546                      (gnus-buffer-exists-p gnus-summary-buffer))
6547             (with-current-buffer gnus-summary-buffer
6548               (let ((header (gnus-summary-article-header article)))
6549                 (when (< article 0)
6550                   (cond
6551                    ((memq article gnus-newsgroup-sparse)
6552                     ;; This is a sparse gap article.
6553                     (setq do-update-line article)
6554                     (setq article (mail-header-id header))
6555                     (setq sparse-header (gnus-read-header article))
6556                     (setq gnus-newsgroup-sparse
6557                           (delq article gnus-newsgroup-sparse)))
6558                    ((vectorp header)
6559                     ;; It's a real article.
6560                     (setq article (mail-header-id header)))
6561                    (t
6562                     ;; It is an extracted pseudo-article.
6563                     (setq article 'pseudo)
6564                     (gnus-request-pseudo-article header))))
6565
6566                 (let ((method (gnus-find-method-for-group
6567                                gnus-newsgroup-name)))
6568                   (when (and (eq (car method) 'nneething)
6569                              (vectorp header))
6570                     (let ((dir (nneething-get-file-name
6571                                 (mail-header-id header))))
6572                       (when (and (stringp dir)
6573                                  (file-directory-p dir))
6574                         (setq article 'nneething)
6575                         (gnus-group-enter-directory dir))))))))
6576
6577           (cond
6578            ;; Refuse to select canceled articles.
6579            ((and (numberp article)
6580                  gnus-summary-buffer
6581                  (get-buffer gnus-summary-buffer)
6582                  (gnus-buffer-exists-p gnus-summary-buffer)
6583                  (eq (cdr (with-current-buffer gnus-summary-buffer
6584                             (assq article gnus-newsgroup-reads)))
6585                      gnus-canceled-mark))
6586             nil)
6587            ;; We first check `gnus-original-article-buffer'.
6588            ((and (get-buffer gnus-original-article-buffer)
6589                  (numberp article)
6590                  (with-current-buffer gnus-original-article-buffer
6591                    (and (equal (car gnus-original-article) group)
6592                         (eq (cdr gnus-original-article) article))))
6593             ;; `insert-buffer-substring' would incorrectly use the
6594             ;; equivalent of string-make-multibyte which amount to decoding
6595             ;; with locale-coding-system, causing failure of
6596             ;; subsequent decoding.
6597             (insert (mm-string-to-multibyte
6598                      (with-current-buffer gnus-original-article-buffer
6599                        (buffer-substring (point-min) (point-max)))))
6600             'article)
6601            ;; Check the backlog.
6602            ((and gnus-keep-backlog
6603                  (gnus-backlog-request-article group article (current-buffer)))
6604             'article)
6605            ;; Check asynchronous pre-fetch.
6606            ((gnus-async-request-fetched-article group article (current-buffer))
6607             (gnus-async-prefetch-next group article gnus-summary-buffer)
6608             (when (and (numberp article) gnus-keep-backlog)
6609               (gnus-backlog-enter-article group article (current-buffer)))
6610             'article)
6611            ;; Check the cache.
6612            ((and gnus-use-cache
6613                  (numberp article)
6614                  (gnus-cache-request-article article group))
6615             'article)
6616            ;; Check the agent cache.
6617            ((gnus-agent-request-article article group)
6618             'article)
6619            ;; Get the article and put into the article buffer.
6620            ((or (stringp article)
6621                 (numberp article))
6622             (let ((gnus-override-method gnus-override-method)
6623                   (methods (and (stringp article)
6624                                 gnus-refer-article-method))
6625                   (backend (car (gnus-find-method-for-group
6626                                  gnus-newsgroup-name)))
6627                   result
6628                   (inhibit-read-only t))
6629               (if (or (not (listp methods))
6630                       (and (symbolp (car methods))
6631                            (assq (car methods) nnoo-definition-alist)))
6632                   (setq methods (list methods)))
6633               (when (and (null gnus-override-method)
6634                          methods)
6635                 (setq gnus-override-method (pop methods)))
6636               (while (not result)
6637                 (when (eq gnus-override-method 'current)
6638                   (setq gnus-override-method
6639                         (with-current-buffer gnus-summary-buffer
6640                           gnus-current-select-method)))
6641                 (erase-buffer)
6642                 (gnus-kill-all-overlays)
6643                 (let ((gnus-newsgroup-name group))
6644                   (gnus-check-group-server))
6645                 (cond
6646                  ((gnus-request-article article group (current-buffer))
6647                   (when (numberp article)
6648                     (gnus-async-prefetch-next group article
6649                                               gnus-summary-buffer)
6650                     (when gnus-keep-backlog
6651                       (gnus-backlog-enter-article
6652                        group article (current-buffer))))
6653                   (setq result 'article))
6654                  (methods
6655                   (setq gnus-override-method (pop methods)))
6656                  ((not (string-match "^400 "
6657                                      (nnheader-get-report backend)))
6658                   ;; If we get 400 server disconnect, reconnect and
6659                   ;; retry; otherwise, assume the article has expired.
6660                   (setq result 'done))))
6661               (and (eq result 'article) 'article)))
6662            ;; It was a pseudo.
6663            (t article)))
6664
6665       ;; Associate this article with the current summary buffer.
6666       (setq gnus-article-current-summary gnus-summary-buffer)
6667
6668       ;; Take the article from the original article buffer
6669       ;; and place it in the buffer it's supposed to be in.
6670       (when (and (get-buffer gnus-article-buffer)
6671                  (equal (buffer-name (current-buffer))
6672                         (buffer-name (get-buffer gnus-article-buffer))))
6673         (save-excursion
6674           (if (get-buffer gnus-original-article-buffer)
6675               (set-buffer gnus-original-article-buffer)
6676             (set-buffer (gnus-get-buffer-create gnus-original-article-buffer))
6677             (buffer-disable-undo)
6678             (setq major-mode 'gnus-original-article-mode)
6679             (setq buffer-read-only t))
6680           (let ((inhibit-read-only t))
6681             (erase-buffer)
6682             (insert-buffer-substring gnus-article-buffer))
6683           (setq gnus-original-article (cons group article)))
6684
6685         ;; Decode charsets.
6686         (run-hooks 'gnus-article-decode-hook)
6687         ;; Mark article as decoded or not.
6688         (setq gnus-article-decoded-p gnus-article-decode-hook))
6689
6690       ;; Update sparse articles.
6691       (when (and do-update-line
6692                  (or (numberp article)
6693                      (stringp article)))
6694         (let ((buf (current-buffer)))
6695           (set-buffer gnus-summary-buffer)
6696           (gnus-summary-update-article do-update-line sparse-header)
6697           (gnus-summary-goto-subject do-update-line nil t)
6698           (set-window-point (gnus-get-buffer-window (current-buffer) t)
6699                             (point))
6700           (set-buffer buf))))))
6701
6702 ;;;
6703 ;;; Article editing
6704 ;;;
6705
6706 (defcustom gnus-article-edit-mode-hook nil
6707   "Hook run in article edit mode buffers."
6708   :group 'gnus-article-various
6709   :type 'hook)
6710
6711 (defvar gnus-article-edit-done-function nil)
6712
6713 (defvar gnus-article-edit-mode-map nil)
6714
6715 ;; Should we be using derived.el for this?
6716 (unless gnus-article-edit-mode-map
6717   (setq gnus-article-edit-mode-map (make-keymap))
6718   (set-keymap-parent gnus-article-edit-mode-map text-mode-map)
6719
6720   (gnus-define-keys gnus-article-edit-mode-map
6721     "\C-c?"    describe-mode
6722     "\C-c\C-c" gnus-article-edit-done
6723     "\C-c\C-k" gnus-article-edit-exit
6724     "\C-c\C-f\C-t" message-goto-to
6725     "\C-c\C-f\C-o" message-goto-from
6726     "\C-c\C-f\C-b" message-goto-bcc
6727     ;;"\C-c\C-f\C-w" message-goto-fcc
6728     "\C-c\C-f\C-c" message-goto-cc
6729     "\C-c\C-f\C-s" message-goto-subject
6730     "\C-c\C-f\C-r" message-goto-reply-to
6731     "\C-c\C-f\C-n" message-goto-newsgroups
6732     "\C-c\C-f\C-d" message-goto-distribution
6733     "\C-c\C-f\C-f" message-goto-followup-to
6734     "\C-c\C-f\C-m" message-goto-mail-followup-to
6735     "\C-c\C-f\C-k" message-goto-keywords
6736     "\C-c\C-f\C-u" message-goto-summary
6737     "\C-c\C-f\C-i" message-insert-or-toggle-importance
6738     "\C-c\C-f\C-a" message-generate-unsubscribed-mail-followup-to
6739     "\C-c\C-b" message-goto-body
6740     "\C-c\C-i" message-goto-signature
6741
6742     "\C-c\C-t" message-insert-to
6743     "\C-c\C-n" message-insert-newsgroups
6744     "\C-c\C-o" message-sort-headers
6745     "\C-c\C-e" message-elide-region
6746     "\C-c\C-v" message-delete-not-region
6747     "\C-c\C-z" message-kill-to-signature
6748     "\M-\r" message-newline-and-reformat
6749     "\C-c\C-a" mml-attach-file
6750     "\C-a" message-beginning-of-line
6751     "\t" message-tab
6752     "\M-;" comment-region)
6753
6754   (gnus-define-keys (gnus-article-edit-wash-map
6755                      "\C-c\C-w" gnus-article-edit-mode-map)
6756     "f" gnus-article-edit-full-stops))
6757
6758 (easy-menu-define
6759   gnus-article-edit-mode-field-menu gnus-article-edit-mode-map ""
6760   '("Field"
6761     ["Fetch To" message-insert-to t]
6762     ["Fetch Newsgroups" message-insert-newsgroups t]
6763     "----"
6764     ["To" message-goto-to t]
6765     ["From" message-goto-from t]
6766     ["Subject" message-goto-subject t]
6767     ["Cc" message-goto-cc t]
6768     ["Reply-To" message-goto-reply-to t]
6769     ["Summary" message-goto-summary t]
6770     ["Keywords" message-goto-keywords t]
6771     ["Newsgroups" message-goto-newsgroups t]
6772     ["Followup-To" message-goto-followup-to t]
6773     ["Mail-Followup-To" message-goto-mail-followup-to t]
6774     ["Distribution" message-goto-distribution t]
6775     ["Body" message-goto-body t]
6776     ["Signature" message-goto-signature t]))
6777
6778 (define-derived-mode gnus-article-edit-mode message-mode "Article Edit"
6779   "Major mode for editing articles.
6780 This is an extended text-mode.
6781
6782 \\{gnus-article-edit-mode-map}"
6783   (make-local-variable 'gnus-article-edit-done-function)
6784   (make-local-variable 'gnus-prev-winconf)
6785   (set (make-local-variable 'font-lock-defaults)
6786        '(message-font-lock-keywords t))
6787   (set (make-local-variable 'mail-header-separator) "")
6788   (set (make-local-variable 'gnus-article-edit-mode) t)
6789   (easy-menu-add message-mode-field-menu message-mode-map)
6790   (mml-mode)
6791   (setq buffer-read-only nil)
6792   (buffer-enable-undo)
6793   (widen))
6794
6795 (defun gnus-article-edit (&optional force)
6796   "Edit the current article.
6797 This will have permanent effect only in mail groups.
6798 If FORCE is non-nil, allow editing of articles even in read-only
6799 groups."
6800   (interactive "P")
6801   (when (and (not force)
6802              (gnus-group-read-only-p))
6803     (error "The current newsgroup does not support article editing"))
6804   (gnus-article-date-original)
6805   (gnus-article-edit-article
6806    'ignore
6807    `(lambda (no-highlight)
6808       'ignore
6809       (gnus-summary-edit-article-done
6810        ,(or (mail-header-references gnus-current-headers) "")
6811        ,(gnus-group-read-only-p) ,gnus-summary-buffer no-highlight))))
6812
6813 (defun gnus-article-edit-article (start-func exit-func &optional quiet)
6814   "Start editing the contents of the current article buffer."
6815   (let ((winconf (current-window-configuration)))
6816     (set-buffer gnus-article-buffer)
6817     (let ((message-auto-save-directory
6818            ;; Don't associate the article buffer with a draft file.
6819            nil))
6820       (gnus-article-edit-mode))
6821     (funcall start-func)
6822     (set-buffer-modified-p nil)
6823     (gnus-configure-windows 'edit-article)
6824     (setq gnus-article-edit-done-function exit-func)
6825     (setq gnus-prev-winconf winconf)
6826     (unless quiet
6827       (gnus-message 6 "C-c C-c to end edits"))))
6828
6829 (defun gnus-article-edit-done (&optional arg)
6830   "Update the article edits and exit."
6831   (interactive "P")
6832   (let ((func gnus-article-edit-done-function)
6833         (buf (current-buffer))
6834         (start (window-start))
6835         (p (point))
6836         (winconf gnus-prev-winconf))
6837     (widen) ;; Widen it in case that users narrowed the buffer.
6838     (funcall func arg)
6839     (set-buffer buf)
6840     ;; The cache and backlog have to be flushed somewhat.
6841     (when gnus-keep-backlog
6842       (gnus-backlog-remove-article
6843        (car gnus-article-current) (cdr gnus-article-current)))
6844     ;; Flush original article as well.
6845     (when (get-buffer gnus-original-article-buffer)
6846       (with-current-buffer gnus-original-article-buffer
6847         (setq gnus-original-article nil)))
6848     (when gnus-use-cache
6849       (gnus-cache-update-article
6850        (car gnus-article-current) (cdr gnus-article-current)))
6851     ;; We remove all text props from the article buffer.
6852     (kill-all-local-variables)
6853     (set-text-properties (point-min) (point-max) nil)
6854     (gnus-article-mode)
6855     (set-window-configuration winconf)
6856     (set-buffer buf)
6857     (set-window-start (get-buffer-window buf) start)
6858     (set-window-point (get-buffer-window buf) (point)))
6859   (gnus-summary-show-article))
6860
6861 (defun gnus-article-edit-exit ()
6862   "Exit the article editing without updating."
6863   (interactive)
6864   (when (or (not (buffer-modified-p))
6865             (yes-or-no-p "Article modified; kill anyway? "))
6866     (let ((curbuf (current-buffer))
6867           (p (point))
6868           (window-start (window-start)))
6869       (erase-buffer)
6870       (if (gnus-buffer-live-p gnus-original-article-buffer)
6871           (insert-buffer-substring gnus-original-article-buffer))
6872       (let ((winconf gnus-prev-winconf))
6873         (kill-all-local-variables)
6874         (gnus-article-mode)
6875         (set-window-configuration winconf)
6876         ;; Tippy-toe some to make sure that point remains where it was.
6877         (save-current-buffer
6878           (set-buffer curbuf)
6879           (set-window-start (get-buffer-window (current-buffer)) window-start)
6880           (goto-char p))))
6881     (gnus-summary-show-article)))
6882
6883 (defun gnus-article-edit-full-stops ()
6884   "Interactively repair spacing at end of sentences."
6885   (interactive)
6886   (save-excursion
6887     (goto-char (point-min))
6888     (search-forward-regexp "^$" nil t)
6889     (let ((case-fold-search nil))
6890       (query-replace-regexp "\\([.!?][])}]* \\)\\([[({A-Z]\\)" "\\1 \\2"))))
6891
6892 ;;;
6893 ;;; Article highlights
6894 ;;;
6895
6896 ;; Written by Per Abrahamsen <abraham@iesd.auc.dk>.
6897
6898 ;;; Internal Variables:
6899
6900 (defcustom gnus-button-url-regexp
6901   (concat
6902    "\\b\\(\\(www\\.\\|\\(s?https?\\|ftp\\|file\\|gopher\\|"
6903    "nntp\\|news\\|telnet\\|wais\\|mailto\\|info\\):\\)"
6904    "\\(//[-a-z0-9_.]+:[0-9]*\\)?"
6905    (if (string-match "[[:digit:]]" "1") ;; Support POSIX?
6906        (let ((chars "-a-z0-9_=#$@~%&*+\\/[:word:]")
6907              (punct "!?:;.,"))
6908          (concat
6909           "\\(?:"
6910           ;; Match paired parentheses, e.g. in Wikipedia URLs:
6911           ;; http://thread.gmane.org/47B4E3B2.3050402@gmail.com
6912           "[" chars punct "]+" "(" "[" chars punct "]+" "[" chars "]*)" "[" chars "]*"
6913           "\\|"
6914           "[" chars punct     "]+" "[" chars "]"
6915           "\\)"))
6916      (concat ;; XEmacs 21.4 doesn't support POSIX.
6917       "\\([-a-z0-9_=!?#$@~%&*+\\/:;.,]\\|\\w\\)+"
6918       "\\([-a-z0-9_=#$@~%&*+\\/]\\|\\w\\)"))
6919    "\\)")
6920   "Regular expression that matches URLs."
6921   :group 'gnus-article-buttons
6922   :type 'regexp)
6923
6924 (defcustom gnus-button-valid-fqdn-regexp
6925   message-valid-fqdn-regexp
6926   "Regular expression that matches a valid FQDN."
6927   :version "22.1"
6928   :group 'gnus-article-buttons
6929   :type 'regexp)
6930
6931 ;; Regexp suggested by Felix Wiemann in <87oeuomcz9.fsf@news2.ososo.de>
6932 (defcustom gnus-button-valid-localpart-regexp
6933   "[a-z0-9$%(*-=?[_][^<>\")!;:,{}\n\t @]*"
6934   "Regular expression that matches a localpart of mail addresses or MIDs."
6935   :version "22.1"
6936   :group 'gnus-article-buttons
6937   :type 'regexp)
6938
6939 (defcustom gnus-button-man-handler 'manual-entry
6940   "Function to use for displaying man pages.
6941 The function must take at least one argument with a string naming the
6942 man page."
6943   :version "22.1"
6944   :type '(choice (function-item :tag "Man" manual-entry)
6945                  (function-item :tag "Woman" woman)
6946                  (function :tag "Other"))
6947   :group 'gnus-article-buttons)
6948
6949 (defcustom gnus-ctan-url "http://tug.ctan.org/tex-archive/"
6950   "Top directory of a CTAN \(Comprehensive TeX Archive Network\) archive.
6951 If the default site is too slow, try to find a CTAN mirror, see
6952 <URL:http://tug.ctan.org/tex-archive/CTAN.sites?action=/index.html>.  See also
6953 the variable `gnus-button-handle-ctan'."
6954   :version "22.1"
6955   :group 'gnus-article-buttons
6956   :link '(custom-manual "(gnus)Group Parameters")
6957   :type '(choice (const "http://www.tex.ac.uk/tex-archive/")
6958                  (const "http://tug.ctan.org/tex-archive/")
6959                  (const "http://www.dante.de/CTAN/")
6960                  (string :tag "Other")))
6961
6962 (defcustom gnus-button-ctan-handler 'browse-url
6963   "Function to use for displaying CTAN links.
6964 The function must take one argument, the string naming the URL."
6965   :version "22.1"
6966   :type '(choice (function-item :tag "Browse Url" browse-url)
6967                  (function :tag "Other"))
6968   :group 'gnus-article-buttons)
6969
6970 (defcustom gnus-button-handle-ctan-bogus-regexp "^/?tex-archive/\\|^/"
6971   "Bogus strings removed from CTAN URLs."
6972   :version "22.1"
6973   :group 'gnus-article-buttons
6974   :type '(choice (const "^/?tex-archive/\\|/")
6975                  (regexp :tag "Other")))
6976
6977 (defcustom gnus-button-ctan-directory-regexp
6978   (regexp-opt
6979    (list "archive-tools" "biblio" "bibliography" "digests" "documentation"
6980          "dviware" "fonts" "graphics" "help" "indexing" "info" "language"
6981          "languages" "macros" "nonfree" "obsolete" "support" "systems"
6982          "tds" "tools" "usergrps" "web") t)
6983   "Regular expression for ctan directories.
6984 It should match all directories in the top level of `gnus-ctan-url'."
6985   :version "22.1"
6986   :group 'gnus-article-buttons
6987   :type 'regexp)
6988
6989 (defcustom gnus-button-mid-or-mail-regexp
6990   (concat "\\b\\(<?" gnus-button-valid-localpart-regexp "@"
6991           gnus-button-valid-fqdn-regexp
6992           ">?\\)\\b")
6993   "Regular expression that matches a message ID or a mail address."
6994   :version "22.1"
6995   :group 'gnus-article-buttons
6996   :type 'regexp)
6997
6998 (defcustom gnus-button-prefer-mid-or-mail 'gnus-button-mid-or-mail-heuristic
6999   "What to do when the button on a string as \"foo123@bar.invalid\" is pushed.
7000 Strings like this can be either a message ID or a mail address.  If it is one
7001 of the symbols `mid' or `mail', Gnus will always assume that the string is a
7002 message ID or a mail address, respectively.  If this variable is set to the
7003 symbol `ask', always query the user what do do.  If it is a function, this
7004 function will be called with the string as its only argument.  The function
7005 must return `mid', `mail', `invalid' or `ask'."
7006   :version "22.1"
7007   :group 'gnus-article-buttons
7008   :type '(choice (function-item :tag "Heuristic function"
7009                                 gnus-button-mid-or-mail-heuristic)
7010                  (const ask)
7011                  (const mid)
7012                  (const mail)))
7013
7014 (defcustom gnus-button-mid-or-mail-heuristic-alist
7015   '((-10.0 . ".+\\$.+@")
7016     (-10.0 . "#")
7017     (-10.0 . "\\*")
7018     (-5.0  . "\\+[^+]*\\+.*@") ;; # two plus signs
7019     (-5.0  . "@[Nn][Ee][Ww][Ss]") ;; /\@news/i
7020     (-5.0  . "@.*[Dd][Ii][Aa][Ll][Uu][Pp]") ;; /\@.*dialup/i;
7021     (-1.0  . "^[^a-z]+@")
7022     ;;
7023     (-5.0  . "\\.[0-9][0-9]+.*@") ;; "\.[0-9]{2,}.*\@"
7024     (-5.0  . "[a-z].*[A-Z].*[a-z].*[A-Z].*@") ;; "([a-z].*[A-Z].*){2,}\@"
7025     (-3.0  . "[A-Z][A-Z][a-z][a-z].*@")
7026     (-5.0  . "\\...?.?@") ;; (-5.0 . "\..{1,3}\@")
7027     ;;
7028     (-2.0  . "^[0-9]")
7029     (-1.0  . "^[0-9][0-9]")
7030     ;;
7031     ;; -3.0 /^[0-9][0-9a-fA-F]{2,2}/;
7032     (-3.0  . "^[0-9][0-9a-fA-F][0-9a-fA-F][^0-9a-fA-F]")
7033     ;; -5.0 /^[0-9][0-9a-fA-F]{3,3}/;
7034     (-5.0  . "^[0-9][0-9a-fA-F][0-9a-fA-F][0-9a-fA-F][^0-9a-fA-F]")
7035     ;;
7036     (-3.0  .  "[0-9][0-9][0-9][0-9][0-9][^0-9].*@") ;; "[0-9]{5,}.*\@"
7037     (-3.0  .  "[0-9][0-9][0-9][0-9][0-9][0-9][0-9][0-9][^0-9].*@")
7038     ;;       "[0-9]{8,}.*\@"
7039     (-3.0
7040      . "[0-9][0-9][0-9][0-9][0-9][0-9][0-9][0-9][0-9][0-9][0-9][0-9].*@")
7041     ;; "[0-9]{12,}.*\@"
7042     ;; compensation for TDMA dated mail addresses:
7043     (25.0  . "-dated-[0-9][0-9][0-9][0-9][0-9][0-9][0-9][0-9]+.*@")
7044     ;;
7045     (-20.0 . "\\.fsf@") ;; Gnus
7046     (-20.0 . "^slrn")
7047     (-20.0 . "^Pine")
7048     (-20.0 . "^alpine\\.")
7049     (-20.0 . "_-_") ;; Subject change in thread
7050     ;;
7051     (-20.0 . "\\.ln@") ;; leafnode
7052     (-30.0 . "@ID-[0-9]+\\.[a-zA-Z]+\\.dfncis\\.de")
7053     (-30.0 . "@4[Aa][Xx]\\.com") ;; Forte Agent
7054     ;;
7055     ;; (5.0 . "") ;; $local_part_len <= 7
7056     (10.0  . "^[^0-9]+@")
7057     (3.0   . "^[^0-9]+[0-9][0-9]?[0-9]?@")
7058     ;;      ^[^0-9]+[0-9]{1,3}\@ digits only at end of local part
7059     (3.0   . "\@stud")
7060     ;;
7061     (2.0   . "[a-z][a-z][._-][A-Z][a-z].*@")
7062     ;;
7063     (0.5   . "^[A-Z][a-z]")
7064     (0.5   . "^[A-Z][a-z][a-z]")
7065     (1.5   . "^[A-Z][a-z][A-Z][a-z][^a-z]") ;; ^[A-Z][a-z]{3,3}
7066     (2.0   . "^[A-Z][a-z][A-Z][a-z][a-z][^a-z]")) ;; ^[A-Z][a-z]{4,4}
7067   "An alist of \(RATE . REGEXP\) pairs for `gnus-button-mid-or-mail-heuristic'.
7068
7069 A negative RATE indicates a message IDs, whereas a positive indicates a mail
7070 address.  The REGEXP is processed with `case-fold-search' set to nil."
7071   :version "22.1"
7072   :group 'gnus-article-buttons
7073   :type '(repeat (cons (number :tag "Rate")
7074                        (regexp :tag "Regexp"))))
7075
7076 (defun gnus-button-mid-or-mail-heuristic (mid-or-mail)
7077   "Guess whether MID-OR-MAIL is a message ID or a mail address.
7078 Returns `mid' if MID-OR-MAIL is a message IDs, `mail' if it's a mail
7079 address, `ask' if unsure and `invalid' if the string is invalid."
7080   (let ((case-fold-search nil)
7081         (list gnus-button-mid-or-mail-heuristic-alist)
7082         (result 0) rate regexp lpartlen elem)
7083     (setq lpartlen
7084           (length (gnus-replace-in-string mid-or-mail "^\\(.*\\)@.*$" "\\1")))
7085     (gnus-message 8 "`%s', length of local part=`%s'." mid-or-mail lpartlen)
7086     ;; Certain special cases...
7087     (when (string-match
7088            (concat
7089             "^0[0-9]+-[0-9][0-9][0-9][0-9]@t-online\\.de$\\|"
7090             "^[0-9]+\\.[0-9]+@compuserve\\|"
7091             "@public\\.gmane\\.org")
7092            mid-or-mail)
7093       (gnus-message 8 "`%s' is a known mail address." mid-or-mail)
7094       (setq result 'mail))
7095     (when (string-match "@.*@\\| " mid-or-mail)
7096       (gnus-message 8 "`%s' is invalid." mid-or-mail)
7097       (setq result 'invalid))
7098     ;; Nothing more to do, if result is not a number here...
7099     (when (numberp result)
7100       (while list
7101         (setq elem (car list)
7102               rate (car elem)
7103               regexp (cdr elem)
7104               list (cdr list))
7105         (when (string-match regexp mid-or-mail)
7106           (setq result (+ result rate))
7107           (gnus-message
7108            9 "`%s' matched `%s', rate `%s', result `%s'."
7109            mid-or-mail regexp rate result)))
7110       (when (<= lpartlen 7)
7111         (setq result (+ result 5.0))
7112         (gnus-message 9 "`%s' matched (<= lpartlen 7), result `%s'."
7113                       mid-or-mail result))
7114       (when (>= lpartlen 12)
7115         (gnus-message 9 "`%s' matched (>= lpartlen 12)" mid-or-mail)
7116         (cond
7117          ((string-match "[0-9][^0-9]+[0-9].*@" mid-or-mail)
7118           ;; Long local part should contain realname if e-mail address,
7119           ;; too many digits: message-id.
7120           ;; $score -= 5.0 + 0.1 * $local_part_len;
7121           (setq rate (* -1.0 (+ 5.0 (* 0.1 lpartlen))))
7122           (setq result (+ result rate))
7123           (gnus-message
7124            9 "Many digits in `%s', rate `%s', result `%s'."
7125            mid-or-mail rate result))
7126          ((string-match "[^aeiouy][^aeiouy][^aeiouy][^aeiouy]+.*\@"
7127                         mid-or-mail)
7128           ;; Too few vowels [^aeiouy]{4,}.*\@
7129           (setq result (+ result -5.0))
7130           (gnus-message
7131            9 "Few vowels in `%s', rate `%s', result `%s'."
7132            mid-or-mail -5.0 result))
7133          (t
7134           (setq result (+ result 5.0))
7135           (gnus-message
7136            9 "`%s', rate `%s', result `%s'." mid-or-mail 5.0 result)))))
7137     (gnus-message 8 "`%s': Final rate is `%s'." mid-or-mail result)
7138     ;; Maybe we should make this a customizable alist: (condition . 'result)
7139     (cond
7140      ((symbolp result) result)
7141      ;; Now convert number into proper results:
7142      ((< result -10.0) 'mid)
7143      ((> result  10.0) 'mail)
7144      (t 'ask))))
7145
7146 (defun gnus-button-handle-mid-or-mail (mid-or-mail)
7147   (let* ((pref gnus-button-prefer-mid-or-mail) guessed
7148          (url-mid (concat "news" ":" mid-or-mail))
7149          (url-mailto (concat "mailto" ":" mid-or-mail)))
7150     (gnus-message 9 "mid-or-mail=%s" mid-or-mail)
7151     (when (fboundp pref)
7152       (setq guessed
7153             ;; get rid of surrounding angles...
7154             (funcall pref
7155                      (gnus-replace-in-string mid-or-mail "^<\\|>$" "")))
7156       (if (or (eq 'mid guessed) (eq 'mail guessed))
7157           (setq pref guessed)
7158         (setq pref 'ask)))
7159     (if (eq pref 'ask)
7160         (save-window-excursion
7161           (if (y-or-n-p (concat "Is <" mid-or-mail "> a mail address? "))
7162               (setq pref 'mail)
7163             (setq pref 'mid))))
7164     (cond ((eq pref 'mid)
7165            (gnus-message 8 "calling `gnus-button-handle-news' %s" url-mid)
7166            (gnus-button-handle-news url-mid))
7167           ((eq pref 'mail)
7168            (gnus-message 8 "calling `gnus-url-mailto'  %s" url-mailto)
7169            (gnus-url-mailto url-mailto))
7170           (t (gnus-message 3 "Invalid string.")))))
7171
7172 (defun gnus-button-handle-custom (fun arg)
7173   "Call function FUN on argument ARG.
7174 Both FUN and ARG are supposed to be strings.  ARG will be passed
7175 as a symbol to FUN."
7176   (funcall (intern fun)
7177            (if (string-match "^customize-apropos" fun)
7178                arg
7179              (intern arg))))
7180
7181 (defvar gnus-button-handle-describe-prefix "^\\(C-h\\|<?[Ff]1>?\\)")
7182
7183 ;; FIXME: Maybe we should merge some of the functions that do quite similar
7184 ;; stuff?
7185
7186 (defun gnus-button-handle-describe-function (url)
7187   "Call `describe-function' when pushing the corresponding URL button."
7188   (describe-function
7189    (intern
7190     (gnus-replace-in-string url gnus-button-handle-describe-prefix ""))))
7191
7192 (defun gnus-button-handle-describe-variable (url)
7193   "Call `describe-variable' when pushing the corresponding URL button."
7194   (describe-variable
7195    (intern
7196     (gnus-replace-in-string url gnus-button-handle-describe-prefix ""))))
7197
7198 (defun gnus-button-handle-symbol (url)
7199 "Display help on variable or function.
7200 Calls `describe-variable' or `describe-function'."
7201   (let ((sym (intern url)))
7202     (cond
7203      ((fboundp sym) (describe-function sym))
7204      ((boundp sym) (describe-variable sym))
7205      (t (gnus-message 3 "`%s' is not a known function of variable." url)))))
7206
7207 (defun gnus-button-handle-describe-key (url)
7208   "Call `describe-key' when pushing the corresponding URL button."
7209   (let* ((key-string
7210           (gnus-replace-in-string url gnus-button-handle-describe-prefix ""))
7211          (keys (ignore-errors (eval `(kbd ,key-string)))))
7212     (if keys
7213         (describe-key keys)
7214       (gnus-message 3 "Invalid key sequence in button: %s" key-string))))
7215
7216 (defun gnus-button-handle-apropos (url)
7217   "Call `apropos' when pushing the corresponding URL button."
7218   (apropos (gnus-replace-in-string url gnus-button-handle-describe-prefix "")))
7219
7220 (defun gnus-button-handle-apropos-command (url)
7221   "Call `apropos' when pushing the corresponding URL button."
7222   (apropos-command
7223    (gnus-replace-in-string url gnus-button-handle-describe-prefix "")))
7224
7225 (defun gnus-button-handle-apropos-variable (url)
7226   "Call `apropos' when pushing the corresponding URL button."
7227   (funcall
7228    (if (fboundp 'apropos-variable) 'apropos-variable 'apropos)
7229    (gnus-replace-in-string url gnus-button-handle-describe-prefix "")))
7230
7231 (defun gnus-button-handle-apropos-documentation (url)
7232   "Call `apropos' when pushing the corresponding URL button."
7233   (funcall
7234    (if (fboundp 'apropos-documentation) 'apropos-documentation 'apropos)
7235    (gnus-replace-in-string url gnus-button-handle-describe-prefix "")))
7236
7237 (defun gnus-button-handle-library (url)
7238   "Call `locate-library' when pushing the corresponding URL button."
7239   (gnus-message 9 "url=`%s'" url)
7240   (let* ((lib (locate-library url))
7241          (file (gnus-replace-in-string (or lib "") "\.elc" ".el")))
7242     (if (not lib)
7243         (gnus-message 1 "Cannot locale library `%s'." url)
7244       (find-file-read-only file))))
7245
7246 (defun gnus-button-handle-ctan (url)
7247   "Call `browse-url' when pushing a CTAN URL button."
7248   (funcall
7249    gnus-button-ctan-handler
7250    (concat
7251     gnus-ctan-url
7252     (gnus-replace-in-string url gnus-button-handle-ctan-bogus-regexp ""))))
7253
7254 (defcustom gnus-button-tex-level 5
7255   "*Integer that says how many TeX-related buttons Gnus will show.
7256 The higher the number, the more buttons will appear and the more false
7257 positives are possible.  Note that you can set this variable local to
7258 specific groups.  Setting it higher in TeX groups is probably a good idea.
7259 See Info node `(gnus)Group Parameters' and the variable `gnus-parameters' on
7260 how to set variables in specific groups."
7261   :version "22.1"
7262   :group 'gnus-article-buttons
7263   :link '(custom-manual "(gnus)Group Parameters")
7264   :type 'integer)
7265
7266 (defcustom gnus-button-man-level 5
7267   "*Integer that says how many man-related buttons Gnus will show.
7268 The higher the number, the more buttons will appear and the more false
7269 positives are possible.  Note that you can set this variable local to
7270 specific groups.  Setting it higher in Unix groups is probably a good idea.
7271 See Info node `(gnus)Group Parameters' and the variable `gnus-parameters' on
7272 how to set variables in specific groups."
7273   :version "22.1"
7274   :group 'gnus-article-buttons
7275   :link '(custom-manual "(gnus)Group Parameters")
7276   :type 'integer)
7277
7278 (defcustom gnus-button-emacs-level 5
7279   "*Integer that says how many emacs-related buttons Gnus will show.
7280 The higher the number, the more buttons will appear and the more false
7281 positives are possible.  Note that you can set this variable local to
7282 specific groups.  Setting it higher in Emacs or Gnus related groups is
7283 probably a good idea.  See Info node `(gnus)Group Parameters' and the variable
7284 `gnus-parameters' on how to set variables in specific groups."
7285   :version "22.1"
7286   :group 'gnus-article-buttons
7287   :link '(custom-manual "(gnus)Group Parameters")
7288   :type 'integer)
7289
7290 (defcustom gnus-button-message-level 5
7291   "*Integer that says how many buttons for news or mail messages will appear.
7292 The higher the number, the more buttons will appear and the more false
7293 positives are possible."
7294   ;; mail addresses, MIDs, URLs for news, ...
7295   :version "22.1"
7296   :group 'gnus-article-buttons
7297   :type 'integer)
7298
7299 (defcustom gnus-button-browse-level 5
7300   "*Integer that says how many buttons for browsing will appear.
7301 The higher the number, the more buttons will appear and the more false
7302 positives are possible."
7303   ;; stuff handled by `browse-url' or `gnus-button-embedded-url'
7304   :version "22.1"
7305   :group 'gnus-article-buttons
7306   :type 'integer)
7307
7308 (defcustom gnus-button-alist
7309   '(("<\\(url:[>\n\t ]*?\\)?\\(nntp\\|news\\):[>\n\t ]*\\([^>\n\t ]*@[^>\n\t ]*\\)>"
7310      0 (>= gnus-button-message-level 0) gnus-button-handle-news 3)
7311     ((concat "\\b\\(nntp\\|news\\):\\("
7312              gnus-button-valid-localpart-regexp "@[a-z0-9.-]+[a-z]\\)")
7313      0 t gnus-button-handle-news 2)
7314     ("\\(\\b<\\(url:[>\n\t ]*\\)?\\(nntp\\|news\\):[>\n\t ]*\\(//\\)?\\([^>\n\t ]*\\)>\\)"
7315      1 (>= gnus-button-message-level 0) gnus-button-fetch-group 5)
7316     ("\\b\\(nntp\\|news\\):\\(//\\)?\\([^'\">\n\t ]+\\)"
7317      0 (>= gnus-button-message-level 0) gnus-button-fetch-group 3)
7318     ;; RFC 2392 (Don't allow `/' in domain part --> CID)
7319     ("\\bmid:\\(//\\)?\\([^'\">\n\t ]+@[^'\">\n\t /]+\\)"
7320      0 (>= gnus-button-message-level 0) gnus-button-message-id 2)
7321     ("\\bin\\( +article\\| +message\\)? +\\(<\\([^\n @<>]+@[^\n @<>]+\\)>\\)"
7322      2 (>= gnus-button-message-level 0) gnus-button-message-id 3)
7323     ("\\b\\(mid\\|message-id\\):? +\\(<\\([^\n @<>]+@[^\n @<>]+\\)>\\)"
7324      2 (>= gnus-button-message-level 0) gnus-button-message-id 3)
7325     ("\\(<URL: *\\)mailto: *\\([^> \n\t]+\\)>"
7326      0 (>= gnus-button-message-level 0) gnus-url-mailto 2)
7327     ;; RFC 2368 (The mailto URL scheme)
7328     ("\\bmailto:\\([-a-z.@_+0-9%=?&/]+\\)"
7329      0 (>= gnus-button-message-level 0) gnus-url-mailto 1)
7330     ("\\bmailto:\\([^ \n\t]+\\)"
7331      0 (>= gnus-button-message-level 0) gnus-url-mailto 1)
7332     ;; CTAN
7333     ((concat "\\bCTAN:[ \t\n]?[^>)!;:,'\n\t ]*\\("
7334              gnus-button-ctan-directory-regexp
7335              "[^][>)!;:,'\n\t ]+\\)")
7336      0 (>= gnus-button-tex-level 1) gnus-button-handle-ctan 1)
7337     ((concat "\\btex-archive/\\("
7338              gnus-button-ctan-directory-regexp
7339              "/[-_.a-z0-9/]+[-_./a-z0-9]+[/a-z0-9]\\)")
7340      1 (>= gnus-button-tex-level 6) gnus-button-handle-ctan 1)
7341     ((concat
7342       "\\b\\("
7343       gnus-button-ctan-directory-regexp
7344       "/[-_.a-z0-9]+/[-_./a-z0-9]+[/a-z0-9]\\)")
7345      1 (>= gnus-button-tex-level 8) gnus-button-handle-ctan 1)
7346     ;; This is info (home-grown style) <info://foo/bar+baz>
7347     ("\\binfo://\\([^'\">\n\t ]+\\)"
7348      0 (>= gnus-button-emacs-level 1) gnus-button-handle-info-url 1)
7349     ;; Info GNOME style <info:foo#bar_baz>
7350     ("\\binfo:\\([^('\n\t\r \"><][^'\n\t\r \"><]*\\)"
7351      0 (>= gnus-button-emacs-level 1) gnus-button-handle-info-url-gnome 1)
7352     ;; Info KDE style <info:(foo)bar baz>
7353     ("<\\(info:\\(([^)]+)[^>\n\r]*\\)\\)>"
7354      1 (>= gnus-button-emacs-level 1) gnus-button-handle-info-url-kde 2)
7355     ("\\((Info-goto-node\\|(info\\)[ \t\n]*\\(\"[^\"]*\"\\))" 0
7356      (>= gnus-button-emacs-level 1) gnus-button-handle-info-url 2)
7357     ("\\b\\(C-h\\|<?[Ff]1>?\\)[ \t\n]+i[ \t\n]+d?[ \t\n]?m[ \t\n]+[^ ]+ ?[^ ]+[ \t\n]+RET\\([ \t\n]+i[ \t\n]+[^ ]+ ?[^ ]+[ \t\n]+RET\\([ \t\n,]*\\)\\)?"
7358      ;; Info links like `C-h i d m Gnus RET' or `C-h i d m Gnus RET i partial RET'
7359      0 (>= gnus-button-emacs-level 1) gnus-button-handle-info-keystrokes 0)
7360     ;; This is custom
7361     ("M-x[ \t\n]\\(customize-[^ ]+\\)[ \t\n]RET[ \t\n]\\([^ ]+\\)[ \t\n]RET" 0
7362      (>= gnus-button-emacs-level 1) gnus-button-handle-custom 1 2)
7363     ;; Emacs help commands
7364     ("M-x[ \t\n]+apropos[ \t\n]+RET[ \t\n]+\\([^ \t\n]+\\)[ \t\n]+RET"
7365      ;; regexp doesn't match arguments containing ` '.
7366      0 (>= gnus-button-emacs-level 1) gnus-button-handle-apropos 1)
7367     ("M-x[ \t\n]+apropos-command[ \t\n]+RET[ \t\n]+\\([^ \t\n]+\\)[ \t\n]+RET"
7368      0 (>= gnus-button-emacs-level 1) gnus-button-handle-apropos-command 1)
7369     ("M-x[ \t\n]+apropos-variable[ \t\n]+RET[ \t\n]+\\([^ \t\n]+\\)[ \t\n]+RET"
7370      0 (>= gnus-button-emacs-level 1) gnus-button-handle-apropos-variable 1)
7371     ("M-x[ \t\n]+apropos-documentation[ \t\n]+RET[ \t\n]+\\([^ \t\n]+\\)[ \t\n]+RET"
7372      0 (>= gnus-button-emacs-level 1) gnus-button-handle-apropos-documentation 1)
7373     ;; The following entries may lead to many false positives so don't enable
7374     ;; them by default (use a high button level).
7375     ("/\\([a-z][-a-z0-9]+\\.el\\)\\>[^.?]"
7376      ;; Exclude [.?] for URLs in gmane.emacs.cvs
7377      1 (>= gnus-button-emacs-level 8) gnus-button-handle-library 1)
7378     ("`\\([a-z][-a-z0-9]+\\.el\\)'"
7379      1 (>= gnus-button-emacs-level 8) gnus-button-handle-library 1)
7380     ("`\\([a-z][a-z0-9]+-[a-z0-9]+-[-a-z0-9]*[a-z]\\|\\(gnus\\|message\\)-[-a-z]+\\)'"
7381      0 (>= gnus-button-emacs-level 8) gnus-button-handle-symbol 1)
7382     ("`\\([a-z][a-z0-9]+-[a-z]+\\)'"
7383      0 (>= gnus-button-emacs-level 9) gnus-button-handle-symbol 1)
7384     ("(setq[ \t\n]+\\([a-z][a-z0-9]+-[-a-z0-9]+\\)[ \t\n]+.+)"
7385      1 (>= gnus-button-emacs-level 7) gnus-button-handle-describe-variable 1)
7386     ("\\bM-x[ \t\n]+\\([^ \t\n]+\\)[ \t\n]+RET"
7387      1 (>= gnus-button-emacs-level 7) gnus-button-handle-describe-function 1)
7388     ("\\b\\(C-h\\|<?[Ff]1>?\\)[ \t\n]+f[ \t\n]+\\([^ \t\n]+\\)[ \t\n]+RET"
7389      0 (>= gnus-button-emacs-level 1) gnus-button-handle-describe-function 2)
7390     ("\\b\\(C-h\\|<?[Ff]1>?\\)[ \t\n]+v[ \t\n]+\\([^ \t\n]+\\)[ \t\n]+RET"
7391      0 (>= gnus-button-emacs-level 1) gnus-button-handle-describe-variable 2)
7392     ("`\\(\\(C-h\\|<?[Ff]1>?\\)[ \t\n]+k[ \t\n]+\\([^']+\\)\\)'"
7393      ;; Unlike the other regexps we really have to require quoting
7394      ;; here to determine where it ends.
7395      1 (>= gnus-button-emacs-level 1) gnus-button-handle-describe-key 3)
7396     ;; This is how URLs _should_ be embedded in text (RFC 1738, RFC 2396)...
7397     ("<URL: *\\([^\n<>]*\\)>"
7398      1 (>= gnus-button-browse-level 0) gnus-button-embedded-url 1)
7399     ;; RFC 2396 (2.4.3., delims) ...
7400     ("\"URL: *\\([^\n\"]*\\)\""
7401      1 (>= gnus-button-browse-level 0) gnus-button-embedded-url 1)
7402     ;; Raw URLs.
7403     (gnus-button-url-regexp
7404      0 (>= gnus-button-browse-level 0) browse-url 0)
7405     ;; man pages
7406     ("\\b\\([a-z][a-z]+([1-9])\\)\\W"
7407      0 (and (>= gnus-button-man-level 1) (< gnus-button-man-level 3))
7408      gnus-button-handle-man 1)
7409     ;; more man pages: resolv.conf(5), iso_8859-1(7), xterm(1x)
7410     ("\\b\\([a-z][-_.a-z0-9]+([1-9])\\)\\W"
7411      0 (and (>= gnus-button-man-level 3) (< gnus-button-man-level 5))
7412      gnus-button-handle-man 1)
7413     ;; even more: Apache::PerlRun(3pm), PDL::IO::FastRaw(3pm),
7414     ;; SoWWWAnchor(3iv), XSelectInput(3X11), X(1), X(7)
7415     ("\\b\\(\\(?:[a-z][-+_.:a-z0-9]+([1-9][X1a-z]*)\\)\\|\\b\\(?:X([1-9])\\)\\)\\W"
7416      0 (>= gnus-button-man-level 5) gnus-button-handle-man 1)
7417     ;; Recognizing patches to .el files.  This is somewhat obscure,
7418     ;; but considering the percentage of Gnus users who hack Emacs
7419     ;; Lisp files...
7420     ("^--- \\([^ .]+\\.el\\).*\n.*\n@@ -?\\([0-9]+\\)" 1
7421      (>= gnus-button-message-level 4) gnus-button-patch 1 2)
7422     ("^\\*\\*\\* \\([^ .]+\\.el\\).*\n.*\n\\*+\n\\*\\*\\* \\([0-9]+\\)" 1
7423      (>= gnus-button-message-level 4) gnus-button-patch 1 2)
7424     ;; MID or mail: To avoid too many false positives we don't try to catch
7425     ;; all kind of allowed MIDs or mail addresses.  Domain part must contain
7426     ;; at least one dot.  TLD must contain two or three chars or be a know TLD
7427     ;; (info|name|...).  Put this entry near the _end_ of `gnus-button-alist'
7428     ;; so that non-ambiguous entries (see above) match first.
7429     (gnus-button-mid-or-mail-regexp
7430      0 (>= gnus-button-message-level 5) gnus-button-handle-mid-or-mail 1))
7431   "*Alist of regexps matching buttons in article bodies.
7432
7433 Each entry has the form (REGEXP BUTTON FORM CALLBACK PAR...), where
7434 REGEXP: is the string (case insensitive) matching text around the button (can
7435 also be Lisp expression evaluating to a string),
7436 BUTTON: is the number of the regexp grouping actually matching the button,
7437 FORM: is a Lisp expression which must eval to true for the button to
7438 be added,
7439 CALLBACK: is the function to call when the user push this button, and each
7440 PAR: is a number of a regexp grouping whose text will be passed to CALLBACK.
7441
7442 CALLBACK can also be a variable, in that case the value of that
7443 variable it the real callback function."
7444   :group 'gnus-article-buttons
7445   :type '(repeat (list (choice regexp variable sexp)
7446                        (integer :tag "Button")
7447                        (sexp :tag "Form")
7448                        (function :tag "Callback")
7449                        (repeat :tag "Par"
7450                                :inline t
7451                                (integer :tag "Regexp group")))))
7452 (put 'gnus-button-alist 'risky-local-variable t)
7453
7454 (defcustom gnus-header-button-alist
7455   '(("^\\(References\\|Message-I[Dd]\\|^In-Reply-To\\):" "<[^<>]+>"
7456      0 (>= gnus-button-message-level 0) gnus-button-message-id 0)
7457     ("^\\(From\\|Reply-To\\):" ": *\\(.+\\)$"
7458      1 (>= gnus-button-message-level 0) gnus-button-reply 1)
7459     ("^\\(Cc\\|To\\):" "[^ \t\n<>,()\"]+@[^ \t\n<>,()\"]+"
7460      0 (>= gnus-button-message-level 0) gnus-msg-mail 0)
7461     ("^X-[Uu][Rr][Ll]:" gnus-button-url-regexp
7462      0 (>= gnus-button-browse-level 0) browse-url 0)
7463     ("^Subject:" gnus-button-url-regexp
7464      0 (>= gnus-button-browse-level 0) browse-url 0)
7465     ("^[^:]+:" gnus-button-url-regexp
7466      0 (>= gnus-button-browse-level 0) browse-url 0)
7467     ("^OpenPGP:.*url=" gnus-button-url-regexp
7468      0 (>= gnus-button-browse-level 0) gnus-button-openpgp 0)
7469     ("^[^:]+:" "\\bmailto:\\([-a-z.@_+0-9%=?&/]+\\)"
7470      0 (>= gnus-button-message-level 0) gnus-url-mailto 1)
7471     ("^[^:]+:" "\\(<\\(url: \\)?\\(nntp\\|news\\):\\([^>\n ]*\\)>\\)"
7472      1 (>= gnus-button-message-level 0) gnus-button-message-id 4))
7473   "*Alist of headers and regexps to match buttons in article heads.
7474
7475 This alist is very similar to `gnus-button-alist', except that each
7476 alist has an additional HEADER element first in each entry:
7477
7478 \(HEADER REGEXP BUTTON FORM CALLBACK PAR)
7479
7480 HEADER is a regexp to match a header.  For a fuller explanation, see
7481 `gnus-button-alist'."
7482   :group 'gnus-article-buttons
7483   :group 'gnus-article-headers
7484   :type '(repeat (list (regexp :tag "Header")
7485                        (choice regexp variable)
7486                        (integer :tag "Button")
7487                        (sexp :tag "Form")
7488                        (function :tag "Callback")
7489                        (repeat :tag "Par"
7490                                :inline t
7491                                (integer :tag "Regexp group")))))
7492 (put 'gnus-header-button-alist 'risky-local-variable t)
7493
7494 ;;; Commands:
7495
7496 (defun gnus-article-push-button (event)
7497   "Check text under the mouse pointer for a callback function.
7498 If the text under the mouse pointer has a `gnus-callback' property,
7499 call it with the value of the `gnus-data' text property."
7500   (interactive "e")
7501   (set-buffer (window-buffer (posn-window (event-start event))))
7502   (let* ((pos (posn-point (event-start event)))
7503          (data (get-text-property pos 'gnus-data))
7504          (fun (get-text-property pos 'gnus-callback)))
7505     (goto-char pos)
7506     (when fun
7507       (funcall fun data))))
7508
7509 (defun gnus-article-press-button ()
7510   "Check text at point for a callback function.
7511 If the text at point has a `gnus-callback' property,
7512 call it with the value of the `gnus-data' text property."
7513   (interactive)
7514   (let ((data (get-text-property (point) 'gnus-data))
7515         (fun (get-text-property (point) 'gnus-callback)))
7516     (when fun
7517       (funcall fun data))))
7518
7519 (defun gnus-article-highlight (&optional force)
7520   "Highlight current article.
7521 This function calls `gnus-article-highlight-headers',
7522 `gnus-article-highlight-citation',
7523 `gnus-article-highlight-signature', and `gnus-article-add-buttons' to
7524 do the highlighting.  See the documentation for those functions."
7525   (interactive (list 'force))
7526   (gnus-article-highlight-headers)
7527   (gnus-article-highlight-citation force)
7528   (gnus-article-highlight-signature)
7529   (gnus-article-add-buttons force)
7530   (gnus-article-add-buttons-to-head))
7531
7532 (defun gnus-article-highlight-some (&optional force)
7533   "Highlight current article.
7534 This function calls `gnus-article-highlight-headers',
7535 `gnus-article-highlight-signature', and `gnus-article-add-buttons' to
7536 do the highlighting.  See the documentation for those functions."
7537   (interactive (list 'force))
7538   (gnus-article-highlight-headers)
7539   (gnus-article-highlight-signature)
7540   (gnus-article-add-buttons))
7541
7542 (defun gnus-article-highlight-headers ()
7543   "Highlight article headers as specified by `gnus-header-face-alist'."
7544   (interactive)
7545   (gnus-with-article-headers
7546     (let (regexp header-face field-face from hpoints fpoints)
7547       (dolist (entry gnus-header-face-alist)
7548         (goto-char (point-min))
7549         (setq regexp (concat "^\\("
7550                              (if (string-equal "" (nth 0 entry))
7551                                  "[^\t ]"
7552                                (nth 0 entry))
7553                              "\\)")
7554               header-face (nth 1 entry)
7555               field-face (nth 2 entry))
7556         (while (and (re-search-forward regexp nil t)
7557                     (not (eobp)))
7558           (beginning-of-line)
7559           (setq from (point))
7560           (unless (search-forward ":" nil t)
7561             (forward-char 1))
7562           (when (and header-face
7563                      (not (memq (point) hpoints)))
7564             (push (point) hpoints)
7565             (gnus-put-text-property from (point) 'face header-face))
7566           (when (and field-face
7567                      (not (memq (setq from (point)) fpoints)))
7568             (push from fpoints)
7569             (if (re-search-forward "^[^ \t]" nil t)
7570                 (forward-char -2)
7571               (goto-char (point-max)))
7572             (gnus-put-text-property from (point) 'face field-face)))))))
7573
7574 (defun gnus-article-highlight-signature ()
7575   "Highlight the signature in an article.
7576 It does this by highlighting everything after
7577 `gnus-signature-separator' using the face `gnus-signature'."
7578   (interactive)
7579   (gnus-with-article-buffer
7580     (let ((inhibit-point-motion-hooks t))
7581       (save-restriction
7582         (when (and gnus-signature-face
7583                    (gnus-article-narrow-to-signature))
7584           (gnus-overlay-put (gnus-make-overlay (point-min) (point-max) nil t)
7585                             'face gnus-signature-face)
7586           (widen)
7587           (gnus-article-search-signature)
7588           (let ((start (match-beginning 0))
7589                 (end (set-marker (make-marker) (1+ (match-end 0)))))
7590             (gnus-article-add-button start (1- end) 'gnus-signature-toggle
7591                                      end)))))))
7592
7593 (defun gnus-button-in-region-p (b e prop)
7594   "Say whether PROP exists in the region."
7595   (text-property-not-all b e prop nil))
7596
7597 (defun gnus-article-add-buttons (&optional force)
7598   "Find external references in the article and make buttons of them.
7599 \"External references\" are things like Message-IDs and URLs, as
7600 specified by `gnus-button-alist'."
7601   (interactive (list 'force))
7602   (gnus-with-article-buffer
7603     (let ((inhibit-point-motion-hooks t)
7604           (case-fold-search t)
7605           (alist gnus-button-alist)
7606           beg entry regexp)
7607       ;; Remove all old markers.
7608       (let (marker entry new-list)
7609         (while (setq marker (pop gnus-button-marker-list))
7610           (if (or (< marker (point-min)) (>= marker (point-max)))
7611               (push marker new-list)
7612             (goto-char marker)
7613             (when (setq entry (gnus-button-entry))
7614               (put-text-property (match-beginning (nth 1 entry))
7615                                  (match-end (nth 1 entry))
7616                                  'gnus-callback nil))
7617             (set-marker marker nil)))
7618         (setq gnus-button-marker-list new-list))
7619       ;; We skip the headers.
7620       (article-goto-body)
7621       (setq beg (point))
7622       (while (setq entry (pop alist))
7623         (setq regexp (eval (car entry)))
7624         (goto-char beg)
7625         (while (re-search-forward regexp nil t)
7626           (let ((start (match-beginning (nth 1 entry)))
7627                 (end (match-end (nth 1 entry)))
7628                 (from (match-beginning 0)))
7629             (when (and (or (eq t (nth 2 entry))
7630                            (eval (nth 2 entry)))
7631                        (not (gnus-button-in-region-p
7632                              start end 'gnus-callback)))
7633               ;; That optional form returned non-nil, so we add the
7634               ;; button.
7635               (setq from (set-marker (make-marker) from))
7636               (push from gnus-button-marker-list)
7637               (unless (and (eq (car entry) 'gnus-button-url-regexp)
7638                            (gnus-article-extend-url-button from start end))
7639                 (gnus-article-add-button start end
7640                                          'gnus-button-push from)))))))))
7641
7642 (defun gnus-article-extend-url-button (beg start end)
7643   "Extend url button if url is folded into two or more lines.
7644 Return non-nil if button is extended.  BEG is a marker that points to
7645 the beginning position of a text containing url.  START and END are
7646 the endpoints of a url button before it is extended.  The concatenated
7647 url is put as the `gnus-button-url' overlay property on the button."
7648   (let ((opoint (point))
7649         (points (list start end))
7650         url delim regexp)
7651     (prog1
7652         (when (and (progn
7653                      (goto-char end)
7654                      (not (looking-at "[\t ]*[\">]")))
7655                    (progn
7656                      (goto-char start)
7657                      (string-match
7658                       "\\(?:\"\\|\\(<\\)\\)[\t ]*\\(?:url[\t ]*:[\t ]*\\)?\\'"
7659                       (buffer-substring (point-at-bol) start)))
7660                    (progn
7661                      (setq url (list (buffer-substring start end))
7662                            delim (if (match-beginning 1) ">" "\""))
7663                      (beginning-of-line)
7664                      (setq regexp (concat
7665                                    (when (and (looking-at
7666                                                message-cite-prefix-regexp)
7667                                               (< (match-end 0) start))
7668                                      (regexp-quote (match-string 0)))
7669                                    "\
7670 \[\t ]*\\(?:\\([^\t\n \">]+\\)[\t ]*$\\|\\([^\t\n \">]*\\)[\t ]*"
7671                                    delim "\\)"))
7672                      (while (progn
7673                               (forward-line 1)
7674                               (and (looking-at regexp)
7675                                    (prog1
7676                                        (match-beginning 1)
7677                                      (push (or (match-string 2)
7678                                                (match-string 1))
7679                                            url)
7680                                      (push (setq end (or (match-end 2)
7681                                                          (match-end 1)))
7682                                            points)
7683                                      (push (or (match-beginning 2)
7684                                                (match-beginning 1))
7685                                            points)))))
7686                      (match-beginning 2)))
7687           (let (gnus-article-mouse-face widget-mouse-face)
7688             (while points
7689               (gnus-article-add-button (pop points) (pop points)
7690                                        'gnus-button-push beg)))
7691           (let ((overlay (gnus-make-overlay start end)))
7692             (gnus-overlay-put overlay 'evaporate t)
7693             (gnus-overlay-put overlay 'gnus-button-url
7694                               (list (mapconcat 'identity (nreverse url) "")))
7695             (when gnus-article-mouse-face
7696               (gnus-overlay-put overlay 'mouse-face gnus-article-mouse-face)))
7697           t)
7698       (goto-char opoint))))
7699
7700 ;; Add buttons to the head of an article.
7701 (defun gnus-article-add-buttons-to-head ()
7702   "Add buttons to the head of the article."
7703   (interactive)
7704   (gnus-with-article-headers
7705     (let (beg end)
7706       (dolist (entry gnus-header-button-alist)
7707         ;; Each alist entry.
7708         (goto-char (point-min))
7709         (while (re-search-forward (car entry) nil t)
7710           ;; Each header matching the entry.
7711           (setq beg (match-beginning 0))
7712           (setq end (or (and (re-search-forward "^[^ \t]" nil t)
7713                              (match-beginning 0))
7714                         (point-max)))
7715           (goto-char beg)
7716           (while (re-search-forward (eval (nth 1 entry)) end t)
7717             ;; Each match within a header.
7718             (let* ((entry (cdr entry))
7719                    (start (match-beginning (nth 1 entry)))
7720                    (end (match-end (nth 1 entry)))
7721                    (form (nth 2 entry)))
7722               (goto-char (match-end 0))
7723               (when (eval form)
7724                 (gnus-article-add-button
7725                  start end (nth 3 entry)
7726                  (buffer-substring (match-beginning (nth 4 entry))
7727                                    (match-end (nth 4 entry)))))))
7728           (goto-char end))))))
7729
7730 ;;; External functions:
7731
7732 (defun gnus-article-add-button (from to fun &optional data)
7733   "Create a button between FROM and TO with callback FUN and data DATA."
7734   (when gnus-article-button-face
7735     (gnus-overlay-put (gnus-make-overlay from to nil t)
7736                       'face gnus-article-button-face))
7737   (gnus-add-text-properties
7738    from to
7739    (nconc (and gnus-article-mouse-face
7740                (list gnus-mouse-face-prop gnus-article-mouse-face))
7741           (list 'gnus-callback fun)
7742           (and data (list 'gnus-data data))))
7743   (widget-convert-button 'link from to :action 'gnus-widget-press-button
7744                          :button-keymap gnus-widget-button-keymap))
7745
7746 ;;; Internal functions:
7747
7748 (defun gnus-article-set-globals ()
7749   (with-current-buffer gnus-summary-buffer
7750     (gnus-set-global-variables)))
7751
7752 (defun gnus-signature-toggle (end)
7753   (gnus-with-article-buffer
7754     (let ((inhibit-point-motion-hooks t))
7755       (if (text-property-any end (point-max) 'article-type 'signature)
7756           (progn
7757             (gnus-delete-wash-type 'signature)
7758             (gnus-remove-text-properties-when
7759              'article-type 'signature end (point-max)
7760              (cons 'article-type (cons 'signature
7761                                        gnus-hidden-properties))))
7762         (gnus-add-wash-type 'signature)
7763         (gnus-add-text-properties-when
7764          'article-type nil end (point-max)
7765          (cons 'article-type (cons 'signature
7766                                    gnus-hidden-properties)))))
7767     (let ((gnus-article-mime-handle-alist-1 gnus-article-mime-handle-alist))
7768       (gnus-set-mode-line 'article))))
7769
7770 (defun gnus-button-entry ()
7771   ;; Return the first entry in `gnus-button-alist' matching this place.
7772   (let ((alist gnus-button-alist)
7773         (entry nil))
7774     (while alist
7775       (setq entry (pop alist))
7776       (if (looking-at (eval (car entry)))
7777           (setq alist nil)
7778         (setq entry nil)))
7779     entry))
7780
7781 (defun gnus-button-push (marker)
7782   ;; Push button starting at MARKER.
7783   (save-excursion
7784     (goto-char marker)
7785     (let* ((entry (gnus-button-entry))
7786            (inhibit-point-motion-hooks t)
7787            (fun (nth 3 entry))
7788            (args (or (and (eq (car entry) 'gnus-button-url-regexp)
7789                           (get-char-property marker 'gnus-button-url))
7790                      (mapcar (lambda (group)
7791                                (let ((string (match-string group)))
7792                                  (set-text-properties
7793                                   0 (length string) nil string)
7794                                  string))
7795                              (nthcdr 4 entry)))))
7796       (cond
7797        ((fboundp fun)
7798         (apply fun args))
7799        ((and (boundp fun)
7800              (fboundp (symbol-value fun)))
7801         (apply (symbol-value fun) args))
7802        (t
7803         (gnus-message 1 "You must define `%S' to use this button"
7804                       (cons fun args)))))))
7805
7806 (defun gnus-parse-news-url (url)
7807   (let (scheme server port group message-id articles)
7808     (with-temp-buffer
7809       (insert url)
7810       (goto-char (point-min))
7811       (when (looking-at "\\([A-Za-z]+\\):")
7812         (setq scheme (match-string 1))
7813         (goto-char (match-end 0)))
7814       (when (looking-at "//\\([^:/]+\\)\\(:?\\)\\([0-9]+\\)?/")
7815         (setq server (match-string 1))
7816         (setq port (if (stringp (match-string 3))
7817                        (string-to-number (match-string 3))
7818                      (match-string 3)))
7819         (goto-char (match-end 0)))
7820
7821       (cond
7822        ((looking-at "\\(.*@.*\\)")
7823         (setq message-id (match-string 1)))
7824        ((looking-at "\\([^/]+\\)/\\([-0-9]+\\)")
7825         (setq group (match-string 1)
7826               articles (split-string (match-string 2) "-")))
7827        ((looking-at "\\([^/]+\\)/?")
7828         (setq group (match-string 1)))
7829        (t
7830         (error "Unknown news URL syntax"))))
7831     (list scheme server port group message-id articles)))
7832
7833 (defun gnus-button-handle-news (url)
7834   "Fetch a news URL."
7835   (destructuring-bind (scheme server port group message-id articles)
7836       (gnus-parse-news-url url)
7837     (cond
7838      (message-id
7839       (with-current-buffer gnus-summary-buffer
7840         (if server
7841             (let ((gnus-refer-article-method
7842                    (nconc (list (list 'nntp server))
7843                           gnus-refer-article-method))
7844                   (nntp-port-number (or port "nntp")))
7845               (gnus-message 7 "Fetching %s with %s"
7846                             message-id gnus-refer-article-method)
7847               (gnus-summary-refer-article message-id))
7848           (gnus-summary-refer-article message-id))))
7849      (group
7850       (gnus-button-fetch-group url)))))
7851
7852 (defun gnus-button-patch (library line)
7853   "Visit an Emacs Lisp library LIBRARY on line LINE."
7854   (interactive)
7855   (let ((file (locate-library (file-name-nondirectory library))))
7856     (unless file
7857       (error "Couldn't find library %s" library))
7858     (find-file file)
7859     (goto-line (string-to-number line))))
7860
7861 (defun gnus-button-handle-man (url)
7862   "Fetch a man page."
7863   (gnus-message 9 "`%s' `%s'" gnus-button-man-handler url)
7864   (when (eq gnus-button-man-handler 'woman)
7865     (setq url (gnus-replace-in-string url "([1-9][X1a-z]*).*\\'" "")))
7866   (gnus-message 9 "`%s' `%s'" gnus-button-man-handler url)
7867   (funcall gnus-button-man-handler url))
7868
7869 (defun gnus-button-handle-info-url (url)
7870   "Fetch an info URL."
7871   (setq url (mm-subst-char-in-string ?+ ?\  url))
7872   (cond
7873    ((string-match "^\\([^:/]+\\)?/\\(.*\\)" url)
7874     (gnus-info-find-node
7875      (concat "(" (or (gnus-url-unhex-string (match-string 1 url))
7876                      "Gnus")
7877              ")" (gnus-url-unhex-string (match-string 2 url)))))
7878    ((string-match "([^)\"]+)[^\"]+" url)
7879     (setq url
7880           (gnus-replace-in-string
7881            (gnus-replace-in-string url "[\n\t ]+" " ") "\"" ""))
7882     (gnus-info-find-node url))
7883    (t (error "Can't parse %s" url))))
7884
7885 (defun gnus-button-handle-info-url-gnome (url)
7886   "Fetch GNOME style info URL."
7887   (setq url (mm-subst-char-in-string ?_ ?\  url))
7888   (if (string-match "\\([^#]+\\)#?\\(.*\\)" url)
7889       (gnus-info-find-node
7890        (concat "("
7891                (gnus-url-unhex-string
7892                  (match-string 1 url))
7893                ")"
7894                (or (gnus-url-unhex-string
7895                     (match-string 2 url))
7896                    "Top")))
7897     (error "Can't parse %s" url)))
7898
7899 (defun gnus-button-handle-info-url-kde (url)
7900   "Fetch KDE style info URL."
7901   (gnus-info-find-node (gnus-url-unhex-string url)))
7902
7903 ;; (info) will autoload info.el
7904 (declare-function Info-menu "info" (menu-item &optional fork))
7905 (declare-function Info-index-next "info" (num))
7906
7907 (defun gnus-button-handle-info-keystrokes (url)
7908   "Call `info' when pushing the corresponding URL button."
7909   ;; For links like `C-h i d m gnus RET part RET , ,', `C-h i d m CC Mode RET'.
7910   (let (node indx comma)
7911     (if (string-match
7912          (concat "\\b\\(C-h\\|<?[Ff]1>?\\)[ \t\n]+i[ \t\n]+d?[ \t\n]?m[ \t\n]+"
7913                  "\\([^ ]+ ?[^ ]+\\)[ \t\n]+RET"
7914                  "\\([ \t\n]+i[ \t\n]+[^ ]+ ?[^ ]+[ \t\n]+RET"
7915                  "\\(?:[ \t\n,]*\\)\\)?")
7916          url)
7917         (setq node (match-string 2 url)
7918               indx (match-string 3 url))
7919       (error "Can't parse %s" url))
7920     (info)
7921     (Info-directory)
7922     (Info-menu node)
7923     (when (> (length indx) 0)
7924       (string-match (concat "[ \t\n]+i[ \t\n]+\\([^ ]+ ?[^ ]+\\)[ \t\n]+RET"
7925                             "\\([ \t\n,]*\\)")
7926                     indx)
7927       (setq comma (match-string 2 indx))
7928       (setq indx  (match-string 1 indx))
7929       (Info-index indx)
7930       (when comma
7931         (dotimes (i (with-temp-buffer
7932                       (insert comma)
7933                       ;; Note: the XEmacs version of `how-many' takes
7934                       ;; no optional argument.
7935                       (goto-char (point-min))
7936                       (how-many ",")))
7937           (Info-index-next 1)))
7938       nil)))
7939
7940 ;; Called after pgg-snarf-keys-region, which autoloads pgg.el.
7941 (declare-function pgg-display-output-buffer "pgg" (start end status))
7942
7943 (defun gnus-button-openpgp (url)
7944   "Retrieve and add an OpenPGP key given URL from an OpenPGP header."
7945   (with-temp-buffer
7946     (mm-url-insert-file-contents-external url)
7947     (pgg-snarf-keys-region (point-min) (point-max))
7948     (pgg-display-output-buffer nil nil nil)))
7949
7950 (defun gnus-button-message-id (message-id)
7951   "Fetch MESSAGE-ID."
7952   (with-current-buffer gnus-summary-buffer
7953     (gnus-summary-refer-article message-id)))
7954
7955 (defun gnus-button-fetch-group (address &rest ignore)
7956   "Fetch GROUP specified by ADDRESS."
7957   (when (string-match "\\`\\(nntp\\|news\\):\\(//\\)?\\(.*\\)\\'"
7958                       address)
7959     ;; Allow to use `gnus-button-fetch-group' in `browse-url-browser-function'
7960     ;; for nntp:// and news://
7961     (setq address (match-string 3 address)))
7962   (if (not (string-match "[:/]" address))
7963       ;; This is just a simple group url.
7964       (gnus-group-read-ephemeral-group address gnus-select-method)
7965     (if (not
7966          (string-match
7967           "^\\([^:/]+\\)\\(:\\([^/]+\\)\\)?/\\([^/]+\\)\\(/\\([0-9]+\\)\\)?"
7968           address))
7969         (error "Can't parse %s" address)
7970       (gnus-group-read-ephemeral-group
7971        (match-string 4 address)
7972        `(nntp ,(match-string 1 address)
7973               (nntp-address ,(match-string 1 address))
7974               (nntp-port-number ,(if (match-end 3)
7975                                      (match-string 3 address)
7976                                    "nntp")))
7977        nil nil nil
7978        (and (match-end 6) (list (string-to-number (match-string 6 address))))))))
7979
7980 (defun gnus-url-parse-query-string (query &optional downcase)
7981   (let (retval pairs cur key val)
7982     (setq pairs (split-string query "&"))
7983     (while pairs
7984       (setq cur (car pairs)
7985             pairs (cdr pairs))
7986       (if (not (string-match "=" cur))
7987           nil                           ; Grace
7988         (setq key (gnus-url-unhex-string (substring cur 0 (match-beginning 0)))
7989               val (gnus-url-unhex-string (substring cur (match-end 0) nil) t))
7990         (if downcase
7991             (setq key (downcase key)))
7992         (setq cur (assoc key retval))
7993         (if cur
7994             (setcdr cur (cons val (cdr cur)))
7995           (setq retval (cons (list key val) retval)))))
7996     retval))
7997
7998 (defun gnus-url-mailto (url)
7999   ;; Send mail to someone
8000   (when (string-match "mailto:/*\\(.*\\)" url)
8001     (setq url (substring url (match-beginning 1) nil)))
8002   (let (to args subject func)
8003     (setq args (gnus-url-parse-query-string
8004                 (if (string-match "^\\?" url)
8005                     (substring url 1)
8006                   (if (string-match "^\\([^?]+\\)\\?\\(.*\\)" url)
8007                       (concat "to=" (match-string 1 url) "&"
8008                               (match-string 2 url))
8009                     (concat "to=" url)))
8010                 t)
8011           subject (cdr-safe (assoc "subject" args)))
8012     (gnus-msg-mail)
8013     (while args
8014       (setq func (intern-soft (concat "message-goto-" (downcase (caar args)))))
8015       (if (fboundp func)
8016           (funcall func)
8017         (message-position-on-field (caar args)))
8018       (insert (gnus-replace-in-string
8019                (mapconcat 'identity (reverse (cdar args)) ", ")
8020                "\r\n" "\n" t))
8021       (setq args (cdr args)))
8022     (if subject
8023         (message-goto-body)
8024       (message-goto-subject))))
8025
8026 (defun gnus-button-embedded-url (address)
8027   "Activate ADDRESS with `browse-url'."
8028   (browse-url (gnus-strip-whitespace address)))
8029
8030 ;;; Next/prev buttons in the article buffer.
8031
8032 (defvar gnus-next-page-line-format "%{%(Next page...%)%}\n")
8033 (defvar gnus-prev-page-line-format "%{%(Previous page...%)%}\n")
8034
8035 (defvar gnus-prev-page-map
8036   (let ((map (make-sparse-keymap)))
8037     (define-key map gnus-mouse-2 'gnus-button-prev-page)
8038     (define-key map "\r" 'gnus-button-prev-page)
8039     map))
8040
8041 (defvar gnus-next-page-map
8042   (let ((map (make-sparse-keymap)))
8043     (unless (>= emacs-major-version 21)
8044       ;; XEmacs doesn't care.
8045       (set-keymap-parent map gnus-article-mode-map))
8046     (define-key map gnus-mouse-2 'gnus-button-next-page)
8047     (define-key map "\r" 'gnus-button-next-page)
8048     map))
8049
8050 (defun gnus-insert-prev-page-button ()
8051   (let ((b (point)) e
8052         (inhibit-read-only t))
8053     (gnus-eval-format
8054      gnus-prev-page-line-format nil
8055      `(keymap ,gnus-prev-page-map
8056               gnus-prev t
8057               gnus-callback gnus-article-button-prev-page
8058               article-type annotation))
8059     (setq e (if (bolp)
8060                 ;; Exclude a newline.
8061                 (1- (point))
8062               (point)))
8063     (when gnus-article-button-face
8064       (gnus-overlay-put (gnus-make-overlay b e nil t)
8065                         'face gnus-article-button-face))
8066     (widget-convert-button
8067      'link b e
8068      :action 'gnus-button-prev-page
8069      :button-keymap gnus-prev-page-map)))
8070
8071 (defun gnus-button-next-page (&optional args more-args)
8072   "Go to the next page."
8073   (interactive)
8074   (let ((win (selected-window)))
8075     (select-window (gnus-get-buffer-window gnus-article-buffer t))
8076     (gnus-article-next-page)
8077     (select-window win)))
8078
8079 (defun gnus-button-prev-page (&optional args more-args)
8080   "Go to the prev page."
8081   (interactive)
8082   (let ((win (selected-window)))
8083     (select-window (gnus-get-buffer-window gnus-article-buffer t))
8084     (gnus-article-prev-page)
8085     (select-window win)))
8086
8087 (defun gnus-insert-next-page-button ()
8088   (let ((b (point)) e
8089         (inhibit-read-only t))
8090     (gnus-eval-format gnus-next-page-line-format nil
8091                       `(keymap ,gnus-next-page-map
8092                                gnus-next t
8093                                gnus-callback gnus-article-button-next-page
8094                                article-type annotation))
8095     (setq e (if (bolp)
8096                 ;; Exclude a newline.
8097                 (1- (point))
8098               (point)))
8099     (when gnus-article-button-face
8100       (gnus-overlay-put (gnus-make-overlay b e nil t)
8101                         'face gnus-article-button-face))
8102     (widget-convert-button
8103      'link b e
8104      :action 'gnus-button-next-page
8105      :button-keymap gnus-next-page-map)))
8106
8107 (defun gnus-article-button-next-page (arg)
8108   "Go to the next page."
8109   (interactive "P")
8110   (let ((win (selected-window)))
8111     (select-window (gnus-get-buffer-window gnus-article-buffer t))
8112     (gnus-article-next-page)
8113     (select-window win)))
8114
8115 (defun gnus-article-button-prev-page (arg)
8116   "Go to the prev page."
8117   (interactive "P")
8118   (let ((win (selected-window)))
8119     (select-window (gnus-get-buffer-window gnus-article-buffer t))
8120     (gnus-article-prev-page)
8121     (select-window win)))
8122
8123 (defvar gnus-decode-header-methods
8124   '(mail-decode-encoded-word-region)
8125   "List of methods used to decode headers.
8126
8127 This variable is a list of FUNCTION or (REGEXP . FUNCTION).  If item
8128 is FUNCTION, FUNCTION will be applied to all newsgroups.  If item is a
8129 \(REGEXP . FUNCTION), FUNCTION will be only apply to the newsgroups
8130 whose names match REGEXP.
8131
8132 For example:
8133 \((\"chinese\" . gnus-decode-encoded-word-region-by-guess)
8134  mail-decode-encoded-word-region
8135  (\"chinese\" . rfc1843-decode-region))
8136 ")
8137
8138 (defvar gnus-decode-header-methods-cache nil)
8139
8140 (defun gnus-multi-decode-header (start end)
8141   "Apply the functions from `gnus-encoded-word-methods' that match."
8142   (unless (and gnus-decode-header-methods-cache
8143                (eq gnus-newsgroup-name
8144                    (car gnus-decode-header-methods-cache)))
8145     (setq gnus-decode-header-methods-cache (list gnus-newsgroup-name))
8146     (dolist (x gnus-decode-header-methods)
8147       (if (symbolp x)
8148           (nconc gnus-decode-header-methods-cache (list x))
8149         (if (and gnus-newsgroup-name
8150                  (string-match (car x) gnus-newsgroup-name))
8151             (nconc gnus-decode-header-methods-cache
8152                    (list (cdr x)))))))
8153   (let ((xlist gnus-decode-header-methods-cache))
8154     (pop xlist)
8155     (save-restriction
8156       (narrow-to-region start end)
8157       (while xlist
8158         (funcall (pop xlist) (point-min) (point-max))))))
8159
8160 ;;;
8161 ;;; Treatment top-level handling.
8162 ;;;
8163
8164 (defun gnus-treat-article (condition &optional part-number total-parts type)
8165   (let ((length (- (point-max) (point-min)))
8166         (alist gnus-treatment-function-alist)
8167         (article-goto-body-goes-to-point-min-p t)
8168         (treated-type
8169          (or (not type)
8170              (catch 'found
8171                (let ((list gnus-article-treat-types))
8172                  (while list
8173                    (when (string-match (pop list) type)
8174                      (throw 'found t)))))))
8175         (highlightp (gnus-visual-p 'article-highlight 'highlight))
8176         val elem)
8177     (gnus-run-hooks 'gnus-part-display-hook)
8178     (dolist (elem alist)
8179       (setq val
8180             (save-excursion
8181               (when (gnus-buffer-live-p gnus-summary-buffer)
8182                 (set-buffer gnus-summary-buffer))
8183               (symbol-value (car elem))))
8184       (when (and (or (consp val)
8185                      treated-type)
8186                  (gnus-treat-predicate val)
8187                  (or (not (get (car elem) 'highlight))
8188                      highlightp))
8189         (save-restriction
8190           (funcall (cadr elem)))))))
8191
8192 ;; Dynamic variables.
8193 (defvar part-number)
8194 (defvar total-parts)
8195 (defvar type)
8196 (defvar condition)
8197 (defvar length)
8198
8199 (defun gnus-treat-predicate (val)
8200   (cond
8201    ((null val)
8202     nil)
8203    (condition
8204     (eq condition val))
8205    ((and (listp val)
8206          (stringp (car val)))
8207     (apply 'gnus-or (mapcar `(lambda (s)
8208                                (string-match s ,(or gnus-newsgroup-name "")))
8209                             val)))
8210    ((listp val)
8211     (let ((pred (pop val)))
8212       (cond
8213        ((eq pred 'or)
8214         (apply 'gnus-or (mapcar 'gnus-treat-predicate val)))
8215        ((eq pred 'and)
8216         (apply 'gnus-and (mapcar 'gnus-treat-predicate val)))
8217        ((eq pred 'not)
8218         (not (gnus-treat-predicate (car val))))
8219        ((eq pred 'typep)
8220         (equal (car val) type))
8221        (t
8222         (error "%S is not a valid predicate" pred)))))
8223    ((eq val t)
8224     t)
8225    ((eq val 'head)
8226     nil)
8227    ((eq val 'first)
8228     (eq part-number 1))
8229    ((eq val 'last)
8230     (eq part-number total-parts))
8231    ((numberp val)
8232     (< length val))
8233    (t
8234     (error "%S is not a valid value" val))))
8235
8236 (defun gnus-article-encrypt-body (protocol &optional n)
8237   "Encrypt the article body."
8238   (interactive
8239    (list
8240     (or gnus-article-encrypt-protocol
8241         (completing-read "Encrypt protocol: "
8242                          gnus-article-encrypt-protocol-alist
8243                          nil t))
8244     current-prefix-arg))
8245   ;; User might hit `K E' instead of `K e', so prompt once.
8246   (when (and gnus-article-encrypt-protocol
8247              gnus-novice-user)
8248     (unless (gnus-y-or-n-p "Really encrypt article(s)? ")
8249       (error "Encrypt aborted.")))
8250   (let ((func (cdr (assoc protocol gnus-article-encrypt-protocol-alist))))
8251     (unless func
8252       (error "Can't find the encrypt protocol %s" protocol))
8253     (if (member gnus-newsgroup-name '("nndraft:delayed"
8254                                       "nndraft:drafts"
8255                                       "nndraft:queue"))
8256         (error "Can't encrypt the article in group %s"
8257                gnus-newsgroup-name))
8258     (gnus-summary-iterate n
8259       (with-current-buffer gnus-summary-buffer
8260         (let ((mail-parse-charset gnus-newsgroup-charset)
8261               (mail-parse-ignored-charsets gnus-newsgroup-ignored-charsets)
8262               (summary-buffer gnus-summary-buffer)
8263               references point)
8264           (gnus-set-global-variables)
8265           (when (gnus-group-read-only-p)
8266             (error "The current newsgroup does not support article encrypt"))
8267           (gnus-summary-show-article t)
8268           (setq references
8269               (or (mail-header-references gnus-current-headers) ""))
8270           (set-buffer gnus-article-buffer)
8271           (let* ((inhibit-read-only t)
8272                  (headers
8273                   (mapcar (lambda (field)
8274                             (and (save-restriction
8275                                    (message-narrow-to-head)
8276                                    (goto-char (point-min))
8277                                    (search-forward field nil t))
8278                                  (prog2
8279                                      (message-narrow-to-field)
8280                                      (buffer-string)
8281                                    (delete-region (point-min) (point-max))
8282                                    (widen))))
8283                           '("Content-Type:" "Content-Transfer-Encoding:"
8284                             "Content-Disposition:"))))
8285             (message-narrow-to-head)
8286             (message-remove-header "MIME-Version")
8287             (goto-char (point-max))
8288             (setq point (point))
8289             (insert (apply 'concat headers))
8290             (widen)
8291             (narrow-to-region point (point-max))
8292             (let ((message-options message-options))
8293               (message-options-set 'message-sender user-mail-address)
8294               (message-options-set 'message-recipients user-mail-address)
8295               (message-options-set 'message-sign-encrypt 'not)
8296               (funcall func))
8297             (goto-char (point-min))
8298             (insert "MIME-Version: 1.0\n")
8299             (widen)
8300             (gnus-summary-edit-article-done
8301              references nil summary-buffer t))
8302           (when gnus-keep-backlog
8303             (gnus-backlog-remove-article
8304              (car gnus-article-current) (cdr gnus-article-current)))
8305           (when (get-buffer gnus-original-article-buffer)
8306             (with-current-buffer gnus-original-article-buffer
8307               (setq gnus-original-article nil)))
8308           (when gnus-use-cache
8309             (gnus-cache-update-article
8310              (car gnus-article-current) (cdr gnus-article-current))))))))
8311
8312 (defvar gnus-mime-security-button-line-format "%{%([[%t:%i]%D]%)%}\n"
8313   "The following specs can be used:
8314 %t  The security MIME type
8315 %i  Additional info
8316 %d  Details
8317 %D  Details if button is pressed")
8318
8319 (defvar gnus-mime-security-button-end-line-format "%{%([[End of %t]%D]%)%}\n"
8320   "The following specs can be used:
8321 %t  The security MIME type
8322 %i  Additional info
8323 %d  Details
8324 %D  Details if button is pressed")
8325
8326 (defvar gnus-mime-security-button-line-format-alist
8327   '((?t gnus-tmp-type ?s)
8328     (?i gnus-tmp-info ?s)
8329     (?d gnus-tmp-details ?s)
8330     (?D gnus-tmp-pressed-details ?s)))
8331
8332 (defvar gnus-mime-security-button-commands
8333   '((gnus-article-press-button "\r" "Show Detail")
8334     (undefined "v")
8335     (undefined "t")
8336     (undefined "C")
8337     (gnus-mime-security-save-part "o" "Save...")
8338     (undefined "\C-o")
8339     (undefined "r")
8340     (undefined "d")
8341     (undefined "c")
8342     (undefined "i")
8343     (undefined "E")
8344     (undefined "e")
8345     (undefined "p")
8346     (gnus-mime-security-pipe-part "|" "Pipe To Command...")
8347     (undefined ".")))
8348
8349 (defvar gnus-mime-security-button-map
8350   (let ((map (make-sparse-keymap)))
8351     (define-key map gnus-mouse-2 'gnus-article-push-button)
8352     (define-key map gnus-down-mouse-3 'gnus-mime-security-button-menu)
8353     (dolist (c gnus-mime-security-button-commands)
8354       (define-key map (cadr c) (car c)))
8355     map))
8356
8357 (easy-menu-define
8358   gnus-mime-security-button-menu gnus-mime-security-button-map
8359   "Security button menu."
8360   `("Security Part"
8361     ,@(delq nil
8362             (mapcar (lambda (c)
8363                       (unless (eq (car c) 'undefined)
8364                         (vector (caddr c) (car c) :active t)))
8365                     gnus-mime-security-button-commands))))
8366
8367 (defun gnus-mime-security-button-menu (event prefix)
8368   "Construct a context-sensitive menu of security commands."
8369   (interactive "e\nP")
8370   (save-window-excursion
8371     (let ((pos (event-start event)))
8372       (select-window (posn-window pos))
8373       (goto-char (posn-point pos))
8374       (gnus-article-check-buffer)
8375       (popup-menu gnus-mime-security-button-menu nil prefix))))
8376
8377 (defvar gnus-mime-security-details-buffer nil)
8378
8379 (defvar gnus-mime-security-button-pressed nil)
8380
8381 (defvar gnus-mime-security-show-details-inline t
8382   "If non-nil, show details in the article buffer.")
8383
8384 (defun gnus-mime-security-verify-or-decrypt (handle)
8385   (mm-remove-parts (cdr handle))
8386   (let ((region (mm-handle-multipart-ctl-parameter handle 'gnus-region))
8387         point (inhibit-read-only t))
8388     (if region
8389         (goto-char (car region)))
8390     (setq point (point))
8391     (with-current-buffer (mm-handle-multipart-original-buffer handle)
8392       (let* ((mm-verify-option 'known)
8393              (mm-decrypt-option 'known)
8394              (nparts (mm-possibly-verify-or-decrypt (cdr handle) handle)))
8395         (unless (eq nparts (cdr handle))
8396           (mm-destroy-parts (cdr handle))
8397           (setcdr handle nparts))))
8398     (gnus-mime-display-security handle)
8399     (when region
8400       (delete-region (point) (cdr region))
8401       (set-marker (car region) nil)
8402       (set-marker (cdr region) nil))
8403     (goto-char point)))
8404
8405 (defun gnus-mime-security-show-details (handle)
8406   (let ((details (mm-handle-multipart-ctl-parameter handle 'gnus-details)))
8407     (if (not details)
8408         (gnus-message 5 "No details.")
8409       (if gnus-mime-security-show-details-inline
8410           (let ((gnus-mime-security-button-pressed
8411                  (not (get-text-property (point) 'gnus-mime-details)))
8412                 (gnus-mime-security-button-line-format
8413                  (get-text-property (point) 'gnus-line-format))
8414                 (inhibit-read-only t))
8415             (forward-char -1)
8416             (while (eq (get-text-property (point) 'gnus-line-format)
8417                        gnus-mime-security-button-line-format)
8418               (forward-char -1))
8419             (forward-char)
8420             (save-restriction
8421               (narrow-to-region (point) (point))
8422               (gnus-insert-mime-security-button handle))
8423             (delete-region (point)
8424                            (or (text-property-not-all
8425                                 (point) (point-max)
8426                                 'gnus-line-format
8427                                 gnus-mime-security-button-line-format)
8428                                (point-max))))
8429         ;; Not inlined.
8430         (if (gnus-buffer-live-p gnus-mime-security-details-buffer)
8431             (with-current-buffer gnus-mime-security-details-buffer
8432               (erase-buffer)
8433               t)
8434           (setq gnus-mime-security-details-buffer
8435                 (gnus-get-buffer-create "*MIME Security Details*")))
8436         (with-current-buffer gnus-mime-security-details-buffer
8437           (insert details)
8438           (goto-char (point-min)))
8439         (pop-to-buffer gnus-mime-security-details-buffer)))))
8440
8441 (defun gnus-mime-security-press-button (handle)
8442   (save-excursion
8443     (if (mm-handle-multipart-ctl-parameter handle 'gnus-info)
8444         (gnus-mime-security-show-details handle)
8445       (gnus-mime-security-verify-or-decrypt handle))))
8446
8447 (defun gnus-insert-mime-security-button (handle &optional displayed)
8448   (let* ((protocol (mm-handle-multipart-ctl-parameter handle 'protocol))
8449          (gnus-tmp-type
8450           (concat
8451            (or (nth 2 (assoc protocol mm-verify-function-alist))
8452                (nth 2 (assoc protocol mm-decrypt-function-alist))
8453                "Unknown")
8454            (if (equal (car handle) "multipart/signed")
8455                " Signed" " Encrypted")
8456            " Part"))
8457          (gnus-tmp-info
8458           (or (mm-handle-multipart-ctl-parameter handle 'gnus-info)
8459               "Undecided"))
8460          (gnus-tmp-details
8461           (mm-handle-multipart-ctl-parameter handle 'gnus-details))
8462          gnus-tmp-pressed-details
8463          b e)
8464     (setq gnus-tmp-details
8465           (if gnus-tmp-details
8466               (concat "\n" gnus-tmp-details)
8467             ""))
8468     (setq gnus-tmp-pressed-details
8469           (if gnus-mime-security-button-pressed gnus-tmp-details ""))
8470     (unless (bolp)
8471       (insert "\n"))
8472     (setq b (point))
8473     (gnus-eval-format
8474      gnus-mime-security-button-line-format
8475      gnus-mime-security-button-line-format-alist
8476      `(keymap ,gnus-mime-security-button-map
8477          gnus-callback gnus-mime-security-press-button
8478          gnus-line-format ,gnus-mime-security-button-line-format
8479          gnus-mime-details ,gnus-mime-security-button-pressed
8480          article-type annotation
8481          gnus-data ,handle))
8482     (setq e (if (bolp)
8483                 ;; Exclude a newline.
8484                 (1- (point))
8485               (point)))
8486     (when gnus-article-button-face
8487       (gnus-overlay-put (gnus-make-overlay b e nil t)
8488                         'face gnus-article-button-face))
8489     (widget-convert-button
8490      'link b e
8491      :mime-handle handle
8492      :action 'gnus-widget-press-button
8493      :button-keymap gnus-mime-security-button-map
8494      :help-echo
8495      (lambda (widget/window &optional overlay pos)
8496        ;; Needed to properly clear the message due to a bug in
8497        ;; wid-edit (XEmacs only).
8498        (when (boundp 'help-echo-owns-message)
8499          (setq help-echo-owns-message t))
8500        (format
8501         "%S: show detail; %S: more options"
8502         (aref gnus-mouse-2 0)
8503         (aref gnus-down-mouse-3 0))))))
8504
8505 (defun gnus-mime-display-security (handle)
8506   (save-restriction
8507     (narrow-to-region (point) (point))
8508     (unless (gnus-unbuttonized-mime-type-p (car handle))
8509       (gnus-insert-mime-security-button handle))
8510     (gnus-mime-display-part (cadr handle))
8511     (unless (bolp)
8512       (insert "\n"))
8513     (unless (gnus-unbuttonized-mime-type-p (car handle))
8514       (let ((gnus-mime-security-button-line-format
8515              gnus-mime-security-button-end-line-format))
8516         (gnus-insert-mime-security-button handle)))
8517     (mm-set-handle-multipart-parameter
8518      handle 'gnus-region
8519      (cons (set-marker (make-marker) (point-min))
8520            (set-marker (make-marker) (point-max))))
8521     (goto-char (point-max))))
8522
8523 (defun gnus-mime-security-run-function (function)
8524   "Run FUNCTION with the security part under point."
8525   (gnus-article-check-buffer)
8526   (let ((data (get-text-property (point) 'gnus-data))
8527         buffer handle)
8528     (when (and (stringp (car-safe data))
8529                (setq buffer (mm-handle-multipart-original-buffer data))
8530                (setq handle (cadr data)))
8531       (if (bufferp (mm-handle-buffer handle))
8532           (progn
8533             (setq handle (cons buffer (copy-sequence (cdr handle))))
8534             (mm-handle-set-undisplayer handle nil))
8535         (setq handle (mm-make-handle
8536                       buffer
8537                       (mm-handle-multipart-ctl-parameter handle 'protocol)
8538                       nil nil nil nil nil nil)))
8539       (funcall function handle))))
8540
8541 (defun gnus-mime-security-save-part ()
8542   "Save the security part under point."
8543   (interactive)
8544   (gnus-mime-security-run-function 'mm-save-part))
8545
8546 (defun gnus-mime-security-pipe-part ()
8547   "Pipe the security part under point to a process."
8548   (interactive)
8549   (gnus-mime-security-run-function 'mm-pipe-part))
8550
8551 (gnus-ems-redefine)
8552
8553 (provide 'gnus-art)
8554
8555 (run-hooks 'gnus-art-load-hook)
8556
8557 ;; arch-tag: 2654516f-6279-48f9-a83b-05c1fa450c33
8558 ;;; gnus-art.el ends here