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

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