lisp/gnus/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           ;; Ignore group parameter.  See `article-hide-headers'.
3719           (gnus-summary-buffer nil))
3720       (with-current-buffer save-buffer
3721         (article-hide-headers 1 t))))
3722   (save-window-excursion
3723     (if (not gnus-default-article-saver)
3724         (error "No default saver is defined")
3725       ;; !!! Magic!  The saving functions all save
3726       ;; `gnus-save-article-buffer' (or so they think), but we
3727       ;; bind that variable to our save-buffer.
3728       (set-buffer gnus-article-buffer)
3729       (let* ((gnus-save-article-buffer save-buffer)
3730              (filename
3731               (cond
3732                ((not gnus-prompt-before-saving) 'default)
3733                ((eq gnus-prompt-before-saving 'always) nil)
3734                (t file)))
3735              (gnus-number-of-articles-to-be-saved
3736               (when (eq gnus-prompt-before-saving t)
3737                 num)))                  ; Magic
3738         (set-buffer gnus-article-current-summary)
3739         (funcall gnus-default-article-saver filename)))))
3740
3741 (defun gnus-read-save-file-name (prompt &optional filename
3742                                         function group headers variable
3743                                         dir-var)
3744   (let ((default-name
3745           (funcall function group headers (symbol-value variable)))
3746         result)
3747     (setq result
3748           (expand-file-name
3749            (cond
3750             ((eq filename 'default)
3751              default-name)
3752             ((eq filename t)
3753              default-name)
3754             (filename filename)
3755             (t
3756              (when (symbol-value dir-var)
3757                (setq default-name (expand-file-name
3758                                    (file-name-nondirectory default-name)
3759                                    (symbol-value dir-var))))
3760              (let* ((split-name (gnus-get-split-value gnus-split-methods))
3761                     (prompt
3762                      (format prompt
3763                              (if (and gnus-number-of-articles-to-be-saved
3764                                       (> gnus-number-of-articles-to-be-saved 1))
3765                                  (format "these %d articles"
3766                                          gnus-number-of-articles-to-be-saved)
3767                                "this article")))
3768                     (file
3769                      ;; Let the split methods have their say.
3770                      (cond
3771                       ;; No split name was found.
3772                       ((null split-name)
3773                        (read-file-name
3774                         (concat prompt " (default "
3775                                 (file-name-nondirectory default-name) "): ")
3776                         (file-name-directory default-name)
3777                         default-name))
3778                       ;; A single group name is returned.
3779                       ((stringp split-name)
3780                        (setq default-name
3781                              (funcall function split-name headers
3782                                       (symbol-value variable)))
3783                        (read-file-name
3784                         (concat prompt " (default "
3785                                 (file-name-nondirectory default-name) "): ")
3786                         (file-name-directory default-name)
3787                         default-name))
3788                       ;; A single split name was found
3789                       ((= 1 (length split-name))
3790                        (let* ((name (expand-file-name
3791                                      (car split-name)
3792                                      gnus-article-save-directory))
3793                               (dir (cond ((file-directory-p name)
3794                                           (file-name-as-directory name))
3795                                          ((file-exists-p name) name)
3796                                          (t gnus-article-save-directory))))
3797                          (read-file-name
3798                           (concat prompt " (default " name "): ")
3799                           dir name)))
3800                       ;; A list of splits was found.
3801                       (t
3802                        (setq split-name (nreverse split-name))
3803                        (let (result)
3804                          (let ((file-name-history
3805                                 (nconc split-name file-name-history)))
3806                            (setq result
3807                                  (expand-file-name
3808                                   (read-file-name
3809                                    (concat prompt " (`M-p' for defaults): ")
3810                                    gnus-article-save-directory
3811                                    (car split-name))
3812                                   gnus-article-save-directory)))
3813                          (car (push result file-name-history)))))))
3814                ;; Create the directory.
3815                (gnus-make-directory (file-name-directory file))
3816                ;; If we have read a directory, we append the default file name.
3817                (when (file-directory-p file)
3818                  (setq file (expand-file-name (file-name-nondirectory
3819                                                default-name)
3820                                               (file-name-as-directory file))))
3821                ;; Possibly translate some characters.
3822                (nnheader-translate-file-chars file))))))
3823     (gnus-make-directory (file-name-directory result))
3824     (when variable
3825       (set variable result))
3826     (when dir-var
3827       (set dir-var (file-name-directory result)))
3828     result))
3829
3830 (defun gnus-article-archive-name (group)
3831   "Return the first instance of an \"Archive-name\" in the current buffer."
3832   (let ((case-fold-search t))
3833     (when (re-search-forward "archive-name: *\\([^ \n\t]+\\)[ \t]*$" nil t)
3834       (nnheader-concat gnus-article-save-directory
3835                        (match-string 1)))))
3836
3837 (defun gnus-article-nndoc-name (group)
3838   "If GROUP is an nndoc group, return the name of the parent group."
3839   (when (eq (car (gnus-find-method-for-group group)) 'nndoc)
3840     (gnus-group-get-parameter group 'save-article-group)))
3841
3842 (defun gnus-summary-save-in-rmail (&optional filename)
3843   "Append this article to Rmail file.
3844 Optional argument FILENAME specifies file name.
3845 Directory to save to is default to `gnus-article-save-directory'."
3846   (setq filename (gnus-read-save-file-name
3847                   "Save %s in rmail file" filename
3848                   gnus-rmail-save-name gnus-newsgroup-name
3849                   gnus-current-headers 'gnus-newsgroup-last-rmail))
3850   (gnus-eval-in-buffer-window gnus-save-article-buffer
3851     (save-excursion
3852       (save-restriction
3853         (widen)
3854         (gnus-output-to-rmail filename))))
3855   filename)
3856
3857 (defun gnus-summary-save-in-mail (&optional filename)
3858   "Append this article to Unix mail file.
3859 Optional argument FILENAME specifies file name.
3860 Directory to save to is default to `gnus-article-save-directory'."
3861   (setq filename (gnus-read-save-file-name
3862                   "Save %s in Unix mail file" filename
3863                   gnus-mail-save-name gnus-newsgroup-name
3864                   gnus-current-headers 'gnus-newsgroup-last-mail))
3865   (gnus-eval-in-buffer-window gnus-save-article-buffer
3866     (save-excursion
3867       (save-restriction
3868         (widen)
3869         (if (and (file-readable-p filename)
3870                  (file-regular-p filename)
3871                  (mail-file-babyl-p filename))
3872             (rmail-output-to-rmail-file filename t)
3873           (gnus-output-to-mail filename)))))
3874   filename)
3875
3876 (put 'gnus-summary-save-in-file :decode t)
3877 (put 'gnus-summary-save-in-file :headers 'gnus-saved-headers)
3878 (defun gnus-summary-save-in-file (&optional filename overwrite)
3879   "Append this article to file.
3880 Optional argument FILENAME specifies file name.
3881 Directory to save to is default to `gnus-article-save-directory'."
3882   (setq filename (gnus-read-save-file-name
3883                   "Save %s in file" filename
3884                   gnus-file-save-name gnus-newsgroup-name
3885                   gnus-current-headers 'gnus-newsgroup-last-file))
3886   (gnus-eval-in-buffer-window gnus-save-article-buffer
3887     (save-excursion
3888       (save-restriction
3889         (widen)
3890         (when (and overwrite
3891                    (file-exists-p filename))
3892           (delete-file filename))
3893         (gnus-output-to-file filename))))
3894   filename)
3895
3896 (put 'gnus-summary-write-to-file :decode t)
3897 (put 'gnus-summary-write-to-file :function 'gnus-summary-save-in-file)
3898 (put 'gnus-summary-write-to-file :headers 'gnus-saved-headers)
3899 (defun gnus-summary-write-to-file (&optional filename)
3900   "Write this article to a file, overwriting it if the file exists.
3901 Optional argument FILENAME specifies file name.
3902 The directory to save in defaults to `gnus-article-save-directory'."
3903   (setq filename (gnus-read-save-file-name
3904                   "Save %s in file" filename
3905                   gnus-file-save-name gnus-newsgroup-name
3906                   gnus-current-headers nil 'gnus-newsgroup-last-directory))
3907   (gnus-summary-save-in-file filename t))
3908
3909 (put 'gnus-summary-save-body-in-file :decode t)
3910 (defun gnus-summary-save-body-in-file (&optional filename overwrite)
3911   "Append this article body to a file.
3912 Optional argument FILENAME specifies file name.
3913 The directory to save in defaults to `gnus-article-save-directory'."
3914   (setq filename (gnus-read-save-file-name
3915                   "Save %s body in file" filename
3916                   gnus-file-save-name gnus-newsgroup-name
3917                   gnus-current-headers 'gnus-newsgroup-last-file))
3918   (gnus-eval-in-buffer-window gnus-save-article-buffer
3919     (save-excursion
3920       (save-restriction
3921         (widen)
3922         (when (article-goto-body)
3923           (narrow-to-region (point) (point-max)))
3924         (when (and overwrite
3925                    (file-exists-p filename))
3926           (delete-file filename))
3927         (gnus-output-to-file filename))))
3928   filename)
3929
3930 (put 'gnus-summary-write-body-to-file :decode t)
3931 (put 'gnus-summary-write-body-to-file
3932      :function 'gnus-summary-save-body-in-file)
3933 (defun gnus-summary-write-body-to-file (&optional filename)
3934   "Write this article body to a file, overwriting it if the file exists.
3935 Optional argument FILENAME specifies file name.
3936 The directory to save in defaults to `gnus-article-save-directory'."
3937   (setq filename (gnus-read-save-file-name
3938                   "Save %s body in file" filename
3939                   gnus-file-save-name gnus-newsgroup-name
3940                   gnus-current-headers nil 'gnus-newsgroup-last-directory))
3941   (gnus-summary-save-body-in-file filename t))
3942
3943 (put 'gnus-summary-save-in-pipe :decode t)
3944 (put 'gnus-summary-save-in-pipe :headers 'gnus-saved-headers)
3945 (defun gnus-summary-save-in-pipe (&optional command raw)
3946   "Pipe this article to subprocess COMMAND.
3947 Valid values for COMMAND include:
3948   a string
3949     The executable command name and possibly arguments.
3950   nil
3951     You will be prompted for the command in the minibuffer.
3952   the symbol `default'
3953     It will be replaced with the command which the variable
3954     `gnus-summary-pipe-output-default-command' holds or the command
3955     last used for saving.
3956 Non-nil value for RAW overrides `:decode' and `:headers' properties
3957 and the raw article including all headers will be piped."
3958   (let ((article (gnus-summary-article-number))
3959         (decode (unless raw
3960                   (get 'gnus-summary-save-in-pipe :decode)))
3961         save-buffer default)
3962     (if article
3963         (if (vectorp (gnus-summary-article-header article))
3964             (save-current-buffer
3965               (gnus-summary-select-article decode decode nil article)
3966               (insert-buffer-substring
3967                (prog1
3968                    (if decode
3969                        gnus-article-buffer
3970                      gnus-original-article-buffer)
3971                  (setq save-buffer
3972                        (nnheader-set-temp-buffer " *Gnus Save*"))))
3973               ;; Remove unwanted headers.
3974               (when (and (not raw)
3975                          (or (get 'gnus-summary-save-in-pipe :headers)
3976                              (not gnus-save-all-headers)))
3977                 (let ((gnus-visible-headers
3978                        (or (symbol-value (get 'gnus-summary-save-in-pipe
3979                                               :headers))
3980                            gnus-saved-headers gnus-visible-headers))
3981                       (gnus-summary-buffer nil))
3982                   (article-hide-headers 1 t))))
3983           (error "%d is not a real article" article))
3984       (error "No article to pipe"))
3985     (setq default (or gnus-summary-pipe-output-default-command
3986                       gnus-last-shell-command))
3987     (unless (stringp command)
3988       (setq command
3989             (if (and (eq command 'default) default)
3990                 default
3991               (gnus-read-shell-command "Shell command on this article: "
3992                                        default))))
3993     (when (string-equal command "")
3994       (if default
3995           (setq command default)
3996         (error "A command is required")))
3997     (gnus-eval-in-buffer-window save-buffer
3998       (save-restriction
3999         (widen)
4000         (shell-command-on-region (point-min) (point-max) command nil)))
4001     (gnus-kill-buffer save-buffer))
4002   (setq gnus-summary-pipe-output-default-command command))
4003
4004 (defun gnus-summary-pipe-to-muttprint (&optional command)
4005   "Pipe this article to muttprint."
4006   (unless (stringp command)
4007     (setq command (read-string
4008                    "Print using command: " gnus-summary-muttprint-program
4009                    nil gnus-summary-muttprint-program)))
4010   (let ((gnus-summary-pipe-output-default-command
4011          gnus-summary-pipe-output-default-command))
4012     (gnus-summary-save-in-pipe command))
4013   (setq gnus-summary-muttprint-program command))
4014
4015 ;;; Article file names when saving.
4016
4017 (defun gnus-capitalize-newsgroup (newsgroup)
4018   "Capitalize NEWSGROUP name."
4019   (when (not (zerop (length newsgroup)))
4020     (concat (char-to-string (upcase (aref newsgroup 0)))
4021             (substring newsgroup 1))))
4022
4023 (defun gnus-Numeric-save-name (newsgroup headers &optional last-file)
4024   "Generate file name from NEWSGROUP, HEADERS, and optional LAST-FILE.
4025 If variable `gnus-use-long-file-name' is non-nil, it is ~/News/News.group/num.
4026 Otherwise, it is like ~/News/news/group/num."
4027   (let ((default
4028           (expand-file-name
4029            (concat (if (gnus-use-long-file-name 'not-save)
4030                        (gnus-capitalize-newsgroup newsgroup)
4031                      (gnus-newsgroup-directory-form newsgroup))
4032                    "/" (int-to-string (mail-header-number headers)))
4033            gnus-article-save-directory)))
4034     (if (and last-file
4035              (string-equal (file-name-directory default)
4036                            (file-name-directory last-file))
4037              (string-match "^[0-9]+$" (file-name-nondirectory last-file)))
4038         default
4039       (or last-file default))))
4040
4041 (defun gnus-numeric-save-name (newsgroup headers &optional last-file)
4042   "Generate file name from NEWSGROUP, HEADERS, and optional LAST-FILE.
4043 If variable `gnus-use-long-file-name' is non-nil, it is
4044 ~/News/news.group/num.  Otherwise, it is like ~/News/news/group/num."
4045   (let ((default
4046           (expand-file-name
4047            (concat (if (gnus-use-long-file-name 'not-save)
4048                        newsgroup
4049                      (gnus-newsgroup-directory-form newsgroup))
4050                    "/" (int-to-string (mail-header-number headers)))
4051            gnus-article-save-directory)))
4052     (if (and last-file
4053              (string-equal (file-name-directory default)
4054                            (file-name-directory last-file))
4055              (string-match "^[0-9]+$" (file-name-nondirectory last-file)))
4056         default
4057       (or last-file default))))
4058
4059 (defun gnus-plain-save-name (newsgroup headers &optional last-file)
4060   "Generate file name from NEWSGROUP, HEADERS, and optional LAST-FILE.
4061 If variable `gnus-use-long-file-name' is non-nil, it is
4062 ~/News/news.group.  Otherwise, it is like ~/News/news/group/news."
4063   (or last-file
4064       (expand-file-name
4065        (if (gnus-use-long-file-name 'not-save)
4066            newsgroup
4067          (file-relative-name
4068           (expand-file-name "news" (gnus-newsgroup-directory-form newsgroup))
4069           default-directory))
4070        gnus-article-save-directory)))
4071
4072 (defun gnus-sender-save-name (newsgroup headers &optional last-file)
4073   "Generate file name from sender."
4074   (let ((from (mail-header-from headers)))
4075     (expand-file-name
4076      (if (and from (string-match "\\([^ <]+\\)@" from))
4077          (match-string 1 from)
4078        "nobody")
4079      gnus-article-save-directory)))
4080
4081 (defun article-verify-x-pgp-sig ()
4082   "Verify X-PGP-Sig."
4083   ;; <ftp://ftp.isc.org/pub/pgpcontrol/FORMAT>
4084   (interactive)
4085   (if (gnus-buffer-live-p gnus-original-article-buffer)
4086       (let ((sig (with-current-buffer gnus-original-article-buffer
4087                    (gnus-fetch-field "X-PGP-Sig")))
4088             items info headers)
4089         (when (and sig
4090                    mml2015-use
4091                    (mml2015-clear-verify-function))
4092           (with-temp-buffer
4093             (insert-buffer-substring gnus-original-article-buffer)
4094             (setq items (split-string sig))
4095             (message-narrow-to-head)
4096             (let ((inhibit-point-motion-hooks t)
4097                   (case-fold-search t))
4098               ;; Don't verify multiple headers.
4099               (setq headers (mapconcat (lambda (header)
4100                                          (concat header ": "
4101                                                  (mail-fetch-field header)
4102                                                  "\n"))
4103                                        (split-string (nth 1 items) ",") "")))
4104             (delete-region (point-min) (point-max))
4105             (insert "-----BEGIN PGP SIGNED MESSAGE-----\n\n")
4106             (insert "X-Signed-Headers: " (nth 1 items) "\n")
4107             (insert headers)
4108             (widen)
4109             (forward-line)
4110             (while (not (eobp))
4111               (if (looking-at "^-")
4112                   (insert "- "))
4113               (forward-line))
4114             (insert "\n-----BEGIN PGP SIGNATURE-----\n")
4115             (insert "Version: " (car items) "\n\n")
4116             (insert (mapconcat 'identity (cddr items) "\n"))
4117             (insert "\n-----END PGP SIGNATURE-----\n")
4118             (let ((mm-security-handle (list (format "multipart/signed"))))
4119               (mml2015-clean-buffer)
4120               (let ((coding-system-for-write (or gnus-newsgroup-charset
4121                                                  'iso-8859-1)))
4122                 (funcall (mml2015-clear-verify-function)))
4123               (setq info
4124                     (or (mm-handle-multipart-ctl-parameter
4125                          mm-security-handle 'gnus-details)
4126                         (mm-handle-multipart-ctl-parameter
4127                          mm-security-handle 'gnus-info)))))
4128           (when info
4129             (let ((inhibit-read-only t) bface eface)
4130               (save-restriction
4131                 (message-narrow-to-head)
4132                 (goto-char (point-max))
4133                 (forward-line -1)
4134                 (setq bface (get-text-property (point-at-bol) 'face)
4135                       eface (get-text-property (1- (point-at-eol)) 'face))
4136                 (message-remove-header "X-Gnus-PGP-Verify")
4137                 (if (re-search-forward "^X-PGP-Sig:" nil t)
4138                     (forward-line)
4139                   (goto-char (point-max)))
4140                 (narrow-to-region (point) (point))
4141                 (insert "X-Gnus-PGP-Verify: " info "\n")
4142                 (goto-char (point-min))
4143                 (forward-line)
4144                 (while (not (eobp))
4145                   (if (not (looking-at "^[ \t]"))
4146                       (insert " "))
4147                   (forward-line))
4148                 ;; Do highlighting.
4149                 (goto-char (point-min))
4150                 (when (looking-at "\\([^:]+\\): *")
4151                   (put-text-property (match-beginning 1) (1+ (match-end 1))
4152                                      'face bface)
4153                   (put-text-property (match-end 0) (point-max)
4154                                      'face eface)))))))))
4155
4156 (defun article-verify-cancel-lock ()
4157   "Verify Cancel-Lock header."
4158   (interactive)
4159   (if (gnus-buffer-live-p gnus-original-article-buffer)
4160       (canlock-verify gnus-original-article-buffer)))
4161
4162 (eval-and-compile
4163   (mapc
4164    (lambda (func)
4165      (let (afunc gfunc)
4166        (if (consp func)
4167            (setq afunc (car func)
4168                  gfunc (cdr func))
4169          (setq afunc func
4170                gfunc (intern (format "gnus-%s" func))))
4171        (defalias gfunc
4172          (when (fboundp afunc)
4173            `(lambda (&optional interactive &rest args)
4174               ,(documentation afunc t)
4175               (interactive (list t))
4176               (with-current-buffer gnus-article-buffer
4177                 (if interactive
4178                     (call-interactively ',afunc)
4179                   (apply ',afunc args))))))))
4180    '(article-hide-headers
4181      article-verify-x-pgp-sig
4182      article-verify-cancel-lock
4183      article-hide-boring-headers
4184      article-treat-overstrike
4185      article-treat-ansi-sequences
4186      article-fill-long-lines
4187      article-capitalize-sentences
4188      article-remove-cr
4189      article-remove-leading-whitespace
4190      article-display-x-face
4191      article-display-face
4192      article-de-quoted-unreadable
4193      article-de-base64-unreadable
4194      article-decode-HZ
4195      article-wash-html
4196      article-unsplit-urls
4197      article-hide-list-identifiers
4198      article-strip-banner
4199      article-babel
4200      article-hide-pem
4201      article-hide-signature
4202      article-strip-headers-in-body
4203      article-remove-trailing-blank-lines
4204      article-strip-leading-blank-lines
4205      article-strip-multiple-blank-lines
4206      article-strip-leading-space
4207      article-strip-trailing-space
4208      article-strip-blank-lines
4209      article-strip-all-blank-lines
4210      article-date-local
4211      article-date-english
4212      article-date-iso8601
4213      article-date-original
4214      article-date-ut
4215      article-decode-mime-words
4216      article-decode-charset
4217      article-decode-encoded-words
4218      article-date-user
4219      article-date-lapsed
4220      article-emphasize
4221      article-treat-dumbquotes
4222      article-normalize-headers
4223      ;;(article-show-all . gnus-article-show-all-headers)
4224      )))
4225 \f
4226 ;;;
4227 ;;; Gnus article mode
4228 ;;;
4229
4230 (put 'gnus-article-mode 'mode-class 'special)
4231
4232 (set-keymap-parent gnus-article-mode-map widget-keymap)
4233
4234 (gnus-define-keys gnus-article-mode-map
4235   " " gnus-article-goto-next-page
4236   "\177" gnus-article-goto-prev-page
4237   [delete] gnus-article-goto-prev-page
4238   [backspace] gnus-article-goto-prev-page
4239   "\C-c^" gnus-article-refer-article
4240   "h" gnus-article-show-summary
4241   "s" gnus-article-show-summary
4242   "\C-c\C-m" gnus-article-mail
4243   "?" gnus-article-describe-briefly
4244   "e" gnus-summary-edit-article
4245   "<" beginning-of-buffer
4246   ">" end-of-buffer
4247   "\C-c\C-i" gnus-info-find-node
4248   "\C-c\C-b" gnus-bug
4249   "R" gnus-article-reply-with-original
4250   "F" gnus-article-followup-with-original
4251   "\C-hk" gnus-article-describe-key
4252   "\C-hc" gnus-article-describe-key-briefly
4253   "\C-hb" gnus-article-describe-bindings
4254
4255   "\C-d" gnus-article-read-summary-keys
4256   "\M-*" gnus-article-read-summary-keys
4257   "\M-#" gnus-article-read-summary-keys
4258   "\M-^" gnus-article-read-summary-keys
4259   "\M-g" gnus-article-read-summary-keys)
4260
4261 (substitute-key-definition
4262  'undefined 'gnus-article-read-summary-keys gnus-article-mode-map)
4263
4264 (gnus-define-keys (gnus-article-send-map "S" gnus-article-mode-map)
4265   "W" gnus-article-wide-reply-with-original)
4266 (if (featurep 'xemacs)
4267     (set-keymap-default-binding gnus-article-send-map
4268                                 'gnus-article-read-summary-send-keys)
4269   (define-key gnus-article-send-map [t] 'gnus-article-read-summary-send-keys))
4270
4271 (defun gnus-article-make-menu-bar ()
4272   (unless (boundp 'gnus-article-commands-menu)
4273     (gnus-summary-make-menu-bar))
4274   (gnus-turn-off-edit-menu 'article)
4275   (unless (boundp 'gnus-article-article-menu)
4276     (easy-menu-define
4277      gnus-article-article-menu gnus-article-mode-map ""
4278      '("Article"
4279        ["Scroll forwards" gnus-article-goto-next-page t]
4280        ["Scroll backwards" gnus-article-goto-prev-page t]
4281        ["Show summary" gnus-article-show-summary t]
4282        ["Fetch Message-ID at point" gnus-article-refer-article t]
4283        ["Mail to address at point" gnus-article-mail t]
4284        ["Send a bug report" gnus-bug t]))
4285
4286     (easy-menu-define
4287      gnus-article-treatment-menu gnus-article-mode-map ""
4288      ;; Fixme: this should use :active (and maybe :visible).
4289      '("Treatment"
4290        ["Hide headers" gnus-article-hide-headers t]
4291        ["Hide signature" gnus-article-hide-signature t]
4292        ["Hide citation" gnus-article-hide-citation t]
4293        ["Treat overstrike" gnus-article-treat-overstrike t]
4294        ["Treat ANSI sequences" gnus-article-treat-ansi-sequences t]
4295        ["Remove carriage return" gnus-article-remove-cr t]
4296        ["Remove leading whitespace" gnus-article-remove-leading-whitespace t]
4297        ["Remove quoted-unreadable" gnus-article-de-quoted-unreadable t]
4298        ["Remove base64" gnus-article-de-base64-unreadable t]
4299        ["Treat html" gnus-article-wash-html t]
4300        ["Remove newlines from within URLs" gnus-article-unsplit-urls t]
4301        ["Decode HZ" gnus-article-decode-HZ t]))
4302
4303     ;; Note "Commands" menu is defined in gnus-sum.el for consistency
4304
4305     ;; Note "Post" menu is defined in gnus-sum.el for consistency
4306
4307     (gnus-run-hooks 'gnus-article-menu-hook)))
4308
4309 (defun gnus-article-mode ()
4310   "Major mode for displaying an article.
4311
4312 All normal editing commands are switched off.
4313
4314 The following commands are available in addition to all summary mode
4315 commands:
4316 \\<gnus-article-mode-map>
4317 \\[gnus-article-next-page]\t Scroll the article one page forwards
4318 \\[gnus-article-prev-page]\t Scroll the article one page backwards
4319 \\[gnus-article-refer-article]\t Go to the article referred to by an article id near point
4320 \\[gnus-article-show-summary]\t Display the summary buffer
4321 \\[gnus-article-mail]\t Send a reply to the address near point
4322 \\[gnus-article-describe-briefly]\t Describe the current mode briefly
4323 \\[gnus-info-find-node]\t Go to the Gnus info node"
4324   (interactive)
4325   (kill-all-local-variables)
4326   (gnus-simplify-mode-line)
4327   (setq mode-name "Article")
4328   (setq major-mode 'gnus-article-mode)
4329   (make-local-variable 'minor-mode-alist)
4330   (use-local-map gnus-article-mode-map)
4331   (when (gnus-visual-p 'article-menu 'menu)
4332     (gnus-article-make-menu-bar)
4333     (when gnus-summary-tool-bar-map
4334       (set (make-local-variable 'tool-bar-map) gnus-summary-tool-bar-map)))
4335   (gnus-update-format-specifications nil 'article-mode)
4336   (set (make-local-variable 'page-delimiter) gnus-page-delimiter)
4337   (set (make-local-variable 'gnus-page-broken) nil)
4338   (make-local-variable 'gnus-button-marker-list)
4339   (make-local-variable 'gnus-article-current-summary)
4340   (make-local-variable 'gnus-article-mime-handles)
4341   (make-local-variable 'gnus-article-decoded-p)
4342   (make-local-variable 'gnus-article-mime-handle-alist)
4343   (make-local-variable 'gnus-article-wash-types)
4344   (make-local-variable 'gnus-article-image-alist)
4345   (make-local-variable 'gnus-article-charset)
4346   (make-local-variable 'gnus-article-ignored-charsets)
4347   ;; Prevent Emacs 22 from displaying non-break space with `nobreak-space'
4348   ;; face.
4349   (set (make-local-variable 'nobreak-char-display) nil)
4350   (setq cursor-in-non-selected-windows nil)
4351   (setq truncate-lines gnus-article-truncate-lines)
4352   (gnus-set-default-directory)
4353   (buffer-disable-undo)
4354   (setq buffer-read-only t
4355         show-trailing-whitespace nil)
4356   (set-syntax-table gnus-article-mode-syntax-table)
4357   (mm-enable-multibyte)
4358   (gnus-run-mode-hooks 'gnus-article-mode-hook))
4359
4360 (defvar gnus-button-marker-list nil
4361   "Regexp matching any of the regexps from `gnus-button-alist'.
4362 Internal variable.")
4363
4364 (defun gnus-article-setup-buffer ()
4365   "Initialize the article buffer."
4366   (let* ((name (if gnus-single-article-buffer "*Article*"
4367                  (concat "*Article " gnus-newsgroup-name "*")))
4368          (original
4369           (progn (string-match "\\*Article" name)
4370                  (concat " *Original Article"
4371                          (substring name (match-end 0))))))
4372     (setq gnus-article-buffer name)
4373     (setq gnus-original-article-buffer original)
4374     (setq gnus-article-mime-handle-alist nil)
4375     (with-current-buffer gnus-summary-buffer
4376       ;; This might be a variable local to the summary buffer.
4377       (unless gnus-single-article-buffer
4378         (setq gnus-article-buffer name)
4379         (setq gnus-original-article-buffer original)
4380         (gnus-set-global-variables)))
4381     (gnus-article-setup-highlight-words)
4382     ;; Init original article buffer.
4383     (with-current-buffer (gnus-get-buffer-create gnus-original-article-buffer)
4384       (mm-enable-multibyte)
4385       (setq major-mode 'gnus-original-article-mode)
4386       (make-local-variable 'gnus-original-article))
4387     (if (and (get-buffer name)
4388              (with-current-buffer name
4389                (if gnus-article-edit-mode
4390                    (if (y-or-n-p "Article mode edit in progress; discard? ")
4391                        (progn
4392                          (set-buffer-modified-p nil)
4393                          (gnus-kill-buffer name)
4394                          (message "")
4395                          nil)
4396                      (error "Action aborted"))
4397                  t)))
4398         (with-current-buffer name
4399           (set (make-local-variable 'gnus-article-edit-mode) nil)
4400           (when gnus-article-mime-handles
4401             (mm-destroy-parts gnus-article-mime-handles)
4402             (setq gnus-article-mime-handles nil))
4403           ;; Set it to nil in article-buffer!
4404           (setq gnus-article-mime-handle-alist nil)
4405           (buffer-disable-undo)
4406           (setq buffer-read-only t)
4407           ;; This list just keeps growing if we don't reset it.
4408           (setq gnus-button-marker-list nil)
4409           (unless (eq major-mode 'gnus-article-mode)
4410             (gnus-article-mode))
4411           (current-buffer))
4412       (with-current-buffer (gnus-get-buffer-create name)
4413         (gnus-article-mode)
4414         (make-local-variable 'gnus-summary-buffer)
4415         (setq gnus-summary-buffer
4416               (gnus-summary-buffer-name gnus-newsgroup-name))
4417         (gnus-summary-set-local-parameters gnus-newsgroup-name)
4418         (current-buffer)))))
4419
4420 ;; Set article window start at LINE, where LINE is the number of lines
4421 ;; from the head of the article.
4422 (defun gnus-article-set-window-start (&optional line)
4423   (let ((article-window (gnus-get-buffer-window gnus-article-buffer t)))
4424     (when article-window
4425       (set-window-start
4426        article-window
4427        (with-current-buffer gnus-article-buffer
4428          (goto-char (point-min))
4429          (if (not line)
4430              (point-min)
4431            (gnus-message 6 "Moved to bookmark")
4432            (search-forward "\n\n" nil t)
4433            (forward-line line)
4434            (point)))))))
4435
4436 (defun gnus-article-prepare (article &optional all-headers header)
4437   "Prepare ARTICLE in article mode buffer.
4438 ARTICLE should either be an article number or a Message-ID.
4439 If ARTICLE is an id, HEADER should be the article headers.
4440 If ALL-HEADERS is non-nil, no headers are hidden."
4441   (save-excursion
4442     ;; Make sure we start in a summary buffer.
4443     (unless (eq major-mode 'gnus-summary-mode)
4444       (set-buffer gnus-summary-buffer))
4445     (setq gnus-summary-buffer (current-buffer))
4446     (let* ((gnus-article (if header (mail-header-number header) article))
4447            (summary-buffer (current-buffer))
4448            (gnus-tmp-internal-hook gnus-article-internal-prepare-hook)
4449            (group gnus-newsgroup-name)
4450            result)
4451       (save-excursion
4452         (gnus-article-setup-buffer)
4453         (set-buffer gnus-article-buffer)
4454         ;; Deactivate active regions.
4455         (when (and (boundp 'transient-mark-mode)
4456                    transient-mark-mode)
4457           (setq mark-active nil))
4458         (if (not (setq result (let ((inhibit-read-only t))
4459                                 (gnus-request-article-this-buffer
4460                                  article group))))
4461             ;; There is no such article.
4462             (save-excursion
4463               (when (and (numberp article)
4464                          (not (memq article gnus-newsgroup-sparse)))
4465                 (setq gnus-article-current
4466                       (cons gnus-newsgroup-name article))
4467                 (set-buffer gnus-summary-buffer)
4468                 (setq gnus-current-article article)
4469                 (if (and (memq article gnus-newsgroup-undownloaded)
4470                          (not (gnus-online (gnus-find-method-for-group
4471                                             gnus-newsgroup-name))))
4472                     (progn
4473                       (gnus-summary-set-agent-mark article)
4474                       (message "Message marked for downloading"))
4475                   (gnus-summary-mark-article article gnus-canceled-mark)
4476                   (unless (memq article gnus-newsgroup-sparse)
4477                     (gnus-error 1 "No such article (may have expired or been canceled)")))))
4478           (if (or (eq result 'pseudo)
4479                   (eq result 'nneething))
4480               (progn
4481                 (with-current-buffer summary-buffer
4482                   (push article gnus-newsgroup-history)
4483                   (setq gnus-last-article gnus-current-article
4484                         gnus-current-article 0
4485                         gnus-current-headers nil
4486                         gnus-article-current nil)
4487                   (if (eq result 'nneething)
4488                       (gnus-configure-windows 'summary)
4489                     (gnus-configure-windows 'article))
4490                   (gnus-set-global-variables))
4491                 (let ((gnus-article-mime-handle-alist-1
4492                        gnus-article-mime-handle-alist))
4493                   (gnus-set-mode-line 'article)))
4494             ;; The result from the `request' was an actual article -
4495             ;; or at least some text that is now displayed in the
4496             ;; article buffer.
4497             (when (and (numberp article)
4498                        (not (eq article gnus-current-article)))
4499               ;; Seems like a new article has been selected.
4500               ;; `gnus-current-article' must be an article number.
4501               (with-current-buffer summary-buffer
4502                 (push article gnus-newsgroup-history)
4503                 (setq gnus-last-article gnus-current-article
4504                       gnus-current-article article
4505                       gnus-current-headers
4506                       (gnus-summary-article-header gnus-current-article)
4507                       gnus-article-current
4508                       (cons gnus-newsgroup-name gnus-current-article))
4509                 (unless (vectorp gnus-current-headers)
4510                   (setq gnus-current-headers nil))
4511                 (gnus-summary-goto-subject gnus-current-article)
4512                 (when (gnus-summary-show-thread)
4513                   ;; If the summary buffer really was folded, the
4514                   ;; previous goto may not actually have gone to
4515                   ;; the right article, but the thread root instead.
4516                   ;; So we go again.
4517                   (gnus-summary-goto-subject gnus-current-article))
4518                 (gnus-run-hooks 'gnus-mark-article-hook)
4519                 (gnus-set-mode-line 'summary)
4520                 (when (gnus-visual-p 'article-highlight 'highlight)
4521                   (gnus-run-hooks 'gnus-visual-mark-article-hook))
4522                 ;; Set the global newsgroup variables here.
4523                 (gnus-set-global-variables)
4524                 (setq gnus-have-all-headers
4525                       (or all-headers gnus-show-all-headers))))
4526             (save-excursion
4527               (gnus-configure-windows 'article))
4528             (when (or (numberp article)
4529                       (stringp article))
4530               (gnus-article-prepare-display)
4531               ;; Do page break.
4532               (goto-char (point-min))
4533               (when gnus-break-pages
4534                 (gnus-narrow-to-page)))
4535             (let ((gnus-article-mime-handle-alist-1
4536                    gnus-article-mime-handle-alist))
4537               (gnus-set-mode-line 'article))
4538             (article-goto-body)
4539             (unless (bobp)
4540               (forward-line -1))
4541             (set-window-point (get-buffer-window (current-buffer)) (point))
4542             (gnus-configure-windows 'article)
4543             t))))))
4544
4545 ;;;###autoload
4546 (defun gnus-article-prepare-display ()
4547   "Make the current buffer look like a nice article."
4548   ;; Hooks for getting information from the article.
4549   ;; This hook must be called before being narrowed.
4550   (let ((gnus-article-buffer (current-buffer))
4551         buffer-read-only
4552         (inhibit-read-only t))
4553     (unless (eq major-mode 'gnus-article-mode)
4554       (gnus-article-mode))
4555     (setq buffer-read-only nil
4556           gnus-article-wash-types nil
4557           gnus-article-image-alist nil)
4558     (gnus-run-hooks 'gnus-tmp-internal-hook)
4559     (when gnus-display-mime-function
4560       (funcall gnus-display-mime-function))
4561     (gnus-run-hooks 'gnus-article-prepare-hook)))
4562
4563 ;;;
4564 ;;; Gnus Sticky Article Mode
4565 ;;;
4566
4567 (define-derived-mode gnus-sticky-article-mode gnus-article-mode "StickyArticle"
4568   "Mode for sticky articles."
4569   ;; Release bindings that won't work.
4570   (substitute-key-definition 'gnus-article-read-summary-keys 'undefined
4571                              gnus-sticky-article-mode-map)
4572   (substitute-key-definition 'gnus-article-refer-article 'undefined
4573                              gnus-sticky-article-mode-map)
4574   (dolist (k '("e" "h" "s" "F" "R"))
4575     (define-key gnus-sticky-article-mode-map k nil))
4576   (define-key gnus-sticky-article-mode-map "k" 'gnus-kill-sticky-article-buffer)
4577   (define-key gnus-sticky-article-mode-map "q" 'bury-buffer)
4578   (define-key gnus-sticky-article-mode-map "\C-hc" 'describe-key-briefly)
4579   (define-key gnus-sticky-article-mode-map "\C-hk" 'describe-key))
4580
4581 (defun gnus-sticky-article (arg)
4582   "Make the current article sticky.
4583 If a prefix ARG is given, ask for a name for this sticky article buffer."
4584   (interactive "P")
4585   (gnus-summary-show-thread)
4586   (gnus-summary-select-article nil nil 'pseudo)
4587   (let (new-art-buf-name)
4588     (gnus-eval-in-buffer-window gnus-article-buffer
4589       (setq new-art-buf-name
4590             (concat
4591              "*Sticky Article: "
4592              (if arg
4593                  (read-from-minibuffer "Sticky article buffer name: ")
4594                (gnus-with-article-headers
4595                  (gnus-article-goto-header "subject")
4596                  (setq new-art-buf-name
4597                        (buffer-substring-no-properties
4598                         (line-beginning-position) (line-end-position)))
4599                  (goto-char (point-min))
4600                  (gnus-article-goto-header "from")
4601                  (setq new-art-buf-name
4602                        (concat
4603                         new-art-buf-name ", "
4604                         (buffer-substring-no-properties
4605                          (line-beginning-position) (line-end-position))))
4606                  (goto-char (point-min))
4607                  (gnus-article-goto-header "date")
4608                  (setq new-art-buf-name
4609                        (concat
4610                         new-art-buf-name ", "
4611                         (buffer-substring-no-properties
4612                          (line-beginning-position) (line-end-position))))))
4613              "*"))
4614       (if (and (gnus-buffer-live-p new-art-buf-name)
4615                (with-current-buffer new-art-buf-name
4616                  (eq major-mode 'gnus-sticky-article-mode)))
4617           (switch-to-buffer new-art-buf-name)
4618         (setq new-art-buf-name (rename-buffer new-art-buf-name t)))
4619       (gnus-sticky-article-mode))
4620     (setq gnus-article-buffer new-art-buf-name))
4621   (gnus-summary-recenter)
4622   (gnus-summary-position-point))
4623
4624 (defun gnus-kill-sticky-article-buffer (&optional buffer)
4625   "Kill the given sticky article BUFFER.
4626 If none is given, assume the current buffer and kill it if it has
4627 `gnus-sticky-article-mode'."
4628   (interactive)
4629   (unless buffer
4630     (setq buffer (current-buffer)))
4631   (with-current-buffer buffer
4632     (when (eq major-mode 'gnus-sticky-article-mode)
4633       (gnus-kill-buffer buffer))))
4634
4635 (defun gnus-kill-sticky-article-buffers (arg)
4636   "Kill all sticky article buffers.
4637 If a prefix ARG is given, ask for confirmation."
4638   (interactive "P")
4639   (dolist (buf (gnus-buffers))
4640     (with-current-buffer buf
4641       (when (eq major-mode 'gnus-sticky-article-mode)
4642         (if (not arg)
4643             (gnus-kill-buffer buf)
4644           (when (yes-or-no-p (concat "Kill buffer " (buffer-name buf) "? "))
4645             (gnus-kill-buffer buf)))))))
4646
4647 ;;;
4648 ;;; Gnus MIME viewing functions
4649 ;;;
4650
4651 (defvar gnus-mime-button-line-format "%{%([%p. %d%T]%)%}%e\n"
4652   "Format of the MIME buttons.
4653
4654 Valid specifiers include:
4655 %t  The MIME type
4656 %T  MIME type, along with additional info
4657 %n  The `name' parameter
4658 %d  The description, if any
4659 %l  The length of the encoded part
4660 %p  The part identifier number
4661 %e  Dots if the part isn't displayed
4662
4663 General format specifiers can also be used.  See Info node
4664 `(gnus)Formatting Variables'.")
4665
4666 (defvar gnus-mime-button-line-format-alist
4667   '((?t gnus-tmp-type ?s)
4668     (?T gnus-tmp-type-long ?s)
4669     (?n gnus-tmp-name ?s)
4670     (?d gnus-tmp-description ?s)
4671     (?p gnus-tmp-id ?s)
4672     (?l gnus-tmp-length ?d)
4673     (?e gnus-tmp-dots ?s)))
4674
4675 (defvar gnus-mime-button-commands
4676   '((gnus-article-press-button "\r" "Toggle Display")
4677     (gnus-mime-view-part "v" "View Interactively...")
4678     (gnus-mime-view-part-as-type "t" "View As Type...")
4679     (gnus-mime-view-part-as-charset "C" "View As charset...")
4680     (gnus-mime-save-part "o" "Save...")
4681     (gnus-mime-save-part-and-strip "\C-o" "Save and Strip")
4682     (gnus-mime-replace-part "r" "Replace part")
4683     (gnus-mime-delete-part "d" "Delete part")
4684     (gnus-mime-copy-part "c" "View As Text, In Other Buffer")
4685     (gnus-mime-inline-part "i" "View As Text, In This Buffer")
4686     (gnus-mime-view-part-internally "E" "View Internally") ;; Why `E'?
4687     (gnus-mime-view-part-externally "e" "View Externally")
4688     (gnus-mime-print-part "p" "Print")
4689     (gnus-mime-pipe-part "|" "Pipe To Command...")
4690     (gnus-mime-action-on-part "." "Take action on the part...")))
4691
4692 (defun gnus-article-mime-part-status ()
4693   (if gnus-article-mime-handle-alist-1
4694       (if (eq 1 (length gnus-article-mime-handle-alist-1))
4695           " (1 part)"
4696         (format " (%d parts)" (length gnus-article-mime-handle-alist-1)))
4697     ""))
4698
4699 (defvar gnus-mime-button-map
4700   (let ((map (make-sparse-keymap)))
4701     (define-key map gnus-mouse-2 'gnus-article-push-button)
4702     (define-key map gnus-down-mouse-3 'gnus-mime-button-menu)
4703     (dolist (c gnus-mime-button-commands)
4704       (define-key map (cadr c) (car c)))
4705     map))
4706
4707 (easy-menu-define
4708   gnus-mime-button-menu gnus-mime-button-map "MIME button menu."
4709   `("MIME Part"
4710     ,@(mapcar (lambda (c)
4711                 (vector (caddr c) (car c) :active t))
4712               gnus-mime-button-commands)))
4713
4714 (defun gnus-mime-button-menu (event prefix)
4715  "Construct a context-sensitive menu of MIME commands."
4716  (interactive "e\nP")
4717  (save-window-excursion
4718    (let ((pos (event-start event)))
4719      (select-window (posn-window pos))
4720      (goto-char (posn-point pos))
4721      (gnus-article-check-buffer)
4722      (popup-menu gnus-mime-button-menu nil prefix))))
4723
4724 (defun gnus-mime-view-all-parts (&optional handles)
4725   "View all the MIME parts."
4726   (interactive)
4727   (with-current-buffer gnus-article-buffer
4728     (let ((handles (or handles gnus-article-mime-handles))
4729           (mail-parse-charset gnus-newsgroup-charset)
4730           (mail-parse-ignored-charsets
4731            (with-current-buffer gnus-summary-buffer
4732              gnus-newsgroup-ignored-charsets)))
4733       (when handles
4734         (mm-remove-parts handles)
4735         (goto-char (point-min))
4736         (or (search-forward "\n\n") (goto-char (point-max)))
4737         (let ((inhibit-read-only t))
4738           (delete-region (point) (point-max))
4739           (mm-display-parts handles))))))
4740
4741 (defun gnus-article-jump-to-part (n)
4742   "Jump to MIME part N."
4743   (interactive "P")
4744   (pop-to-buffer gnus-article-buffer)
4745   ;; FIXME: why is it necessary?
4746   (sit-for 0)
4747   (let ((parts (length gnus-article-mime-handle-alist)))
4748     (or n (setq n
4749                 (string-to-number
4750                  (read-string ;; Emacs 21 doesn't have `read-number'.
4751                   (format "Jump to part (2..%s): " parts)))))
4752     (unless (and (integerp n) (<= n parts) (>= n 1))
4753       (setq n
4754             (progn
4755               (gnus-message 7 "Invalid part `%s', using %s instead."
4756                             n parts)
4757               parts)))
4758     (gnus-message 9 "Jumping to part %s." n)
4759     (cond ((>= gnus-auto-select-part 1)
4760            (while (and (<= n parts)
4761                        (not (gnus-article-goto-part n)))
4762              (setq n (1+ n))))
4763           ((< gnus-auto-select-part 0)
4764            (while (and (>= n 1)
4765                        (not (gnus-article-goto-part n)))
4766              (setq n (1- n))))
4767           (t
4768            (gnus-article-goto-part n)))))
4769
4770 (eval-when-compile
4771   (defsubst gnus-article-edit-part (handles &optional current-id)
4772     "Edit an article in order to delete a mime part.
4773 This function is exclusively used by `gnus-mime-save-part-and-strip'
4774 and `gnus-mime-delete-part', and not provided at run-time normally."
4775     (gnus-article-edit-article
4776      `(lambda ()
4777         (buffer-disable-undo)
4778         (erase-buffer)
4779         (let ((mail-parse-charset (or gnus-article-charset
4780                                       ',gnus-newsgroup-charset))
4781               (mail-parse-ignored-charsets
4782                (or gnus-article-ignored-charsets
4783                    ',gnus-newsgroup-ignored-charsets))
4784               (mbl mml-buffer-list))
4785           (setq mml-buffer-list nil)
4786           (insert-buffer-substring gnus-original-article-buffer)
4787           (mime-to-mml ',handles)
4788           (setq gnus-article-mime-handles nil)
4789           (let ((mbl1 mml-buffer-list))
4790             (setq mml-buffer-list mbl)
4791             (set (make-local-variable 'mml-buffer-list) mbl1))
4792           (gnus-make-local-hook 'kill-buffer-hook)
4793           (add-hook 'kill-buffer-hook 'mml-destroy-buffers t t)))
4794      `(lambda (no-highlight)
4795         (let ((mail-parse-charset (or gnus-article-charset
4796                                       ',gnus-newsgroup-charset))
4797               (message-options message-options)
4798               (message-options-set-recipient)
4799               (mail-parse-ignored-charsets
4800                (or gnus-article-ignored-charsets
4801                    ',gnus-newsgroup-ignored-charsets)))
4802           (mml-to-mime)
4803           (mml-destroy-buffers)
4804           (remove-hook 'kill-buffer-hook
4805                        'mml-destroy-buffers t)
4806           (kill-local-variable 'mml-buffer-list))
4807         (gnus-summary-edit-article-done
4808          ,(or (mail-header-references gnus-current-headers) "")
4809          ,(gnus-group-read-only-p)
4810          ,gnus-summary-buffer no-highlight))
4811      t)
4812     (gnus-article-edit-done)
4813     (gnus-summary-expand-window)
4814     (gnus-summary-show-article)
4815     (when (and current-id (integerp gnus-auto-select-part))
4816       (gnus-article-jump-to-part
4817        (if (text-property-any (point-min) (point-max)
4818                               'gnus-part (+ current-id gnus-auto-select-part))
4819            (+ current-id gnus-auto-select-part)
4820          (with-current-buffer gnus-article-buffer
4821            (length gnus-article-mime-handle-alist)))))))
4822
4823 (defun gnus-mime-replace-part (file)
4824   "Replace MIME part under point with an external body."
4825   ;; Useful if file has already been saved to disk
4826   (interactive
4827    (list
4828     (read-file-name "Replace MIME part with file: "
4829                     (or mm-default-directory default-directory)
4830                     nil nil)))
4831   (gnus-mime-save-part-and-strip file))
4832
4833 (defun gnus-mime-save-part-and-strip (&optional file)
4834   "Save the MIME part under point then replace it with an external body.
4835 If FILE is given, use it for the external part."
4836   (interactive)
4837   (gnus-article-check-buffer)
4838   (when (gnus-group-read-only-p)
4839     (error "The current group does not support deleting of parts"))
4840   (when (mm-complicated-handles gnus-article-mime-handles)
4841     (error "\
4842 The current article has a complicated MIME structure, giving up..."))
4843   (let* ((data (get-text-property (point) 'gnus-data))
4844          (id (get-text-property (point) 'gnus-part))
4845          param
4846          (handles gnus-article-mime-handles))
4847     (unless file
4848       (setq file
4849             (and data (mm-save-part data "Delete MIME part and save to: "))))
4850     (when file
4851       (with-current-buffer (mm-handle-buffer data)
4852         (erase-buffer)
4853         (insert "Content-Type: " (mm-handle-media-type data))
4854         (mml-insert-parameter-string (cdr (mm-handle-type data))
4855                                      '(charset))
4856         ;; Add a filename for the sake of saving the part again.
4857         (mml-insert-parameter
4858          (mail-header-encode-parameter "name" (file-name-nondirectory file)))
4859         (insert "\n")
4860         (insert "Content-ID: " (message-make-message-id) "\n")
4861         (insert "Content-Transfer-Encoding: binary\n")
4862         (insert "\n"))
4863       (setcdr data
4864               (cdr (mm-make-handle nil
4865                                    `("message/external-body"
4866                                      (access-type . "LOCAL-FILE")
4867                                      (name . ,file)))))
4868       ;; (set-buffer gnus-summary-buffer)
4869       (gnus-article-edit-part handles id))))
4870
4871 ;; A function like `gnus-summary-save-parts' (`X m', `<MIME> <Extract all
4872 ;; parts...>') but with stripping would be nice.
4873
4874 (defun gnus-mime-delete-part ()
4875   "Delete the MIME part under point.
4876 Replace it with some information about the removed part."
4877   (interactive)
4878   (gnus-article-check-buffer)
4879   (when (gnus-group-read-only-p)
4880     (error "The current group does not support deleting of parts"))
4881   (when (mm-complicated-handles gnus-article-mime-handles)
4882     (error "\
4883 The current article has a complicated MIME structure, giving up..."))
4884   (when (or gnus-expert-user
4885             (gnus-yes-or-no-p "\
4886 Deleting parts may malfunction or destroy the article; continue? "))
4887     (let* ((data (get-text-property (point) 'gnus-data))
4888            (id (get-text-property (point) 'gnus-part))
4889            (handles gnus-article-mime-handles)
4890            (none "(none)")
4891            (description
4892             (let ((desc (mm-handle-description data)))
4893               (when desc
4894                 (mail-decode-encoded-word-string desc))))
4895            (filename
4896             (or (mail-content-type-get (mm-handle-disposition data) 'filename)
4897                 none))
4898            (type (mm-handle-media-type data)))
4899       (unless data
4900         (error "No MIME part under point"))
4901       (with-current-buffer (mm-handle-buffer data)
4902         (let ((bsize (format "%s" (buffer-size))))
4903           (erase-buffer)
4904           (insert
4905            (concat
4906             ",----\n"
4907             "| The following attachment has been deleted:\n"
4908             "|\n"
4909             "| Type:           " type "\n"
4910             "| Filename:       " filename "\n"
4911             "| Size (encoded): " bsize " Byte\n"
4912             (when description
4913               (concat    "| Description:    " description "\n"))
4914             "`----\n"))
4915           (setcdr data
4916                   (cdr (mm-make-handle
4917                         nil `("text/plain") nil nil
4918                         (list "attachment")
4919                         (format "Deleted attachment (%s bytes)" bsize))))))
4920       ;; (set-buffer gnus-summary-buffer)
4921       (gnus-article-edit-part handles id))))
4922
4923 (defun gnus-mime-save-part ()
4924   "Save the MIME part under point."
4925   (interactive)
4926   (gnus-article-check-buffer)
4927   (let ((data (get-text-property (point) 'gnus-data)))
4928     (when data
4929       (mm-save-part data))))
4930
4931 (defun gnus-mime-pipe-part ()
4932   "Pipe the MIME part under point to a process."
4933   (interactive)
4934   (gnus-article-check-buffer)
4935   (let ((data (get-text-property (point) 'gnus-data)))
4936     (when data
4937       (mm-pipe-part data))))
4938
4939 (defun gnus-mime-view-part ()
4940   "Interactively choose a viewing method for the MIME part under point."
4941   (interactive)
4942   (gnus-article-check-buffer)
4943   (let ((data (get-text-property (point) 'gnus-data)))
4944     (when data
4945       (setq gnus-article-mime-handles
4946             (mm-merge-handles
4947              gnus-article-mime-handles (setq data (copy-sequence data))))
4948       (mm-interactively-view-part data))))
4949
4950 (defun gnus-mime-view-part-as-type-internal ()
4951   (gnus-article-check-buffer)
4952   (let* ((handle (get-text-property (point) 'gnus-data))
4953          (name (or
4954                 ;; Content-Type: foo/bar; name=...
4955                 (mail-content-type-get (mm-handle-type handle) 'name)
4956                 ;; Content-Disposition: attachment; filename=...
4957                 (cdr (assq 'filename (cdr (mm-handle-disposition handle))))))
4958          (def-type (and name (mm-default-file-encoding name))))
4959     (or (and def-type (cons def-type 0))
4960         (and handle
4961              (equal (mm-handle-media-supertype handle) "text")
4962              '("text/plain" . 0))
4963         '("application/octet-stream" . 0))))
4964
4965 (defun gnus-mime-view-part-as-type (&optional mime-type pred)
4966   "Choose a MIME media type, and view the part as such.
4967 If non-nil, PRED is a predicate to use during completion to limit the
4968 available media-types."
4969   (interactive)
4970   (unless mime-type
4971     (setq mime-type
4972           (let ((default (gnus-mime-view-part-as-type-internal)))
4973             (completing-read
4974              (format "View as MIME type (default %s): "
4975                      (car default))
4976              (mapcar #'list (mailcap-mime-types))
4977              pred nil nil nil
4978              (car default)))))
4979   (gnus-article-check-buffer)
4980   (let ((handle (get-text-property (point) 'gnus-data)))
4981     (when handle
4982       (when (equal (mm-handle-media-type handle) "message/external-body")
4983         (unless (mm-handle-cache handle)
4984           (mm-extern-cache-contents handle))
4985         (setq handle (mm-handle-cache handle)))
4986       (setq handle
4987             (mm-make-handle (mm-handle-buffer handle)
4988                             (cons mime-type (cdr (mm-handle-type handle)))
4989                             (mm-handle-encoding handle)
4990                             (mm-handle-undisplayer handle)
4991                             (mm-handle-disposition handle)
4992                             (mm-handle-description handle)
4993                             nil
4994                             (mm-handle-id handle)))
4995       (setq gnus-article-mime-handles
4996             (mm-merge-handles gnus-article-mime-handles handle))
4997       (when (mm-handle-displayed-p handle)
4998         (mm-remove-part handle))
4999       (gnus-mm-display-part handle))))
5000
5001 (defun gnus-mime-copy-part (&optional handle arg)
5002   "Put the MIME part under point into a new buffer.
5003 If `auto-compression-mode' is enabled, compressed files like .gz and .bz2
5004 are decompressed."
5005   (interactive (list nil current-prefix-arg))
5006   (gnus-article-check-buffer)
5007   (unless handle
5008     (setq handle (get-text-property (point) 'gnus-data)))
5009   (when handle
5010     (let ((filename (or (mail-content-type-get (mm-handle-type handle)
5011                                                'name)
5012                         (mail-content-type-get (mm-handle-disposition handle)
5013                                                'filename)))
5014           contents dont-decode charset coding-system)
5015       (mm-with-unibyte-buffer
5016         (mm-insert-part handle)
5017         (setq contents (or (condition-case nil
5018                                (mm-decompress-buffer filename nil 'sig)
5019                              (error
5020                               (setq dont-decode t)
5021                               nil))
5022                            (buffer-string))))
5023       (setq filename (cond (filename (file-name-nondirectory filename))
5024                            (dont-decode "*raw data*")
5025                            (t "*decoded*")))
5026       (cond
5027        (dont-decode)
5028        ((not arg)
5029         (unless (setq charset (mail-content-type-get
5030                                (mm-handle-type handle) 'charset))
5031           (unless (setq coding-system (mm-with-unibyte-buffer
5032                                         (insert contents)
5033                                         (mm-find-buffer-file-coding-system)))
5034             (setq charset gnus-newsgroup-charset))))
5035        ((numberp arg)
5036         (setq charset (or (cdr (assq arg
5037                                      gnus-summary-show-article-charset-alist))
5038                           (mm-read-coding-system "Charset: ")))))
5039       (switch-to-buffer (generate-new-buffer filename))
5040       (if (or coding-system
5041               (and charset
5042                    (setq coding-system (mm-charset-to-coding-system charset))
5043                    (not (eq charset 'ascii))))
5044           (progn
5045             (mm-enable-multibyte)
5046             (insert (mm-decode-coding-string contents coding-system))
5047             (setq buffer-file-coding-system
5048                   (if (boundp 'last-coding-system-used)
5049                       (symbol-value 'last-coding-system-used)
5050                     coding-system)))
5051         (mm-disable-multibyte)
5052         (insert contents)
5053         (setq buffer-file-coding-system mm-binary-coding-system))
5054       ;; We do it this way to make `normal-mode' set the appropriate mode.
5055       (unwind-protect
5056           (progn
5057             (setq buffer-file-name (expand-file-name filename))
5058             (normal-mode))
5059         (setq buffer-file-name nil))
5060       (goto-char (point-min)))))
5061
5062 (defun gnus-mime-print-part (&optional handle filename)
5063   "Print the MIME part under point."
5064   (interactive (list nil (ps-print-preprint current-prefix-arg)))
5065   (gnus-article-check-buffer)
5066   (let* ((handle (or handle (get-text-property (point) 'gnus-data)))
5067          (contents (and handle (mm-get-part handle)))
5068          (file (mm-make-temp-file (expand-file-name "mm." mm-tmp-directory)))
5069          (printer (mailcap-mime-info (mm-handle-media-type handle) "print")))
5070     (when contents
5071         (if printer
5072             (unwind-protect
5073                 (progn
5074                   (mm-save-part-to-file handle file)
5075                   (call-process shell-file-name nil
5076                                 (generate-new-buffer " *mm*")
5077                                 nil
5078                                 shell-command-switch
5079                                 (mm-mailcap-command
5080                                  printer file (mm-handle-type handle))))
5081               (delete-file file))
5082           (with-temp-buffer
5083             (insert contents)
5084             (gnus-print-buffer))
5085           (ps-despool filename)))))
5086
5087 (defun gnus-mime-inline-part (&optional handle arg)
5088   "Insert the MIME part under point into the current buffer.
5089 Compressed files like .gz and .bz2 are decompressed."
5090   (interactive (list nil current-prefix-arg))
5091   (gnus-article-check-buffer)
5092   (unless handle
5093     (setq handle (get-text-property (point) 'gnus-data)))
5094   (when handle
5095     (let ((b (point))
5096           (inhibit-read-only t)
5097           contents charset coding-system)
5098       (if (and (not arg) (mm-handle-undisplayer handle))
5099           (mm-remove-part handle)
5100         (mm-with-unibyte-buffer
5101           (mm-insert-part handle)
5102           (setq contents
5103                 (or (mm-decompress-buffer
5104                      (or (mail-content-type-get (mm-handle-type handle)
5105                                                 'name)
5106                          (mail-content-type-get (mm-handle-disposition handle)
5107                                                 'filename))
5108                      nil t)
5109                     (buffer-string))))
5110         (cond
5111          ((not arg)
5112           (unless (setq charset (mail-content-type-get
5113                                  (mm-handle-type handle) 'charset))
5114             (unless (setq coding-system
5115                           (mm-with-unibyte-buffer
5116                             (insert contents)
5117                             (mm-find-buffer-file-coding-system)))
5118               (setq charset gnus-newsgroup-charset))))
5119          ((numberp arg)
5120           (if (mm-handle-undisplayer handle)
5121               (mm-remove-part handle))
5122           (setq charset
5123                 (or (cdr (assq arg
5124                                gnus-summary-show-article-charset-alist))
5125                     (mm-read-coding-system "Charset: "))))
5126          (t
5127           (if (mm-handle-undisplayer handle)
5128               (mm-remove-part handle))))
5129         (forward-line 2)
5130         (mm-insert-inline
5131          handle
5132          (if (or coding-system
5133                  (and charset
5134                       (setq coding-system
5135                             (mm-charset-to-coding-system charset))
5136                       (not (eq coding-system 'ascii))))
5137              (mm-decode-coding-string contents coding-system)
5138            (mm-string-to-multibyte contents)))
5139         (goto-char b)))))
5140
5141 (defun gnus-mime-set-charset-parameters (handle charset)
5142   "Set CHARSET to parameters in HANDLE.
5143 CHARSET may either be a string or a symbol."
5144   (unless (stringp charset)
5145     (setq charset (symbol-name charset)))
5146   (if (stringp (car handle))
5147       (dolist (h (cdr handle))
5148         (gnus-mime-set-charset-parameters h charset))
5149     (let* ((type (mm-handle-type (if (equal (mm-handle-media-type handle)
5150                                             "message/external-body")
5151                                      (progn
5152                                        (unless (mm-handle-cache handle)
5153                                          (mm-extern-cache-contents handle))
5154                                        (mm-handle-cache handle))
5155                                    handle)))
5156            (param (assq 'charset (cdr type))))
5157       (if param
5158           (setcdr param charset)
5159         (setcdr type (cons (cons 'charset charset) (cdr type)))))))
5160
5161 (defun gnus-mime-view-part-as-charset (&optional handle arg)
5162   "Insert the MIME part under point into the current buffer using the
5163 specified charset."
5164   (interactive (list nil current-prefix-arg))
5165   (gnus-article-check-buffer)
5166   (let ((handle (or handle (get-text-property (point) 'gnus-data)))
5167         (fun (get-text-property (point) 'gnus-callback))
5168         (gnus-newsgroup-ignored-charsets 'gnus-all)
5169         charset form preferred parts)
5170     (when handle
5171       (when (prog1
5172                 (and fun
5173                      (setq charset
5174                            (or (cdr (assq
5175                                      arg
5176                                      gnus-summary-show-article-charset-alist))
5177                                (mm-read-coding-system "Charset: "))))
5178               (if (mm-handle-undisplayer handle)
5179                   (mm-remove-part handle)))
5180         (gnus-mime-set-charset-parameters handle charset)
5181         (when (and (consp (setq form (cdr-safe fun)))
5182                    (setq form (ignore-errors
5183                                 (assq 'gnus-mime-display-alternative form)))
5184                    (setq preferred (caddr form))
5185                    (progn
5186                      (when (eq (car preferred) 'quote)
5187                        (setq preferred (cadr preferred)))
5188                      (not (equal preferred
5189                                  (get-text-property (point) 'gnus-data))))
5190                    (setq parts (get-text-property (point) 'gnus-part))
5191                    (setq parts (cdr (assq parts
5192                                           gnus-article-mime-handle-alist)))
5193                    (equal (mm-handle-media-type parts) "multipart/alternative")
5194                    (setq parts (reverse (cdr parts))))
5195           (setcar (cddr form)
5196                   (list 'quote (or (cadr (member preferred parts))
5197                                    (car parts)))))
5198         (funcall fun handle)))))
5199
5200 (defun gnus-mime-view-part-externally (&optional handle)
5201   "View the MIME part under point with an external viewer."
5202   (interactive)
5203   (gnus-article-check-buffer)
5204   (let* ((handle (or handle (get-text-property (point) 'gnus-data)))
5205          (mm-user-display-methods nil)
5206          (mm-inlined-types nil)
5207          (mail-parse-charset gnus-newsgroup-charset)
5208          (mail-parse-ignored-charsets
5209           (with-current-buffer gnus-summary-buffer
5210             gnus-newsgroup-ignored-charsets))
5211          (type (mm-handle-media-type handle))
5212          (method (mailcap-mime-info type))
5213          (mm-enable-external t))
5214     (if (not (stringp method))
5215         (gnus-mime-view-part-as-type
5216          nil (lambda (types) (stringp (mailcap-mime-info (car types)))))
5217       (when handle
5218         (if (mm-handle-undisplayer handle)
5219             (mm-remove-part handle)
5220           (mm-display-part handle))))))
5221
5222 (defun gnus-mime-view-part-internally (&optional handle)
5223   "View the MIME part under point with an internal viewer.
5224 If no internal viewer is available, use an external viewer."
5225   (interactive)
5226   (gnus-article-check-buffer)
5227   (let* ((handle (or handle (get-text-property (point) 'gnus-data)))
5228          (mm-inlined-types '(".*"))
5229          (mm-inline-large-images t)
5230          (mail-parse-charset gnus-newsgroup-charset)
5231          (mail-parse-ignored-charsets
5232           (with-current-buffer gnus-summary-buffer
5233             gnus-newsgroup-ignored-charsets))
5234          (inhibit-read-only t))
5235     (if (not (mm-inlinable-p handle))
5236         (gnus-mime-view-part-as-type
5237          nil (lambda (types) (mm-inlinable-p handle (car types))))
5238       (when handle
5239         (if (mm-handle-undisplayer handle)
5240             (mm-remove-part handle)
5241           (mm-display-part handle))))))
5242
5243 (defun gnus-mime-action-on-part (&optional action)
5244   "Do something with the MIME attachment at \(point\)."
5245   (interactive
5246    (list (completing-read "Action: " gnus-mime-action-alist nil t)))
5247   (gnus-article-check-buffer)
5248   (let ((action-pair (assoc action gnus-mime-action-alist)))
5249     (if action-pair
5250         (funcall (cdr action-pair)))))
5251
5252 (defun gnus-article-part-wrapper (n function &optional no-handle interactive)
5253   "Call FUNCTION on MIME part N.
5254 Unless NO-HANDLE, call FUNCTION with N-th MIME handle as it's only argument.
5255 If INTERACTIVE, call FUNCTION interactivly."
5256   (let (window frame)
5257     ;; Check whether the article is displayed.
5258     (unless (and (gnus-buffer-live-p gnus-article-buffer)
5259                  (setq window (get-buffer-window gnus-article-buffer t))
5260                  (frame-visible-p (setq frame (window-frame window))))
5261       (error "No article is displayed"))
5262     (with-current-buffer gnus-article-buffer
5263       ;; Check whether the article displays the right contents.
5264       (unless (with-current-buffer gnus-summary-buffer
5265                 (eq gnus-current-article (gnus-summary-article-number)))
5266         (error "You should select the right article first"))
5267       (if n
5268           (setq n (prefix-numeric-value n))
5269         (let ((pt (point)))
5270           (setq n (or (get-text-property pt 'gnus-part)
5271                       (and (not (bobp))
5272                            (get-text-property (1- pt) 'gnus-part))
5273                       (get-text-property (prog2
5274                                              (forward-line 1)
5275                                              (point)
5276                                            (goto-char pt))
5277                                          'gnus-part)
5278                       (get-text-property
5279                        (or (and (setq pt (previous-single-property-change
5280                                           pt 'gnus-part))
5281                                 (1- pt))
5282                            (next-single-property-change (point) 'gnus-part)
5283                            (point))
5284                        'gnus-part)
5285                       1))))
5286       ;; Check whether the specified part exists.
5287       (when (> n (length gnus-article-mime-handle-alist))
5288         (error "No such part")))
5289     (unless
5290         (progn
5291           ;; To select the window is needed so that the cursor
5292           ;; might be visible on the MIME button.
5293           (select-window (prog1
5294                              window
5295                            (setq window (selected-window))
5296                            ;; Article may be displayed in the other frame.
5297                            (gnus-select-frame-set-input-focus
5298                             (prog1
5299                                 frame
5300                               (setq frame (selected-frame))))))
5301           (when (gnus-article-goto-part n)
5302             ;; We point the cursor and the arrow at the MIME button
5303             ;; when the `function' prompt the user for something.
5304             (let ((cursor-in-non-selected-windows t)
5305                   (overlay-arrow-string "=>")
5306                   (overlay-arrow-position (point-marker)))
5307               (unwind-protect
5308                   (cond
5309                    ((and no-handle interactive)
5310                     (call-interactively function))
5311                    (no-handle
5312                     (funcall function))
5313                    (interactive
5314                     (call-interactively
5315                      function
5316                      (cdr (assq n gnus-article-mime-handle-alist))))
5317                    (t
5318                     (funcall function
5319                              (cdr (assq n gnus-article-mime-handle-alist)))))
5320                 (set-marker overlay-arrow-position nil)
5321                 (unless gnus-auto-select-part
5322                   (gnus-select-frame-set-input-focus frame)
5323                   (select-window window))))
5324             t))
5325       (if gnus-inhibit-mime-unbuttonizing
5326           ;; This is the default though the program shouldn't reach here.
5327           (error "No such part")
5328         ;; The part which doesn't have the MIME button is selected.
5329         ;; So, we display all the buttons and redo it.
5330         (let ((gnus-inhibit-mime-unbuttonizing t))
5331           (gnus-summary-show-article)
5332           (gnus-article-part-wrapper n function no-handle))))))
5333
5334 (defun gnus-article-pipe-part (n)
5335   "Pipe MIME part N, which is the numerical prefix."
5336   (interactive "P")
5337   (gnus-article-part-wrapper n 'mm-pipe-part))
5338
5339 (defun gnus-article-save-part (n)
5340   "Save MIME part N, which is the numerical prefix."
5341   (interactive "P")
5342   (gnus-article-part-wrapper n 'mm-save-part))
5343
5344 (defun gnus-article-interactively-view-part (n)
5345   "View MIME part N interactively, which is the numerical prefix."
5346   (interactive "P")
5347   (gnus-article-part-wrapper n 'mm-interactively-view-part))
5348
5349 (defun gnus-article-copy-part (n)
5350   "Copy MIME part N, which is the numerical prefix."
5351   (interactive "P")
5352   (gnus-article-part-wrapper n 'gnus-mime-copy-part))
5353
5354 (defun gnus-article-view-part-as-charset (n)
5355   "View MIME part N using a specified charset.
5356 N is the numerical prefix."
5357   (interactive "P")
5358   (gnus-article-part-wrapper n 'gnus-mime-view-part-as-charset))
5359
5360 (defun gnus-article-view-part-externally (n)
5361   "View MIME part N externally, which is the numerical prefix."
5362   (interactive "P")
5363   (gnus-article-part-wrapper n 'gnus-mime-view-part-externally))
5364
5365 (defun gnus-article-inline-part (n)
5366   "Inline MIME part N, which is the numerical prefix."
5367   (interactive "P")
5368   (gnus-article-part-wrapper n 'gnus-mime-inline-part))
5369
5370 (defun gnus-article-save-part-and-strip (n)
5371   "Save MIME part N and replace it with an external body.
5372 N is the numerical prefix."
5373   (interactive "P")
5374   (gnus-article-part-wrapper n 'gnus-mime-save-part-and-strip t))
5375
5376 (defun gnus-article-replace-part (n)
5377   "Replace MIME part N with an external body.
5378 N is the numerical prefix."
5379   (interactive "P")
5380   (gnus-article-part-wrapper n 'gnus-mime-replace-part t t))
5381
5382 (defun gnus-article-delete-part (n)
5383   "Delete MIME part N and add some information about the removed part.
5384 N is the numerical prefix."
5385   (interactive "P")
5386   (gnus-article-part-wrapper n 'gnus-mime-delete-part t))
5387
5388 (defun gnus-article-view-part-as-type (n)
5389   "Choose a MIME media type, and view part N as such.
5390 N is the numerical prefix."
5391   (interactive "P")
5392   (gnus-article-part-wrapper n 'gnus-mime-view-part-as-type t))
5393
5394 (defun gnus-article-mime-match-handle-first (condition)
5395   (if condition
5396       (let (n)
5397         (dolist (ihandle gnus-article-mime-handle-alist)
5398           (if (and (cond
5399                     ((functionp condition)
5400                      (funcall condition (cdr ihandle)))
5401                     ((eq condition 'undisplayed)
5402                      (not (or (mm-handle-undisplayer (cdr ihandle))
5403                               (equal (mm-handle-media-type (cdr ihandle))
5404                                      "multipart/alternative"))))
5405                     ((eq condition 'undisplayed-alternative)
5406                      (not (mm-handle-undisplayer (cdr ihandle))))
5407                     (t t))
5408                    (gnus-article-goto-part (car ihandle))
5409                    (or (not n) (< (car ihandle) n)))
5410               (setq n (car ihandle))))
5411         (or n 1))
5412     1))
5413
5414 (defun gnus-article-view-part (&optional n)
5415   "View MIME part N, which is the numerical prefix."
5416   (interactive "P")
5417   (with-current-buffer gnus-article-buffer
5418     (or (numberp n) (setq n (gnus-article-mime-match-handle-first
5419                              gnus-article-mime-match-handle-function)))
5420     (when (> n (length gnus-article-mime-handle-alist))
5421       (error "No such part"))
5422     (let ((handle (cdr (assq n gnus-article-mime-handle-alist))))
5423       (when (gnus-article-goto-part n)
5424         (if (equal (car handle) "multipart/alternative")
5425             (gnus-article-press-button)
5426           (when (eq (gnus-mm-display-part handle) 'internal)
5427             (gnus-set-window-start)))))))
5428
5429 (defsubst gnus-article-mime-total-parts ()
5430   (if (bufferp (car gnus-article-mime-handles))
5431       1 ;; single part
5432     (1- (length gnus-article-mime-handles))))
5433
5434 (defun gnus-mm-display-part (handle)
5435   "Display HANDLE and fix MIME button."
5436   (let ((id (get-text-property (point) 'gnus-part))
5437         (point (point))
5438         (inhibit-read-only t))
5439     (forward-line 1)
5440     (prog1
5441         (let ((window (selected-window))
5442               (mail-parse-charset gnus-newsgroup-charset)
5443               (mail-parse-ignored-charsets
5444                (if (gnus-buffer-live-p gnus-summary-buffer)
5445                    (with-current-buffer gnus-summary-buffer
5446                      gnus-newsgroup-ignored-charsets)
5447                  nil)))
5448           (save-excursion
5449             (unwind-protect
5450                 (let ((win (gnus-get-buffer-window (current-buffer) t))
5451                       (beg (point)))
5452                   (when win
5453                     (select-window win))
5454                   (goto-char point)
5455                   (forward-line)
5456                   (if (mm-handle-displayed-p handle)
5457                       ;; This will remove the part.
5458                       (mm-display-part handle)
5459                     (save-restriction
5460                       (narrow-to-region (point)
5461                                         (if (eobp) (point) (1+ (point))))
5462                       (mm-display-part handle)
5463                       ;; We narrow to the part itself and
5464                       ;; then call the treatment functions.
5465                       (goto-char (point-min))
5466                       (forward-line 1)
5467                       (narrow-to-region (point) (point-max))
5468                       (gnus-treat-article
5469                        nil id
5470                        (gnus-article-mime-total-parts)
5471                        (mm-handle-media-type handle)))))
5472               (if (window-live-p window)
5473                   (select-window window)))))
5474       (goto-char point)
5475       (gnus-delete-line)
5476       (gnus-insert-mime-button
5477        handle id (list (mm-handle-displayed-p handle)))
5478       (goto-char point))))
5479
5480 (defun gnus-article-goto-part (n)
5481   "Go to MIME part N."
5482   (gnus-goto-char (text-property-any (point-min) (point-max) 'gnus-part n)))
5483
5484 (defun gnus-insert-mime-button (handle gnus-tmp-id &optional displayed)
5485   (let ((gnus-tmp-name
5486          (or (mail-content-type-get (mm-handle-type handle) 'name)
5487              (mail-content-type-get (mm-handle-disposition handle) 'filename)
5488              (mail-content-type-get (mm-handle-type handle) 'url)
5489              ""))
5490         (gnus-tmp-type (mm-handle-media-type handle))
5491         (gnus-tmp-description (or (mm-handle-description handle) ""))
5492         (gnus-tmp-dots
5493          (if (if displayed (car displayed)
5494                (mm-handle-displayed-p handle))
5495              "" "..."))
5496         (gnus-tmp-length (with-current-buffer (mm-handle-buffer handle)
5497                            (buffer-size)))
5498         gnus-tmp-type-long b e)
5499     (when (string-match ".*/" gnus-tmp-name)
5500       (setq gnus-tmp-name (replace-match "" t t gnus-tmp-name)))
5501     (setq gnus-tmp-type-long (concat gnus-tmp-type
5502                                      (and (not (equal gnus-tmp-name ""))
5503                                           (concat "; " gnus-tmp-name))))
5504     (unless (equal gnus-tmp-description "")
5505       (setq gnus-tmp-type-long (concat " --- " gnus-tmp-type-long)))
5506     (unless (bolp)
5507       (insert "\n"))
5508     (setq b (point))
5509     (gnus-eval-format
5510      gnus-mime-button-line-format gnus-mime-button-line-format-alist
5511      `(keymap ,gnus-mime-button-map
5512               gnus-callback gnus-mm-display-part
5513               gnus-part ,gnus-tmp-id
5514               article-type annotation
5515               gnus-data ,handle))
5516     (setq e (if (bolp)
5517                 ;; Exclude a newline.
5518                 (1- (point))
5519               (point)))
5520     (when gnus-article-button-face
5521       (gnus-overlay-put (gnus-make-overlay b e nil t)
5522                         'face gnus-article-button-face))
5523     (widget-convert-button
5524      'link b e
5525      :mime-handle handle
5526      :action 'gnus-widget-press-button
5527      :button-keymap gnus-mime-button-map
5528      :help-echo
5529      (lambda (widget/window &optional overlay pos)
5530        ;; Needed to properly clear the message due to a bug in
5531        ;; wid-edit (XEmacs only).
5532        (if (boundp 'help-echo-owns-message)
5533            (setq help-echo-owns-message t))
5534        (format
5535         "%S: %s the MIME part; %S: more options"
5536         (aref gnus-mouse-2 0)
5537         ;; XEmacs will get a single widget arg; Emacs 21 will get
5538         ;; window, overlay, position.
5539         (if (mm-handle-displayed-p
5540              (if overlay
5541                  (with-current-buffer (gnus-overlay-buffer overlay)
5542                    (widget-get (widget-at (gnus-overlay-start overlay))
5543                                :mime-handle))
5544                (widget-get widget/window :mime-handle)))
5545             "hide" "show")
5546         (aref gnus-down-mouse-3 0))))))
5547
5548 (defun gnus-widget-press-button (elems el)
5549   (goto-char (widget-get elems :from))
5550   (gnus-article-press-button))
5551
5552 (defvar gnus-displaying-mime nil)
5553
5554 (defun gnus-display-mime (&optional ihandles)
5555   "Display the MIME parts."
5556   (save-excursion
5557     (save-selected-window
5558       (let ((window (get-buffer-window gnus-article-buffer))
5559             (point (point)))
5560         (when window
5561           (select-window window)
5562           ;; We have to do this since selecting the window
5563           ;; may change the point.  So we set the window point.
5564           (set-window-point window point)))
5565       (let ((handles ihandles)
5566             (inhibit-read-only t)
5567             handle)
5568         (cond (handles)
5569               ((setq handles (mm-dissect-buffer nil gnus-article-loose-mime))
5570                (when gnus-article-emulate-mime
5571                  (mm-uu-dissect-text-parts handles)))
5572               (gnus-article-emulate-mime
5573                (setq handles (mm-uu-dissect))))
5574         (when (and (not ihandles)
5575                    (not gnus-displaying-mime))
5576           ;; Top-level call; we clean up.
5577           (when gnus-article-mime-handles
5578             (mm-destroy-parts gnus-article-mime-handles)
5579             (setq gnus-article-mime-handle-alist nil));; A trick.
5580           (setq gnus-article-mime-handles handles)
5581           ;; We allow users to glean info from the handles.
5582           (when gnus-article-mime-part-function
5583             (gnus-mime-part-function handles)))
5584         (if (and handles
5585                  (or (not (stringp (car handles)))
5586                      (cdr handles)))
5587             (progn
5588               (when (and (not ihandles)
5589                          (not gnus-displaying-mime))
5590                 ;; Clean up for mime parts.
5591                 (article-goto-body)
5592                 (delete-region (point) (point-max)))
5593               (let ((gnus-displaying-mime t))
5594                 (gnus-mime-display-part handles)))
5595           (save-restriction
5596             (article-goto-body)
5597             (narrow-to-region (point) (point-max))
5598             (gnus-treat-article nil 1 1)
5599             (widen)))
5600         (unless ihandles
5601           ;; Highlight the headers.
5602           (save-excursion
5603             (save-restriction
5604               (article-goto-body)
5605               (narrow-to-region (point-min) (point))
5606               (gnus-article-save-original-date
5607                (gnus-treat-article 'head)))))))
5608     ;; Cope with broken MIME messages.
5609     (goto-char (point-max))
5610     (unless (bolp)
5611       (insert "\n"))))
5612
5613 (defcustom gnus-mime-display-multipart-as-mixed nil
5614   "Display \"multipart\" parts as  \"multipart/mixed\".
5615
5616 If t, it overrides nil values of
5617 `gnus-mime-display-multipart-alternative-as-mixed' and
5618 `gnus-mime-display-multipart-related-as-mixed'."
5619   :group 'gnus-article-mime
5620   :type 'boolean)
5621
5622 (defcustom gnus-mime-display-multipart-alternative-as-mixed nil
5623   "Display \"multipart/alternative\" parts as  \"multipart/mixed\"."
5624   :version "22.1"
5625   :group 'gnus-article-mime
5626   :type 'boolean)
5627
5628 (defcustom gnus-mime-display-multipart-related-as-mixed nil
5629   "Display \"multipart/related\" parts as  \"multipart/mixed\".
5630
5631 If displaying \"text/html\" is discouraged \(see
5632 `mm-discouraged-alternatives'\) images or other material inside a
5633 \"multipart/related\" part might be overlooked when this variable is nil."
5634   :version "22.1"
5635   :group 'gnus-article-mime
5636   :type 'boolean)
5637
5638 (defun gnus-mime-display-part (handle)
5639   (cond
5640    ;; Maybe a broken MIME message.
5641    ((null handle))
5642    ;; Single part.
5643    ((not (stringp (car handle)))
5644     (gnus-mime-display-single handle))
5645    ;; User-defined multipart
5646    ((cdr (assoc (car handle) gnus-mime-multipart-functions))
5647     (funcall (cdr (assoc (car handle) gnus-mime-multipart-functions))
5648              handle))
5649    ;; multipart/alternative
5650    ((and (equal (car handle) "multipart/alternative")
5651          (not (or gnus-mime-display-multipart-as-mixed
5652                   gnus-mime-display-multipart-alternative-as-mixed)))
5653     (let ((id (1+ (length gnus-article-mime-handle-alist))))
5654       (push (cons id handle) gnus-article-mime-handle-alist)
5655       (gnus-mime-display-alternative (cdr handle) nil nil id)))
5656    ;; multipart/related
5657    ((and (equal (car handle) "multipart/related")
5658          (not (or gnus-mime-display-multipart-as-mixed
5659                   gnus-mime-display-multipart-related-as-mixed)))
5660     ;;;!!!We should find the start part, but we just default
5661     ;;;!!!to the first part.
5662     ;;(gnus-mime-display-part (cadr handle))
5663     ;;;!!! Most multipart/related is an HTML message plus images.
5664     ;;;!!! Unfortunately we are unable to let W3 display those
5665     ;;;!!! included images, so we just display it as a mixed multipart.
5666     ;;(gnus-mime-display-mixed (cdr handle))
5667     ;;;!!! No, w3 can display everything just fine.
5668     (gnus-mime-display-part (cadr handle)))
5669    ((equal (car handle) "multipart/signed")
5670     (gnus-add-wash-type 'signed)
5671     (gnus-mime-display-security handle))
5672    ((equal (car handle) "multipart/encrypted")
5673     (gnus-add-wash-type 'encrypted)
5674     (gnus-mime-display-security handle))
5675    ;; Other multiparts are handled like multipart/mixed.
5676    (t
5677     (gnus-mime-display-mixed (cdr handle)))))
5678
5679 (defun gnus-mime-part-function (handles)
5680   (if (stringp (car handles))
5681       (mapcar 'gnus-mime-part-function (cdr handles))
5682     (funcall gnus-article-mime-part-function handles)))
5683
5684 (defun gnus-mime-display-mixed (handles)
5685   (mapcar 'gnus-mime-display-part handles))
5686
5687 (defun gnus-mime-display-single (handle)
5688   (let ((type (mm-handle-media-type handle))
5689         (ignored gnus-ignored-mime-types)
5690         (not-attachment t)
5691         (move nil)
5692         display text)
5693     (catch 'ignored
5694       (progn
5695         (while ignored
5696           (when (string-match (pop ignored) type)
5697             (throw 'ignored nil)))
5698         (if (and (setq not-attachment
5699                        (and (not (mm-inline-override-p handle))
5700                             (or (not (mm-handle-disposition handle))
5701                                 (equal (car (mm-handle-disposition handle))
5702                                        "inline")
5703                                 (mm-attachment-override-p handle))))
5704                  (mm-automatic-display-p handle)
5705                  (or (and
5706                       (mm-inlinable-p handle)
5707                       (mm-inlined-p handle))
5708                      (mm-automatic-external-display-p type)))
5709             (setq display t)
5710           (when (equal (mm-handle-media-supertype handle) "text")
5711             (setq text t)))
5712         (let ((id (1+ (length gnus-article-mime-handle-alist)))
5713               beg)
5714           (push (cons id handle) gnus-article-mime-handle-alist)
5715           (when (and display
5716                      (equal (mm-handle-media-supertype handle) "message"))
5717             (insert-char
5718              ?\n
5719              (cond ((not (bolp)) 2)
5720                    ((or (bobp) (eq (char-before (1- (point))) ?\n)) 0)
5721                    (t 1))))
5722           (when (or (not display)
5723                     (not (gnus-unbuttonized-mime-type-p type)))
5724             (gnus-insert-mime-button
5725              handle id (list (or display (and not-attachment text))))
5726             (gnus-article-insert-newline)
5727             ;; Remember modify the number of forward lines.
5728             (setq move t))
5729           (setq beg (point))
5730           (cond
5731            (display
5732             (when move
5733               (forward-line -1)
5734               (setq beg (point)))
5735             (let ((mail-parse-charset gnus-newsgroup-charset)
5736                   (mail-parse-ignored-charsets
5737                    (save-excursion (condition-case ()
5738                                        (set-buffer gnus-summary-buffer)
5739                                      (error))
5740                                    gnus-newsgroup-ignored-charsets)))
5741               (mm-display-part handle t))
5742             (goto-char (point-max)))
5743            ((and text not-attachment)
5744             (when move
5745               (forward-line -1)
5746               (setq beg (point)))
5747             (gnus-article-insert-newline)
5748             (mm-insert-inline
5749              handle
5750              (let ((charset (or (mail-content-type-get (mm-handle-type handle)
5751                                                        'charset)
5752                                 (and (equal type "text/calendar") 'utf-8))))
5753                (cond ((not charset)
5754                       (mm-string-as-multibyte (mm-get-part handle)))
5755                      ((eq charset 'gnus-decoded)
5756                       (with-current-buffer (mm-handle-buffer handle)
5757                         (buffer-string)))
5758                      (t
5759                       (mm-decode-string (mm-get-part handle) charset)))))
5760             (goto-char (point-max))))
5761           ;; Do highlighting.
5762           (save-excursion
5763             (save-restriction
5764               (narrow-to-region beg (point))
5765               (if (eq handle gnus-article-mime-handles)
5766                   ;; The format=flowed case.
5767                   (gnus-treat-article nil 1 1 (mm-handle-media-type handle))
5768                 ;; Don't count signature parts that are never displayed.
5769                 ;; The part number should be re-calculated supposing this
5770                 ;; might be a message/rfc822 part.
5771                 (let (handles)
5772                   (dolist (part gnus-article-mime-handles)
5773                     (unless (or (stringp part)
5774                                 (equal (car (mm-handle-type part))
5775                                        "application/pgp-signature"))
5776                       (push part handles)))
5777                   (gnus-treat-article
5778                    nil (length (memq handle handles)) (length handles)
5779                    (mm-handle-media-type handle)))))))))))
5780
5781 (defun gnus-unbuttonized-mime-type-p (type)
5782   "Say whether TYPE is to be unbuttonized."
5783   (unless gnus-inhibit-mime-unbuttonizing
5784     (when (catch 'found
5785             (let ((types gnus-unbuttonized-mime-types))
5786               (while types
5787                 (when (string-match (pop types) type)
5788                   (throw 'found t)))))
5789       (not (catch 'found
5790              (let ((types gnus-buttonized-mime-types))
5791                (while types
5792                  (when (string-match (pop types) type)
5793                    (throw 'found t)))))))))
5794
5795 (defun gnus-article-insert-newline ()
5796   "Insert a newline, but mark it as undeletable."
5797   (gnus-put-text-property
5798    (point) (progn (insert "\n") (point)) 'gnus-undeletable t))
5799
5800 (defun gnus-mime-display-alternative (handles &optional preferred ibegend id)
5801   (let* ((preferred (or preferred (mm-preferred-alternative handles)))
5802          (ihandles handles)
5803          (point (point))
5804          handle (inhibit-read-only t) from props begend not-pref)
5805     (save-window-excursion
5806       (save-restriction
5807         (when ibegend
5808           (narrow-to-region (car ibegend)
5809                             (or (cdr ibegend)
5810                                 (progn
5811                                   (goto-char (car ibegend))
5812                                   (forward-line 2)
5813                                   (point))))
5814           (delete-region (point-min) (point-max))
5815           (mm-remove-parts handles))
5816         (setq begend (list (point-marker)))
5817         ;; Do the toggle.
5818         (unless (setq not-pref (cadr (member preferred ihandles)))
5819           (setq not-pref (car ihandles)))
5820         (when (or ibegend
5821                   (not preferred)
5822                   (not (gnus-unbuttonized-mime-type-p
5823                         "multipart/alternative")))
5824           (gnus-add-text-properties
5825            (setq from (point))
5826            (progn
5827              (insert (format "%d.  " id))
5828              (point))
5829            `(gnus-callback
5830              (lambda (handles)
5831                (unless ,(not ibegend)
5832                  (setq gnus-article-mime-handle-alist
5833                        ',gnus-article-mime-handle-alist))
5834                (gnus-mime-display-alternative
5835                 ',ihandles ',not-pref ',begend ,id))
5836              keymap ,gnus-mime-button-map
5837              ,gnus-mouse-face-prop ,gnus-article-mouse-face
5838              face ,gnus-article-button-face
5839              gnus-part ,id
5840              article-type multipart))
5841           (widget-convert-button 'link from (point)
5842                                  :action 'gnus-widget-press-button
5843                                  :button-keymap gnus-widget-button-keymap)
5844           ;; Do the handles
5845           (while (setq handle (pop handles))
5846             (gnus-add-text-properties
5847              (setq from (point))
5848              (progn
5849                (insert (format "(%c) %-18s"
5850                                (if (equal handle preferred) ?* ? )
5851                                (mm-handle-media-type handle)))
5852                (point))
5853              `(gnus-callback
5854                (lambda (handles)
5855                  (unless ,(not ibegend)
5856                    (setq gnus-article-mime-handle-alist
5857                          ',gnus-article-mime-handle-alist))
5858                  (gnus-mime-display-alternative
5859                   ',ihandles ',handle ',begend ,id))
5860                keymap ,gnus-mime-button-map
5861                ,gnus-mouse-face-prop ,gnus-article-mouse-face
5862                face ,gnus-article-button-face
5863                gnus-part ,id
5864                gnus-data ,handle))
5865             (widget-convert-button 'link from (point)
5866                                    :action 'gnus-widget-press-button
5867                                    :button-keymap gnus-widget-button-keymap)
5868             (insert "  "))
5869           (insert "\n\n"))
5870         (when preferred
5871           (if (stringp (car preferred))
5872               (gnus-display-mime preferred)
5873             (let ((mail-parse-charset gnus-newsgroup-charset)
5874                   (mail-parse-ignored-charsets
5875                    (with-current-buffer gnus-summary-buffer
5876                      gnus-newsgroup-ignored-charsets)))
5877               (mm-display-part preferred)
5878               ;; Do highlighting.
5879               (save-excursion
5880                 (save-restriction
5881                   (narrow-to-region (car begend) (point-max))
5882                   (gnus-treat-article
5883                    nil (length gnus-article-mime-handle-alist)
5884                    (gnus-article-mime-total-parts)
5885                    (mm-handle-media-type handle))))))
5886           (goto-char (point-max))
5887           (setcdr begend (point-marker)))))
5888     (when ibegend
5889       (goto-char point))))
5890
5891 (defconst gnus-article-wash-status-strings
5892   (let ((alist '((cite "c" "Possible hidden citation text"
5893                        " " "All citation text visible")
5894                  (headers "h" "Hidden headers"
5895                           " " "All headers visible.")
5896                  (pgp "p" "Encrypted or signed message status hidden"
5897                       " " "No hidden encryption nor digital signature status")
5898                  (signature "s" "Signature has been hidden"
5899                             " " "Signature is visible")
5900                  (overstrike "o" "Overstrike (^H) characters applied"
5901                              " " "No overstrike characters applied")
5902                  (emphasis "e" "/*_Emphasis_*/ characters applied"
5903                            " " "No /*_emphasis_*/ characters applied")))
5904         result)
5905     (dolist (entry alist result)
5906       (let ((key (nth 0 entry))
5907             (on (copy-sequence (nth 1 entry)))
5908             (on-help (nth 2 entry))
5909             (off (copy-sequence (nth 3 entry)))
5910             (off-help (nth 4 entry)))
5911         (put-text-property 0 1 'help-echo on-help on)
5912         (put-text-property 0 1 'help-echo off-help off)
5913         (push (list key on off) result))))
5914   "Alist of strings describing wash status in the mode line.
5915 Each entry has the form (KEY ON OF), where the KEY is a symbol
5916 representing the particular washing function, ON is the string to use
5917 in the article mode line when the washing function is active, and OFF
5918 is the string to use when it is inactive.")
5919
5920 (defun gnus-article-wash-status-entry (key value)
5921   (let ((entry (assoc key gnus-article-wash-status-strings)))
5922     (if value (nth 1 entry) (nth 2 entry))))
5923
5924 (defun gnus-article-wash-status ()
5925   "Return a string which display status of article washing."
5926   (with-current-buffer gnus-article-buffer
5927     (let ((cite (memq 'cite gnus-article-wash-types))
5928           (headers (memq 'headers gnus-article-wash-types))
5929           (boring (memq 'boring-headers gnus-article-wash-types))
5930           (pgp (memq 'pgp gnus-article-wash-types))
5931           (pem (memq 'pem gnus-article-wash-types))
5932           (signed (memq 'signed gnus-article-wash-types))
5933           (encrypted (memq 'encrypted gnus-article-wash-types))
5934           (signature (memq 'signature gnus-article-wash-types))
5935           (overstrike (memq 'overstrike gnus-article-wash-types))
5936           (emphasis (memq 'emphasis gnus-article-wash-types)))
5937       (concat
5938        (gnus-article-wash-status-entry 'cite cite)
5939        (gnus-article-wash-status-entry 'headers (or headers boring))
5940        (gnus-article-wash-status-entry 'pgp (or pgp pem signed encrypted))
5941        (gnus-article-wash-status-entry 'signature signature)
5942        (gnus-article-wash-status-entry 'overstrike overstrike)
5943        (gnus-article-wash-status-entry 'emphasis emphasis)))))
5944
5945 (defun gnus-add-wash-type (type)
5946   "Add a washing of TYPE to the current status."
5947   (add-to-list 'gnus-article-wash-types type))
5948
5949 (defun gnus-delete-wash-type (type)
5950   "Add a washing of TYPE to the current status."
5951   (setq gnus-article-wash-types (delq type gnus-article-wash-types)))
5952
5953 (defun gnus-add-image (category image)
5954   "Add IMAGE of CATEGORY to the list of displayed images."
5955   (let ((entry (assq category gnus-article-image-alist)))
5956     (unless entry
5957       (setq entry (list category))
5958       (push entry gnus-article-image-alist))
5959     (nconc entry (list image))))
5960
5961 (defun gnus-delete-images (category)
5962   "Delete all images in CATEGORY."
5963   (let ((entry (assq category gnus-article-image-alist)))
5964     (dolist (image (cdr entry))
5965       (gnus-remove-image image category))
5966     (setq gnus-article-image-alist (delq entry gnus-article-image-alist))
5967     (gnus-delete-wash-type category)))
5968
5969 (defalias 'gnus-article-hide-headers-if-wanted 'gnus-article-maybe-hide-headers)
5970
5971 (defun gnus-article-maybe-hide-headers ()
5972   "Hide unwanted headers if `gnus-have-all-headers' is nil.
5973 Provided for backwards compatibility."
5974   (when (and (or (not (gnus-buffer-live-p gnus-summary-buffer))
5975                  (not (with-current-buffer gnus-summary-buffer
5976                         gnus-have-all-headers)))
5977              (not gnus-inhibit-hiding))
5978     (gnus-article-hide-headers)))
5979
5980 ;;; Article savers.
5981
5982 (defun gnus-output-to-file (file-name)
5983   "Append the current article to a file named FILE-NAME.
5984 If `gnus-article-save-coding-system' is non-nil, it is used to encode
5985 text and used as the value of the coding cookie which is added to the
5986 top of a file.  Otherwise, this function saves a raw article without
5987 the coding cookie."
5988   (let* ((artbuf (current-buffer))
5989          (file-name-coding-system nnmail-pathname-coding-system)
5990          (coding gnus-article-save-coding-system)
5991          (coding-system-for-read (if coding
5992                                      nil ;; Rely on the coding cookie.
5993                                    mm-text-coding-system))
5994          (coding-system-for-write (or coding
5995                                       mm-text-coding-system-for-write
5996                                       mm-text-coding-system))
5997          (exists (file-exists-p file-name)))
5998     (with-temp-buffer
5999       (when exists
6000         (insert-file-contents file-name)
6001         (goto-char (point-min))
6002         ;; Remove the existing coding cookie.
6003         (when (looking-at "X-Gnus-Coding-System: .+\n\n")
6004           (delete-region (match-beginning 0) (match-end 0))))
6005       (goto-char (point-max))
6006       (insert-buffer-substring artbuf)
6007       ;; Append newline at end of the buffer as separator, and then
6008       ;; save it to file.
6009       (goto-char (point-max))
6010       (insert "\n")
6011       (when coding
6012         ;; If the coding system is not suitable to encode the text,
6013         ;; ask a user for a proper one.
6014         (when (fboundp 'select-safe-coding-system)
6015           (setq coding (coding-system-base
6016                         (save-window-excursion
6017                           (select-safe-coding-system (point-min) (point-max)
6018                                                      coding))))
6019           (setq coding-system-for-write
6020                 (or (cdr (assq coding '((mule-utf-8 . utf-8))))
6021                     coding)))
6022         (goto-char (point-min))
6023         ;; Add the coding cookie.
6024         (insert (format "X-Gnus-Coding-System: -*- coding: %s; -*-\n\n"
6025                         coding-system-for-write)))
6026       (if exists
6027           (progn
6028             (write-region (point-min) (point-max) file-name nil 'no-message)
6029             (message "Appended to %s" file-name))
6030         (write-region (point-min) (point-max) file-name))))
6031   t)
6032
6033 (defun gnus-narrow-to-page (&optional arg)
6034   "Narrow the article buffer to a page.
6035 If given a numerical ARG, move forward ARG pages."
6036   (interactive "P")
6037   (setq arg (if arg (prefix-numeric-value arg) 0))
6038   (with-current-buffer gnus-article-buffer
6039     (widen)
6040     ;; Remove any old next/prev buttons.
6041     (when (gnus-visual-p 'page-marker)
6042       (let ((inhibit-read-only t))
6043         (gnus-remove-text-with-property 'gnus-prev)
6044         (gnus-remove-text-with-property 'gnus-next)))
6045     (let (st nd pt)
6046       (when (save-excursion
6047               (cond ((< arg 0)
6048                      (if (re-search-backward page-delimiter nil 'move (abs arg))
6049                          (prog1
6050                              (setq nd (match-beginning 0)
6051                                    pt nd)
6052                            (when (re-search-backward page-delimiter nil t)
6053                              (setq st (match-end 0))))
6054                        (when (re-search-forward page-delimiter nil t)
6055                          (setq nd (match-beginning 0)
6056                                pt (point-min)))))
6057                     ((> arg 0)
6058                      (if (re-search-forward page-delimiter nil 'move arg)
6059                          (prog1
6060                              (setq st (match-end 0)
6061                                    pt st)
6062                            (when (re-search-forward page-delimiter nil t)
6063                              (setq nd (match-beginning 0))))
6064                        (when (re-search-backward page-delimiter nil t)
6065                          (setq st (match-end 0)
6066                                pt (point-max)))))
6067                     (t
6068                      (when (re-search-backward page-delimiter nil t)
6069                        (goto-char (setq st (match-end 0))))
6070                      (when (re-search-forward page-delimiter nil t)
6071                        (setq nd (match-beginning 0)))
6072                      (or st nd))))
6073         (setq gnus-page-broken t)
6074         (when pt (goto-char pt))
6075         (narrow-to-region (or st (point-min)) (or nd (point-max)))
6076         (when (gnus-visual-p 'page-marker)
6077           (save-excursion
6078             (when nd
6079               (goto-char nd)
6080               (gnus-insert-next-page-button))
6081             (when st
6082               (goto-char st)
6083               (gnus-insert-prev-page-button))))))))
6084
6085 ;; Article mode commands
6086
6087 (defun gnus-article-goto-next-page ()
6088   "Show the next page of the article."
6089   (interactive)
6090   (when (gnus-article-next-page)
6091     (goto-char (point-min))
6092     (gnus-article-read-summary-keys nil (gnus-character-to-event ?n))))
6093
6094
6095 (defun gnus-article-goto-prev-page ()
6096   "Show the previous page of the article."
6097   (interactive)
6098   (if (save-restriction (widen) (bobp)) ;; Real beginning-of-buffer?
6099       (gnus-article-read-summary-keys nil (gnus-character-to-event ?p))
6100     (gnus-article-prev-page nil)))
6101
6102 ;; This is cleaner but currently breaks `gnus-pick-mode':
6103 ;;
6104 ;; (defun gnus-article-goto-next-page ()
6105 ;;   "Show the next page of the article."
6106 ;;   (interactive)
6107 ;;   (gnus-eval-in-buffer-window gnus-summary-buffer
6108 ;;     (gnus-summary-next-page)))
6109 ;;
6110 ;; (defun gnus-article-goto-prev-page ()
6111 ;;   "Show the next page of the article."
6112 ;;   (interactive)
6113 ;;   (gnus-eval-in-buffer-window gnus-summary-buffer
6114 ;;     (gnus-summary-prev-page)))
6115
6116 (defun gnus-article-next-page (&optional lines)
6117   "Show the next page of the current article.
6118 If end of article, return non-nil.  Otherwise return nil.
6119 Argument LINES specifies lines to be scrolled up."
6120   (interactive "p")
6121   (move-to-window-line (if (featurep 'xemacs) -1 (- -1 scroll-margin)))
6122   (if (and (not (and gnus-article-over-scroll
6123                      (> (count-lines (window-start) (point-max))
6124                         (if (featurep 'xemacs)
6125                             (or lines (1- (window-height)))
6126                           (+ (or lines (1- (window-height))) scroll-margin)))))
6127            (save-excursion
6128              (end-of-line)
6129              (and (pos-visible-in-window-p)     ;Not continuation line.
6130                   (>= (1+ (point)) (point-max))))) ;Allow for trailing newline.
6131       ;; Nothing in this page.
6132       (if (or (not gnus-page-broken)
6133               (save-excursion
6134                 (save-restriction
6135                   (widen)
6136                   (forward-line)
6137                   (eobp)))) ;Real end-of-buffer?
6138           (progn
6139             (when gnus-article-over-scroll
6140               (gnus-article-next-page-1 lines))
6141             t)                  ;Nothing more.
6142         (gnus-narrow-to-page 1)         ;Go to next page.
6143         nil)
6144     ;; More in this page.
6145     (gnus-article-next-page-1 lines)
6146     nil))
6147
6148 (defmacro gnus-article-beginning-of-window ()
6149   "Move point to the beginning of the window.
6150 In Emacs, the point is placed at the line number which `scroll-margin'
6151 specifies."
6152   (if (featurep 'xemacs)
6153       '(move-to-window-line 0)
6154     '(move-to-window-line
6155       (min (max 0 scroll-margin)
6156            (max 1 (- (window-height)
6157                      (if mode-line-format 1 0)
6158                      (if header-line-format 1 0)
6159                      2))))))
6160
6161 (defun gnus-article-next-page-1 (lines)
6162   (unless (featurep 'xemacs)
6163     ;; Protect against the bug that Emacs 21.x hangs up when scrolling up for
6164     ;; too many number of lines if `scroll-margin' is set as two or greater.
6165     (when (and (numberp lines)
6166                (> lines 0)
6167                (> scroll-margin 0))
6168       (setq lines (min lines
6169                        (max 0 (- (count-lines (window-start) (point-max))
6170                                  scroll-margin))))))
6171   (condition-case ()
6172       (let ((scroll-in-place nil))
6173         (scroll-up lines))
6174     (end-of-buffer
6175      ;; Long lines may cause an end-of-buffer error.
6176      (goto-char (point-max))))
6177   (gnus-article-beginning-of-window))
6178
6179 (defun gnus-article-prev-page (&optional lines)
6180   "Show previous page of current article.
6181 Argument LINES specifies lines to be scrolled down."
6182   (interactive "p")
6183   (move-to-window-line 0)
6184   (if (and gnus-page-broken
6185            (bobp)
6186            (not (save-restriction (widen) (bobp)))) ;Real beginning-of-buffer?
6187       (progn
6188         (gnus-narrow-to-page -1)        ;Go to previous page.
6189         (goto-char (point-max))
6190         (recenter (if gnus-article-over-scroll
6191                       (if lines
6192                           (max (if (featurep 'xemacs)
6193                                    lines
6194                                  (+ lines scroll-margin))
6195                                3)
6196                         (- (window-height) 2))
6197                     -1)))
6198     (prog1
6199         (condition-case ()
6200             (let ((scroll-in-place nil))
6201               (scroll-down lines))
6202           (beginning-of-buffer
6203            (goto-char (point-min))))
6204       (gnus-article-beginning-of-window))))
6205
6206 (defun gnus-article-only-boring-p ()
6207   "Decide whether there is only boring text remaining in the article.
6208 Something \"interesting\" is a word of at least two letters that does
6209 not have a face in `gnus-article-boring-faces'."
6210   (when (and gnus-article-skip-boring
6211              (boundp 'gnus-article-boring-faces)
6212              (symbol-value 'gnus-article-boring-faces))
6213     (save-excursion
6214       (let ((inhibit-point-motion-hooks t))
6215         (catch 'only-boring
6216           (while (re-search-forward "\\b\\w\\w" nil t)
6217             (forward-char -1)
6218             (when (not (gnus-intersection
6219                         (gnus-faces-at (point))
6220                         (symbol-value 'gnus-article-boring-faces)))
6221               (throw 'only-boring nil)))
6222           (throw 'only-boring t))))))
6223
6224 (defun gnus-article-refer-article ()
6225   "Read article specified by message-id around point."
6226   (interactive)
6227   (save-excursion
6228     (re-search-backward "[ \t]\\|^" (point-at-bol) t)
6229     (re-search-forward "<?news:<?\\|<" (point-at-eol) t)
6230     (if (re-search-forward "[^@ ]+@[^ \t>]+" (point-at-eol) t)
6231         (let ((msg-id (concat "<" (match-string 0) ">")))
6232           (set-buffer gnus-summary-buffer)
6233           (gnus-summary-refer-article msg-id))
6234       (error "No references around point"))))
6235
6236 (defun gnus-article-show-summary ()
6237   "Reconfigure windows to show summary buffer."
6238   (interactive)
6239   (if (not (gnus-buffer-live-p gnus-summary-buffer))
6240       (error "There is no summary buffer for this article buffer")
6241     (gnus-article-set-globals)
6242     (gnus-configure-windows 'article)
6243     (gnus-summary-goto-subject gnus-current-article)
6244     (gnus-summary-position-point)))
6245
6246 (defun gnus-article-describe-briefly ()
6247   "Describe article mode commands briefly."
6248   (interactive)
6249   (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")))
6250
6251 (defun gnus-article-summary-command ()
6252   "Execute the last keystroke in the summary buffer."
6253   (interactive)
6254   (let ((obuf (current-buffer))
6255         (owin (current-window-configuration))
6256         func)
6257     (switch-to-buffer gnus-article-current-summary 'norecord)
6258     (setq func (lookup-key (current-local-map) (this-command-keys)))
6259     (call-interactively func)
6260     (set-buffer obuf)
6261     (set-window-configuration owin)
6262     (set-window-point (get-buffer-window (current-buffer)) (point))))
6263
6264 (defun gnus-article-summary-command-nosave ()
6265   "Execute the last keystroke in the summary buffer."
6266   (interactive)
6267   (let (func)
6268     (pop-to-buffer gnus-article-current-summary)
6269     (setq func (lookup-key (current-local-map) (this-command-keys)))
6270     (call-interactively func)))
6271
6272 (defun gnus-article-check-buffer ()
6273   "Beep if not in an article buffer."
6274   (unless (equal major-mode 'gnus-article-mode)
6275     (error "Command invoked outside of a Gnus article buffer")))
6276
6277 (defun gnus-article-read-summary-keys (&optional arg key not-restore-window)
6278   "Read a summary buffer key sequence and execute it from the article buffer."
6279   (interactive "P")
6280   (gnus-article-check-buffer)
6281   (let ((nosaves
6282          '("q" "Q"  "c" "r" "\C-c\C-f" "m"  "a" "f"
6283            "Zc" "ZC" "ZE" "ZQ" "ZZ" "Zn" "ZR" "ZG" "ZN" "ZP"
6284            "=" "^" "\M-^" "|"))
6285         (nosave-but-article
6286          '("A " "A<" "A>" "AM" "AP" "AR" "AT" "A\C-?" "A\M-\r" "A\r" "Ab" "Ae"
6287            "An" "Ap" [?A (meta return)] [?A delete]))
6288         (nosave-in-article
6289          '("AS" "\C-d"))
6290         (up-to-top
6291          '("n" "Gn" "p" "Gp"))
6292         keys new-sum-point)
6293     (with-current-buffer gnus-article-current-summary
6294       (let (gnus-pick-mode)
6295         (setq unread-command-events (nconc unread-command-events
6296                                            (list (or key last-command-event)))
6297               keys (if (featurep 'xemacs)
6298                        (events-to-keys (read-key-sequence nil t))
6299                      (read-key-sequence nil t)))))
6300
6301     (message "")
6302
6303     (cond
6304      ((eq (aref keys (1- (length keys))) ?\C-h)
6305       (gnus-article-describe-bindings (substring keys 0 -1)))
6306      ((or (member keys nosaves)
6307           (member keys nosave-but-article)
6308           (member keys nosave-in-article))
6309       (let (func)
6310         (save-window-excursion
6311           (pop-to-buffer gnus-article-current-summary)
6312           ;; We disable the pick minor mode commands.
6313           (let (gnus-pick-mode)
6314             (setq func (lookup-key (current-local-map) keys))))
6315         (if (or (not func)
6316                 (numberp func))
6317             (ding)
6318           (unless (member keys nosave-in-article)
6319             (set-buffer gnus-article-current-summary))
6320           (call-interactively func)
6321           (setq new-sum-point (point)))
6322         (when (member keys nosave-but-article)
6323           (pop-to-buffer gnus-article-buffer))))
6324      (t
6325       ;; These commands should restore window configuration.
6326       (let ((obuf (current-buffer))
6327             (owin (current-window-configuration))
6328             win func in-buffer selected new-sum-start new-sum-hscroll err)
6329         (cond (not-restore-window
6330                (pop-to-buffer gnus-article-current-summary)
6331                (setq win (selected-window)))
6332               ((setq win (get-buffer-window gnus-article-current-summary))
6333                (select-window win))
6334               (t
6335                (let ((summary-buffer gnus-article-current-summary))
6336                  (gnus-configure-windows 'article)
6337                  (unless (setq win (get-buffer-window summary-buffer 'visible))
6338                    (let ((gnus-buffer-configuration
6339                           '(article ((vertical 1.0
6340                                                (summary 0.25 point)
6341                                                (article 1.0))))))
6342                      (gnus-configure-windows 'article))
6343                    (setq win (get-buffer-window summary-buffer 'visible)))
6344                  (gnus-select-frame-set-input-focus (window-frame win))
6345                  (select-window win))))
6346         (setq in-buffer (current-buffer))
6347         ;; We disable the pick minor mode commands.
6348         (if (and (setq func (let (gnus-pick-mode)
6349                               (lookup-key (current-local-map) keys)))
6350                  (functionp func)
6351                  (condition-case code
6352                      (progn
6353                        (call-interactively func)
6354                        t)
6355                    (error
6356                     (setq err code)
6357                     nil)))
6358             (progn
6359               (when (eq win (selected-window))
6360                 (setq new-sum-point (point)
6361                       new-sum-start (window-start win)
6362                       new-sum-hscroll (window-hscroll win)))
6363               (when (or (eq in-buffer (current-buffer))
6364                         (when (eq obuf (current-buffer))
6365                           (set-buffer in-buffer)
6366                           t))
6367                 (setq selected (gnus-summary-select-article))
6368                 (set-buffer obuf)
6369                 (unless not-restore-window
6370                   (set-window-configuration owin))
6371                 (when (and (eq selected 'old)
6372                            new-sum-point)
6373                   (set-window-start (get-buffer-window (current-buffer))
6374                                     1)
6375                   (set-window-point (get-buffer-window (current-buffer))
6376                                     (if (article-goto-body)
6377                                         (1- (point))
6378                                       (point))))
6379                 (when (and (not not-restore-window)
6380                            new-sum-point
6381                            (window-live-p win)
6382                            (with-current-buffer (window-buffer win)
6383                              (eq major-mode 'gnus-summary-mode)))
6384                   (set-window-point win new-sum-point)
6385                   (set-window-start win new-sum-start)
6386                   (set-window-hscroll win new-sum-hscroll))))
6387           (set-window-configuration owin)
6388           (if err
6389               (signal (car err) (cdr err))
6390             (ding))))))))
6391
6392 (defun gnus-article-read-summary-send-keys ()
6393   (interactive)
6394   (let ((unread-command-events (list (gnus-character-to-event ?S))))
6395     (gnus-article-read-summary-keys)))
6396
6397 (defun gnus-article-describe-key (key)
6398   "Display documentation of the function invoked by KEY.
6399 KEY is a string or a vector."
6400   (interactive (list (let ((cursor-in-echo-area t)) ;; better for XEmacs.
6401                        (read-key-sequence "Describe key: "))))
6402   (gnus-article-check-buffer)
6403   (if (memq (key-binding key t) '(gnus-article-read-summary-keys
6404                                   gnus-article-read-summary-send-keys))
6405       (with-current-buffer gnus-article-current-summary
6406         (setq unread-command-events
6407               (if (featurep 'xemacs)
6408                   (append key nil)
6409                 (mapcar (lambda (x) (if (and (integerp x) (>= x 128))
6410                                         (list 'meta (- x 128))
6411                                       x))
6412                         key)))
6413         (let ((cursor-in-echo-area t)
6414               gnus-pick-mode)
6415           (describe-key (read-key-sequence nil t))))
6416     (describe-key key)))
6417
6418 (defun gnus-article-describe-key-briefly (key &optional insert)
6419   "Display documentation of the function invoked by KEY.
6420 KEY is a string or a vector."
6421   (interactive (list (let ((cursor-in-echo-area t)) ;; better for XEmacs.
6422                        (read-key-sequence "Describe key: "))
6423                      current-prefix-arg))
6424   (gnus-article-check-buffer)
6425   (if (memq (key-binding key t) '(gnus-article-read-summary-keys
6426                                   gnus-article-read-summary-send-keys))
6427       (with-current-buffer gnus-article-current-summary
6428         (setq unread-command-events
6429               (if (featurep 'xemacs)
6430                   (append key nil)
6431                 (mapcar (lambda (x) (if (and (integerp x) (>= x 128))
6432                                         (list 'meta (- x 128))
6433                                       x))
6434                         key)))
6435         (let ((cursor-in-echo-area t)
6436               gnus-pick-mode)
6437           (describe-key-briefly (read-key-sequence nil t) insert)))
6438     (describe-key-briefly key insert)))
6439
6440 ;;`gnus-agent-mode' in gnus-agent.el will define it.
6441 (defvar gnus-agent-summary-mode)
6442 (defvar gnus-draft-mode)
6443
6444 (defun gnus-article-describe-bindings (&optional prefix)
6445   "Show a list of all defined keys, and their definitions.
6446 The optional argument PREFIX, if non-nil, should be a key sequence;
6447 then we display only bindings that start with that prefix."
6448   (interactive)
6449   (gnus-article-check-buffer)
6450   (let ((keymap (copy-keymap gnus-article-mode-map))
6451         (map (copy-keymap gnus-article-send-map))
6452         (sumkeys (where-is-internal 'gnus-article-read-summary-keys))
6453         agent draft)
6454     (define-key keymap "S" map)
6455     (define-key map [t] nil)
6456     (with-current-buffer gnus-article-current-summary
6457       (set-keymap-parent map (key-binding "S"))
6458       (let (key def gnus-pick-mode)
6459         (while sumkeys
6460           (setq key (pop sumkeys))
6461           (cond ((and (vectorp key) (= (length key) 1)
6462                       (consp (setq def (aref key 0)))
6463                       (numberp (car def)) (numberp (cdr def)))
6464                  (when (< (max (car def) (cdr def)) 128)
6465                    (setq sumkeys
6466                          (append (mapcar
6467                                   #'vector
6468                                   (nreverse (gnus-uncompress-range def)))
6469                                  sumkeys))))
6470                 ((setq def (key-binding key))
6471                  (unless (eq def 'undefined)
6472                    (define-key keymap key def))))))
6473       (when (boundp 'gnus-agent-summary-mode)
6474         (setq agent gnus-agent-summary-mode))
6475       (when (boundp 'gnus-draft-mode)
6476         (setq draft gnus-draft-mode)))
6477     (with-temp-buffer
6478       (use-local-map keymap)
6479       (set (make-local-variable 'gnus-agent-summary-mode) agent)
6480       (set (make-local-variable 'gnus-draft-mode) draft)
6481       (describe-bindings prefix))
6482     (let ((item `((lambda (prefix)
6483                     (with-current-buffer ,(current-buffer)
6484                       (gnus-article-describe-bindings prefix)))
6485                   ,prefix)))
6486       (with-current-buffer (if (fboundp 'help-buffer)
6487                                (let (help-xref-following) (help-buffer))
6488                              "*Help*") ;; Emacs 21
6489         (setq help-xref-stack-item item)))))
6490
6491 (defun gnus-article-reply-with-original (&optional wide)
6492   "Start composing a reply mail to the current message.
6493 The text in the region will be yanked.  If the region isn't active,
6494 the entire article will be yanked."
6495   (interactive)
6496   (let ((article (cdr gnus-article-current))
6497         contents)
6498     (if (not (gnus-region-active-p))
6499         (with-current-buffer gnus-summary-buffer
6500           (gnus-summary-reply (list (list article)) wide))
6501       (setq contents (buffer-substring (point) (mark t)))
6502       ;; Deactivate active regions.
6503       (when (and (boundp 'transient-mark-mode)
6504                  transient-mark-mode)
6505         (setq mark-active nil))
6506       (with-current-buffer gnus-summary-buffer
6507         (gnus-summary-reply
6508          (list (list article contents)) wide)))))
6509
6510 (defun gnus-article-wide-reply-with-original ()
6511   "Start composing a wide reply mail to the current message.
6512 The text in the region will be yanked.  If the region isn't active,
6513 the entire article will be yanked."
6514   (interactive)
6515   (gnus-article-reply-with-original t))
6516
6517 (defun gnus-article-followup-with-original ()
6518   "Compose a followup to the current article.
6519 The text in the region will be yanked.  If the region isn't active,
6520 the entire article will be yanked."
6521   (interactive)
6522   (let ((article (cdr gnus-article-current))
6523         contents)
6524       (if (not (gnus-region-active-p))
6525           (with-current-buffer gnus-summary-buffer
6526             (gnus-summary-followup (list (list article))))
6527         (setq contents (buffer-substring (point) (mark t)))
6528         ;; Deactivate active regions.
6529         (when (and (boundp 'transient-mark-mode)
6530                    transient-mark-mode)
6531           (setq mark-active nil))
6532         (with-current-buffer gnus-summary-buffer
6533           (gnus-summary-followup
6534            (list (list article contents)))))))
6535
6536 (defun gnus-article-hide (&optional arg force)
6537   "Hide all the gruft in the current article.
6538 This means that signatures, cited text and (some) headers will be
6539 hidden.
6540 If given a prefix, show the hidden text instead."
6541   (interactive (append (gnus-article-hidden-arg) (list 'force)))
6542   (gnus-article-hide-headers arg)
6543   (gnus-article-hide-list-identifiers arg)
6544   (gnus-article-hide-citation-maybe arg force)
6545   (gnus-article-hide-signature arg))
6546
6547 (defun gnus-article-maybe-highlight ()
6548   "Do some article highlighting if article highlighting is requested."
6549   (when (gnus-visual-p 'article-highlight 'highlight)
6550     (gnus-article-highlight-some)))
6551
6552 (defun gnus-check-group-server ()
6553   ;; Make sure the connection to the server is alive.
6554   (unless (gnus-server-opened
6555            (gnus-find-method-for-group gnus-newsgroup-name))
6556     (gnus-check-server (gnus-find-method-for-group gnus-newsgroup-name))
6557     (gnus-request-group gnus-newsgroup-name t)))
6558
6559 (eval-when-compile
6560   (autoload 'nneething-get-file-name "nneething"))
6561
6562 (defun gnus-request-article-this-buffer (article group)
6563   "Get an article and insert it into this buffer."
6564   (let (do-update-line sparse-header)
6565     (prog1
6566         (save-excursion
6567           (erase-buffer)
6568           (gnus-kill-all-overlays)
6569           (setq group (or group gnus-newsgroup-name))
6570
6571           ;; Using `gnus-request-article' directly will insert the article into
6572           ;; `nntp-server-buffer' - so we'll save some time by not having to
6573           ;; copy it from the server buffer into the article buffer.
6574
6575           ;; We only request an article by message-id when we do not have the
6576           ;; headers for it, so we'll have to get those.
6577           (when (stringp article)
6578             (gnus-read-header article))
6579
6580           ;; If the article number is negative, that means that this article
6581           ;; doesn't belong in this newsgroup (possibly), so we find its
6582           ;; message-id and request it by id instead of number.
6583           (when (and (numberp article)
6584                      gnus-summary-buffer
6585                      (get-buffer gnus-summary-buffer)
6586                      (gnus-buffer-exists-p gnus-summary-buffer))
6587             (with-current-buffer gnus-summary-buffer
6588               (let ((header (gnus-summary-article-header article)))
6589                 (when (< article 0)
6590                   (cond
6591                    ((memq article gnus-newsgroup-sparse)
6592                     ;; This is a sparse gap article.
6593                     (setq do-update-line article)
6594                     (setq article (mail-header-id header))
6595                     (setq sparse-header (gnus-read-header article))
6596                     (setq gnus-newsgroup-sparse
6597                           (delq article gnus-newsgroup-sparse)))
6598                    ((vectorp header)
6599                     ;; It's a real article.
6600                     (setq article (mail-header-id header)))
6601                    (t
6602                     ;; It is an extracted pseudo-article.
6603                     (setq article 'pseudo)
6604                     (gnus-request-pseudo-article header))))
6605
6606                 (let ((method (gnus-find-method-for-group
6607                                gnus-newsgroup-name)))
6608                   (when (and (eq (car method) 'nneething)
6609                              (vectorp header))
6610                     (let ((dir (nneething-get-file-name
6611                                 (mail-header-id header))))
6612                       (when (and (stringp dir)
6613                                  (file-directory-p dir))
6614                         (setq article 'nneething)
6615                         (gnus-group-enter-directory dir))))))))
6616
6617           (cond
6618            ;; Refuse to select canceled articles.
6619            ((and (numberp article)
6620                  gnus-summary-buffer
6621                  (get-buffer gnus-summary-buffer)
6622                  (gnus-buffer-exists-p gnus-summary-buffer)
6623                  (eq (cdr (with-current-buffer gnus-summary-buffer
6624                             (assq article gnus-newsgroup-reads)))
6625                      gnus-canceled-mark))
6626             nil)
6627            ;; We first check `gnus-original-article-buffer'.
6628            ((and (get-buffer gnus-original-article-buffer)
6629                  (numberp article)
6630                  (with-current-buffer gnus-original-article-buffer
6631                    (and (equal (car gnus-original-article) group)
6632                         (eq (cdr gnus-original-article) article))))
6633             ;; `insert-buffer-substring' would incorrectly use the
6634             ;; equivalent of string-make-multibyte which amount to decoding
6635             ;; with locale-coding-system, causing failure of
6636             ;; subsequent decoding.
6637             (insert (mm-string-to-multibyte
6638                      (with-current-buffer gnus-original-article-buffer
6639                        (buffer-substring (point-min) (point-max)))))
6640             'article)
6641            ;; Check the backlog.
6642            ((and gnus-keep-backlog
6643                  (gnus-backlog-request-article group article (current-buffer)))
6644             'article)
6645            ;; Check asynchronous pre-fetch.
6646            ((gnus-async-request-fetched-article group article (current-buffer))
6647             (gnus-async-prefetch-next group article gnus-summary-buffer)
6648             (when (and (numberp article) gnus-keep-backlog)
6649               (gnus-backlog-enter-article group article (current-buffer)))
6650             'article)
6651            ;; Check the cache.
6652            ((and gnus-use-cache
6653                  (numberp article)
6654                  (gnus-cache-request-article article group))
6655             'article)
6656            ;; Check the agent cache.
6657            ((gnus-agent-request-article article group)
6658             'article)
6659            ;; Get the article and put into the article buffer.
6660            ((or (stringp article)
6661                 (numberp article))
6662             (let ((gnus-override-method gnus-override-method)
6663                   (methods (and (stringp article)
6664                                 gnus-refer-article-method))
6665                   (backend (car (gnus-find-method-for-group
6666                                  gnus-newsgroup-name)))
6667                   result
6668                   (inhibit-read-only t))
6669               (if (or (not (listp methods))
6670                       (and (symbolp (car methods))
6671                            (assq (car methods) nnoo-definition-alist)))
6672                   (setq methods (list methods)))
6673               (when (and (null gnus-override-method)
6674                          methods)
6675                 (setq gnus-override-method (pop methods)))
6676               (while (not result)
6677                 (when (eq gnus-override-method 'current)
6678                   (setq gnus-override-method
6679                         (with-current-buffer gnus-summary-buffer
6680                           gnus-current-select-method)))
6681                 (erase-buffer)
6682                 (gnus-kill-all-overlays)
6683                 (let ((gnus-newsgroup-name group))
6684                   (gnus-check-group-server))
6685                 (cond
6686                  ((gnus-request-article article group (current-buffer))
6687                   (when (numberp article)
6688                     (gnus-async-prefetch-next group article
6689                                               gnus-summary-buffer)
6690                     (when gnus-keep-backlog
6691                       (gnus-backlog-enter-article
6692                        group article (current-buffer))))
6693                   (setq result 'article))
6694                  (methods
6695                   (setq gnus-override-method (pop methods)))
6696                  ((not (string-match "^400 "
6697                                      (nnheader-get-report backend)))
6698                   ;; If we get 400 server disconnect, reconnect and
6699                   ;; retry; otherwise, assume the article has expired.
6700                   (setq result 'done))))
6701               (and (eq result 'article) 'article)))
6702            ;; It was a pseudo.
6703            (t article)))
6704
6705       ;; Associate this article with the current summary buffer.
6706       (setq gnus-article-current-summary gnus-summary-buffer)
6707
6708       ;; Take the article from the original article buffer
6709       ;; and place it in the buffer it's supposed to be in.
6710       (when (and (get-buffer gnus-article-buffer)
6711                  (equal (buffer-name (current-buffer))
6712                         (buffer-name (get-buffer gnus-article-buffer))))
6713         (save-excursion
6714           (if (get-buffer gnus-original-article-buffer)
6715               (set-buffer gnus-original-article-buffer)
6716             (set-buffer (gnus-get-buffer-create gnus-original-article-buffer))
6717             (buffer-disable-undo)
6718             (setq major-mode 'gnus-original-article-mode)
6719             (setq buffer-read-only t))
6720           (let ((inhibit-read-only t))
6721             (erase-buffer)
6722             (insert-buffer-substring gnus-article-buffer))
6723           (setq gnus-original-article (cons group article)))
6724
6725         ;; Decode charsets.
6726         (run-hooks 'gnus-article-decode-hook)
6727         ;; Mark article as decoded or not.
6728         (setq gnus-article-decoded-p gnus-article-decode-hook))
6729
6730       ;; Update sparse articles.
6731       (when (and do-update-line
6732                  (or (numberp article)
6733                      (stringp article)))
6734         (let ((buf (current-buffer)))
6735           (set-buffer gnus-summary-buffer)
6736           (gnus-summary-update-article do-update-line sparse-header)
6737           (gnus-summary-goto-subject do-update-line nil t)
6738           (set-window-point (gnus-get-buffer-window (current-buffer) t)
6739                             (point))
6740           (set-buffer buf))))))
6741
6742 ;;;
6743 ;;; Article editing
6744 ;;;
6745
6746 (defcustom gnus-article-edit-mode-hook nil
6747   "Hook run in article edit mode buffers."
6748   :group 'gnus-article-various
6749   :type 'hook)
6750
6751 (defvar gnus-article-edit-done-function nil)
6752
6753 (defvar gnus-article-edit-mode-map nil)
6754
6755 ;; Should we be using derived.el for this?
6756 (unless gnus-article-edit-mode-map
6757   (setq gnus-article-edit-mode-map (make-keymap))
6758   (set-keymap-parent gnus-article-edit-mode-map text-mode-map)
6759
6760   (gnus-define-keys gnus-article-edit-mode-map
6761     "\C-c?"    describe-mode
6762     "\C-c\C-c" gnus-article-edit-done
6763     "\C-c\C-k" gnus-article-edit-exit
6764     "\C-c\C-f\C-t" message-goto-to
6765     "\C-c\C-f\C-o" message-goto-from
6766     "\C-c\C-f\C-b" message-goto-bcc
6767     ;;"\C-c\C-f\C-w" message-goto-fcc
6768     "\C-c\C-f\C-c" message-goto-cc
6769     "\C-c\C-f\C-s" message-goto-subject
6770     "\C-c\C-f\C-r" message-goto-reply-to
6771     "\C-c\C-f\C-n" message-goto-newsgroups
6772     "\C-c\C-f\C-d" message-goto-distribution
6773     "\C-c\C-f\C-f" message-goto-followup-to
6774     "\C-c\C-f\C-m" message-goto-mail-followup-to
6775     "\C-c\C-f\C-k" message-goto-keywords
6776     "\C-c\C-f\C-u" message-goto-summary
6777     "\C-c\C-f\C-i" message-insert-or-toggle-importance
6778     "\C-c\C-f\C-a" message-generate-unsubscribed-mail-followup-to
6779     "\C-c\C-b" message-goto-body
6780     "\C-c\C-i" message-goto-signature
6781
6782     "\C-c\C-t" message-insert-to
6783     "\C-c\C-n" message-insert-newsgroups
6784     "\C-c\C-o" message-sort-headers
6785     "\C-c\C-e" message-elide-region
6786     "\C-c\C-v" message-delete-not-region
6787     "\C-c\C-z" message-kill-to-signature
6788     "\M-\r" message-newline-and-reformat
6789     "\C-c\C-a" mml-attach-file
6790     "\C-a" message-beginning-of-line
6791     "\t" message-tab
6792     "\M-;" comment-region)
6793
6794   (gnus-define-keys (gnus-article-edit-wash-map
6795                      "\C-c\C-w" gnus-article-edit-mode-map)
6796     "f" gnus-article-edit-full-stops))
6797
6798 (easy-menu-define
6799   gnus-article-edit-mode-field-menu gnus-article-edit-mode-map ""
6800   '("Field"
6801     ["Fetch To" message-insert-to t]
6802     ["Fetch Newsgroups" message-insert-newsgroups t]
6803     "----"
6804     ["To" message-goto-to t]
6805     ["From" message-goto-from t]
6806     ["Subject" message-goto-subject t]
6807     ["Cc" message-goto-cc t]
6808     ["Reply-To" message-goto-reply-to t]
6809     ["Summary" message-goto-summary t]
6810     ["Keywords" message-goto-keywords t]
6811     ["Newsgroups" message-goto-newsgroups t]
6812     ["Followup-To" message-goto-followup-to t]
6813     ["Mail-Followup-To" message-goto-mail-followup-to t]
6814     ["Distribution" message-goto-distribution t]
6815     ["Body" message-goto-body t]
6816     ["Signature" message-goto-signature t]))
6817
6818 (define-derived-mode gnus-article-edit-mode message-mode "Article Edit"
6819   "Major mode for editing articles.
6820 This is an extended text-mode.
6821
6822 \\{gnus-article-edit-mode-map}"
6823   (make-local-variable 'gnus-article-edit-done-function)
6824   (make-local-variable 'gnus-prev-winconf)
6825   (set (make-local-variable 'font-lock-defaults)
6826        '(message-font-lock-keywords t))
6827   (set (make-local-variable 'mail-header-separator) "")
6828   (set (make-local-variable 'gnus-article-edit-mode) t)
6829   (easy-menu-add message-mode-field-menu message-mode-map)
6830   (mml-mode)
6831   (setq buffer-read-only nil)
6832   (buffer-enable-undo)
6833   (widen))
6834
6835 (defun gnus-article-edit (&optional force)
6836   "Edit the current article.
6837 This will have permanent effect only in mail groups.
6838 If FORCE is non-nil, allow editing of articles even in read-only
6839 groups."
6840   (interactive "P")
6841   (when (and (not force)
6842              (gnus-group-read-only-p))
6843     (error "The current newsgroup does not support article editing"))
6844   (gnus-article-date-original)
6845   (gnus-article-edit-article
6846    'ignore
6847    `(lambda (no-highlight)
6848       'ignore
6849       (gnus-summary-edit-article-done
6850        ,(or (mail-header-references gnus-current-headers) "")
6851        ,(gnus-group-read-only-p) ,gnus-summary-buffer no-highlight))))
6852
6853 (defun gnus-article-edit-article (start-func exit-func &optional quiet)
6854   "Start editing the contents of the current article buffer."
6855   (let ((winconf (current-window-configuration)))
6856     (set-buffer gnus-article-buffer)
6857     (let ((message-auto-save-directory
6858            ;; Don't associate the article buffer with a draft file.
6859            nil))
6860       (gnus-article-edit-mode))
6861     (funcall start-func)
6862     (set-buffer-modified-p nil)
6863     (gnus-configure-windows 'edit-article)
6864     (setq gnus-article-edit-done-function exit-func)
6865     (setq gnus-prev-winconf winconf)
6866     (unless quiet
6867       (gnus-message 6 "C-c C-c to end edits"))))
6868
6869 (defun gnus-article-edit-done (&optional arg)
6870   "Update the article edits and exit."
6871   (interactive "P")
6872   (let ((func gnus-article-edit-done-function)
6873         (buf (current-buffer))
6874         (start (window-start))
6875         (p (point))
6876         (winconf gnus-prev-winconf))
6877     (widen) ;; Widen it in case that users narrowed the buffer.
6878     (funcall func arg)
6879     (set-buffer buf)
6880     ;; The cache and backlog have to be flushed somewhat.
6881     (when gnus-keep-backlog
6882       (gnus-backlog-remove-article
6883        (car gnus-article-current) (cdr gnus-article-current)))
6884     ;; Flush original article as well.
6885     (when (get-buffer gnus-original-article-buffer)
6886       (with-current-buffer gnus-original-article-buffer
6887         (setq gnus-original-article nil)))
6888     (when gnus-use-cache
6889       (gnus-cache-update-article
6890        (car gnus-article-current) (cdr gnus-article-current)))
6891     ;; We remove all text props from the article buffer.
6892     (kill-all-local-variables)
6893     (set-text-properties (point-min) (point-max) nil)
6894     (gnus-article-mode)
6895     (set-window-configuration winconf)
6896     (set-buffer buf)
6897     (set-window-start (get-buffer-window buf) start)
6898     (set-window-point (get-buffer-window buf) (point)))
6899   (gnus-summary-show-article))
6900
6901 (defun gnus-article-edit-exit ()
6902   "Exit the article editing without updating."
6903   (interactive)
6904   (when (or (not (buffer-modified-p))
6905             (yes-or-no-p "Article modified; kill anyway? "))
6906     (let ((curbuf (current-buffer))
6907           (p (point))
6908           (window-start (window-start)))
6909       (erase-buffer)
6910       (if (gnus-buffer-live-p gnus-original-article-buffer)
6911           (insert-buffer-substring gnus-original-article-buffer))
6912       (let ((winconf gnus-prev-winconf))
6913         (kill-all-local-variables)
6914         (gnus-article-mode)
6915         (set-window-configuration winconf)
6916         ;; Tippy-toe some to make sure that point remains where it was.
6917         (save-current-buffer
6918           (set-buffer curbuf)
6919           (set-window-start (get-buffer-window (current-buffer)) window-start)
6920           (goto-char p))))
6921     (gnus-summary-show-article)))
6922
6923 (defun gnus-article-edit-full-stops ()
6924   "Interactively repair spacing at end of sentences."
6925   (interactive)
6926   (save-excursion
6927     (goto-char (point-min))
6928     (search-forward-regexp "^$" nil t)
6929     (let ((case-fold-search nil))
6930       (query-replace-regexp "\\([.!?][])}]* \\)\\([[({A-Z]\\)" "\\1 \\2"))))
6931
6932 ;;;
6933 ;;; Article highlights
6934 ;;;
6935
6936 ;; Written by Per Abrahamsen <abraham@iesd.auc.dk>.
6937
6938 ;;; Internal Variables:
6939
6940 (defcustom gnus-button-url-regexp
6941   (concat
6942    "\\b\\(\\(www\\.\\|\\(s?https?\\|ftp\\|file\\|gopher\\|"
6943    "nntp\\|news\\|telnet\\|wais\\|mailto\\|info\\):\\)"
6944    "\\(//[-a-z0-9_.]+:[0-9]*\\)?"
6945    (if (string-match "[[:digit:]]" "1") ;; Support POSIX?
6946        (let ((chars "-a-z0-9_=#$@~%&*+\\/[:word:]")
6947              (punct "!?:;.,"))
6948          (concat
6949           "\\(?:"
6950           ;; Match paired parentheses, e.g. in Wikipedia URLs:
6951           ;; http://thread.gmane.org/47B4E3B2.3050402@gmail.com
6952           "[" chars punct "]+" "(" "[" chars punct "]+" "[" chars "]*)" "[" chars "]*"
6953           "\\|"
6954           "[" chars punct     "]+" "[" chars "]"
6955           "\\)"))
6956      (concat ;; XEmacs 21.4 doesn't support POSIX.
6957       "\\([-a-z0-9_=!?#$@~%&*+\\/:;.,]\\|\\w\\)+"
6958       "\\([-a-z0-9_=#$@~%&*+\\/]\\|\\w\\)"))
6959    "\\)")
6960   "Regular expression that matches URLs."
6961   :group 'gnus-article-buttons
6962   :type 'regexp)
6963
6964 (defcustom gnus-button-valid-fqdn-regexp
6965   message-valid-fqdn-regexp
6966   "Regular expression that matches a valid FQDN."
6967   :version "22.1"
6968   :group 'gnus-article-buttons
6969   :type 'regexp)
6970
6971 ;; Regexp suggested by Felix Wiemann in <87oeuomcz9.fsf@news2.ososo.de>
6972 (defcustom gnus-button-valid-localpart-regexp
6973   "[a-z0-9$%(*-=?[_][^<>\")!;:,{}\n\t @]*"
6974   "Regular expression that matches a localpart of mail addresses or MIDs."
6975   :version "22.1"
6976   :group 'gnus-article-buttons
6977   :type 'regexp)
6978
6979 (defcustom gnus-button-man-handler 'manual-entry
6980   "Function to use for displaying man pages.
6981 The function must take at least one argument with a string naming the
6982 man page."
6983   :version "22.1"
6984   :type '(choice (function-item :tag "Man" manual-entry)
6985                  (function-item :tag "Woman" woman)
6986                  (function :tag "Other"))
6987   :group 'gnus-article-buttons)
6988
6989 (defcustom gnus-ctan-url "http://tug.ctan.org/tex-archive/"
6990   "Top directory of a CTAN \(Comprehensive TeX Archive Network\) archive.
6991 If the default site is too slow, try to find a CTAN mirror, see
6992 <URL:http://tug.ctan.org/tex-archive/CTAN.sites?action=/index.html>.  See also
6993 the variable `gnus-button-handle-ctan'."
6994   :version "22.1"
6995   :group 'gnus-article-buttons
6996   :link '(custom-manual "(gnus)Group Parameters")
6997   :type '(choice (const "http://www.tex.ac.uk/tex-archive/")
6998                  (const "http://tug.ctan.org/tex-archive/")
6999                  (const "http://www.dante.de/CTAN/")
7000                  (string :tag "Other")))
7001
7002 (defcustom gnus-button-ctan-handler 'browse-url
7003   "Function to use for displaying CTAN links.
7004 The function must take one argument, the string naming the URL."
7005   :version "22.1"
7006   :type '(choice (function-item :tag "Browse Url" browse-url)
7007                  (function :tag "Other"))
7008   :group 'gnus-article-buttons)
7009
7010 (defcustom gnus-button-handle-ctan-bogus-regexp "^/?tex-archive/\\|^/"
7011   "Bogus strings removed from CTAN URLs."
7012   :version "22.1"
7013   :group 'gnus-article-buttons
7014   :type '(choice (const "^/?tex-archive/\\|/")
7015                  (regexp :tag "Other")))
7016
7017 (defcustom gnus-button-ctan-directory-regexp
7018   (regexp-opt
7019    (list "archive-tools" "biblio" "bibliography" "digests" "documentation"
7020          "dviware" "fonts" "graphics" "help" "indexing" "info" "language"
7021          "languages" "macros" "nonfree" "obsolete" "support" "systems"
7022          "tds" "tools" "usergrps" "web") t)
7023   "Regular expression for ctan directories.
7024 It should match all directories in the top level of `gnus-ctan-url'."
7025   :version "22.1"
7026   :group 'gnus-article-buttons
7027   :type 'regexp)
7028
7029 (defcustom gnus-button-mid-or-mail-regexp
7030   (concat "\\b\\(<?" gnus-button-valid-localpart-regexp "@"
7031           gnus-button-valid-fqdn-regexp
7032           ">?\\)\\b")
7033   "Regular expression that matches a message ID or a mail address."
7034   :version "22.1"
7035   :group 'gnus-article-buttons
7036   :type 'regexp)
7037
7038 (defcustom gnus-button-prefer-mid-or-mail 'gnus-button-mid-or-mail-heuristic
7039   "What to do when the button on a string as \"foo123@bar.invalid\" is pushed.
7040 Strings like this can be either a message ID or a mail address.  If it is one
7041 of the symbols `mid' or `mail', Gnus will always assume that the string is a
7042 message ID or a mail address, respectively.  If this variable is set to the
7043 symbol `ask', always query the user what do do.  If it is a function, this
7044 function will be called with the string as its only argument.  The function
7045 must return `mid', `mail', `invalid' or `ask'."
7046   :version "22.1"
7047   :group 'gnus-article-buttons
7048   :type '(choice (function-item :tag "Heuristic function"
7049                                 gnus-button-mid-or-mail-heuristic)
7050                  (const ask)
7051                  (const mid)
7052                  (const mail)))
7053
7054 (defcustom gnus-button-mid-or-mail-heuristic-alist
7055   '((-10.0 . ".+\\$.+@")
7056     (-10.0 . "#")
7057     (-10.0 . "\\*")
7058     (-5.0  . "\\+[^+]*\\+.*@") ;; # two plus signs
7059     (-5.0  . "@[Nn][Ee][Ww][Ss]") ;; /\@news/i
7060     (-5.0  . "@.*[Dd][Ii][Aa][Ll][Uu][Pp]") ;; /\@.*dialup/i;
7061     (-1.0  . "^[^a-z]+@")
7062     ;;
7063     (-5.0  . "\\.[0-9][0-9]+.*@") ;; "\.[0-9]{2,}.*\@"
7064     (-5.0  . "[a-z].*[A-Z].*[a-z].*[A-Z].*@") ;; "([a-z].*[A-Z].*){2,}\@"
7065     (-3.0  . "[A-Z][A-Z][a-z][a-z].*@")
7066     (-5.0  . "\\...?.?@") ;; (-5.0 . "\..{1,3}\@")
7067     ;;
7068     (-2.0  . "^[0-9]")
7069     (-1.0  . "^[0-9][0-9]")
7070     ;;
7071     ;; -3.0 /^[0-9][0-9a-fA-F]{2,2}/;
7072     (-3.0  . "^[0-9][0-9a-fA-F][0-9a-fA-F][^0-9a-fA-F]")
7073     ;; -5.0 /^[0-9][0-9a-fA-F]{3,3}/;
7074     (-5.0  . "^[0-9][0-9a-fA-F][0-9a-fA-F][0-9a-fA-F][^0-9a-fA-F]")
7075     ;;
7076     (-3.0  .  "[0-9][0-9][0-9][0-9][0-9][^0-9].*@") ;; "[0-9]{5,}.*\@"
7077     (-3.0  .  "[0-9][0-9][0-9][0-9][0-9][0-9][0-9][0-9][^0-9].*@")
7078     ;;       "[0-9]{8,}.*\@"
7079     (-3.0
7080      . "[0-9][0-9][0-9][0-9][0-9][0-9][0-9][0-9][0-9][0-9][0-9][0-9].*@")
7081     ;; "[0-9]{12,}.*\@"
7082     ;; compensation for TDMA dated mail addresses:
7083     (25.0  . "-dated-[0-9][0-9][0-9][0-9][0-9][0-9][0-9][0-9]+.*@")
7084     ;;
7085     (-20.0 . "\\.fsf@") ;; Gnus
7086     (-20.0 . "^slrn")
7087     (-20.0 . "^Pine")
7088     (-20.0 . "^alpine\\.")
7089     (-20.0 . "_-_") ;; Subject change in thread
7090     ;;
7091     (-20.0 . "\\.ln@") ;; leafnode
7092     (-30.0 . "@ID-[0-9]+\\.[a-zA-Z]+\\.dfncis\\.de")
7093     (-30.0 . "@4[Aa][Xx]\\.com") ;; Forte Agent
7094     ;;
7095     ;; (5.0 . "") ;; $local_part_len <= 7
7096     (10.0  . "^[^0-9]+@")
7097     (3.0   . "^[^0-9]+[0-9][0-9]?[0-9]?@")
7098     ;;      ^[^0-9]+[0-9]{1,3}\@ digits only at end of local part
7099     (3.0   . "\@stud")
7100     ;;
7101     (2.0   . "[a-z][a-z][._-][A-Z][a-z].*@")
7102     ;;
7103     (0.5   . "^[A-Z][a-z]")
7104     (0.5   . "^[A-Z][a-z][a-z]")
7105     (1.5   . "^[A-Z][a-z][A-Z][a-z][^a-z]") ;; ^[A-Z][a-z]{3,3}
7106     (2.0   . "^[A-Z][a-z][A-Z][a-z][a-z][^a-z]")) ;; ^[A-Z][a-z]{4,4}
7107   "An alist of \(RATE . REGEXP\) pairs for `gnus-button-mid-or-mail-heuristic'.
7108
7109 A negative RATE indicates a message IDs, whereas a positive indicates a mail
7110 address.  The REGEXP is processed with `case-fold-search' set to nil."
7111   :version "22.1"
7112   :group 'gnus-article-buttons
7113   :type '(repeat (cons (number :tag "Rate")
7114                        (regexp :tag "Regexp"))))
7115
7116 (defun gnus-button-mid-or-mail-heuristic (mid-or-mail)
7117   "Guess whether MID-OR-MAIL is a message ID or a mail address.
7118 Returns `mid' if MID-OR-MAIL is a message IDs, `mail' if it's a mail
7119 address, `ask' if unsure and `invalid' if the string is invalid."
7120   (let ((case-fold-search nil)
7121         (list gnus-button-mid-or-mail-heuristic-alist)
7122         (result 0) rate regexp lpartlen elem)
7123     (setq lpartlen
7124           (length (gnus-replace-in-string mid-or-mail "^\\(.*\\)@.*$" "\\1")))
7125     (gnus-message 8 "`%s', length of local part=`%s'." mid-or-mail lpartlen)
7126     ;; Certain special cases...
7127     (when (string-match
7128            (concat
7129             "^0[0-9]+-[0-9][0-9][0-9][0-9]@t-online\\.de$\\|"
7130             "^[0-9]+\\.[0-9]+@compuserve\\|"
7131             "@public\\.gmane\\.org")
7132            mid-or-mail)
7133       (gnus-message 8 "`%s' is a known mail address." mid-or-mail)
7134       (setq result 'mail))
7135     (when (string-match "@.*@\\| " mid-or-mail)
7136       (gnus-message 8 "`%s' is invalid." mid-or-mail)
7137       (setq result 'invalid))
7138     ;; Nothing more to do, if result is not a number here...
7139     (when (numberp result)
7140       (while list
7141         (setq elem (car list)
7142               rate (car elem)
7143               regexp (cdr elem)
7144               list (cdr list))
7145         (when (string-match regexp mid-or-mail)
7146           (setq result (+ result rate))
7147           (gnus-message
7148            9 "`%s' matched `%s', rate `%s', result `%s'."
7149            mid-or-mail regexp rate result)))
7150       (when (<= lpartlen 7)
7151         (setq result (+ result 5.0))
7152         (gnus-message 9 "`%s' matched (<= lpartlen 7), result `%s'."
7153                       mid-or-mail result))
7154       (when (>= lpartlen 12)
7155         (gnus-message 9 "`%s' matched (>= lpartlen 12)" mid-or-mail)
7156         (cond
7157          ((string-match "[0-9][^0-9]+[0-9].*@" mid-or-mail)
7158           ;; Long local part should contain realname if e-mail address,
7159           ;; too many digits: message-id.
7160           ;; $score -= 5.0 + 0.1 * $local_part_len;
7161           (setq rate (* -1.0 (+ 5.0 (* 0.1 lpartlen))))
7162           (setq result (+ result rate))
7163           (gnus-message
7164            9 "Many digits in `%s', rate `%s', result `%s'."
7165            mid-or-mail rate result))
7166          ((string-match "[^aeiouy][^aeiouy][^aeiouy][^aeiouy]+.*\@"
7167                         mid-or-mail)
7168           ;; Too few vowels [^aeiouy]{4,}.*\@
7169           (setq result (+ result -5.0))
7170           (gnus-message
7171            9 "Few vowels in `%s', rate `%s', result `%s'."
7172            mid-or-mail -5.0 result))
7173          (t
7174           (setq result (+ result 5.0))
7175           (gnus-message
7176            9 "`%s', rate `%s', result `%s'." mid-or-mail 5.0 result)))))
7177     (gnus-message 8 "`%s': Final rate is `%s'." mid-or-mail result)
7178     ;; Maybe we should make this a customizable alist: (condition . 'result)
7179     (cond
7180      ((symbolp result) result)
7181      ;; Now convert number into proper results:
7182      ((< result -10.0) 'mid)
7183      ((> result  10.0) 'mail)
7184      (t 'ask))))
7185
7186 (defun gnus-button-handle-mid-or-mail (mid-or-mail)
7187   (let* ((pref gnus-button-prefer-mid-or-mail) guessed
7188          (url-mid (concat "news" ":" mid-or-mail))
7189          (url-mailto (concat "mailto" ":" mid-or-mail)))
7190     (gnus-message 9 "mid-or-mail=%s" mid-or-mail)
7191     (when (fboundp pref)
7192       (setq guessed
7193             ;; get rid of surrounding angles...
7194             (funcall pref
7195                      (gnus-replace-in-string mid-or-mail "^<\\|>$" "")))
7196       (if (or (eq 'mid guessed) (eq 'mail guessed))
7197           (setq pref guessed)
7198         (setq pref 'ask)))
7199     (if (eq pref 'ask)
7200         (save-window-excursion
7201           (if (y-or-n-p (concat "Is <" mid-or-mail "> a mail address? "))
7202               (setq pref 'mail)
7203             (setq pref 'mid))))
7204     (cond ((eq pref 'mid)
7205            (gnus-message 8 "calling `gnus-button-handle-news' %s" url-mid)
7206            (gnus-button-handle-news url-mid))
7207           ((eq pref 'mail)
7208            (gnus-message 8 "calling `gnus-url-mailto'  %s" url-mailto)
7209            (gnus-url-mailto url-mailto))
7210           (t (gnus-message 3 "Invalid string.")))))
7211
7212 (defun gnus-button-handle-custom (fun arg)
7213   "Call function FUN on argument ARG.
7214 Both FUN and ARG are supposed to be strings.  ARG will be passed
7215 as a symbol to FUN."
7216   (funcall (intern fun)
7217            (if (string-match "^customize-apropos" fun)
7218                arg
7219              (intern arg))))
7220
7221 (defvar gnus-button-handle-describe-prefix "^\\(C-h\\|<?[Ff]1>?\\)")
7222
7223 ;; FIXME: Maybe we should merge some of the functions that do quite similar
7224 ;; stuff?
7225
7226 (defun gnus-button-handle-describe-function (url)
7227   "Call `describe-function' when pushing the corresponding URL button."
7228   (describe-function
7229    (intern
7230     (gnus-replace-in-string url gnus-button-handle-describe-prefix ""))))
7231
7232 (defun gnus-button-handle-describe-variable (url)
7233   "Call `describe-variable' when pushing the corresponding URL button."
7234   (describe-variable
7235    (intern
7236     (gnus-replace-in-string url gnus-button-handle-describe-prefix ""))))
7237
7238 (defun gnus-button-handle-symbol (url)
7239 "Display help on variable or function.
7240 Calls `describe-variable' or `describe-function'."
7241   (let ((sym (intern url)))
7242     (cond
7243      ((fboundp sym) (describe-function sym))
7244      ((boundp sym) (describe-variable sym))
7245      (t (gnus-message 3 "`%s' is not a known function of variable." url)))))
7246
7247 (defun gnus-button-handle-describe-key (url)
7248   "Call `describe-key' when pushing the corresponding URL button."
7249   (let* ((key-string
7250           (gnus-replace-in-string url gnus-button-handle-describe-prefix ""))
7251          (keys (ignore-errors (eval `(kbd ,key-string)))))
7252     (if keys
7253         (describe-key keys)
7254       (gnus-message 3 "Invalid key sequence in button: %s" key-string))))
7255
7256 (defun gnus-button-handle-apropos (url)
7257   "Call `apropos' when pushing the corresponding URL button."
7258   (apropos (gnus-replace-in-string url gnus-button-handle-describe-prefix "")))
7259
7260 (defun gnus-button-handle-apropos-command (url)
7261   "Call `apropos' when pushing the corresponding URL button."
7262   (apropos-command
7263    (gnus-replace-in-string url gnus-button-handle-describe-prefix "")))
7264
7265 (defun gnus-button-handle-apropos-variable (url)
7266   "Call `apropos' when pushing the corresponding URL button."
7267   (funcall
7268    (if (fboundp 'apropos-variable) 'apropos-variable 'apropos)
7269    (gnus-replace-in-string url gnus-button-handle-describe-prefix "")))
7270
7271 (defun gnus-button-handle-apropos-documentation (url)
7272   "Call `apropos' when pushing the corresponding URL button."
7273   (funcall
7274    (if (fboundp 'apropos-documentation) 'apropos-documentation 'apropos)
7275    (gnus-replace-in-string url gnus-button-handle-describe-prefix "")))
7276
7277 (defun gnus-button-handle-library (url)
7278   "Call `locate-library' when pushing the corresponding URL button."
7279   (gnus-message 9 "url=`%s'" url)
7280   (let* ((lib (locate-library url))
7281          (file (gnus-replace-in-string (or lib "") "\.elc" ".el")))
7282     (if (not lib)
7283         (gnus-message 1 "Cannot locale library `%s'." url)
7284       (find-file-read-only file))))
7285
7286 (defun gnus-button-handle-ctan (url)
7287   "Call `browse-url' when pushing a CTAN URL button."
7288   (funcall
7289    gnus-button-ctan-handler
7290    (concat
7291     gnus-ctan-url
7292     (gnus-replace-in-string url gnus-button-handle-ctan-bogus-regexp ""))))
7293
7294 (defcustom gnus-button-tex-level 5
7295   "*Integer that says how many TeX-related buttons Gnus will show.
7296 The higher the number, the more buttons will appear and the more false
7297 positives are possible.  Note that you can set this variable local to
7298 specific groups.  Setting it higher in TeX groups is probably a good idea.
7299 See Info node `(gnus)Group Parameters' and the variable `gnus-parameters' on
7300 how to set variables in specific groups."
7301   :version "22.1"
7302   :group 'gnus-article-buttons
7303   :link '(custom-manual "(gnus)Group Parameters")
7304   :type 'integer)
7305
7306 (defcustom gnus-button-man-level 5
7307   "*Integer that says how many man-related buttons Gnus will show.
7308 The higher the number, the more buttons will appear and the more false
7309 positives are possible.  Note that you can set this variable local to
7310 specific groups.  Setting it higher in Unix groups is probably a good idea.
7311 See Info node `(gnus)Group Parameters' and the variable `gnus-parameters' on
7312 how to set variables in specific groups."
7313   :version "22.1"
7314   :group 'gnus-article-buttons
7315   :link '(custom-manual "(gnus)Group Parameters")
7316   :type 'integer)
7317
7318 (defcustom gnus-button-emacs-level 5
7319   "*Integer that says how many emacs-related buttons Gnus will show.
7320 The higher the number, the more buttons will appear and the more false
7321 positives are possible.  Note that you can set this variable local to
7322 specific groups.  Setting it higher in Emacs or Gnus related groups is
7323 probably a good idea.  See Info node `(gnus)Group Parameters' and the variable
7324 `gnus-parameters' on how to set variables in specific groups."
7325   :version "22.1"
7326   :group 'gnus-article-buttons
7327   :link '(custom-manual "(gnus)Group Parameters")
7328   :type 'integer)
7329
7330 (defcustom gnus-button-message-level 5
7331   "*Integer that says how many buttons for news or mail messages will appear.
7332 The higher the number, the more buttons will appear and the more false
7333 positives are possible."
7334   ;; mail addresses, MIDs, URLs for news, ...
7335   :version "22.1"
7336   :group 'gnus-article-buttons
7337   :type 'integer)
7338
7339 (defcustom gnus-button-browse-level 5
7340   "*Integer that says how many buttons for browsing will appear.
7341 The higher the number, the more buttons will appear and the more false
7342 positives are possible."
7343   ;; stuff handled by `browse-url' or `gnus-button-embedded-url'
7344   :version "22.1"
7345   :group 'gnus-article-buttons
7346   :type 'integer)
7347
7348 (defcustom gnus-button-alist
7349   '(("<\\(url:[>\n\t ]*?\\)?\\(nntp\\|news\\):[>\n\t ]*\\([^>\n\t ]*@[^>\n\t ]*\\)>"
7350      0 (>= gnus-button-message-level 0) gnus-button-handle-news 3)
7351     ((concat "\\b\\(nntp\\|news\\):\\("
7352              gnus-button-valid-localpart-regexp "@[a-z0-9.-]+[a-z]\\)")
7353      0 t gnus-button-handle-news 2)
7354     ("\\(\\b<\\(url:[>\n\t ]*\\)?\\(nntp\\|news\\):[>\n\t ]*\\(//\\)?\\([^>\n\t ]*\\)>\\)"
7355      1 (>= gnus-button-message-level 0) gnus-button-fetch-group 5)
7356     ("\\b\\(nntp\\|news\\):\\(//\\)?\\([^'\">\n\t ]+\\)"
7357      0 (>= gnus-button-message-level 0) gnus-button-fetch-group 3)
7358     ;; RFC 2392 (Don't allow `/' in domain part --> CID)
7359     ("\\bmid:\\(//\\)?\\([^'\">\n\t ]+@[^'\">\n\t /]+\\)"
7360      0 (>= gnus-button-message-level 0) gnus-button-message-id 2)
7361     ("\\bin\\( +article\\| +message\\)? +\\(<\\([^\n @<>]+@[^\n @<>]+\\)>\\)"
7362      2 (>= gnus-button-message-level 0) gnus-button-message-id 3)
7363     ("\\b\\(mid\\|message-id\\):? +\\(<\\([^\n @<>]+@[^\n @<>]+\\)>\\)"
7364      2 (>= gnus-button-message-level 0) gnus-button-message-id 3)
7365     ("\\(<URL: *\\)mailto: *\\([^> \n\t]+\\)>"
7366      0 (>= gnus-button-message-level 0) gnus-url-mailto 2)
7367     ;; RFC 2368 (The mailto URL scheme)
7368     ("\\bmailto:\\([-a-z.@_+0-9%=?&/]+\\)"
7369      0 (>= gnus-button-message-level 0) gnus-url-mailto 1)
7370     ("\\bmailto:\\([^ \n\t]+\\)"
7371      0 (>= gnus-button-message-level 0) gnus-url-mailto 1)
7372     ;; CTAN
7373     ((concat "\\bCTAN:[ \t\n]?[^>)!;:,'\n\t ]*\\("
7374              gnus-button-ctan-directory-regexp
7375              "[^][>)!;:,'\n\t ]+\\)")
7376      0 (>= gnus-button-tex-level 1) gnus-button-handle-ctan 1)
7377     ((concat "\\btex-archive/\\("
7378              gnus-button-ctan-directory-regexp
7379              "/[-_.a-z0-9/]+[-_./a-z0-9]+[/a-z0-9]\\)")
7380      1 (>= gnus-button-tex-level 6) gnus-button-handle-ctan 1)
7381     ((concat
7382       "\\b\\("
7383       gnus-button-ctan-directory-regexp
7384       "/[-_.a-z0-9]+/[-_./a-z0-9]+[/a-z0-9]\\)")
7385      1 (>= gnus-button-tex-level 8) gnus-button-handle-ctan 1)
7386     ;; This is info (home-grown style) <info://foo/bar+baz>
7387     ("\\binfo://\\([^'\">\n\t ]+\\)"
7388      0 (>= gnus-button-emacs-level 1) gnus-button-handle-info-url 1)
7389     ;; Info GNOME style <info:foo#bar_baz>
7390     ("\\binfo:\\([^('\n\t\r \"><][^'\n\t\r \"><]*\\)"
7391      0 (>= gnus-button-emacs-level 1) gnus-button-handle-info-url-gnome 1)
7392     ;; Info KDE style <info:(foo)bar baz>
7393     ("<\\(info:\\(([^)]+)[^>\n\r]*\\)\\)>"
7394      1 (>= gnus-button-emacs-level 1) gnus-button-handle-info-url-kde 2)
7395     ("\\((Info-goto-node\\|(info\\)[ \t\n]*\\(\"[^\"]*\"\\))" 0
7396      (>= gnus-button-emacs-level 1) gnus-button-handle-info-url 2)
7397     ("\\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,]*\\)\\)?"
7398      ;; Info links like `C-h i d m Gnus RET' or `C-h i d m Gnus RET i partial RET'
7399      0 (>= gnus-button-emacs-level 1) gnus-button-handle-info-keystrokes 0)
7400     ;; This is custom
7401     ("M-x[ \t\n]\\(customize-[^ ]+\\)[ \t\n]RET[ \t\n]\\([^ ]+\\)[ \t\n]RET" 0
7402      (>= gnus-button-emacs-level 1) gnus-button-handle-custom 1 2)
7403     ;; Emacs help commands
7404     ("M-x[ \t\n]+apropos[ \t\n]+RET[ \t\n]+\\([^ \t\n]+\\)[ \t\n]+RET"
7405      ;; regexp doesn't match arguments containing ` '.
7406      0 (>= gnus-button-emacs-level 1) gnus-button-handle-apropos 1)
7407     ("M-x[ \t\n]+apropos-command[ \t\n]+RET[ \t\n]+\\([^ \t\n]+\\)[ \t\n]+RET"
7408      0 (>= gnus-button-emacs-level 1) gnus-button-handle-apropos-command 1)
7409     ("M-x[ \t\n]+apropos-variable[ \t\n]+RET[ \t\n]+\\([^ \t\n]+\\)[ \t\n]+RET"
7410      0 (>= gnus-button-emacs-level 1) gnus-button-handle-apropos-variable 1)
7411     ("M-x[ \t\n]+apropos-documentation[ \t\n]+RET[ \t\n]+\\([^ \t\n]+\\)[ \t\n]+RET"
7412      0 (>= gnus-button-emacs-level 1) gnus-button-handle-apropos-documentation 1)
7413     ;; The following entries may lead to many false positives so don't enable
7414     ;; them by default (use a high button level).
7415     ("/\\([a-z][-a-z0-9]+\\.el\\)\\>[^.?]"
7416      ;; Exclude [.?] for URLs in gmane.emacs.cvs
7417      1 (>= gnus-button-emacs-level 8) gnus-button-handle-library 1)
7418     ("`\\([a-z][-a-z0-9]+\\.el\\)'"
7419      1 (>= gnus-button-emacs-level 8) gnus-button-handle-library 1)
7420     ("`\\([a-z][a-z0-9]+-[a-z0-9]+-[-a-z0-9]*[a-z]\\|\\(gnus\\|message\\)-[-a-z]+\\)'"
7421      0 (>= gnus-button-emacs-level 8) gnus-button-handle-symbol 1)
7422     ("`\\([a-z][a-z0-9]+-[a-z]+\\)'"
7423      0 (>= gnus-button-emacs-level 9) gnus-button-handle-symbol 1)
7424     ("(setq[ \t\n]+\\([a-z][a-z0-9]+-[-a-z0-9]+\\)[ \t\n]+.+)"
7425      1 (>= gnus-button-emacs-level 7) gnus-button-handle-describe-variable 1)
7426     ("\\bM-x[ \t\n]+\\([^ \t\n]+\\)[ \t\n]+RET"
7427      1 (>= gnus-button-emacs-level 7) gnus-button-handle-describe-function 1)
7428     ("\\b\\(C-h\\|<?[Ff]1>?\\)[ \t\n]+f[ \t\n]+\\([^ \t\n]+\\)[ \t\n]+RET"
7429      0 (>= gnus-button-emacs-level 1) gnus-button-handle-describe-function 2)
7430     ("\\b\\(C-h\\|<?[Ff]1>?\\)[ \t\n]+v[ \t\n]+\\([^ \t\n]+\\)[ \t\n]+RET"
7431      0 (>= gnus-button-emacs-level 1) gnus-button-handle-describe-variable 2)
7432     ("`\\(\\(C-h\\|<?[Ff]1>?\\)[ \t\n]+k[ \t\n]+\\([^']+\\)\\)'"
7433      ;; Unlike the other regexps we really have to require quoting
7434      ;; here to determine where it ends.
7435      1 (>= gnus-button-emacs-level 1) gnus-button-handle-describe-key 3)
7436     ;; This is how URLs _should_ be embedded in text (RFC 1738, RFC 2396)...
7437     ("<URL: *\\([^\n<>]*\\)>"
7438      1 (>= gnus-button-browse-level 0) gnus-button-embedded-url 1)
7439     ;; RFC 2396 (2.4.3., delims) ...
7440     ("\"URL: *\\([^\n\"]*\\)\""
7441      1 (>= gnus-button-browse-level 0) gnus-button-embedded-url 1)
7442     ;; Raw URLs.
7443     (gnus-button-url-regexp
7444      0 (>= gnus-button-browse-level 0) browse-url 0)
7445     ;; man pages
7446     ("\\b\\([a-z][a-z]+([1-9])\\)\\W"
7447      0 (and (>= gnus-button-man-level 1) (< gnus-button-man-level 3))
7448      gnus-button-handle-man 1)
7449     ;; more man pages: resolv.conf(5), iso_8859-1(7), xterm(1x)
7450     ("\\b\\([a-z][-_.a-z0-9]+([1-9])\\)\\W"
7451      0 (and (>= gnus-button-man-level 3) (< gnus-button-man-level 5))
7452      gnus-button-handle-man 1)
7453     ;; even more: Apache::PerlRun(3pm), PDL::IO::FastRaw(3pm),
7454     ;; SoWWWAnchor(3iv), XSelectInput(3X11), X(1), X(7)
7455     ("\\b\\(\\(?:[a-z][-+_.:a-z0-9]+([1-9][X1a-z]*)\\)\\|\\b\\(?:X([1-9])\\)\\)\\W"
7456      0 (>= gnus-button-man-level 5) gnus-button-handle-man 1)
7457     ;; Recognizing patches to .el files.  This is somewhat obscure,
7458     ;; but considering the percentage of Gnus users who hack Emacs
7459     ;; Lisp files...
7460     ("^--- \\([^ .]+\\.el\\).*\n.*\n@@ -?\\([0-9]+\\)" 1
7461      (>= gnus-button-message-level 4) gnus-button-patch 1 2)
7462     ("^\\*\\*\\* \\([^ .]+\\.el\\).*\n.*\n\\*+\n\\*\\*\\* \\([0-9]+\\)" 1
7463      (>= gnus-button-message-level 4) gnus-button-patch 1 2)
7464     ;; MID or mail: To avoid too many false positives we don't try to catch
7465     ;; all kind of allowed MIDs or mail addresses.  Domain part must contain
7466     ;; at least one dot.  TLD must contain two or three chars or be a know TLD
7467     ;; (info|name|...).  Put this entry near the _end_ of `gnus-button-alist'
7468     ;; so that non-ambiguous entries (see above) match first.
7469     (gnus-button-mid-or-mail-regexp
7470      0 (>= gnus-button-message-level 5) gnus-button-handle-mid-or-mail 1))
7471   "*Alist of regexps matching buttons in article bodies.
7472
7473 Each entry has the form (REGEXP BUTTON FORM CALLBACK PAR...), where
7474 REGEXP: is the string (case insensitive) matching text around the button (can
7475 also be Lisp expression evaluating to a string),
7476 BUTTON: is the number of the regexp grouping actually matching the button,
7477 FORM: is a Lisp expression which must eval to true for the button to
7478 be added,
7479 CALLBACK: is the function to call when the user push this button, and each
7480 PAR: is a number of a regexp grouping whose text will be passed to CALLBACK.
7481
7482 CALLBACK can also be a variable, in that case the value of that
7483 variable it the real callback function."
7484   :group 'gnus-article-buttons
7485   :type '(repeat (list (choice regexp variable sexp)
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-button-alist 'risky-local-variable t)
7493
7494 (defcustom gnus-header-button-alist
7495   '(("^\\(References\\|Message-I[Dd]\\|^In-Reply-To\\):" "<[^<>]+>"
7496      0 (>= gnus-button-message-level 0) gnus-button-message-id 0)
7497     ("^\\(From\\|Reply-To\\):" ": *\\(.+\\)$"
7498      1 (>= gnus-button-message-level 0) gnus-button-reply 1)
7499     ("^\\(Cc\\|To\\):" "[^ \t\n<>,()\"]+@[^ \t\n<>,()\"]+"
7500      0 (>= gnus-button-message-level 0) gnus-msg-mail 0)
7501     ("^X-[Uu][Rr][Ll]:" gnus-button-url-regexp
7502      0 (>= gnus-button-browse-level 0) browse-url 0)
7503     ("^Subject:" gnus-button-url-regexp
7504      0 (>= gnus-button-browse-level 0) browse-url 0)
7505     ("^[^:]+:" gnus-button-url-regexp
7506      0 (>= gnus-button-browse-level 0) browse-url 0)
7507     ("^OpenPGP:.*url=" gnus-button-url-regexp
7508      0 (>= gnus-button-browse-level 0) gnus-button-openpgp 0)
7509     ("^[^:]+:" "\\bmailto:\\([-a-z.@_+0-9%=?&/]+\\)"
7510      0 (>= gnus-button-message-level 0) gnus-url-mailto 1)
7511     ("^[^:]+:" "\\(<\\(url: \\)?\\(nntp\\|news\\):\\([^>\n ]*\\)>\\)"
7512      1 (>= gnus-button-message-level 0) gnus-button-message-id 4))
7513   "*Alist of headers and regexps to match buttons in article heads.
7514
7515 This alist is very similar to `gnus-button-alist', except that each
7516 alist has an additional HEADER element first in each entry:
7517
7518 \(HEADER REGEXP BUTTON FORM CALLBACK PAR)
7519
7520 HEADER is a regexp to match a header.  For a fuller explanation, see
7521 `gnus-button-alist'."
7522   :group 'gnus-article-buttons
7523   :group 'gnus-article-headers
7524   :type '(repeat (list (regexp :tag "Header")
7525                        (choice regexp variable)
7526                        (integer :tag "Button")
7527                        (sexp :tag "Form")
7528                        (function :tag "Callback")
7529                        (repeat :tag "Par"
7530                                :inline t
7531                                (integer :tag "Regexp group")))))
7532 (put 'gnus-header-button-alist 'risky-local-variable t)
7533
7534 ;;; Commands:
7535
7536 (defun gnus-article-push-button (event)
7537   "Check text under the mouse pointer for a callback function.
7538 If the text under the mouse pointer has a `gnus-callback' property,
7539 call it with the value of the `gnus-data' text property."
7540   (interactive "e")
7541   (set-buffer (window-buffer (posn-window (event-start event))))
7542   (let* ((pos (posn-point (event-start event)))
7543          (data (get-text-property pos 'gnus-data))
7544          (fun (get-text-property pos 'gnus-callback)))
7545     (goto-char pos)
7546     (when fun
7547       (funcall fun data))))
7548
7549 (defun gnus-article-press-button ()
7550   "Check text at point for a callback function.
7551 If the text at point has a `gnus-callback' property,
7552 call it with the value of the `gnus-data' text property."
7553   (interactive)
7554   (let ((data (get-text-property (point) 'gnus-data))
7555         (fun (get-text-property (point) 'gnus-callback)))
7556     (when fun
7557       (funcall fun data))))
7558
7559 (defun gnus-article-highlight (&optional force)
7560   "Highlight current article.
7561 This function calls `gnus-article-highlight-headers',
7562 `gnus-article-highlight-citation',
7563 `gnus-article-highlight-signature', and `gnus-article-add-buttons' to
7564 do the highlighting.  See the documentation for those functions."
7565   (interactive (list 'force))
7566   (gnus-article-highlight-headers)
7567   (gnus-article-highlight-citation force)
7568   (gnus-article-highlight-signature)
7569   (gnus-article-add-buttons force)
7570   (gnus-article-add-buttons-to-head))
7571
7572 (defun gnus-article-highlight-some (&optional force)
7573   "Highlight current article.
7574 This function calls `gnus-article-highlight-headers',
7575 `gnus-article-highlight-signature', and `gnus-article-add-buttons' to
7576 do the highlighting.  See the documentation for those functions."
7577   (interactive (list 'force))
7578   (gnus-article-highlight-headers)
7579   (gnus-article-highlight-signature)
7580   (gnus-article-add-buttons))
7581
7582 (defun gnus-article-highlight-headers ()
7583   "Highlight article headers as specified by `gnus-header-face-alist'."
7584   (interactive)
7585   (gnus-with-article-headers
7586     (let (regexp header-face field-face from hpoints fpoints)
7587       (dolist (entry gnus-header-face-alist)
7588         (goto-char (point-min))
7589         (setq regexp (concat "^\\("
7590                              (if (string-equal "" (nth 0 entry))
7591                                  "[^\t ]"
7592                                (nth 0 entry))
7593                              "\\)")
7594               header-face (nth 1 entry)
7595               field-face (nth 2 entry))
7596         (while (and (re-search-forward regexp nil t)
7597                     (not (eobp)))
7598           (beginning-of-line)
7599           (setq from (point))
7600           (unless (search-forward ":" nil t)
7601             (forward-char 1))
7602           (when (and header-face
7603                      (not (memq (point) hpoints)))
7604             (push (point) hpoints)
7605             (gnus-put-text-property from (point) 'face header-face))
7606           (when (and field-face
7607                      (not (memq (setq from (point)) fpoints)))
7608             (push from fpoints)
7609             (if (re-search-forward "^[^ \t]" nil t)
7610                 (forward-char -2)
7611               (goto-char (point-max)))
7612             (gnus-put-text-property from (point) 'face field-face)))))))
7613
7614 (defun gnus-article-highlight-signature ()
7615   "Highlight the signature in an article.
7616 It does this by highlighting everything after
7617 `gnus-signature-separator' using the face `gnus-signature'."
7618   (interactive)
7619   (gnus-with-article-buffer
7620     (let ((inhibit-point-motion-hooks t))
7621       (save-restriction
7622         (when (and gnus-signature-face
7623                    (gnus-article-narrow-to-signature))
7624           (gnus-overlay-put (gnus-make-overlay (point-min) (point-max) nil t)
7625                             'face gnus-signature-face)
7626           (widen)
7627           (gnus-article-search-signature)
7628           (let ((start (match-beginning 0))
7629                 (end (set-marker (make-marker) (1+ (match-end 0)))))
7630             (gnus-article-add-button start (1- end) 'gnus-signature-toggle
7631                                      end)))))))
7632
7633 (defun gnus-button-in-region-p (b e prop)
7634   "Say whether PROP exists in the region."
7635   (text-property-not-all b e prop nil))
7636
7637 (defun gnus-article-add-buttons (&optional force)
7638   "Find external references in the article and make buttons of them.
7639 \"External references\" are things like Message-IDs and URLs, as
7640 specified by `gnus-button-alist'."
7641   (interactive (list 'force))
7642   (gnus-with-article-buffer
7643     (let ((inhibit-point-motion-hooks t)
7644           (case-fold-search t)
7645           (alist gnus-button-alist)
7646           beg entry regexp)
7647       ;; Remove all old markers.
7648       (let (marker entry new-list)
7649         (while (setq marker (pop gnus-button-marker-list))
7650           (if (or (< marker (point-min)) (>= marker (point-max)))
7651               (push marker new-list)
7652             (goto-char marker)
7653             (when (setq entry (gnus-button-entry))
7654               (put-text-property (match-beginning (nth 1 entry))
7655                                  (match-end (nth 1 entry))
7656                                  'gnus-callback nil))
7657             (set-marker marker nil)))
7658         (setq gnus-button-marker-list new-list))
7659       ;; We skip the headers.
7660       (article-goto-body)
7661       (setq beg (point))
7662       (while (setq entry (pop alist))
7663         (setq regexp (eval (car entry)))
7664         (goto-char beg)
7665         (while (re-search-forward regexp nil t)
7666           (let ((start (match-beginning (nth 1 entry)))
7667                 (end (match-end (nth 1 entry)))
7668                 (from (match-beginning 0)))
7669             (when (and (or (eq t (nth 2 entry))
7670                            (eval (nth 2 entry)))
7671                        (not (gnus-button-in-region-p
7672                              start end 'gnus-callback)))
7673               ;; That optional form returned non-nil, so we add the
7674               ;; button.
7675               (setq from (set-marker (make-marker) from))
7676               (push from gnus-button-marker-list)
7677               (unless (and (eq (car entry) 'gnus-button-url-regexp)
7678                            (gnus-article-extend-url-button from start end))
7679                 (gnus-article-add-button start end
7680                                          'gnus-button-push from)))))))))
7681
7682 (defun gnus-article-extend-url-button (beg start end)
7683   "Extend url button if url is folded into two or more lines.
7684 Return non-nil if button is extended.  BEG is a marker that points to
7685 the beginning position of a text containing url.  START and END are
7686 the endpoints of a url button before it is extended.  The concatenated
7687 url is put as the `gnus-button-url' overlay property on the button."
7688   (let ((opoint (point))
7689         (points (list start end))
7690         url delim regexp)
7691     (prog1
7692         (when (and (progn
7693                      (goto-char end)
7694                      (not (looking-at "[\t ]*[\">]")))
7695                    (progn
7696                      (goto-char start)
7697                      (string-match
7698                       "\\(?:\"\\|\\(<\\)\\)[\t ]*\\(?:url[\t ]*:[\t ]*\\)?\\'"
7699                       (buffer-substring (point-at-bol) start)))
7700                    (progn
7701                      (setq url (list (buffer-substring start end))
7702                            delim (if (match-beginning 1) ">" "\""))
7703                      (beginning-of-line)
7704                      (setq regexp (concat
7705                                    (when (and (looking-at
7706                                                message-cite-prefix-regexp)
7707                                               (< (match-end 0) start))
7708                                      (regexp-quote (match-string 0)))
7709                                    "\
7710 \[\t ]*\\(?:\\([^\t\n \">]+\\)[\t ]*$\\|\\([^\t\n \">]*\\)[\t ]*"
7711                                    delim "\\)"))
7712                      (while (progn
7713                               (forward-line 1)
7714                               (and (looking-at regexp)
7715                                    (prog1
7716                                        (match-beginning 1)
7717                                      (push (or (match-string 2)
7718                                                (match-string 1))
7719                                            url)
7720                                      (push (setq end (or (match-end 2)
7721                                                          (match-end 1)))
7722                                            points)
7723                                      (push (or (match-beginning 2)
7724                                                (match-beginning 1))
7725                                            points)))))
7726                      (match-beginning 2)))
7727           (let (gnus-article-mouse-face widget-mouse-face)
7728             (while points
7729               (gnus-article-add-button (pop points) (pop points)
7730                                        'gnus-button-push beg)))
7731           (let ((overlay (gnus-make-overlay start end)))
7732             (gnus-overlay-put overlay 'evaporate t)
7733             (gnus-overlay-put overlay 'gnus-button-url
7734                               (list (mapconcat 'identity (nreverse url) "")))
7735             (when gnus-article-mouse-face
7736               (gnus-overlay-put overlay 'mouse-face gnus-article-mouse-face)))
7737           t)
7738       (goto-char opoint))))
7739
7740 ;; Add buttons to the head of an article.
7741 (defun gnus-article-add-buttons-to-head ()
7742   "Add buttons to the head of the article."
7743   (interactive)
7744   (gnus-with-article-headers
7745     (let (beg end)
7746       (dolist (entry gnus-header-button-alist)
7747         ;; Each alist entry.
7748         (goto-char (point-min))
7749         (while (re-search-forward (car entry) nil t)
7750           ;; Each header matching the entry.
7751           (setq beg (match-beginning 0))
7752           (setq end (or (and (re-search-forward "^[^ \t]" nil t)
7753                              (match-beginning 0))
7754                         (point-max)))
7755           (goto-char beg)
7756           (while (re-search-forward (eval (nth 1 entry)) end t)
7757             ;; Each match within a header.
7758             (let* ((entry (cdr entry))
7759                    (start (match-beginning (nth 1 entry)))
7760                    (end (match-end (nth 1 entry)))
7761                    (form (nth 2 entry)))
7762               (goto-char (match-end 0))
7763               (when (eval form)
7764                 (gnus-article-add-button
7765                  start end (nth 3 entry)
7766                  (buffer-substring (match-beginning (nth 4 entry))
7767                                    (match-end (nth 4 entry)))))))
7768           (goto-char end))))))
7769
7770 ;;; External functions:
7771
7772 (defun gnus-article-add-button (from to fun &optional data)
7773   "Create a button between FROM and TO with callback FUN and data DATA."
7774   (when gnus-article-button-face
7775     (gnus-overlay-put (gnus-make-overlay from to nil t)
7776                       'face gnus-article-button-face))
7777   (gnus-add-text-properties
7778    from to
7779    (nconc (and gnus-article-mouse-face
7780                (list gnus-mouse-face-prop gnus-article-mouse-face))
7781           (list 'gnus-callback fun)
7782           (and data (list 'gnus-data data))))
7783   (widget-convert-button 'link from to :action 'gnus-widget-press-button
7784                          :button-keymap gnus-widget-button-keymap))
7785
7786 ;;; Internal functions:
7787
7788 (defun gnus-article-set-globals ()
7789   (with-current-buffer gnus-summary-buffer
7790     (gnus-set-global-variables)))
7791
7792 (defun gnus-signature-toggle (end)
7793   (gnus-with-article-buffer
7794     (let ((inhibit-point-motion-hooks t))
7795       (if (text-property-any end (point-max) 'article-type 'signature)
7796           (progn
7797             (gnus-delete-wash-type 'signature)
7798             (gnus-remove-text-properties-when
7799              'article-type 'signature end (point-max)
7800              (cons 'article-type (cons 'signature
7801                                        gnus-hidden-properties))))
7802         (gnus-add-wash-type 'signature)
7803         (gnus-add-text-properties-when
7804          'article-type nil end (point-max)
7805          (cons 'article-type (cons 'signature
7806                                    gnus-hidden-properties)))))
7807     (let ((gnus-article-mime-handle-alist-1 gnus-article-mime-handle-alist))
7808       (gnus-set-mode-line 'article))))
7809
7810 (defun gnus-button-entry ()
7811   ;; Return the first entry in `gnus-button-alist' matching this place.
7812   (let ((alist gnus-button-alist)
7813         (entry nil))
7814     (while alist
7815       (setq entry (pop alist))
7816       (if (looking-at (eval (car entry)))
7817           (setq alist nil)
7818         (setq entry nil)))
7819     entry))
7820
7821 (defun gnus-button-push (marker)
7822   ;; Push button starting at MARKER.
7823   (save-excursion
7824     (goto-char marker)
7825     (let* ((entry (gnus-button-entry))
7826            (inhibit-point-motion-hooks t)
7827            (fun (nth 3 entry))
7828            (args (or (and (eq (car entry) 'gnus-button-url-regexp)
7829                           (get-char-property marker 'gnus-button-url))
7830                      (mapcar (lambda (group)
7831                                (let ((string (match-string group)))
7832                                  (set-text-properties
7833                                   0 (length string) nil string)
7834                                  string))
7835                              (nthcdr 4 entry)))))
7836       (cond
7837        ((fboundp fun)
7838         (apply fun args))
7839        ((and (boundp fun)
7840              (fboundp (symbol-value fun)))
7841         (apply (symbol-value fun) args))
7842        (t
7843         (gnus-message 1 "You must define `%S' to use this button"
7844                       (cons fun args)))))))
7845
7846 (defun gnus-parse-news-url (url)
7847   (let (scheme server port group message-id articles)
7848     (with-temp-buffer
7849       (insert url)
7850       (goto-char (point-min))
7851       (when (looking-at "\\([A-Za-z]+\\):")
7852         (setq scheme (match-string 1))
7853         (goto-char (match-end 0)))
7854       (when (looking-at "//\\([^:/]+\\)\\(:?\\)\\([0-9]+\\)?/")
7855         (setq server (match-string 1))
7856         (setq port (if (stringp (match-string 3))
7857                        (string-to-number (match-string 3))
7858                      (match-string 3)))
7859         (goto-char (match-end 0)))
7860
7861       (cond
7862        ((looking-at "\\(.*@.*\\)")
7863         (setq message-id (match-string 1)))
7864        ((looking-at "\\([^/]+\\)/\\([-0-9]+\\)")
7865         (setq group (match-string 1)
7866               articles (split-string (match-string 2) "-")))
7867        ((looking-at "\\([^/]+\\)/?")
7868         (setq group (match-string 1)))
7869        (t
7870         (error "Unknown news URL syntax"))))
7871     (list scheme server port group message-id articles)))
7872
7873 (defun gnus-button-handle-news (url)
7874   "Fetch a news URL."
7875   (destructuring-bind (scheme server port group message-id articles)
7876       (gnus-parse-news-url url)
7877     (cond
7878      (message-id
7879       (with-current-buffer gnus-summary-buffer
7880         (if server
7881             (let ((gnus-refer-article-method
7882                    (nconc (list (list 'nntp server))
7883                           gnus-refer-article-method))
7884                   (nntp-port-number (or port "nntp")))
7885               (gnus-message 7 "Fetching %s with %s"
7886                             message-id gnus-refer-article-method)
7887               (gnus-summary-refer-article message-id))
7888           (gnus-summary-refer-article message-id))))
7889      (group
7890       (gnus-button-fetch-group url)))))
7891
7892 (defun gnus-button-patch (library line)
7893   "Visit an Emacs Lisp library LIBRARY on line LINE."
7894   (interactive)
7895   (let ((file (locate-library (file-name-nondirectory library))))
7896     (unless file
7897       (error "Couldn't find library %s" library))
7898     (find-file file)
7899     (goto-line (string-to-number line))))
7900
7901 (defun gnus-button-handle-man (url)
7902   "Fetch a man page."
7903   (gnus-message 9 "`%s' `%s'" gnus-button-man-handler url)
7904   (when (eq gnus-button-man-handler 'woman)
7905     (setq url (gnus-replace-in-string url "([1-9][X1a-z]*).*\\'" "")))
7906   (gnus-message 9 "`%s' `%s'" gnus-button-man-handler url)
7907   (funcall gnus-button-man-handler url))
7908
7909 (defun gnus-button-handle-info-url (url)
7910   "Fetch an info URL."
7911   (setq url (mm-subst-char-in-string ?+ ?\  url))
7912   (cond
7913    ((string-match "^\\([^:/]+\\)?/\\(.*\\)" url)
7914     (gnus-info-find-node
7915      (concat "(" (or (gnus-url-unhex-string (match-string 1 url))
7916                      "Gnus")
7917              ")" (gnus-url-unhex-string (match-string 2 url)))))
7918    ((string-match "([^)\"]+)[^\"]+" url)
7919     (setq url
7920           (gnus-replace-in-string
7921            (gnus-replace-in-string url "[\n\t ]+" " ") "\"" ""))
7922     (gnus-info-find-node url))
7923    (t (error "Can't parse %s" url))))
7924
7925 (defun gnus-button-handle-info-url-gnome (url)
7926   "Fetch GNOME style info URL."
7927   (setq url (mm-subst-char-in-string ?_ ?\  url))
7928   (if (string-match "\\([^#]+\\)#?\\(.*\\)" url)
7929       (gnus-info-find-node
7930        (concat "("
7931                (gnus-url-unhex-string
7932                  (match-string 1 url))
7933                ")"
7934                (or (gnus-url-unhex-string
7935                     (match-string 2 url))
7936                    "Top")))
7937     (error "Can't parse %s" url)))
7938
7939 (defun gnus-button-handle-info-url-kde (url)
7940   "Fetch KDE style info URL."
7941   (gnus-info-find-node (gnus-url-unhex-string url)))
7942
7943 ;; (info) will autoload info.el
7944 (declare-function Info-menu "info" (menu-item &optional fork))
7945 (declare-function Info-index-next "info" (num))
7946
7947 (defun gnus-button-handle-info-keystrokes (url)
7948   "Call `info' when pushing the corresponding URL button."
7949   ;; For links like `C-h i d m gnus RET part RET , ,', `C-h i d m CC Mode RET'.
7950   (let (node indx comma)
7951     (if (string-match
7952          (concat "\\b\\(C-h\\|<?[Ff]1>?\\)[ \t\n]+i[ \t\n]+d?[ \t\n]?m[ \t\n]+"
7953                  "\\([^ ]+ ?[^ ]+\\)[ \t\n]+RET"
7954                  "\\([ \t\n]+i[ \t\n]+[^ ]+ ?[^ ]+[ \t\n]+RET"
7955                  "\\(?:[ \t\n,]*\\)\\)?")
7956          url)
7957         (setq node (match-string 2 url)
7958               indx (match-string 3 url))
7959       (error "Can't parse %s" url))
7960     (info)
7961     (Info-directory)
7962     (Info-menu node)
7963     (when (> (length indx) 0)
7964       (string-match (concat "[ \t\n]+i[ \t\n]+\\([^ ]+ ?[^ ]+\\)[ \t\n]+RET"
7965                             "\\([ \t\n,]*\\)")
7966                     indx)
7967       (setq comma (match-string 2 indx))
7968       (setq indx  (match-string 1 indx))
7969       (Info-index indx)
7970       (when comma
7971         (dotimes (i (with-temp-buffer
7972                       (insert comma)
7973                       ;; Note: the XEmacs version of `how-many' takes
7974                       ;; no optional argument.
7975                       (goto-char (point-min))
7976                       (how-many ",")))
7977           (Info-index-next 1)))
7978       nil)))
7979
7980 ;; Called after pgg-snarf-keys-region, which autoloads pgg.el.
7981 (declare-function pgg-display-output-buffer "pgg" (start end status))
7982
7983 (defun gnus-button-openpgp (url)
7984   "Retrieve and add an OpenPGP key given URL from an OpenPGP header."
7985   (with-temp-buffer
7986     (mm-url-insert-file-contents-external url)
7987     (pgg-snarf-keys-region (point-min) (point-max))
7988     (pgg-display-output-buffer nil nil nil)))
7989
7990 (defun gnus-button-message-id (message-id)
7991   "Fetch MESSAGE-ID."
7992   (with-current-buffer gnus-summary-buffer
7993     (gnus-summary-refer-article message-id)))
7994
7995 (defun gnus-button-fetch-group (address &rest ignore)
7996   "Fetch GROUP specified by ADDRESS."
7997   (when (string-match "\\`\\(nntp\\|news\\):\\(//\\)?\\(.*\\)\\'"
7998                       address)
7999     ;; Allow to use `gnus-button-fetch-group' in `browse-url-browser-function'
8000     ;; for nntp:// and news://
8001     (setq address (match-string 3 address)))
8002   (if (not (string-match "[:/]" address))
8003       ;; This is just a simple group url.
8004       (gnus-group-read-ephemeral-group address gnus-select-method)
8005     (if (not
8006          (string-match
8007           "^\\([^:/]+\\)\\(:\\([^/]+\\)\\)?/\\([^/]+\\)\\(/\\([0-9]+\\)\\)?"
8008           address))
8009         (error "Can't parse %s" address)
8010       (gnus-group-read-ephemeral-group
8011        (match-string 4 address)
8012        `(nntp ,(match-string 1 address)
8013               (nntp-address ,(match-string 1 address))
8014               (nntp-port-number ,(if (match-end 3)
8015                                      (match-string 3 address)
8016                                    "nntp")))
8017        nil nil nil
8018        (and (match-end 6) (list (string-to-number (match-string 6 address))))))))
8019
8020 (defun gnus-url-parse-query-string (query &optional downcase)
8021   (let (retval pairs cur key val)
8022     (setq pairs (split-string query "&"))
8023     (while pairs
8024       (setq cur (car pairs)
8025             pairs (cdr pairs))
8026       (if (not (string-match "=" cur))
8027           nil                           ; Grace
8028         (setq key (gnus-url-unhex-string (substring cur 0 (match-beginning 0)))
8029               val (gnus-url-unhex-string (substring cur (match-end 0) nil) t))
8030         (if downcase
8031             (setq key (downcase key)))
8032         (setq cur (assoc key retval))
8033         (if cur
8034             (setcdr cur (cons val (cdr cur)))
8035           (setq retval (cons (list key val) retval)))))
8036     retval))
8037
8038 (defun gnus-url-mailto (url)
8039   ;; Send mail to someone
8040   (when (string-match "mailto:/*\\(.*\\)" url)
8041     (setq url (substring url (match-beginning 1) nil)))
8042   (let (to args subject func)
8043     (setq args (gnus-url-parse-query-string
8044                 (if (string-match "^\\?" url)
8045                     (substring url 1)
8046                   (if (string-match "^\\([^?]+\\)\\?\\(.*\\)" url)
8047                       (concat "to=" (match-string 1 url) "&"
8048                               (match-string 2 url))
8049                     (concat "to=" url)))
8050                 t)
8051           subject (cdr-safe (assoc "subject" args)))
8052     (gnus-msg-mail)
8053     (while args
8054       (setq func (intern-soft (concat "message-goto-" (downcase (caar args)))))
8055       (if (fboundp func)
8056           (funcall func)
8057         (message-position-on-field (caar args)))
8058       (insert (gnus-replace-in-string
8059                (mapconcat 'identity (reverse (cdar args)) ", ")
8060                "\r\n" "\n" t))
8061       (setq args (cdr args)))
8062     (if subject
8063         (message-goto-body)
8064       (message-goto-subject))))
8065
8066 (defun gnus-button-embedded-url (address)
8067   "Activate ADDRESS with `browse-url'."
8068   (browse-url (gnus-strip-whitespace address)))
8069
8070 ;;; Next/prev buttons in the article buffer.
8071
8072 (defvar gnus-next-page-line-format "%{%(Next page...%)%}\n")
8073 (defvar gnus-prev-page-line-format "%{%(Previous page...%)%}\n")
8074
8075 (defvar gnus-prev-page-map
8076   (let ((map (make-sparse-keymap)))
8077     (define-key map gnus-mouse-2 'gnus-button-prev-page)
8078     (define-key map "\r" 'gnus-button-prev-page)
8079     map))
8080
8081 (defvar gnus-next-page-map
8082   (let ((map (make-sparse-keymap)))
8083     (unless (>= emacs-major-version 21)
8084       ;; XEmacs doesn't care.
8085       (set-keymap-parent map gnus-article-mode-map))
8086     (define-key map gnus-mouse-2 'gnus-button-next-page)
8087     (define-key map "\r" 'gnus-button-next-page)
8088     map))
8089
8090 (defun gnus-insert-prev-page-button ()
8091   (let ((b (point)) e
8092         (inhibit-read-only t))
8093     (gnus-eval-format
8094      gnus-prev-page-line-format nil
8095      `(keymap ,gnus-prev-page-map
8096               gnus-prev t
8097               gnus-callback gnus-article-button-prev-page
8098               article-type annotation))
8099     (setq e (if (bolp)
8100                 ;; Exclude a newline.
8101                 (1- (point))
8102               (point)))
8103     (when gnus-article-button-face
8104       (gnus-overlay-put (gnus-make-overlay b e nil t)
8105                         'face gnus-article-button-face))
8106     (widget-convert-button
8107      'link b e
8108      :action 'gnus-button-prev-page
8109      :button-keymap gnus-prev-page-map)))
8110
8111 (defun gnus-button-next-page (&optional args more-args)
8112   "Go to the next page."
8113   (interactive)
8114   (let ((win (selected-window)))
8115     (select-window (gnus-get-buffer-window gnus-article-buffer t))
8116     (gnus-article-next-page)
8117     (select-window win)))
8118
8119 (defun gnus-button-prev-page (&optional args more-args)
8120   "Go to the prev page."
8121   (interactive)
8122   (let ((win (selected-window)))
8123     (select-window (gnus-get-buffer-window gnus-article-buffer t))
8124     (gnus-article-prev-page)
8125     (select-window win)))
8126
8127 (defun gnus-insert-next-page-button ()
8128   (let ((b (point)) e
8129         (inhibit-read-only t))
8130     (gnus-eval-format gnus-next-page-line-format nil
8131                       `(keymap ,gnus-next-page-map
8132                                gnus-next t
8133                                gnus-callback gnus-article-button-next-page
8134                                article-type annotation))
8135     (setq e (if (bolp)
8136                 ;; Exclude a newline.
8137                 (1- (point))
8138               (point)))
8139     (when gnus-article-button-face
8140       (gnus-overlay-put (gnus-make-overlay b e nil t)
8141                         'face gnus-article-button-face))
8142     (widget-convert-button
8143      'link b e
8144      :action 'gnus-button-next-page
8145      :button-keymap gnus-next-page-map)))
8146
8147 (defun gnus-article-button-next-page (arg)
8148   "Go to the next page."
8149   (interactive "P")
8150   (let ((win (selected-window)))
8151     (select-window (gnus-get-buffer-window gnus-article-buffer t))
8152     (gnus-article-next-page)
8153     (select-window win)))
8154
8155 (defun gnus-article-button-prev-page (arg)
8156   "Go to the prev page."
8157   (interactive "P")
8158   (let ((win (selected-window)))
8159     (select-window (gnus-get-buffer-window gnus-article-buffer t))
8160     (gnus-article-prev-page)
8161     (select-window win)))
8162
8163 (defvar gnus-decode-header-methods
8164   '(mail-decode-encoded-word-region)
8165   "List of methods used to decode headers.
8166
8167 This variable is a list of FUNCTION or (REGEXP . FUNCTION).  If item
8168 is FUNCTION, FUNCTION will be applied to all newsgroups.  If item is a
8169 \(REGEXP . FUNCTION), FUNCTION will be only apply to the newsgroups
8170 whose names match REGEXP.
8171
8172 For example:
8173 \((\"chinese\" . gnus-decode-encoded-word-region-by-guess)
8174  mail-decode-encoded-word-region
8175  (\"chinese\" . rfc1843-decode-region))
8176 ")
8177
8178 (defvar gnus-decode-header-methods-cache nil)
8179
8180 (defun gnus-multi-decode-header (start end)
8181   "Apply the functions from `gnus-encoded-word-methods' that match."
8182   (unless (and gnus-decode-header-methods-cache
8183                (eq gnus-newsgroup-name
8184                    (car gnus-decode-header-methods-cache)))
8185     (setq gnus-decode-header-methods-cache (list gnus-newsgroup-name))
8186     (dolist (x gnus-decode-header-methods)
8187       (if (symbolp x)
8188           (nconc gnus-decode-header-methods-cache (list x))
8189         (if (and gnus-newsgroup-name
8190                  (string-match (car x) gnus-newsgroup-name))
8191             (nconc gnus-decode-header-methods-cache
8192                    (list (cdr x)))))))
8193   (let ((xlist gnus-decode-header-methods-cache))
8194     (pop xlist)
8195     (save-restriction
8196       (narrow-to-region start end)
8197       (while xlist
8198         (funcall (pop xlist) (point-min) (point-max))))))
8199
8200 ;;;
8201 ;;; Treatment top-level handling.
8202 ;;;
8203
8204 (defun gnus-treat-article (condition &optional part-number total-parts type)
8205   (let ((length (- (point-max) (point-min)))
8206         (alist gnus-treatment-function-alist)
8207         (article-goto-body-goes-to-point-min-p t)
8208         (treated-type
8209          (or (not type)
8210              (catch 'found
8211                (let ((list gnus-article-treat-types))
8212                  (while list
8213                    (when (string-match (pop list) type)
8214                      (throw 'found t)))))))
8215         (highlightp (gnus-visual-p 'article-highlight 'highlight))
8216         val elem)
8217     (gnus-run-hooks 'gnus-part-display-hook)
8218     (dolist (elem alist)
8219       (setq val
8220             (save-excursion
8221               (when (gnus-buffer-live-p gnus-summary-buffer)
8222                 (set-buffer gnus-summary-buffer))
8223               (symbol-value (car elem))))
8224       (when (and (or (consp val)
8225                      treated-type)
8226                  (gnus-treat-predicate val)
8227                  (or (not (get (car elem) 'highlight))
8228                      highlightp))
8229         (save-restriction
8230           (funcall (cadr elem)))))))
8231
8232 ;; Dynamic variables.
8233 (defvar part-number)
8234 (defvar total-parts)
8235 (defvar type)
8236 (defvar condition)
8237 (defvar length)
8238
8239 (defun gnus-treat-predicate (val)
8240   (cond
8241    ((null val)
8242     nil)
8243    (condition
8244     (eq condition val))
8245    ((and (listp val)
8246          (stringp (car val)))
8247     (apply 'gnus-or (mapcar `(lambda (s)
8248                                (string-match s ,(or gnus-newsgroup-name "")))
8249                             val)))
8250    ((listp val)
8251     (let ((pred (pop val)))
8252       (cond
8253        ((eq pred 'or)
8254         (apply 'gnus-or (mapcar 'gnus-treat-predicate val)))
8255        ((eq pred 'and)
8256         (apply 'gnus-and (mapcar 'gnus-treat-predicate val)))
8257        ((eq pred 'not)
8258         (not (gnus-treat-predicate (car val))))
8259        ((eq pred 'typep)
8260         (equal (car val) type))
8261        (t
8262         (error "%S is not a valid predicate" pred)))))
8263    ((eq val t)
8264     t)
8265    ((eq val 'head)
8266     nil)
8267    ((eq val 'first)
8268     (eq part-number 1))
8269    ((eq val 'last)
8270     (eq part-number total-parts))
8271    ((numberp val)
8272     (< length val))
8273    (t
8274     (error "%S is not a valid value" val))))
8275
8276 (defun gnus-article-encrypt-body (protocol &optional n)
8277   "Encrypt the article body."
8278   (interactive
8279    (list
8280     (or gnus-article-encrypt-protocol
8281         (completing-read "Encrypt protocol: "
8282                          gnus-article-encrypt-protocol-alist
8283                          nil t))
8284     current-prefix-arg))
8285   ;; User might hit `K E' instead of `K e', so prompt once.
8286   (when (and gnus-article-encrypt-protocol
8287              gnus-novice-user)
8288     (unless (gnus-y-or-n-p "Really encrypt article(s)? ")
8289       (error "Encrypt aborted.")))
8290   (let ((func (cdr (assoc protocol gnus-article-encrypt-protocol-alist))))
8291     (unless func
8292       (error "Can't find the encrypt protocol %s" protocol))
8293     (if (member gnus-newsgroup-name '("nndraft:delayed"
8294                                       "nndraft:drafts"
8295                                       "nndraft:queue"))
8296         (error "Can't encrypt the article in group %s"
8297                gnus-newsgroup-name))
8298     (gnus-summary-iterate n
8299       (with-current-buffer gnus-summary-buffer
8300         (let ((mail-parse-charset gnus-newsgroup-charset)
8301               (mail-parse-ignored-charsets gnus-newsgroup-ignored-charsets)
8302               (summary-buffer gnus-summary-buffer)
8303               references point)
8304           (gnus-set-global-variables)
8305           (when (gnus-group-read-only-p)
8306             (error "The current newsgroup does not support article encrypt"))
8307           (gnus-summary-show-article t)
8308           (setq references
8309               (or (mail-header-references gnus-current-headers) ""))
8310           (set-buffer gnus-article-buffer)
8311           (let* ((inhibit-read-only t)
8312                  (headers
8313                   (mapcar (lambda (field)
8314                             (and (save-restriction
8315                                    (message-narrow-to-head)
8316                                    (goto-char (point-min))
8317                                    (search-forward field nil t))
8318                                  (prog2
8319                                      (message-narrow-to-field)
8320                                      (buffer-string)
8321                                    (delete-region (point-min) (point-max))
8322                                    (widen))))
8323                           '("Content-Type:" "Content-Transfer-Encoding:"
8324                             "Content-Disposition:"))))
8325             (message-narrow-to-head)
8326             (message-remove-header "MIME-Version")
8327             (goto-char (point-max))
8328             (setq point (point))
8329             (insert (apply 'concat headers))
8330             (widen)
8331             (narrow-to-region point (point-max))
8332             (let ((message-options message-options))
8333               (message-options-set 'message-sender user-mail-address)
8334               (message-options-set 'message-recipients user-mail-address)
8335               (message-options-set 'message-sign-encrypt 'not)
8336               (funcall func))
8337             (goto-char (point-min))
8338             (insert "MIME-Version: 1.0\n")
8339             (widen)
8340             (gnus-summary-edit-article-done
8341              references nil summary-buffer t))
8342           (when gnus-keep-backlog
8343             (gnus-backlog-remove-article
8344              (car gnus-article-current) (cdr gnus-article-current)))
8345           (when (get-buffer gnus-original-article-buffer)
8346             (with-current-buffer gnus-original-article-buffer
8347               (setq gnus-original-article nil)))
8348           (when gnus-use-cache
8349             (gnus-cache-update-article
8350              (car gnus-article-current) (cdr gnus-article-current))))))))
8351
8352 (defvar gnus-mime-security-button-line-format "%{%([[%t:%i]%D]%)%}\n"
8353   "The following specs can be used:
8354 %t  The security MIME type
8355 %i  Additional info
8356 %d  Details
8357 %D  Details if button is pressed")
8358
8359 (defvar gnus-mime-security-button-end-line-format "%{%([[End of %t]%D]%)%}\n"
8360   "The following specs can be used:
8361 %t  The security MIME type
8362 %i  Additional info
8363 %d  Details
8364 %D  Details if button is pressed")
8365
8366 (defvar gnus-mime-security-button-line-format-alist
8367   '((?t gnus-tmp-type ?s)
8368     (?i gnus-tmp-info ?s)
8369     (?d gnus-tmp-details ?s)
8370     (?D gnus-tmp-pressed-details ?s)))
8371
8372 (defvar gnus-mime-security-button-commands
8373   '((gnus-article-press-button "\r" "Show Detail")
8374     (undefined "v")
8375     (undefined "t")
8376     (undefined "C")
8377     (gnus-mime-security-save-part "o" "Save...")
8378     (undefined "\C-o")
8379     (undefined "r")
8380     (undefined "d")
8381     (undefined "c")
8382     (undefined "i")
8383     (undefined "E")
8384     (undefined "e")
8385     (undefined "p")
8386     (gnus-mime-security-pipe-part "|" "Pipe To Command...")
8387     (undefined ".")))
8388
8389 (defvar gnus-mime-security-button-map
8390   (let ((map (make-sparse-keymap)))
8391     (define-key map gnus-mouse-2 'gnus-article-push-button)
8392     (define-key map gnus-down-mouse-3 'gnus-mime-security-button-menu)
8393     (dolist (c gnus-mime-security-button-commands)
8394       (define-key map (cadr c) (car c)))
8395     map))
8396
8397 (easy-menu-define
8398   gnus-mime-security-button-menu gnus-mime-security-button-map
8399   "Security button menu."
8400   `("Security Part"
8401     ,@(delq nil
8402             (mapcar (lambda (c)
8403                       (unless (eq (car c) 'undefined)
8404                         (vector (caddr c) (car c) :active t)))
8405                     gnus-mime-security-button-commands))))
8406
8407 (defun gnus-mime-security-button-menu (event prefix)
8408   "Construct a context-sensitive menu of security commands."
8409   (interactive "e\nP")
8410   (save-window-excursion
8411     (let ((pos (event-start event)))
8412       (select-window (posn-window pos))
8413       (goto-char (posn-point pos))
8414       (gnus-article-check-buffer)
8415       (popup-menu gnus-mime-security-button-menu nil prefix))))
8416
8417 (defvar gnus-mime-security-details-buffer nil)
8418
8419 (defvar gnus-mime-security-button-pressed nil)
8420
8421 (defvar gnus-mime-security-show-details-inline t
8422   "If non-nil, show details in the article buffer.")
8423
8424 (defun gnus-mime-security-verify-or-decrypt (handle)
8425   (mm-remove-parts (cdr handle))
8426   (let ((region (mm-handle-multipart-ctl-parameter handle 'gnus-region))
8427         point (inhibit-read-only t))
8428     (if region
8429         (goto-char (car region)))
8430     (setq point (point))
8431     (with-current-buffer (mm-handle-multipart-original-buffer handle)
8432       (let* ((mm-verify-option 'known)
8433              (mm-decrypt-option 'known)
8434              (nparts (mm-possibly-verify-or-decrypt (cdr handle) handle)))
8435         (unless (eq nparts (cdr handle))
8436           (mm-destroy-parts (cdr handle))
8437           (setcdr handle nparts))))
8438     (gnus-mime-display-security handle)
8439     (when region
8440       (delete-region (point) (cdr region))
8441       (set-marker (car region) nil)
8442       (set-marker (cdr region) nil))
8443     (goto-char point)))
8444
8445 (defun gnus-mime-security-show-details (handle)
8446   (let ((details (mm-handle-multipart-ctl-parameter handle 'gnus-details)))
8447     (if (not details)
8448         (gnus-message 5 "No details.")
8449       (if gnus-mime-security-show-details-inline
8450           (let ((gnus-mime-security-button-pressed
8451                  (not (get-text-property (point) 'gnus-mime-details)))
8452                 (gnus-mime-security-button-line-format
8453                  (get-text-property (point) 'gnus-line-format))
8454                 (inhibit-read-only t))
8455             (forward-char -1)
8456             (while (eq (get-text-property (point) 'gnus-line-format)
8457                        gnus-mime-security-button-line-format)
8458               (forward-char -1))
8459             (forward-char)
8460             (save-restriction
8461               (narrow-to-region (point) (point))
8462               (gnus-insert-mime-security-button handle))
8463             (delete-region (point)
8464                            (or (text-property-not-all
8465                                 (point) (point-max)
8466                                 'gnus-line-format
8467                                 gnus-mime-security-button-line-format)
8468                                (point-max))))
8469         ;; Not inlined.
8470         (if (gnus-buffer-live-p gnus-mime-security-details-buffer)
8471             (with-current-buffer gnus-mime-security-details-buffer
8472               (erase-buffer)
8473               t)
8474           (setq gnus-mime-security-details-buffer
8475                 (gnus-get-buffer-create "*MIME Security Details*")))
8476         (with-current-buffer gnus-mime-security-details-buffer
8477           (insert details)
8478           (goto-char (point-min)))
8479         (pop-to-buffer gnus-mime-security-details-buffer)))))
8480
8481 (defun gnus-mime-security-press-button (handle)
8482   (save-excursion
8483     (if (mm-handle-multipart-ctl-parameter handle 'gnus-info)
8484         (gnus-mime-security-show-details handle)
8485       (gnus-mime-security-verify-or-decrypt handle))))
8486
8487 (defun gnus-insert-mime-security-button (handle &optional displayed)
8488   (let* ((protocol (mm-handle-multipart-ctl-parameter handle 'protocol))
8489          (gnus-tmp-type
8490           (concat
8491            (or (nth 2 (assoc protocol mm-verify-function-alist))
8492                (nth 2 (assoc protocol mm-decrypt-function-alist))
8493                "Unknown")
8494            (if (equal (car handle) "multipart/signed")
8495                " Signed" " Encrypted")
8496            " Part"))
8497          (gnus-tmp-info
8498           (or (mm-handle-multipart-ctl-parameter handle 'gnus-info)
8499               "Undecided"))
8500          (gnus-tmp-details
8501           (mm-handle-multipart-ctl-parameter handle 'gnus-details))
8502          gnus-tmp-pressed-details
8503          b e)
8504     (setq gnus-tmp-details
8505           (if gnus-tmp-details
8506               (concat "\n" gnus-tmp-details)
8507             ""))
8508     (setq gnus-tmp-pressed-details
8509           (if gnus-mime-security-button-pressed gnus-tmp-details ""))
8510     (unless (bolp)
8511       (insert "\n"))
8512     (setq b (point))
8513     (gnus-eval-format
8514      gnus-mime-security-button-line-format
8515      gnus-mime-security-button-line-format-alist
8516      `(keymap ,gnus-mime-security-button-map
8517          gnus-callback gnus-mime-security-press-button
8518          gnus-line-format ,gnus-mime-security-button-line-format
8519          gnus-mime-details ,gnus-mime-security-button-pressed
8520          article-type annotation
8521          gnus-data ,handle))
8522     (setq e (if (bolp)
8523                 ;; Exclude a newline.
8524                 (1- (point))
8525               (point)))
8526     (when gnus-article-button-face
8527       (gnus-overlay-put (gnus-make-overlay b e nil t)
8528                         'face gnus-article-button-face))
8529     (widget-convert-button
8530      'link b e
8531      :mime-handle handle
8532      :action 'gnus-widget-press-button
8533      :button-keymap gnus-mime-security-button-map
8534      :help-echo
8535      (lambda (widget/window &optional overlay pos)
8536        ;; Needed to properly clear the message due to a bug in
8537        ;; wid-edit (XEmacs only).
8538        (when (boundp 'help-echo-owns-message)
8539          (setq help-echo-owns-message t))
8540        (format
8541         "%S: show detail; %S: more options"
8542         (aref gnus-mouse-2 0)
8543         (aref gnus-down-mouse-3 0))))))
8544
8545 (defun gnus-mime-display-security (handle)
8546   (save-restriction
8547     (narrow-to-region (point) (point))
8548     (unless (gnus-unbuttonized-mime-type-p (car handle))
8549       (gnus-insert-mime-security-button handle))
8550     (gnus-mime-display-part (cadr handle))
8551     (unless (bolp)
8552       (insert "\n"))
8553     (unless (gnus-unbuttonized-mime-type-p (car handle))
8554       (let ((gnus-mime-security-button-line-format
8555              gnus-mime-security-button-end-line-format))
8556         (gnus-insert-mime-security-button handle)))
8557     (mm-set-handle-multipart-parameter
8558      handle 'gnus-region
8559      (cons (set-marker (make-marker) (point-min))
8560            (set-marker (make-marker) (point-max))))
8561     (goto-char (point-max))))
8562
8563 (defun gnus-mime-security-run-function (function)
8564   "Run FUNCTION with the security part under point."
8565   (gnus-article-check-buffer)
8566   (let ((data (get-text-property (point) 'gnus-data))
8567         buffer handle)
8568     (when (and (stringp (car-safe data))
8569                (setq buffer (mm-handle-multipart-original-buffer data))
8570                (setq handle (cadr data)))
8571       (if (bufferp (mm-handle-buffer handle))
8572           (progn
8573             (setq handle (cons buffer (copy-sequence (cdr handle))))
8574             (mm-handle-set-undisplayer handle nil))
8575         (setq handle (mm-make-handle
8576                       buffer
8577                       (mm-handle-multipart-ctl-parameter handle 'protocol)
8578                       nil nil nil nil nil nil)))
8579       (funcall function handle))))
8580
8581 (defun gnus-mime-security-save-part ()
8582   "Save the security part under point."
8583   (interactive)
8584   (gnus-mime-security-run-function 'mm-save-part))
8585
8586 (defun gnus-mime-security-pipe-part ()
8587   "Pipe the security part under point to a process."
8588   (interactive)
8589   (gnus-mime-security-run-function 'mm-pipe-part))
8590
8591 (gnus-ems-redefine)
8592
8593 (provide 'gnus-art)
8594
8595 (run-hooks 'gnus-art-load-hook)
8596
8597 ;; arch-tag: 2654516f-6279-48f9-a83b-05c1fa450c33
8598 ;;; gnus-art.el ends here