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

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