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

   1 ;;; gnus-art.el --- article mode commands for Gnus
   2
   3 ;; Copyright (C) 1996-2011 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-sum)
  37 (require 'gnus-spec)
  38 (require 'gnus-int)
  39 (require 'gnus-win)
  40 (require 'mm-bodies)
  41 (require 'mail-parse)
  42 (require 'mm-decode)
  43 (require 'mm-view)
  44 (require 'wid-edit)
  45 (require 'mm-uu)
  46 (require 'message)
  47
  48 (autoload 'gnus-msg-mail "gnus-msg" nil t)
  49 (autoload 'gnus-button-mailto "gnus-msg")
  50 (autoload 'gnus-button-reply "gnus-msg" nil t)
  51 (autoload 'parse-time-string "parse-time" nil nil)
  52 (autoload 'ansi-color-apply-on-region "ansi-color")
  53 (autoload 'mm-url-insert-file-contents-external "mm-url")
  54 (autoload 'mm-extern-cache-contents "mm-extern")
  55
  56 (defgroup gnus-article nil
  57   "Article display."
  58   :link '(custom-manual "(gnus)Article Buffer")
  59   :group 'gnus)
  60
  61 (defgroup gnus-article-treat nil
  62   "Treating article parts."
  63   :link '(custom-manual "(gnus)Article Hiding")
  64   :group 'gnus-article)
  65
  66 (defgroup gnus-article-hiding nil
  67   "Hiding article parts."
  68   :link '(custom-manual "(gnus)Article Hiding")
  69   :group 'gnus-article)
  70
  71 (defgroup gnus-article-highlight nil
  72   "Article highlighting."
  73   :link '(custom-manual "(gnus)Article Highlighting")
  74   :group 'gnus-article
  75   :group 'gnus-visual)
  76
  77 (defgroup gnus-article-signature nil
  78   "Article signatures."
  79   :link '(custom-manual "(gnus)Article Signature")
  80   :group 'gnus-article)
  81
  82 (defgroup gnus-article-headers nil
  83   "Article headers."
  84   :link '(custom-manual "(gnus)Hiding Headers")
  85   :group 'gnus-article)
  86
  87 (defgroup gnus-article-washing nil
  88   "Special commands on articles."
  89   :link '(custom-manual "(gnus)Article Washing")
  90   :group 'gnus-article)
  91
  92 (defgroup gnus-article-emphasis nil
  93   "Fontisizing articles."
  94   :link '(custom-manual "(gnus)Article Fontisizing")
  95   :group 'gnus-article)
  96
  97 (defgroup gnus-article-saving nil
  98   "Saving articles."
  99   :link '(custom-manual "(gnus)Saving Articles")
 100   :group 'gnus-article)
 101
 102 (defgroup gnus-article-mime nil
 103   "Worshiping the MIME wonder."
 104   :link '(custom-manual "(gnus)Using MIME")
 105   :group 'gnus-article)
 106
 107 (defgroup gnus-article-buttons nil
 108   "Pushable buttons in the article buffer."
 109   :link '(custom-manual "(gnus)Article Buttons")
 110   :group 'gnus-article)
 111
 112 (defgroup gnus-article-various nil
 113   "Other article options."
 114   :link '(custom-manual "(gnus)Misc Article")
 115   :group 'gnus-article)
 116
 117 (defcustom gnus-ignored-headers
 118   (mapcar
 119    (lambda (header)
 120      (concat "^" header ":"))
 121    '("Path" "Expires" "Date-Received" "References" "Xref" "Lines"
 122      "Relay-Version" "Message-ID" "Approved" "Sender" "Received"
 123      "X-UIDL" "MIME-Version" "Return-Path" "In-Reply-To"
 124      "Content-Type" "Content-Transfer-Encoding" "X-WebTV-Signature"
 125      "X-MimeOLE" "X-MSMail-Priority" "X-Priority" "X-Loop"
 126      "X-Authentication-Warning" "X-MIME-Autoconverted" "X-Face"
 127      "X-Attribution" "X-Originating-IP" "Delivered-To"
 128      "NNTP-[-A-Za-z]+" "Distribution" "X-no-archive" "X-Trace"
 129      "X-Complaints-To" "X-NNTP-Posting-Host" "X-Orig.*"
 130      "Abuse-Reports-To" "Cache-Post-Path" "X-Article-Creation-Date"
 131      "X-Poster" "X-Mail2News-Path" "X-Server-Date" "X-Cache"
 132      "Originator" "X-Problems-To" "X-Auth-User" "X-Post-Time"
 133      "X-Admin" "X-UID" "Resent-[-A-Za-z]+" "X-Mailing-List"
 134      "Precedence" "Original-[-A-Za-z]+" "X-filename" "X-Orcpt"
 135      "Old-Received" "X-Pgp" "X-Auth" "X-From-Line"
 136      "X-Gnus-Article-Number" "X-Majordomo" "X-Url" "X-Sender"
 137      "MBOX-Line" "Priority" "X400-[-A-Za-z]+"
 138      "Status" "X-Gnus-Mail-Source" "Cancel-Lock"
 139      "X-FTN" "X-EXP32-SerialNo" "Encoding" "Importance"
 140      "Autoforwarded" "Original-Encoded-Information-Types" "X-Ya-Pop3"
 141      "X-Face-Version" "X-Vms-To" "X-ML-NAME" "X-ML-COUNT"
 142      "Mailing-List" "X-finfo" "X-md5sum" "X-md5sum-Origin"
 143      "X-Sun-Charset" "X-Accept-Language" "X-Envelope-Sender"
 144      "List-[A-Za-z]+" "X-Listprocessor-Version"
 145      "X-Received" "X-Distribute" "X-Sequence" "X-Juno-Line-Breaks"
 146      "X-Notes-Item" "X-MS-TNEF-Correlator" "x-uunet-gateway"
 147      "X-Received" "Content-length" "X-precedence"
 148      "X-Authenticated-User" "X-Comment" "X-Report" "X-Abuse-Info"
 149      "X-HTTP-Proxy" "X-Mydeja-Info" "X-Copyright" "X-No-Markup"
 150      "X-Abuse-Info" "X-From_" "X-Accept-Language" "Errors-To"
 151      "X-BeenThere" "X-Mailman-Version" "List-Help" "List-Post"
 152      "List-Subscribe" "List-Id" "List-Unsubscribe" "List-Archive"
 153      "X-Content-length" "X-Posting-Agent" "Original-Received"
 154      "X-Request-PGP" "X-Fingerprint" "X-WRIEnvto" "X-WRIEnvfrom"
 155      "X-Virus-Scanned" "X-Delivery-Agent" "Posted-Date" "X-Gateway"
 156      "X-Local-Origin" "X-Local-Destination" "X-UserInfo1"
 157      "X-Received-Date" "X-Hashcash" "Face" "X-DMCA-Notifications"
 158      "X-Abuse-and-DMCA-Info" "X-Postfilter" "X-Gpg-.*" "X-Disclaimer"
 159      "Envelope-To" "X-Spam-Score" "System-Type" "X-Injected-Via-Gmane"
 160      "X-Gmane-NNTP-Posting-Host" "Jabber-ID" "Archived-At"
 161      "Envelope-Sender" "Envelope-Recipients"))
 162   "*All headers that start with this regexp will be hidden.
 163 This variable can also be a list of regexps of headers to be ignored.
 164 If `gnus-visible-headers' is non-nil, this variable will be ignored."
 165   :type '(choice :custom-show nil
 166                  regexp
 167                  (repeat regexp))
 168   :group 'gnus-article-hiding)
 169
 170 (defcustom gnus-visible-headers
 171   "^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:"
 172   "*All headers that do not match this regexp will be hidden.
 173 This variable can also be a list of regexp of headers to remain visible.
 174 If this variable is non-nil, `gnus-ignored-headers' will be ignored."
 175   :type '(choice
 176           (repeat :value-to-internal (lambda (widget value)
 177                                        (custom-split-regexp-maybe value))
 178                   :match (lambda (widget value)
 179                            (or (stringp value)
 180                                (widget-editable-list-match widget value)))
 181                   regexp)
 182           (const :tag "Use gnus-ignored-headers" nil)
 183           regexp)
 184   :group 'gnus-article-hiding)
 185
 186 (defcustom gnus-sorted-header-list
 187   '("^From:" "^Subject:" "^Summary:" "^Keywords:" "^Newsgroups:"
 188     "^Followup-To:" "^To:" "^Cc:" "^Date:" "^Organization:")
 189   "*This variable is a list of regular expressions.
 190 If it is non-nil, headers that match the regular expressions will
 191 be placed first in the article buffer in the sequence specified by
 192 this list."
 193   :type '(repeat regexp)
 194   :group 'gnus-article-hiding)
 195
 196 (defcustom gnus-boring-article-headers '(empty followup-to reply-to)
 197   "Headers that are only to be displayed if they have interesting data.
 198 Possible values in this list are:
 199
 200   'empty       Headers with no content.
 201   'newsgroups  Newsgroup identical to Gnus group.
 202   'to-address  To identical to To-address.
 203   'to-list     To identical to To-list.
 204   'cc-list     CC identical to To-list.
 205   'followup-to Followup-to identical to Newsgroups.
 206   'reply-to    Reply-to identical to From.
 207   'date        Date less than four days old.
 208   'long-to     To and/or Cc longer than 1024 characters.
 209   'many-to     Multiple To and/or Cc."
 210   :type '(set (const :tag "Headers with no content." empty)
 211               (const :tag "Newsgroups identical to Gnus group." newsgroups)
 212               (const :tag "To identical to To-address." to-address)
 213               (const :tag "To identical to To-list." to-list)
 214               (const :tag "CC identical to To-list." cc-list)
 215               (const :tag "Followup-to identical to Newsgroups." followup-to)
 216               (const :tag "Reply-to identical to From." reply-to)
 217               (const :tag "Date less than four days old." date)
 218               (const :tag "To and/or Cc longer than 1024 characters." long-to)
 219               (const :tag "Multiple To and/or Cc headers." many-to))
 220   :group 'gnus-article-hiding)
 221
 222 (defcustom gnus-article-skip-boring nil
 223   "Skip over text that is not worth reading.
 224 By default, if you set this t, then Gnus will display citations and
 225 signatures, but will never scroll down to show you a page consisting
 226 only of boring text.  Boring text is controlled by
 227 `gnus-article-boring-faces'."
 228   :version "22.1"
 229   :type 'boolean
 230   :group 'gnus-article-hiding)
 231
 232 (defcustom gnus-signature-separator '("^-- $" "^-- *$")
 233   "Regexp matching signature separator.
 234 This can also be a list of regexps.  In that case, it will be checked
 235 from head to tail looking for a separator.  Searches will be done from
 236 the end of the buffer."
 237   :type '(choice :format "%{%t%}: %[Value Menu%]\n%v"
 238                  (regexp)
 239                  (repeat :tag "List of regexp" regexp))
 240   :group 'gnus-article-signature)
 241
 242 (defcustom gnus-signature-limit nil
 243   "Provide a limit to what is considered a signature.
 244 If it is a number, no signature may not be longer (in characters) than
 245 that number.  If it is a floating point number, no signature may be
 246 longer (in lines) than that number.  If it is a function, the function
 247 will be called without any parameters, and if it returns nil, there is
 248 no signature in the buffer.  If it is a string, it will be used as a
 249 regexp.  If it matches, the text in question is not a signature.
 250
 251 This can also be a list of the above values."
 252   :type '(choice (const nil)
 253                  (integer :value 200)
 254                  (number :value 4.0)
 255                  function
 256                  (regexp :value ".*"))
 257   :group 'gnus-article-signature)
 258
 259 (defcustom gnus-hidden-properties '(invisible t intangible t)
 260   "Property list to use for hiding text."
 261   :type 'sexp
 262   :group 'gnus-article-hiding)
 263
 264 ;; Fixme: This isn't the right thing for mixed graphical and non-graphical
 265 ;; frames in a session.
 266 (defcustom gnus-article-x-face-command
 267   (if (featurep 'xemacs)
 268       (if (or (gnus-image-type-available-p 'xface)
 269               (gnus-image-type-available-p 'pbm))
 270           'gnus-display-x-face-in-from
 271         "{ echo '/* Width=48, Height=48 */'; uncompface; } | icontopbm | ee -")
 272     (if (gnus-image-type-available-p 'pbm)
 273         'gnus-display-x-face-in-from
 274       "{ echo '/* Width=48, Height=48 */'; uncompface; } | icontopbm | \
 275 display -"))
 276   "*String or function to be executed to display an X-Face header.
 277 If it is a string, the command will be executed in a sub-shell
 278 asynchronously.  The compressed face will be piped to this command."
 279   :type `(choice string
 280                  (function-item gnus-display-x-face-in-from)
 281                  function)
 282   :version "21.1"
 283   :group 'gnus-picon
 284   :group 'gnus-article-washing)
 285
 286 (defcustom gnus-article-x-face-too-ugly nil
 287   "Regexp matching posters whose face shouldn't be shown automatically."
 288   :type '(choice regexp (const nil))
 289   :group 'gnus-article-washing)
 290
 291 (defcustom gnus-article-banner-alist nil
 292   "Banner alist for stripping.
 293 For example,
 294      ((egroups . \"^[ \\t\\n]*-------------------+\\\\( \\\\(e\\\\|Yahoo! \\\\)Groups Sponsor -+\\\\)?....\\n\\\\(.+\\n\\\\)+\"))"
 295   :version "21.1"
 296   :type '(repeat (cons symbol regexp))
 297   :group 'gnus-article-washing)
 298
 299 (gnus-define-group-parameter
 300  banner
 301  :variable-document
 302  "Alist of regexps (to match group names) and banner."
 303  :variable-group gnus-article-washing
 304  :parameter-type
 305  '(choice :tag "Banner"
 306           :value nil
 307           (const :tag "Remove signature" signature)
 308           (symbol :tag "Item in `gnus-article-banner-alist'" none)
 309           regexp
 310           (const :tag "None" nil))
 311  :parameter-document
 312  "If non-nil, specify how to remove `banners' from articles.
 313
 314 Symbol `signature' means to remove signatures delimited by
 315 `gnus-signature-separator'.  Any other symbol is used to look up a
 316 regular expression to match the banner in `gnus-article-banner-alist'.
 317 A string is used as a regular expression to match the banner
 318 directly.")
 319
 320 (defcustom gnus-article-address-banner-alist nil
 321   "Alist of mail addresses and banners.
 322 Each element has the form (ADDRESS . BANNER), where ADDRESS is a regexp
 323 to match a mail address in the From: header, BANNER is one of a symbol
 324 `signature', an item in `gnus-article-banner-alist', a regexp and nil.
 325 If ADDRESS matches author's mail address, it will remove things like
 326 advertisements.  For example:
 327
 328 \((\"@yoo-hoo\\\\.co\\\\.jp\\\\'\" . \"\\n_+\\nDo You Yoo-hoo!\\\\?\\n.*\\n.*\\n\"))
 329 "
 330   :type '(repeat
 331           (cons
 332            (regexp :tag "Address")
 333            (choice :tag "Banner" :value nil
 334                    (const :tag "Remove signature" signature)
 335                    (symbol :tag "Item in `gnus-article-banner-alist'" none)
 336                    regexp
 337                    (const :tag "None" nil))))
 338   :version "22.1"
 339   :group 'gnus-article-washing)
 340
 341 (defmacro gnus-emphasis-custom-with-format (&rest body)
 342   `(let ((format "\
 343 \\(\\s-\\|^\\|\\=\\|[-\"]\\|\\s(\\)\\(%s\\(\\w+\\(\\s-+\\w+\\)*[.,]?\\)%s\\)\
 344 \\(\\([-,.;:!?\"]\\|\\s)\\)+\\s-\\|[?!.]\\s-\\|\\s)\\|\\s-\\)"))
 345      ,@body))
 346
 347 (defun gnus-emphasis-custom-value-to-external (value)
 348   (gnus-emphasis-custom-with-format
 349    (if (consp (car value))
 350        (list (format format (car (car value)) (cdr (car value)))
 351              2
 352              (if (nth 1 value) 2 3)
 353              (nth 2 value))
 354      value)))
 355
 356 (defun gnus-emphasis-custom-value-to-internal (value)
 357   (gnus-emphasis-custom-with-format
 358    (let ((regexp (concat "\\`"
 359                          (format (regexp-quote format)
 360                                  "\\([^()]+\\)" "\\([^()]+\\)")
 361                          "\\'"))
 362          pattern)
 363      (if (string-match regexp (setq pattern (car value)))
 364          (list (cons (match-string 1 pattern) (match-string 2 pattern))
 365                (= (nth 2 value) 2)
 366                (nth 3 value))
 367        value))))
 368
 369 (defcustom gnus-emphasis-alist
 370   (let ((types
 371          '(("\\*" "\\*" bold nil 2)
 372            ("_" "_" underline)
 373            ("/" "/" italic)
 374            ("_/" "/_" underline-italic)
 375            ("_\\*" "\\*_" underline-bold)
 376            ("\\*/" "/\\*" bold-italic)
 377            ("_\\*/" "/\\*_" underline-bold-italic))))
 378     (nconc
 379      (gnus-emphasis-custom-with-format
 380       (mapcar (lambda (spec)
 381                 (list (format format (car spec) (cadr spec))
 382                       (or (nth 3 spec) 2)
 383                       (or (nth 4 spec) 3)
 384                       (intern (format "gnus-emphasis-%s" (nth 2 spec)))))
 385               types))
 386      '(;; I've never seen anyone use this strikethru convention whereas I've
 387        ;; several times seen it triggered by normal text.  --Stef
 388        ;; Miles suggests that this form is sometimes used but for italics,
 389        ;; so maybe we should map it to `italic'.
 390        ;; ("\\(\\s-\\|^\\)\\(-\\(\\(\\w\\|-[^-]\\)+\\)-\\)\\(\\s-\\|[?!.,;]\\)"
 391        ;; 2 3 gnus-emphasis-strikethru)
 392        ("\\(\\s-\\|^\\)\\(_\\(\\(\\w\\|_[^_]\\)+\\)_\\)\\(\\s-\\|[?!.,;]\\)"
 393         2 3 gnus-emphasis-underline))))
 394   "*Alist that says how to fontify certain phrases.
 395 Each item looks like this:
 396
 397   (\"_\\\\(\\\\w+\\\\)_\" 0 1 'underline)
 398
 399 The first element is a regular expression to be matched.  The second
 400 is a number that says what regular expression grouping used to find
 401 the entire emphasized word.  The third is a number that says what
 402 regexp grouping should be displayed and highlighted.  The fourth
 403 is the face used for highlighting."
 404   :type
 405   '(repeat
 406     (menu-choice
 407      :format "%[Customizing Style%]\n%v"
 408      :indent 2
 409      (group :tag "Default"
 410             :value ("" 0 0 default)
 411             :value-create
 412             (lambda (widget)
 413               (let ((value (widget-get
 414                             (cadr (widget-get (widget-get widget :parent)
 415                                               :args))
 416                             :value)))
 417                 (if (not (eq (nth 2 value) 'default))
 418                     (widget-put
 419                      widget
 420                      :value
 421                      (gnus-emphasis-custom-value-to-external value))))
 422               (widget-group-value-create widget))
 423             regexp
 424             (integer :format "Match group: %v")
 425             (integer :format "Emphasize group: %v")
 426             face)
 427      (group :tag "Simple"
 428             :value (("_" . "_") nil default)
 429             (cons :format "%v"
 430                   (regexp :format "Start regexp: %v")
 431                   (regexp :format "End regexp: %v"))
 432             (boolean :format "Show start and end patterns: %[%v%]\n"
 433                      :on " On " :off " Off ")
 434             face)))
 435   :get (lambda (symbol)
 436          (mapcar 'gnus-emphasis-custom-value-to-internal
 437                  (default-value symbol)))
 438   :set (lambda (symbol value)
 439          (set-default symbol (mapcar 'gnus-emphasis-custom-value-to-external
 440                                      value)))
 441   :group 'gnus-article-emphasis)
 442
 443 (defcustom gnus-emphasize-whitespace-regexp "^[ \t]+\\|[ \t]*\n"
 444   "A regexp to describe whitespace which should not be emphasized.
 445 Typical values are \"^[ \\t]+\\\\|[ \\t]*\\n\" and \"[ \\t]+\\\\|[ \\t]*\\n\".
 446 The former avoids underlining of leading and trailing whitespace,
 447 and the latter avoids underlining any whitespace at all."
 448   :version "21.1"
 449   :group 'gnus-article-emphasis
 450   :type 'regexp)
 451
 452 (defface gnus-emphasis-bold '((t (:bold t)))
 453   "Face used for displaying strong emphasized text (*word*)."
 454   :group 'gnus-article-emphasis)
 455
 456 (defface gnus-emphasis-italic '((t (:italic t)))
 457   "Face used for displaying italic emphasized text (/word/)."
 458   :group 'gnus-article-emphasis)
 459
 460 (defface gnus-emphasis-underline '((t (:underline t)))
 461   "Face used for displaying underlined emphasized text (_word_)."
 462   :group 'gnus-article-emphasis)
 463
 464 (defface gnus-emphasis-underline-bold '((t (:bold t :underline t)))
 465   "Face used for displaying underlined bold emphasized text (_*word*_)."
 466   :group 'gnus-article-emphasis)
 467
 468 (defface gnus-emphasis-underline-italic '((t (:italic t :underline t)))
 469   "Face used for displaying underlined italic emphasized text (_/word/_)."
 470   :group 'gnus-article-emphasis)
 471
 472 (defface gnus-emphasis-bold-italic '((t (:bold t :italic t)))
 473   "Face used for displaying bold italic emphasized text (/*word*/)."
 474   :group 'gnus-article-emphasis)
 475
 476 (defface gnus-emphasis-underline-bold-italic
 477   '((t (:bold t :italic t :underline t)))
 478   "Face used for displaying underlined bold italic emphasized text.
 479 Example: (_/*word*/_)."
 480   :group 'gnus-article-emphasis)
 481
 482 (defface gnus-emphasis-strikethru (if (featurep 'xemacs)
 483                                       '((t (:strikethru t)))
 484                                     '((t (:strike-through t))))
 485   "Face used for displaying strike-through text (-word-)."
 486   :group 'gnus-article-emphasis)
 487
 488 (defface gnus-emphasis-highlight-words
 489   '((t (:background "black" :foreground "yellow")))
 490   "Face used for displaying highlighted words."
 491   :group 'gnus-article-emphasis)
 492
 493 (defcustom gnus-article-time-format "%a, %d %b %Y %T %Z"
 494   "Format for display of Date headers in article bodies.
 495 See `format-time-string' for the possible values.
 496
 497 The variable can also be function, which should return a complete Date
 498 header.  The function is called with one argument, the time, which can
 499 be fed to `format-time-string'."
 500   :type '(choice string function)
 501   :link '(custom-manual "(gnus)Article Date")
 502   :group 'gnus-article-washing)
 503
 504 (defcustom gnus-save-all-headers t
 505   "*If non-nil, don't remove any headers before saving.
 506 This will be overridden by the `:headers' property that the symbol of
 507 the saver function, which is specified by `gnus-default-article-saver',
 508 might have."
 509   :group 'gnus-article-saving
 510   :type 'boolean)
 511
 512 (defcustom gnus-prompt-before-saving 'always
 513   "*This variable says how much prompting is to be done when saving articles.
 514 If it is nil, no prompting will be done, and the articles will be
 515 saved to the default files.  If this variable is `always', each and
 516 every article that is saved will be preceded by a prompt, even when
 517 saving large batches of articles.  If this variable is neither nil not
 518 `always', there the user will be prompted once for a file name for
 519 each invocation of the saving commands."
 520   :group 'gnus-article-saving
 521   :type '(choice (item always)
 522                  (item :tag "never" nil)
 523                  (sexp :tag "once" :format "%t\n" :value t)))
 524
 525 (defcustom gnus-saved-headers gnus-visible-headers
 526   "Headers to keep if `gnus-save-all-headers' is nil.
 527 If `gnus-save-all-headers' is non-nil, this variable will be ignored.
 528 If that variable is nil, however, all headers that match this regexp
 529 will be kept while the rest will be deleted before saving.  This and
 530 `gnus-save-all-headers' will be overridden by the `:headers' property
 531 that the symbol of the saver function, which is specified by
 532 `gnus-default-article-saver', might have."
 533   :group 'gnus-article-saving
 534   :type 'regexp)
 535
 536 ;; Note that "Rmail format" is mbox since Emacs 23, but Babyl before.
 537 (defcustom gnus-default-article-saver 'gnus-summary-save-in-rmail
 538   "A function to save articles in your favourite format.
 539 The function will be called by way of the `gnus-summary-save-article'
 540 command, and friends such as `gnus-summary-save-article-rmail'.
 541
 542 Gnus provides the following functions:
 543
 544 * gnus-summary-save-in-rmail (Rmail format)
 545 * gnus-summary-save-in-mail (Unix mail format)
 546 * gnus-summary-save-in-folder (MH folder)
 547 * gnus-summary-save-in-file (article format)
 548 * gnus-summary-save-body-in-file (article body)
 549 * gnus-summary-save-in-vm (use VM's folder format)
 550 * gnus-summary-write-to-file (article format -- overwrite)
 551 * gnus-summary-write-body-to-file (article body -- overwrite)
 552 * gnus-summary-save-in-pipe (article format)
 553
 554 The symbol of each function may have the following properties:
 555
 556 * :decode
 557 The value non-nil means save decoded articles.  This is meaningful
 558 only with `gnus-summary-save-in-file', `gnus-summary-save-body-in-file',
 559 `gnus-summary-write-to-file', `gnus-summary-write-body-to-file', and
 560 `gnus-summary-save-in-pipe'.
 561
 562 * :function
 563 The value specifies an alternative function which appends, not
 564 overwrites, articles to a file.  This implies that when saving many
 565 articles at a time, `gnus-prompt-before-saving' is bound to t and all
 566 articles are saved in a single file.  This is meaningful only with
 567 `gnus-summary-write-to-file' and `gnus-summary-write-body-to-file'.
 568
 569 * :headers
 570 The value specifies the symbol of a variable of which the value
 571 specifies headers to be saved.  If it is omitted,
 572 `gnus-save-all-headers' and `gnus-saved-headers' control what
 573 headers should be saved."
 574   :group 'gnus-article-saving
 575   :type '(radio (function-item gnus-summary-save-in-rmail)
 576                 (function-item gnus-summary-save-in-mail)
 577                 (function-item gnus-summary-save-in-folder)
 578                 (function-item gnus-summary-save-in-file)
 579                 (function-item gnus-summary-save-body-in-file)
 580                 (function-item gnus-summary-save-in-vm)
 581                 (function-item gnus-summary-write-to-file)
 582                 (function-item gnus-summary-write-body-to-file)
 583                 (function-item gnus-summary-save-in-pipe)
 584                 (function)))
 585
 586 (defcustom gnus-article-save-coding-system
 587   (or (and (mm-coding-system-p 'utf-8) 'utf-8)
 588       (and (mm-coding-system-p 'iso-2022-7bit) 'iso-2022-7bit)
 589       (and (mm-coding-system-p 'emacs-mule) 'emacs-mule)
 590       (and (mm-coding-system-p 'escape-quoted) 'escape-quoted))
 591   "Coding system used to save decoded articles to a file.
 592
 593 The recommended coding systems are `utf-8', `iso-2022-7bit' and so on,
 594 which can safely encode any characters in text.  This is used by the
 595 commands including:
 596
 597 * gnus-summary-save-article-file
 598 * gnus-summary-save-article-body-file
 599 * gnus-summary-write-article-file
 600 * gnus-summary-write-article-body-file
 601
 602 and the functions to which you may set `gnus-default-article-saver':
 603
 604 * gnus-summary-save-in-file
 605 * gnus-summary-save-body-in-file
 606 * gnus-summary-write-to-file
 607 * gnus-summary-write-body-to-file
 608
 609 Those commands and functions save just text displayed in the article
 610 buffer to a file if the value of this variable is non-nil.  Note that
 611 buttonized MIME parts will be lost in a saved file in that case.
 612 Otherwise, raw articles will be saved."
 613   :group 'gnus-article-saving
 614   :type `(choice
 615           :format "%{%t%}:\n %[Value Menu%] %v"
 616           (const :tag "Save raw articles" nil)
 617           ,@(delq nil
 618                   (mapcar
 619                    (lambda (arg) (if (mm-coding-system-p (nth 3 arg)) arg))
 620                    '((const :tag "UTF-8" utf-8)
 621                      (const :tag "iso-2022-7bit" iso-2022-7bit)
 622                      (const :tag "Emacs internal" emacs-mule)
 623                      (const :tag "escape-quoted" escape-quoted))))
 624           (symbol :tag "Coding system")))
 625
 626 (defcustom gnus-rmail-save-name 'gnus-plain-save-name
 627   "A function generating a file name to save articles in Rmail format.
 628 The function is called with NEWSGROUP, HEADERS, and optional LAST-FILE."
 629   :group 'gnus-article-saving
 630   :type 'function)
 631
 632 (defcustom gnus-mail-save-name 'gnus-plain-save-name
 633   "A function generating a file name to save articles in Unix mail format.
 634 The function is called with NEWSGROUP, HEADERS, and optional LAST-FILE."
 635   :group 'gnus-article-saving
 636   :type 'function)
 637
 638 (defcustom gnus-folder-save-name 'gnus-folder-save-name
 639   "A function generating a file name to save articles in MH folder.
 640 The function is called with NEWSGROUP, HEADERS, and optional LAST-FOLDER."
 641   :group 'gnus-article-saving
 642   :type 'function)
 643
 644 (defcustom gnus-file-save-name 'gnus-numeric-save-name
 645   "A function generating a file name to save articles in article format.
 646 The function is called with NEWSGROUP, HEADERS, and optional
 647 LAST-FILE."
 648   :group 'gnus-article-saving
 649   :type 'function)
 650
 651 (defcustom gnus-split-methods
 652   '((gnus-article-archive-name)
 653     (gnus-article-nndoc-name))
 654   "*Variable used to suggest where articles are to be saved.
 655 For instance, if you would like to save articles related to Gnus in
 656 the file \"gnus-stuff\", and articles related to VM in \"vm-stuff\",
 657 you could set this variable to something like:
 658
 659  '((\"^Subject:.*gnus\\|^Newsgroups:.*gnus\" \"gnus-stuff\")
 660    (\"^Subject:.*vm\\|^Xref:.*vm\" \"vm-stuff\"))
 661
 662 This variable is an alist where the key is the match and the
 663 value is a list of possible files to save in if the match is
 664 non-nil.
 665
 666 If the match is a string, it is used as a regexp match on the
 667 article.  If the match is a symbol, that symbol will be funcalled
 668 from the buffer of the article to be saved with the newsgroup as the
 669 parameter.  If it is a list, it will be evaled in the same buffer.
 670
 671 If this form or function returns a string, this string will be used as a
 672 possible file name; and if it returns a non-nil list, that list will be
 673 used as possible file names."
 674   :group 'gnus-article-saving
 675   :type '(repeat (choice (list :value (fun) function)
 676                          (cons :value ("" "") regexp (repeat string))
 677                          (sexp :value nil))))
 678
 679 (defcustom gnus-page-delimiter "^\^L"
 680   "*Regexp describing what to use as article page delimiters.
 681 The default value is \"^\^L\", which is a form linefeed at the
 682 beginning of a line."
 683   :type 'regexp
 684   :group 'gnus-article-various)
 685
 686 (defcustom gnus-article-mode-line-format "Gnus: %g %S%m"
 687   "*The format specification for the article mode line.
 688 See `gnus-summary-mode-line-format' for a closer description.
 689
 690 The following additional specs are available:
 691
 692 %w  The article washing status.
 693 %m  The number of MIME parts in the article."
 694   :version "24.1"
 695   :type 'string
 696   :group 'gnus-article-various)
 697
 698 (defcustom gnus-article-mode-hook nil
 699   "*A hook for Gnus article mode."
 700   :type 'hook
 701   :group 'gnus-article-various)
 702
 703 (when (featurep 'xemacs)
 704   ;; Extracted from gnus-xmas-define in order to preserve user settings
 705   (when (fboundp 'turn-off-scroll-in-place)
 706     (add-hook 'gnus-article-mode-hook 'turn-off-scroll-in-place))
 707   ;; Extracted from gnus-xmas-redefine in order to preserve user settings
 708   (add-hook 'gnus-article-mode-hook 'gnus-xmas-article-menu-add))
 709
 710 (defcustom gnus-article-menu-hook nil
 711   "*Hook run after the creation of the article mode menu."
 712   :type 'hook
 713   :group 'gnus-article-various)
 714
 715 (defcustom gnus-article-prepare-hook nil
 716   "*A hook called after an article has been prepared in the article buffer."
 717   :type 'hook
 718   :group 'gnus-article-various)
 719
 720 (defcustom gnus-copy-article-ignored-headers nil
 721   "List of headers to be removed when copying an article.
 722 Each element is a regular expression."
 723   :version "23.1" ;; No Gnus
 724   :type '(repeat regexp)
 725   :group 'gnus-article-various)
 726
 727 (make-obsolete-variable 'gnus-article-hide-pgp-hook nil
 728                         "Gnus 5.10 (Emacs 22.1)")
 729
 730 (defface gnus-button
 731   '((t (:weight bold)))
 732   "Face used for highlighting a button in the article buffer."
 733   :group 'gnus-article-buttons)
 734
 735 (defcustom gnus-article-button-face 'gnus-button
 736   "Face used for highlighting buttons in the article buffer.
 737
 738 An article button is a piece of text that you can activate by pressing
 739 `RET' or `mouse-2' above it."
 740   :type 'face
 741   :group 'gnus-article-buttons)
 742
 743 (defcustom gnus-article-mouse-face 'highlight
 744   "Face used for mouse highlighting in the article buffer.
 745
 746 Article buttons will be displayed in this face when the cursor is
 747 above them."
 748   :type 'face
 749   :group 'gnus-article-buttons)
 750
 751 (defcustom gnus-signature-face 'gnus-signature
 752   "Face used for highlighting a signature in the article buffer.
 753 Obsolete; use the face `gnus-signature' for customizations instead."
 754   :type 'face
 755   :group 'gnus-article-highlight
 756   :group 'gnus-article-signature)
 757
 758 (defface gnus-signature
 759   '((t
 760      (:italic t)))
 761   "Face used for highlighting a signature in the article buffer."
 762   :group 'gnus-article-highlight
 763   :group 'gnus-article-signature)
 764 ;; backward-compatibility alias
 765 (put 'gnus-signature-face 'face-alias 'gnus-signature)
 766 (put 'gnus-signature-face 'obsolete-face "22.1")
 767
 768 (defface gnus-header-from
 769   '((((class color)
 770       (background dark))
 771      (:foreground "PaleGreen1"))
 772     (((class color)
 773       (background light))
 774      (:foreground "red3"))
 775     (t
 776      (:italic t)))
 777   "Face used for displaying from headers."
 778   :group 'gnus-article-headers
 779   :group 'gnus-article-highlight)
 780 ;; backward-compatibility alias
 781 (put 'gnus-header-from-face 'face-alias 'gnus-header-from)
 782 (put 'gnus-header-from-face 'obsolete-face "22.1")
 783
 784 (defface gnus-header-subject
 785   '((((class color)
 786       (background dark))
 787      (:foreground "SeaGreen1"))
 788     (((class color)
 789       (background light))
 790      (:foreground "red4"))
 791     (t
 792      (:bold t :italic t)))
 793   "Face used for displaying subject headers."
 794   :group 'gnus-article-headers
 795   :group 'gnus-article-highlight)
 796 ;; backward-compatibility alias
 797 (put 'gnus-header-subject-face 'face-alias 'gnus-header-subject)
 798 (put 'gnus-header-subject-face 'obsolete-face "22.1")
 799
 800 (defface gnus-header-newsgroups
 801   '((((class color)
 802       (background dark))
 803      (:foreground "yellow" :italic t))
 804     (((class color)
 805       (background light))
 806      (:foreground "MidnightBlue" :italic t))
 807     (t
 808      (:italic t)))
 809   "Face used for displaying newsgroups headers.
 810 In the default setup this face is only used for crossposted
 811 articles."
 812   :group 'gnus-article-headers
 813   :group 'gnus-article-highlight)
 814 ;; backward-compatibility alias
 815 (put 'gnus-header-newsgroups-face 'face-alias 'gnus-header-newsgroups)
 816 (put 'gnus-header-newsgroups-face 'obsolete-face "22.1")
 817
 818 (defface gnus-header-name
 819   '((((class color)
 820       (background dark))
 821      (:foreground "SpringGreen2"))
 822     (((class color)
 823       (background light))
 824      (:foreground "maroon"))
 825     (t
 826      (:bold t)))
 827   "Face used for displaying header names."
 828   :group 'gnus-article-headers
 829   :group 'gnus-article-highlight)
 830 ;; backward-compatibility alias
 831 (put 'gnus-header-name-face 'face-alias 'gnus-header-name)
 832 (put 'gnus-header-name-face 'obsolete-face "22.1")
 833
 834 (defface gnus-header-content
 835   '((((class color)
 836       (background dark))
 837      (:foreground "SpringGreen1" :italic t))
 838     (((class color)
 839       (background light))
 840      (:foreground "indianred4" :italic t))
 841     (t
 842      (:italic t)))  "Face used for displaying header content."
 843   :group 'gnus-article-headers
 844   :group 'gnus-article-highlight)
 845 ;; backward-compatibility alias
 846 (put 'gnus-header-content-face 'face-alias 'gnus-header-content)
 847 (put 'gnus-header-content-face 'obsolete-face "22.1")
 848
 849 (defcustom gnus-header-face-alist
 850   '(("From" nil gnus-header-from)
 851     ("Subject" nil gnus-header-subject)
 852     ("Newsgroups:.*," nil gnus-header-newsgroups)
 853     ("" gnus-header-name gnus-header-content))
 854   "*Controls highlighting of article headers.
 855
 856 An alist of the form (HEADER NAME CONTENT).
 857
 858 HEADER is a regular expression which should match the name of a
 859 header and NAME and CONTENT are either face names or nil.
 860
 861 The name of each header field will be displayed using the face
 862 specified by the first element in the list where HEADER matches
 863 the header name and NAME is non-nil.  Similarly, the content will
 864 be displayed by the first non-nil matching CONTENT face."
 865   :group 'gnus-article-headers
 866   :group 'gnus-article-highlight
 867   :type '(repeat (list (regexp :tag "Header")
 868                        (choice :tag "Name"
 869                                (item :tag "skip" nil)
 870                                (face :value default))
 871                        (choice :tag "Content"
 872                                (item :tag "skip" nil)
 873                                (face :value default)))))
 874
 875 (defcustom gnus-face-properties-alist (if (featurep 'xemacs)
 876                                           '((xface . (:face gnus-x-face)))
 877                                         '((pbm . (:face gnus-x-face))
 878                                           (png . nil)))
 879   "Alist of image types and properties applied to Face and X-Face images.
 880 Here are examples:
 881
 882 ;; Specify the altitude of Face images in the From header.
 883 \(setq gnus-face-properties-alist
 884       '((pbm . (:face gnus-x-face :ascent 80))
 885         (png . (:ascent 80))))
 886
 887 ;; Show Face images as pressed buttons.
 888 \(setq gnus-face-properties-alist
 889       '((pbm . (:face gnus-x-face :relief -2))
 890         (png . (:relief -2))))
 891
 892 See the manual for the valid properties for various image types.
 893 Currently, `pbm' is used for X-Face images and `png' is used for Face
 894 images in Emacs.  Only the `:face' property is effective on the `xface'
 895 image type in XEmacs if it is built with the libcompface library."
 896   :version "23.1" ;; No Gnus
 897   :group 'gnus-article-headers
 898   :type '(repeat (cons :format "%v" (symbol :tag "Image type") plist)))
 899
 900 (defcustom gnus-article-decode-hook
 901   '(article-decode-charset article-decode-encoded-words
 902                            article-decode-group-name article-decode-idna-rhs)
 903   "*Hook run to decode charsets in articles."
 904   :group 'gnus-article-headers
 905   :type 'hook)
 906
 907 (defcustom gnus-display-mime-function 'gnus-display-mime
 908   "Function to display MIME articles."
 909   :group 'gnus-article-mime
 910   :type 'function)
 911
 912 (defvar gnus-decode-header-function 'mail-decode-encoded-word-region
 913   "Function used to decode headers.")
 914
 915 (defvar gnus-decode-address-function 'mail-decode-encoded-address-region
 916   "Function used to decode addresses.")
 917
 918 (defvar gnus-article-dumbquotes-map
 919   '((?\200 "EUR")
 920     (?\202 ",")
 921     (?\203 "f")
 922     (?\204 ",,")
 923     (?\205 "...")
 924     (?\213 "<")
 925     (?\214 "OE")
 926     (?\221 "`")
 927     (?\222 "'")
 928     (?\223 "``")
 929     (?\224 "\"")
 930     (?\225 "*")
 931     (?\226 "-")
 932     (?\227 "--")
 933     (?\230 "~")
 934     (?\231 "(TM)")
 935     (?\233 ">")
 936     (?\234 "oe")
 937     (?\264 "'"))
 938   "Table for MS-to-Latin1 translation.")
 939
 940 (defcustom gnus-ignored-mime-types nil
 941   "List of MIME types that should be ignored by Gnus."
 942   :version "21.1"
 943   :group 'gnus-article-mime
 944   :type '(repeat regexp))
 945
 946 (defcustom gnus-unbuttonized-mime-types '(".*/.*")
 947   "List of MIME types that should not be given buttons when rendered inline.
 948 See also `gnus-buttonized-mime-types' which may override this variable.
 949 This variable is only used when `gnus-inhibit-mime-unbuttonizing' is nil."
 950   :version "21.1"
 951   :group 'gnus-article-mime
 952   :type '(repeat regexp))
 953
 954 (defcustom gnus-buttonized-mime-types nil
 955   "List of MIME types that should be given buttons when rendered inline.
 956 If set, this variable overrides `gnus-unbuttonized-mime-types'.
 957 To see e.g. security buttons you could set this to
 958 `(\"multipart/signed\")'.  You could also add \"multipart/alternative\" to
 959 this list to display radio buttons that allow you to choose one of two
 960 media types those mails include.  See also `mm-discouraged-alternatives'.
 961 This variable is only used when `gnus-inhibit-mime-unbuttonizing' is nil."
 962   :version "22.1"
 963   :group 'gnus-article-mime
 964   :type '(repeat regexp))
 965
 966 (defcustom gnus-inhibit-mime-unbuttonizing nil
 967   "If non-nil, all MIME parts get buttons.
 968 When nil (the default value), then some MIME parts do not get buttons,
 969 as described by the variables `gnus-buttonized-mime-types' and
 970 `gnus-unbuttonized-mime-types'."
 971   :version "22.1"
 972   :group 'gnus-article-mime
 973   :type 'boolean)
 974
 975 (defcustom gnus-body-boundary-delimiter "_"
 976   "String used to delimit header and body.
 977 This variable is used by `gnus-article-treat-body-boundary' which can
 978 be controlled by `gnus-treat-body-boundary'."
 979   :version "22.1"
 980   :group 'gnus-article-various
 981   :type '(choice (item :tag "None" :value nil)
 982                  string))
 983
 984 (defcustom gnus-picon-databases '("/usr/lib/picon" "/usr/local/faces"
 985                                   "/usr/share/picons")
 986   "Defines the location of the faces database.
 987 For information on obtaining this database of pretty pictures, please
 988 see http://www.cs.indiana.edu/picons/ftp/index.html"
 989   :version "22.1"
 990   :type '(repeat directory)
 991   :link '(url-link :tag "download"
 992                    "http://www.cs.indiana.edu/picons/ftp/index.html")
 993   :link '(custom-manual "(gnus)Picons")
 994   :group 'gnus-picon)
 995
 996 (defun gnus-picons-installed-p ()
 997   "Say whether picons are installed on your machine."
 998   (let ((installed nil))
 999     (dolist (database gnus-picon-databases)
1000       (when (file-exists-p database)
1001         (setq installed t)))
1002     installed))
1003
1004 (defcustom gnus-article-mime-part-function nil
1005   "Function called with a MIME handle as the argument.
1006 This is meant for people who want to do something automatic based
1007 on parts -- for instance, adding Vcard info to a database."
1008   :group 'gnus-article-mime
1009   :type '(choice (const nil)
1010                  function))
1011
1012 (defcustom gnus-mime-multipart-functions nil
1013   "An alist of MIME types to functions to display them."
1014   :version "21.1"
1015   :group 'gnus-article-mime
1016   :type '(repeat (cons :format "%v" (string :tag "MIME type") function)))
1017
1018 (defcustom gnus-article-date-headers '(combined-lapsed)
1019   "A list of Date header formats to display.
1020 Valid formats are `ut' (universal time), `local' (local time
1021 zone), `english' (readable English), `lapsed' (elapsed time),
1022 `combined-lapsed' (both the original date and the elapsed time),
1023 `original' (the original date header), `iso8601' (ISO8601
1024 format), and `user-defined' (a user-defined format defined by the
1025 `gnus-article-time-format' variable).
1026
1027 You have as many date headers as you want in the article buffer.
1028 Some of these headers are updated automatically.  See
1029 `gnus-article-update-date-headers' for details."
1030   :version "24.1"
1031   :group 'gnus-article-headers
1032   :type '(repeat
1033           (item :tag "Universal time (UT)" :value 'ut)
1034           (item :tag "Local time zone" :value 'local)
1035           (item :tag "Readable English" :value 'english)
1036           (item :tag "Elapsed time" :value 'lapsed)
1037           (item :tag "Original and elapsed time" :value 'combined-lapsed)
1038           (item :tag "Original date header" :value 'original)
1039           (item :tag "ISO8601 format" :value 'iso8601)
1040           (item :tag "User-defined" :value 'user-defined)))
1041
1042 (defcustom gnus-article-update-date-headers 1
1043   "A number that says how often to update the date header (in seconds).
1044 If nil, don't update it at all."
1045   :version "24.1"
1046   :group 'gnus-article-headers
1047   :type '(choice
1048           (item :tag "Don't update" :value nil)
1049           integer))
1050
1051 (defcustom gnus-article-mime-match-handle-function 'undisplayed-alternative
1052   "Function called with a MIME handle as the argument.
1053 This is meant for people who want to view first matched part.
1054 For `undisplayed-alternative' (default), the first undisplayed
1055 part or alternative part is used.  For `undisplayed', the first
1056 undisplayed part is used.  For a function, the first part which
1057 the function return t is used.  For nil, the first part is
1058 used."
1059   :version "21.1"
1060   :group 'gnus-article-mime
1061   :type '(choice
1062           (item :tag "first" :value nil)
1063           (item :tag "undisplayed" :value undisplayed)
1064           (item :tag "undisplayed or alternative"
1065                 :value undisplayed-alternative)
1066           (function)))
1067
1068 (defcustom gnus-mime-action-alist
1069   '(("save to file" . gnus-mime-save-part)
1070     ("save and strip" . gnus-mime-save-part-and-strip)
1071     ("replace with file" . gnus-mime-replace-part)
1072     ("delete part" . gnus-mime-delete-part)
1073     ("display as text" . gnus-mime-inline-part)
1074     ("view the part" . gnus-mime-view-part)
1075     ("pipe to command" . gnus-mime-pipe-part)
1076     ("toggle display" . gnus-article-press-button)
1077     ("toggle display" . gnus-article-view-part-as-charset)
1078     ("view as type" . gnus-mime-view-part-as-type)
1079     ("view internally" . gnus-mime-view-part-internally)
1080     ("view externally" . gnus-mime-view-part-externally))
1081   "An alist of actions that run on the MIME attachment."
1082   :group 'gnus-article-mime
1083   :type '(repeat (cons (string :tag "name")
1084                        (function))))
1085
1086 (defcustom gnus-auto-select-part 1
1087   "Advance to next MIME part when deleting or stripping parts.
1088
1089 When 0, point will be placed on the same part as before.  When
1090 positive (negative), move point forward (backwards) this many
1091 parts.  When nil, redisplay article."
1092   :version "23.1" ;; No Gnus
1093   :group 'gnus-article-mime
1094   :type '(choice (const nil :tag "Redisplay article.")
1095                  (const 1 :tag "Next part.")
1096                  (const 0 :tag "Current part.")
1097                  integer))
1098
1099 ;;;
1100 ;;; The treatment variables
1101 ;;;
1102
1103 (defvar gnus-part-display-hook nil
1104   "Hook called on parts that are to receive treatment.")
1105
1106 (defvar gnus-article-treat-custom
1107   '(choice (const :tag "Off" nil)
1108            (const :tag "On" t)
1109            (const :tag "Header" head)
1110            (const :tag "First" first)
1111            (const :tag "Last" last)
1112            (integer :tag "Less")
1113            (repeat :tag "Groups" regexp)
1114            (sexp :tag "Predicate")))
1115
1116 (defvar gnus-article-treat-head-custom
1117   '(choice (const :tag "Off" nil)
1118            (const :tag "Header" head)))
1119
1120 (defvar gnus-article-treat-types '("text/plain" "text/x-verbatim"
1121                                    "text/x-patch")
1122   "Parts to treat.")
1123
1124 (defvar gnus-inhibit-treatment nil
1125   "Whether to inhibit treatment.")
1126
1127 (defcustom gnus-treat-highlight-signature '(or t (typep "text/x-vcard"))
1128   "Highlight the signature.
1129 Valid values are nil, t, `head', `first', `last', an integer or a
1130 predicate.  See Info node `(gnus)Customizing Articles'."
1131   :group 'gnus-article-treat
1132   :link '(custom-manual "(gnus)Customizing Articles")
1133   :type gnus-article-treat-custom)
1134 (put 'gnus-treat-highlight-signature 'highlight t)
1135
1136 (defcustom gnus-treat-buttonize 100000
1137   "Add buttons.
1138 Valid values are nil, t, `head', `first', `last', an integer or a
1139 predicate.  See Info node `(gnus)Customizing Articles'."
1140   :group 'gnus-article-treat
1141   :link '(custom-manual "(gnus)Customizing Articles")
1142   :type gnus-article-treat-custom)
1143 (put 'gnus-treat-buttonize 'highlight t)
1144
1145 (defcustom gnus-treat-buttonize-head 'head
1146   "Add buttons to the head.
1147 Valid values are nil, t, `head', `first', `last', an integer or a
1148 predicate.  See Info node `(gnus)Customizing Articles'."
1149   :group 'gnus-article-treat
1150   :link '(custom-manual "(gnus)Customizing Articles")
1151   :type gnus-article-treat-head-custom)
1152 (put 'gnus-treat-buttonize-head 'highlight t)
1153
1154 (defcustom gnus-treat-date 'head
1155   "Display dates according to the `gnus-article-date-headers' variable.
1156 Valid values are nil, t, `head', `first', `last', an integer or a
1157 predicate.  See Info node `(gnus)Customizing Articles'."
1158   :version "24.1"
1159   :group 'gnus-article-treat
1160   :link '(custom-manual "(gnus)Customizing Articles")
1161   :type gnus-article-treat-head-custom)
1162
1163 (defcustom gnus-treat-emphasize 50000
1164   "Emphasize text.
1165 Valid values are nil, t, `head', `first', `last', an integer or a
1166 predicate.  See Info node `(gnus)Customizing Articles'."
1167   :group 'gnus-article-treat
1168   :link '(custom-manual "(gnus)Customizing Articles")
1169   :type gnus-article-treat-custom)
1170 (put 'gnus-treat-emphasize 'highlight t)
1171
1172 (defcustom gnus-treat-strip-cr nil
1173   "Remove carriage returns.
1174 Valid values are nil, t, `head', `first', `last', an integer or a
1175 predicate.  See Info node `(gnus)Customizing Articles'."
1176   :version "22.1"
1177   :group 'gnus-article-treat
1178   :link '(custom-manual "(gnus)Customizing Articles")
1179   :type gnus-article-treat-custom)
1180
1181 (defcustom gnus-treat-unsplit-urls nil
1182   "Remove newlines from within URLs.
1183 Valid values are nil, t, `head', `first', `last', an integer or a
1184 predicate.  See Info node `(gnus)Customizing Articles'."
1185   :version "22.1"
1186   :group 'gnus-article-treat
1187   :link '(custom-manual "(gnus)Customizing Articles")
1188   :type gnus-article-treat-custom)
1189
1190 (defcustom gnus-treat-leading-whitespace nil
1191   "Remove leading whitespace in headers.
1192 Valid values are nil, t, `head', `first', `last', an integer or a
1193 predicate.  See Info node `(gnus)Customizing Articles'."
1194   :version "22.1"
1195   :group 'gnus-article-treat
1196   :link '(custom-manual "(gnus)Customizing Articles")
1197   :type gnus-article-treat-custom)
1198
1199 (defcustom gnus-treat-hide-headers 'head
1200   "Hide headers.
1201 Valid values are nil, t, `head', `first', `last', an integer or a
1202 predicate.  See Info node `(gnus)Customizing Articles'."
1203   :group 'gnus-article-treat
1204   :link '(custom-manual "(gnus)Customizing Articles")
1205   :type gnus-article-treat-head-custom)
1206
1207 (defcustom gnus-treat-hide-boring-headers nil
1208   "Hide boring headers.
1209 Valid values are nil, t, `head', `first', `last', an integer or a
1210 predicate.  See Info node `(gnus)Customizing Articles'."
1211   :group 'gnus-article-treat
1212   :link '(custom-manual "(gnus)Customizing Articles")
1213   :type gnus-article-treat-head-custom)
1214
1215 (defcustom gnus-treat-hide-signature nil
1216   "Hide the signature.
1217 Valid values are nil, t, `head', `first', `last', an integer or a
1218 predicate.  See Info node `(gnus)Customizing Articles'."
1219   :group 'gnus-article-treat
1220   :link '(custom-manual "(gnus)Customizing Articles")
1221   :type gnus-article-treat-custom)
1222
1223 (defcustom gnus-treat-fill-article nil
1224   "Fill the article.
1225 Valid values are nil, t, `head', `first', `last', an integer or a
1226 predicate.  See Info node `(gnus)Customizing Articles'."
1227   :group 'gnus-article-treat
1228   :link '(custom-manual "(gnus)Customizing Articles")
1229   :type gnus-article-treat-custom)
1230
1231 (defcustom gnus-treat-hide-citation nil
1232   "Hide cited text.
1233 Valid values are nil, t, `head', `first', `last', an integer or a
1234 predicate.  See Info node `(gnus)Customizing Articles'."
1235   :group 'gnus-article-treat
1236   :link '(custom-manual "(gnus)Customizing Articles")
1237   :type gnus-article-treat-custom)
1238
1239 (defcustom gnus-treat-hide-citation-maybe nil
1240   "Hide cited text.
1241 Valid values are nil, t, `head', `first', `last', an integer or a
1242 predicate.  See Info node `(gnus)Customizing Articles'."
1243   :group 'gnus-article-treat
1244   :link '(custom-manual "(gnus)Customizing Articles")
1245   :type gnus-article-treat-custom)
1246
1247 (defcustom gnus-treat-strip-list-identifiers 'head
1248   "Strip list identifiers from `gnus-list-identifiers`.
1249 Valid values are nil, t, `head', `first', `last', an integer or a
1250 predicate.  See Info node `(gnus)Customizing Articles'."
1251   :version "21.1"
1252   :group 'gnus-article-treat
1253   :link '(custom-manual "(gnus)Customizing Articles")
1254   :type gnus-article-treat-custom)
1255
1256 (gnus-define-group-parameter
1257  list-identifier
1258  :variable-document
1259  "Alist of regexps and correspondent identifiers."
1260  :variable-group gnus-article-washing
1261  :parameter-type
1262  '(choice :tag "Identifier"
1263           :value nil
1264           (symbol :tag "Item in `gnus-list-identifiers'" none)
1265           regexp
1266           (const :tag "None" nil))
1267  :parameter-document
1268  "If non-nil, specify how to remove `identifiers' from articles' subject.
1269
1270 Any symbol is used to look up a regular expression to match the
1271 banner in `gnus-list-identifiers'.  A string is used as a regular
1272 expression to match the identifier directly.")
1273
1274 (make-obsolete-variable 'gnus-treat-strip-pgp nil
1275                         "Gnus 5.10 (Emacs 22.1)")
1276
1277 (defcustom gnus-treat-strip-pem nil
1278   "Strip PEM signatures.
1279 Valid values are nil, t, `head', `first', `last', an integer or a
1280 predicate.  See Info node `(gnus)Customizing Articles'."
1281   :group 'gnus-article-treat
1282   :link '(custom-manual "(gnus)Customizing Articles")
1283   :type gnus-article-treat-custom)
1284
1285 (defcustom gnus-treat-strip-banner t
1286   "Strip banners from articles.
1287 The banner to be stripped is specified in the `banner' group parameter.
1288 Valid values are nil, t, `head', `first', `last', an integer or a
1289 predicate.  See Info node `(gnus)Customizing Articles'."
1290   :group 'gnus-article-treat
1291   :link '(custom-manual "(gnus)Customizing Articles")
1292   :type gnus-article-treat-custom)
1293
1294 (defcustom gnus-treat-highlight-headers 'head
1295   "Highlight the headers.
1296 Valid values are nil, t, `head', `first', `last', an integer or a
1297 predicate.  See Info node `(gnus)Customizing Articles'."
1298   :group 'gnus-article-treat
1299   :link '(custom-manual "(gnus)Customizing Articles")
1300   :type gnus-article-treat-head-custom)
1301 (put 'gnus-treat-highlight-headers 'highlight t)
1302
1303 (defcustom gnus-treat-highlight-citation t
1304   "Highlight cited text.
1305 Valid values are nil, t, `head', `first', `last', an integer or a
1306 predicate.  See Info node `(gnus)Customizing Articles'."
1307   :group 'gnus-article-treat
1308   :link '(custom-manual "(gnus)Customizing Articles")
1309   :type gnus-article-treat-custom)
1310 (put 'gnus-treat-highlight-citation 'highlight t)
1311
1312 (defcustom gnus-treat-strip-headers-in-body t
1313   "Strip the X-No-Archive header line from the beginning of the body.
1314 Valid values are nil, t, `head', `first', `last', an integer or a
1315 predicate.  See Info node `(gnus)Customizing Articles'."
1316   :version "21.1"
1317   :group 'gnus-article-treat
1318   :link '(custom-manual "(gnus)Customizing Articles")
1319   :type gnus-article-treat-custom)
1320
1321 (defcustom gnus-treat-strip-trailing-blank-lines nil
1322   "Strip trailing blank lines.
1323 Valid values are nil, t, `head', `first', `last', an integer or a
1324 predicate.  See Info node `(gnus)Customizing Articles'.
1325
1326 When set to t, it also strips trailing blanks in all MIME parts.
1327 Consider to use `last' instead."
1328   :group 'gnus-article-treat
1329   :link '(custom-manual "(gnus)Customizing Articles")
1330   :type gnus-article-treat-custom)
1331
1332 (defcustom gnus-treat-strip-leading-blank-lines nil
1333   "Strip leading blank lines.
1334 Valid values are nil, t, `head', `first', `last', an integer or a
1335 predicate.  See Info node `(gnus)Customizing Articles'.
1336
1337 When set to t, it also strips trailing blanks in all MIME parts."
1338   :group 'gnus-article-treat
1339   :link '(custom-manual "(gnus)Customizing Articles")
1340   :type gnus-article-treat-custom)
1341
1342 (defcustom gnus-treat-strip-multiple-blank-lines nil
1343   "Strip multiple blank lines.
1344 Valid values are nil, t, `head', `first', `last', an integer or a
1345 predicate.  See Info node `(gnus)Customizing Articles'."
1346   :group 'gnus-article-treat
1347   :link '(custom-manual "(gnus)Customizing Articles")
1348   :type gnus-article-treat-custom)
1349
1350 (defcustom gnus-treat-unfold-headers 'head
1351   "Unfold folded header lines.
1352 Valid values are nil, t, `head', `first', `last', an integer or a
1353 predicate.  See Info node `(gnus)Customizing Articles'."
1354   :version "22.1"
1355   :group 'gnus-article-treat
1356   :link '(custom-manual "(gnus)Customizing Articles")
1357   :type gnus-article-treat-custom)
1358
1359 (defcustom gnus-article-unfold-long-headers nil
1360   "If non-nil, allow unfolding headers even if the header is long.
1361 If it is a regexp, only long headers matching this regexp are unfolded.
1362 If it is t, all long headers are unfolded.
1363
1364 This variable has no effect if `gnus-treat-unfold-headers' is nil."
1365   :version "23.1" ;; No Gnus
1366   :group 'gnus-article-treat
1367   :type '(choice (const nil)
1368                  (const :tag "all" t)
1369                  (regexp)))
1370
1371 (defcustom gnus-treat-fold-headers nil
1372   "Fold headers.
1373 Valid values are nil, t, `head', `first', `last', an integer or a
1374 predicate.  See Info node `(gnus)Customizing Articles'."
1375   :version "22.1"
1376   :group 'gnus-article-treat
1377   :link '(custom-manual "(gnus)Customizing Articles")
1378   :type gnus-article-treat-custom)
1379
1380 (defcustom gnus-treat-fold-newsgroups 'head
1381   "Fold the Newsgroups and Followup-To headers.
1382 Valid values are nil, t, `head', `first', `last', an integer or a
1383 predicate.  See Info node `(gnus)Customizing Articles'."
1384   :version "22.1"
1385   :group 'gnus-article-treat
1386   :link '(custom-manual "(gnus)Customizing Articles")
1387   :type gnus-article-treat-custom)
1388
1389 (defcustom gnus-treat-overstrike t
1390   "Treat overstrike highlighting.
1391 Valid values are nil, t, `head', `first', `last', an integer or a
1392 predicate.  See Info node `(gnus)Customizing Articles'."
1393   :group 'gnus-article-treat
1394   :link '(custom-manual "(gnus)Customizing Articles")
1395   :type gnus-article-treat-custom)
1396 (put 'gnus-treat-overstrike 'highlight t)
1397
1398 (defcustom gnus-treat-ansi-sequences (if (locate-library "ansi-color") t)
1399   "Treat ANSI SGR control sequences.
1400 Valid values are nil, t, `head', `first', `last', an integer or a
1401 predicate.  See Info node `(gnus)Customizing Articles'."
1402   :group 'gnus-article-treat
1403   :link '(custom-manual "(gnus)Customizing Articles")
1404   :type gnus-article-treat-custom)
1405
1406 (make-obsolete-variable 'gnus-treat-display-xface
1407                         'gnus-treat-display-x-face "Emacs 22.1")
1408
1409 (defcustom gnus-treat-display-x-face
1410   (and (not noninteractive)
1411        (gnus-image-type-available-p 'xbm)
1412        (if (featurep 'xemacs)
1413            (featurep 'xface)
1414          (condition-case nil
1415              (and (string-match "^0x" (shell-command-to-string "uncompface"))
1416                   (executable-find "icontopbm"))
1417            ;; shell-command-to-string may signal an error, e.g. if
1418            ;; shell-file-name is not found.
1419            (error nil)))
1420        'head)
1421   "Display X-Face headers.
1422 Valid values are nil and `head'.
1423 See Info node `(gnus)Customizing Articles' and Info node
1424 `(gnus)X-Face' for details."
1425   :group 'gnus-article-treat
1426   :version "21.1"
1427   :link '(custom-manual "(gnus)Customizing Articles")
1428   :link '(custom-manual "(gnus)X-Face")
1429   :type gnus-article-treat-head-custom
1430   :set (lambda (symbol value)
1431          (set-default
1432           symbol
1433           (cond ((or (boundp symbol) (get symbol 'saved-value))
1434                  value)
1435                 ((boundp 'gnus-treat-display-xface)
1436                  (message "\
1437 ** gnus-treat-display-xface is an obsolete variable;\
1438  use gnus-treat-display-x-face instead")
1439                  (default-value 'gnus-treat-display-xface))
1440                 ((get 'gnus-treat-display-xface 'saved-value)
1441                  (message "\
1442 ** gnus-treat-display-xface is an obsolete variable;\
1443  use gnus-treat-display-x-face instead")
1444                  (eval (car (get 'gnus-treat-display-xface 'saved-value))))
1445                 (t
1446                  value)))))
1447 (put 'gnus-treat-display-x-face 'highlight t)
1448
1449 (defcustom gnus-treat-display-face
1450   (and (not noninteractive)
1451        (gnus-image-type-available-p 'png)
1452        'head)
1453   "Display Face headers.
1454 Valid values are nil, t, `head', `first', `last', an integer or a
1455 predicate.  See Info node `(gnus)Customizing Articles' and Info
1456 node `(gnus)Face' for details."
1457   :group 'gnus-article-treat
1458   :version "22.1"
1459   :link '(custom-manual "(gnus)Customizing Articles")
1460   :link '(custom-manual "(gnus)X-Face")
1461   :type gnus-article-treat-head-custom)
1462 (put 'gnus-treat-display-face 'highlight t)
1463
1464 (defcustom gnus-treat-display-smileys (gnus-image-type-available-p 'xpm)
1465   "Display smileys.
1466 Valid values are nil, t, `head', `first', `last', an integer or a
1467 predicate.  See Info node `(gnus)Customizing Articles' and Info
1468 node `(gnus)Smileys' for details."
1469   :group 'gnus-article-treat
1470   :version "21.1"
1471   :link '(custom-manual "(gnus)Customizing Articles")
1472   :link '(custom-manual "(gnus)Smileys")
1473   :type gnus-article-treat-custom)
1474 (put 'gnus-treat-display-smileys 'highlight t)
1475
1476 (defcustom gnus-treat-from-picon
1477   (if (and (gnus-image-type-available-p 'xpm)
1478            (gnus-picons-installed-p))
1479       'head nil)
1480   "Display picons in the From header.
1481 Valid values are nil, t, `head', `first', `last', an integer or a
1482 predicate.  See Info node `(gnus)Customizing Articles' and Info
1483 node `(gnus)Picons' for details."
1484   :version "22.1"
1485   :group 'gnus-article-treat
1486   :group 'gnus-picon
1487   :link '(custom-manual "(gnus)Customizing Articles")
1488   :link '(custom-manual "(gnus)Picons")
1489   :type gnus-article-treat-head-custom)
1490 (put 'gnus-treat-from-picon 'highlight t)
1491
1492 (defcustom gnus-treat-mail-picon
1493   (if (and (gnus-image-type-available-p 'xpm)
1494            (gnus-picons-installed-p))
1495       'head nil)
1496   "Display picons in To and Cc headers.
1497 Valid values are nil, t, `head', `first', `last', an integer or a
1498 predicate.  See Info node `(gnus)Customizing Articles' and Info
1499 node `(gnus)Picons' for details."
1500   :version "22.1"
1501   :group 'gnus-article-treat
1502   :group 'gnus-picon
1503   :link '(custom-manual "(gnus)Customizing Articles")
1504   :link '(custom-manual "(gnus)Picons")
1505   :type gnus-article-treat-head-custom)
1506 (put 'gnus-treat-mail-picon 'highlight t)
1507
1508 (defcustom gnus-treat-newsgroups-picon
1509   (if (and (gnus-image-type-available-p 'xpm)
1510            (gnus-picons-installed-p))
1511       'head nil)
1512   "Display picons in the Newsgroups and Followup-To headers.
1513 Valid values are nil, t, `head', `first', `last', an integer or a
1514 predicate.  See Info node `(gnus)Customizing Articles' and Info
1515 node `(gnus)Picons' for details."
1516   :version "22.1"
1517   :group 'gnus-article-treat
1518   :group 'gnus-picon
1519   :link '(custom-manual "(gnus)Customizing Articles")
1520   :link '(custom-manual "(gnus)Picons")
1521   :type gnus-article-treat-head-custom)
1522 (put 'gnus-treat-newsgroups-picon 'highlight t)
1523
1524 (defcustom gnus-treat-from-gravatar nil
1525   "Display gravatars in the From header.
1526 Valid values are nil, t, `head', `first', `last', an integer or a
1527 predicate.  See Info node `(gnus)Customizing Articles' and Info
1528 node `(gnus)Gravatars' for details."
1529   :version "24.1"
1530   :group 'gnus-article-treat
1531   :group 'gnus-gravatar
1532   :link '(custom-manual "(gnus)Customizing Articles")
1533   :link '(custom-manual "(gnus)Gravatars")
1534   :type gnus-article-treat-head-custom)
1535 (put 'gnus-treat-from-gravatar 'highlight t)
1536
1537 (defcustom gnus-treat-mail-gravatar nil
1538   "Display gravatars in To and Cc headers.
1539 Valid values are nil, t, `head', `first', `last', an integer or a
1540 predicate.  See Info node `(gnus)Customizing Articles' and Info
1541 node `(gnus)Gravatars' for details."
1542   :version "24.1"
1543   :group 'gnus-article-treat
1544   :group 'gnus-gravatar
1545   :link '(custom-manual "(gnus)Customizing Articles")
1546   :link '(custom-manual "(gnus)Gravatars")
1547   :type gnus-article-treat-head-custom)
1548 (put 'gnus-treat-mail-gravatar 'highlight t)
1549
1550 (defcustom gnus-treat-body-boundary
1551   (if (or gnus-treat-newsgroups-picon
1552           gnus-treat-mail-picon
1553           gnus-treat-from-picon
1554           gnus-treat-from-gravatar
1555           gnus-treat-mail-gravatar)
1556       ;; If there's much decoration, the user might prefer a boundery.
1557       'head
1558     nil)
1559   "Draw a boundary at the end of the headers.
1560 Valid values are nil and `head'.
1561 See Info node `(gnus)Customizing Articles' for details."
1562   :version "22.1"
1563   :group 'gnus-article-treat
1564   :link '(custom-manual "(gnus)Customizing Articles")
1565   :type gnus-article-treat-head-custom)
1566
1567 (defcustom gnus-treat-capitalize-sentences nil
1568   "Capitalize sentence-starting words.
1569 Valid values are nil, t, `head', `first', `last', an integer or a
1570 predicate.  See Info node `(gnus)Customizing Articles'."
1571   :version "21.1"
1572   :group 'gnus-article-treat
1573   :link '(custom-manual "(gnus)Customizing Articles")
1574   :type gnus-article-treat-custom)
1575
1576 (defcustom gnus-treat-wash-html nil
1577   "Format as HTML.
1578 Valid values are nil, t, `head', `first', `last', an integer or a
1579 predicate.  See Info node `(gnus)Customizing Articles'."
1580   :version "22.1"
1581   :group 'gnus-article-treat
1582   :link '(custom-manual "(gnus)Customizing Articles")
1583   :type gnus-article-treat-custom)
1584
1585 (defcustom gnus-treat-fill-long-lines '(typep "text/plain")
1586   "Fill long lines.
1587 Valid values are nil, t, `head', `first', `last', an integer or a
1588 predicate.  See Info node `(gnus)Customizing Articles'."
1589   :version "24.1"
1590   :group 'gnus-article-treat
1591   :link '(custom-manual "(gnus)Customizing Articles")
1592   :type gnus-article-treat-custom)
1593
1594 (defcustom gnus-treat-x-pgp-sig nil
1595   "Verify X-PGP-Sig.
1596 To automatically treat X-PGP-Sig, set it to head.
1597 Valid values are nil, t, `head', `first', `last', an integer or a
1598 predicate.  See Info node `(gnus)Customizing Articles'."
1599   :version "22.1"
1600   :group 'gnus-article-treat
1601   :group 'mime-security
1602   :link '(custom-manual "(gnus)Customizing Articles")
1603   :type gnus-article-treat-custom)
1604
1605 (defvar gnus-article-encrypt-protocol-alist
1606   '(("PGP" . mml2015-self-encrypt)))
1607
1608 ;; Set to nil if more than one protocol added to
1609 ;; gnus-article-encrypt-protocol-alist.
1610 (defcustom gnus-article-encrypt-protocol "PGP"
1611   "The protocol used for encrypt articles.
1612 It is a string, such as \"PGP\". If nil, ask user."
1613   :version "22.1"
1614   :type 'string
1615   :group 'mime-security)
1616
1617 (defcustom gnus-use-idna (and (condition-case nil (require 'idna) (file-error))
1618                               (mm-coding-system-p 'utf-8)
1619                               (executable-find idna-program))
1620   "Whether IDNA decoding of headers is used when viewing messages.
1621 This requires GNU Libidn, and by default only enabled if it is found."
1622   :version "22.1"
1623   :group 'gnus-article-headers
1624   :type 'boolean)
1625
1626 (defcustom gnus-article-over-scroll nil
1627   "If non-nil, allow scrolling the article buffer even when there no more text."
1628   :version "22.1"
1629   :group 'gnus-article
1630   :type 'boolean)
1631
1632 (defcustom gnus-inhibit-images nil
1633   "Non-nil means inhibit displaying of images inline in the article body."
1634   :version "24.1"
1635   :group 'gnus-article
1636   :type 'boolean)
1637
1638 (defcustom gnus-blocked-images 'gnus-block-private-groups
1639   "Images that have URLs matching this regexp will be blocked.
1640 This can also be a function to be evaluated.  If so, it will be
1641 called with the group name as the parameter, and should return a
1642 regexp."
1643   :version "24.1"
1644   :group 'gnus-art
1645   :type 'regexp)
1646
1647 ;;; Internal variables
1648
1649 (defvar gnus-english-month-names
1650   '("January" "February" "March" "April" "May" "June" "July" "August"
1651     "September" "October" "November" "December"))
1652
1653 (defvar article-goto-body-goes-to-point-min-p nil)
1654 (defvar gnus-article-wash-types nil)
1655 (defvar gnus-article-emphasis-alist nil)
1656 (defvar gnus-article-image-alist nil)
1657
1658 (defvar gnus-article-mime-handle-alist-1 nil)
1659 (defvar gnus-treatment-function-alist
1660   '((gnus-treat-x-pgp-sig gnus-article-verify-x-pgp-sig)
1661     (gnus-treat-strip-banner gnus-article-strip-banner)
1662     (gnus-treat-strip-headers-in-body gnus-article-strip-headers-in-body)
1663     (gnus-treat-highlight-signature gnus-article-highlight-signature)
1664     (gnus-treat-buttonize gnus-article-add-buttons)
1665     (gnus-treat-fill-article gnus-article-fill-cited-article)
1666     (gnus-treat-fill-long-lines gnus-article-fill-cited-long-lines)
1667     (gnus-treat-strip-cr gnus-article-remove-cr)
1668     (gnus-treat-unsplit-urls gnus-article-unsplit-urls)
1669     (gnus-treat-display-x-face gnus-article-display-x-face)
1670     (gnus-treat-display-face gnus-article-display-face)
1671     (gnus-treat-hide-headers gnus-article-maybe-hide-headers)
1672     (gnus-treat-hide-boring-headers gnus-article-hide-boring-headers)
1673     (gnus-treat-hide-signature gnus-article-hide-signature)
1674     (gnus-treat-strip-list-identifiers gnus-article-hide-list-identifiers)
1675     (gnus-treat-leading-whitespace gnus-article-remove-leading-whitespace)
1676     (gnus-treat-from-picon gnus-treat-from-picon)
1677     (gnus-treat-mail-picon gnus-treat-mail-picon)
1678     (gnus-treat-newsgroups-picon gnus-treat-newsgroups-picon)
1679     (gnus-treat-strip-pem gnus-article-hide-pem)
1680     (gnus-treat-date gnus-article-treat-date)
1681     (gnus-treat-from-gravatar gnus-treat-from-gravatar)
1682     (gnus-treat-mail-gravatar gnus-treat-mail-gravatar)
1683     (gnus-treat-highlight-headers gnus-article-highlight-headers)
1684     (gnus-treat-highlight-signature gnus-article-highlight-signature)
1685     (gnus-treat-strip-trailing-blank-lines
1686      gnus-article-remove-trailing-blank-lines)
1687     (gnus-treat-strip-leading-blank-lines
1688      gnus-article-strip-leading-blank-lines)
1689     (gnus-treat-strip-multiple-blank-lines
1690      gnus-article-strip-multiple-blank-lines)
1691     (gnus-treat-overstrike gnus-article-treat-overstrike)
1692     (gnus-treat-ansi-sequences gnus-article-treat-ansi-sequences)
1693     (gnus-treat-unfold-headers gnus-article-treat-unfold-headers)
1694     (gnus-treat-fold-newsgroups gnus-article-treat-fold-newsgroups)
1695     (gnus-treat-fold-headers gnus-article-treat-fold-headers)
1696     (gnus-treat-buttonize-head gnus-article-add-buttons-to-head)
1697     (gnus-treat-display-smileys gnus-treat-smiley)
1698     (gnus-treat-capitalize-sentences gnus-article-capitalize-sentences)
1699     (gnus-treat-wash-html gnus-article-wash-html)
1700     (gnus-treat-emphasize gnus-article-emphasize)
1701     (gnus-treat-hide-citation gnus-article-hide-citation)
1702     (gnus-treat-hide-citation-maybe gnus-article-hide-citation-maybe)
1703     (gnus-treat-highlight-citation gnus-article-highlight-citation)
1704     (gnus-treat-body-boundary gnus-article-treat-body-boundary)))
1705
1706 (defvar gnus-article-mime-handle-alist nil)
1707 (defvar article-lapsed-timer nil)
1708 (defvar gnus-article-current-summary nil)
1709
1710 (defvar gnus-article-mode-syntax-table
1711   (let ((table (copy-syntax-table text-mode-syntax-table)))
1712     ;; This causes the citation match run O(2^n).
1713     ;; (modify-syntax-entry ?- "w" table)
1714     (modify-syntax-entry ?> ")<" table)
1715     (modify-syntax-entry ?< "(>" table)
1716     ;; make M-. in article buffers work for `foo' strings
1717     (modify-syntax-entry ?' " " table)
1718     (modify-syntax-entry ?` " " table)
1719     table)
1720   "Syntax table used in article mode buffers.
1721 Initialized from `text-mode-syntax-table.")
1722
1723 (defvar gnus-save-article-buffer nil)
1724
1725 (defvar gnus-number-of-articles-to-be-saved nil)
1726
1727 (defvar gnus-inhibit-hiding nil)
1728
1729 (defvar gnus-article-edit-mode nil)
1730
1731 ;;; Macros for dealing with the article buffer.
1732
1733 (defmacro gnus-with-article-headers (&rest forms)
1734   `(with-current-buffer gnus-article-buffer
1735      (save-restriction
1736        (let ((inhibit-read-only t)
1737              (inhibit-point-motion-hooks t)
1738              (case-fold-search t))
1739          (article-narrow-to-head)
1740          ,@forms))))
1741
1742 (put 'gnus-with-article-headers 'lisp-indent-function 0)
1743 (put 'gnus-with-article-headers 'edebug-form-spec '(body))
1744
1745 (defmacro gnus-with-article-buffer (&rest forms)
1746   `(when (buffer-live-p (get-buffer gnus-article-buffer))
1747      (with-current-buffer gnus-article-buffer
1748        (let ((inhibit-read-only t))
1749          ,@forms))))
1750
1751 (put 'gnus-with-article-buffer 'lisp-indent-function 0)
1752 (put 'gnus-with-article-buffer 'edebug-form-spec '(body))
1753
1754 (defun gnus-article-goto-header (header)
1755   "Go to HEADER, which is a regular expression."
1756   (re-search-forward (concat "^\\(" header "\\):") nil t))
1757
1758 (defsubst gnus-article-hide-text (b e props)
1759   "Set text PROPS on the B to E region, extending `intangible' 1 past B."
1760   (gnus-add-text-properties-when 'article-type nil b e props)
1761   (when (memq 'intangible props)
1762     (put-text-property
1763      (max (1- b) (point-min))
1764      b 'intangible (cddr (memq 'intangible props)))))
1765
1766 (defsubst gnus-article-unhide-text (b e)
1767   "Remove hidden text properties from region between B and E."
1768   (remove-text-properties b e gnus-hidden-properties)
1769   (when (memq 'intangible gnus-hidden-properties)
1770     (put-text-property (max (1- b) (point-min))
1771                        b 'intangible nil)))
1772
1773 (defun gnus-article-hide-text-type (b e type)
1774   "Hide text of TYPE between B and E."
1775   (gnus-add-wash-type type)
1776   (gnus-article-hide-text
1777    b e (cons 'article-type (cons type gnus-hidden-properties))))
1778
1779 (defun gnus-article-unhide-text-type (b e type)
1780   "Unhide text of TYPE between B and E."
1781   (gnus-delete-wash-type type)
1782   (remove-text-properties
1783    b e (cons 'article-type (cons type gnus-hidden-properties)))
1784   (when (memq 'intangible gnus-hidden-properties)
1785     (put-text-property (max (1- b) (point-min))
1786                        b 'intangible nil)))
1787
1788 (defun gnus-article-hide-text-of-type (type)
1789   "Hide text of TYPE in the current buffer."
1790   (save-excursion
1791     (let ((b (point-min))
1792           (e (point-max)))
1793       (while (setq b (text-property-any b e 'article-type type))
1794         (add-text-properties b (incf b) gnus-hidden-properties)))))
1795
1796 (defun gnus-article-delete-text-of-type (type)
1797   "Delete text of TYPE in the current buffer."
1798   (save-excursion
1799     (let ((b (point-min)))
1800       (if (eq type 'multipart)
1801           ;; Remove MIME buttons associated with multipart/alternative parts.
1802           (progn
1803             (goto-char b)
1804             (while (if (get-text-property (point) 'gnus-part)
1805                        (setq b (point))
1806                      (when (setq b (next-single-property-change (point)
1807                                                                 'gnus-part))
1808                        (goto-char b)
1809                        t))
1810               (end-of-line)
1811               (skip-chars-forward "\n")
1812               (when (eq (get-text-property b 'article-type) 'multipart)
1813                 (delete-region b (point)))))
1814         (while (setq b (text-property-any b (point-max) 'article-type type))
1815           (delete-region
1816            b (or (text-property-not-all b (point-max) 'article-type type)
1817                  (point-max))))))))
1818
1819 (defun gnus-article-delete-invisible-text ()
1820   "Delete all invisible text in the current buffer."
1821   (save-excursion
1822     (let ((b (point-min)))
1823       (while (setq b (text-property-any b (point-max) 'invisible t))
1824         (delete-region
1825          b (or (text-property-not-all b (point-max) 'invisible t)
1826                (point-max)))))))
1827
1828 (defun gnus-article-text-type-exists-p (type)
1829   "Say whether any text of type TYPE exists in the buffer."
1830   (text-property-any (point-min) (point-max) 'article-type type))
1831
1832 (defsubst gnus-article-header-rank ()
1833   "Give the rank of the string HEADER as given by `gnus-sorted-header-list'."
1834   (let ((list gnus-sorted-header-list)
1835         (i 1))
1836     (while list
1837       (if (looking-at (car list))
1838           (setq list nil)
1839         (setq list (cdr list))
1840         (incf i)))
1841       i))
1842
1843 (defun article-hide-headers (&optional arg delete)
1844   "Hide unwanted headers and possibly sort them as well."
1845   (interactive)
1846   ;; This function might be inhibited.
1847   (unless gnus-inhibit-hiding
1848     (let ((inhibit-read-only t)
1849           (case-fold-search t)
1850           (max (1+ (length gnus-sorted-header-list)))
1851           (inhibit-point-motion-hooks t)
1852           (cur (current-buffer))
1853           ignored visible beg)
1854       (save-excursion
1855         ;; `gnus-ignored-headers' and `gnus-visible-headers' may be
1856         ;; group parameters, so we should go to the summary buffer.
1857         (when (prog1
1858                   (condition-case nil
1859                       (progn (set-buffer gnus-summary-buffer) t)
1860                     (error nil))
1861                 (setq ignored (when (not gnus-visible-headers)
1862                                 (cond ((stringp gnus-ignored-headers)
1863                                        gnus-ignored-headers)
1864                                       ((listp gnus-ignored-headers)
1865                                        (mapconcat 'identity
1866                                                   gnus-ignored-headers
1867                                                   "\\|"))))
1868                       visible (cond ((stringp gnus-visible-headers)
1869                                      gnus-visible-headers)
1870                                     ((and gnus-visible-headers
1871                                           (listp gnus-visible-headers))
1872                                      (mapconcat 'identity
1873                                                 gnus-visible-headers
1874                                                 "\\|")))))
1875           (set-buffer cur))
1876         (save-restriction
1877           ;; First we narrow to just the headers.
1878           (article-narrow-to-head)
1879           ;; Hide any "From " lines at the beginning of (mail) articles.
1880           (while (looking-at "From ")
1881             (forward-line 1))
1882           (unless (bobp)
1883             (delete-region (point-min) (point)))
1884           ;; Then treat the rest of the header lines.
1885           ;; Then we use the two regular expressions
1886           ;; `gnus-ignored-headers' and `gnus-visible-headers' to
1887           ;; select which header lines is to remain visible in the
1888           ;; article buffer.
1889           (while (re-search-forward "^[^ \t:]*:" nil t)
1890             (beginning-of-line)
1891             ;; Mark the rank of the header.
1892             (put-text-property
1893              (point) (1+ (point)) 'message-rank
1894              (if (or (and visible (looking-at visible))
1895                      (and ignored
1896                           (not (looking-at ignored))))
1897                  (gnus-article-header-rank)
1898                (+ 2 max)))
1899             (forward-line 1))
1900           (message-sort-headers-1)
1901           (when (setq beg (text-property-any
1902                            (point-min) (point-max) 'message-rank (+ 2 max)))
1903             ;; We delete the unwanted headers.
1904             (gnus-add-wash-type 'headers)
1905             (add-text-properties (point-min) (+ 5 (point-min))
1906                                  '(article-type headers dummy-invisible t))
1907             (delete-region beg (point-max))))))))
1908
1909 (defun article-hide-boring-headers (&optional arg)
1910   "Toggle hiding of headers that aren't very interesting.
1911 If given a negative prefix, always show; if given a positive prefix,
1912 always hide."
1913   (interactive (gnus-article-hidden-arg))
1914   (when (and (not (gnus-article-check-hidden-text 'boring-headers arg))
1915              (not gnus-show-all-headers))
1916     (save-excursion
1917       (save-restriction
1918         (let ((inhibit-read-only t)
1919               (inhibit-point-motion-hooks t))
1920           (article-narrow-to-head)
1921           (dolist (elem gnus-boring-article-headers)
1922             (goto-char (point-min))
1923             (cond
1924              ;; Hide empty headers.
1925              ((eq elem 'empty)
1926               (while (re-search-forward "^[^: \t]+:[ \t]*\n[^ \t]" nil t)
1927                 (forward-line -1)
1928                 (gnus-article-hide-text-type
1929                  (point-at-bol)
1930                  (progn
1931                    (end-of-line)
1932                    (if (re-search-forward "^[^ \t]" nil t)
1933                        (match-beginning 0)
1934                      (point-max)))
1935                  'boring-headers)))
1936              ;; Hide boring Newsgroups header.
1937              ((eq elem 'newsgroups)
1938               (when (gnus-string-equal
1939                      (gnus-fetch-field "newsgroups")
1940                      (gnus-group-real-name
1941                       (if (boundp 'gnus-newsgroup-name)
1942                           gnus-newsgroup-name
1943                         "")))
1944                 (gnus-article-hide-header "newsgroups")))
1945              ((eq elem 'to-address)
1946               (let ((to (message-fetch-field "to"))
1947                     (to-address
1948                      (gnus-parameter-to-address
1949                       (if (boundp 'gnus-newsgroup-name)
1950                           gnus-newsgroup-name ""))))
1951                 (when (and to to-address
1952                            (ignore-errors
1953                              (gnus-string-equal
1954                               ;; only one address in To
1955                               (nth 1 (mail-extract-address-components to))
1956                               to-address)))
1957                   (gnus-article-hide-header "to"))))
1958              ((eq elem 'to-list)
1959               (let ((to (message-fetch-field "to"))
1960                     (to-list
1961                      (gnus-parameter-to-list
1962                       (if (boundp 'gnus-newsgroup-name)
1963                           gnus-newsgroup-name ""))))
1964                 (when (and to to-list
1965                            (ignore-errors
1966                              (gnus-string-equal
1967                               ;; only one address in To
1968                               (nth 1 (mail-extract-address-components to))
1969                               to-list)))
1970                   (gnus-article-hide-header "to"))))
1971              ((eq elem 'cc-list)
1972               (let ((cc (message-fetch-field "cc"))
1973                     (to-list
1974                      (gnus-parameter-to-list
1975                       (if (boundp 'gnus-newsgroup-name)
1976                           gnus-newsgroup-name ""))))
1977                 (when (and cc to-list
1978                            (ignore-errors
1979                              (gnus-string-equal
1980                               ;; only one address in CC
1981                               (nth 1 (mail-extract-address-components cc))
1982                               to-list)))
1983                   (gnus-article-hide-header "cc"))))
1984              ((eq elem 'followup-to)
1985               (when (gnus-string-equal
1986                      (message-fetch-field "followup-to")
1987                      (message-fetch-field "newsgroups"))
1988                 (gnus-article-hide-header "followup-to")))
1989              ((eq elem 'reply-to)
1990               (if (gnus-group-find-parameter
1991                    gnus-newsgroup-name 'broken-reply-to)
1992                   (gnus-article-hide-header "reply-to")
1993                 (let ((from (message-fetch-field "from"))
1994                       (reply-to (message-fetch-field "reply-to")))
1995                   (when
1996                       (and
1997                        from reply-to
1998                        (ignore-errors
1999                          (equal
2000                           (sort (mapcar
2001                                  (lambda (x) (downcase (cadr x)))
2002                                  (mail-extract-address-components from t))
2003                                 'string<)
2004                           (sort (mapcar
2005                                  (lambda (x) (downcase (cadr x)))
2006                                  (mail-extract-address-components reply-to t))
2007                                 'string<))))
2008                     (gnus-article-hide-header "reply-to")))))
2009              ((eq elem 'date)
2010               (let ((date (with-current-buffer gnus-original-article-buffer
2011                             ;; If date in `gnus-article-buffer' is localized
2012                             ;; (`gnus-treat-date-user-defined'),
2013                             ;; `days-between' might fail.
2014                             (message-fetch-field "date"))))
2015                 (when (and date
2016                            (< (days-between (current-time-string) date)
2017                               4))
2018                   (gnus-article-hide-header "date"))))
2019              ((eq elem 'long-to)
2020               (let ((to (message-fetch-field "to"))
2021                     (cc (message-fetch-field "cc")))
2022                 (when (> (length to) 1024)
2023                   (gnus-article-hide-header "to"))
2024                 (when (> (length cc) 1024)
2025                   (gnus-article-hide-header "cc"))))
2026              ((eq elem 'many-to)
2027               (let ((to-count 0)
2028                     (cc-count 0))
2029                 (goto-char (point-min))
2030                 (while (re-search-forward "^to:" nil t)
2031                   (setq to-count (1+ to-count)))
2032                 (when (> to-count 1)
2033                   (while (> to-count 0)
2034                     (goto-char (point-min))
2035                     (save-restriction
2036                       (re-search-forward "^to:" nil nil to-count)
2037                       (forward-line -1)
2038                       (narrow-to-region (point) (point-max))
2039                       (gnus-article-hide-header "to"))
2040                     (setq to-count (1- to-count))))
2041                 (goto-char (point-min))
2042                 (while (re-search-forward "^cc:" nil t)
2043                   (setq cc-count (1+ cc-count)))
2044                 (when (> cc-count 1)
2045                   (while (> cc-count 0)
2046                     (goto-char (point-min))
2047                     (save-restriction
2048                       (re-search-forward "^cc:" nil nil cc-count)
2049                       (forward-line -1)
2050                       (narrow-to-region (point) (point-max))
2051                       (gnus-article-hide-header "cc"))
2052                     (setq cc-count (1- cc-count)))))))))))))
2053
2054 (defun gnus-article-hide-header (header)
2055   (save-excursion
2056     (goto-char (point-min))
2057     (when (re-search-forward (concat "^" header ":") nil t)
2058       (gnus-article-hide-text-type
2059        (point-at-bol)
2060        (progn
2061          (end-of-line)
2062          (if (re-search-forward "^[^ \t]" nil t)
2063              (match-beginning 0)
2064            (point-max)))
2065        'boring-headers))))
2066
2067 (defvar gnus-article-normalized-header-length 40
2068   "Length of normalized headers.")
2069
2070 (defun article-normalize-headers ()
2071   "Make all header lines 40 characters long."
2072   (interactive)
2073   (let ((inhibit-read-only t)
2074         column)
2075     (save-excursion
2076       (save-restriction
2077         (article-narrow-to-head)
2078         (while (not (eobp))
2079           (cond
2080            ((< (setq column (- (point-at-eol) (point)))
2081                gnus-article-normalized-header-length)
2082             (end-of-line)
2083             (insert (make-string
2084                      (- gnus-article-normalized-header-length column)
2085                      ? )))
2086            ((> column gnus-article-normalized-header-length)
2087             (gnus-put-text-property
2088              (progn
2089                (forward-char gnus-article-normalized-header-length)
2090                (point))
2091              (point-at-eol)
2092              'invisible t))
2093            (t
2094             ;; Do nothing.
2095             ))
2096           (forward-line 1))))))
2097
2098 (defun article-treat-dumbquotes ()
2099   "Translate M****s*** sm*rtq**t*s and other symbols into proper text.
2100 Note that this function guesses whether a character is a sm*rtq**t* or
2101 not, so it should only be used interactively.
2102
2103 Sm*rtq**t*s are M****s***'s unilateral extension to the
2104 iso-8859-1 character map in an attempt to provide more quoting
2105 characters.  If you see something like \\222 or \\264 where
2106 you're expecting some kind of apostrophe or quotation mark, then
2107 try this wash."
2108   (interactive)
2109   (article-translate-strings gnus-article-dumbquotes-map))
2110
2111 (defvar org-entities)
2112
2113 (defun article-treat-non-ascii ()
2114   "Translate many Unicode characters into their ASCII equivalents."
2115   (interactive)
2116   (require 'org-entities)
2117   (let ((table (make-char-table (if (featurep 'xemacs) 'generic))))
2118     (dolist (elem org-entities)
2119       (when (and (listp elem)
2120                  (= (length (nth 6 elem)) 1))
2121         (if (featurep 'xemacs)
2122             (put-char-table (aref (nth 6 elem) 0) (nth 4 elem) table)
2123           (set-char-table-range table (aref (nth 6 elem) 0) (nth 4 elem)))))
2124     (save-excursion
2125       (when (article-goto-body)
2126         (let ((inhibit-read-only t)
2127               replace props)
2128           (while (not (eobp))
2129             (if (not (setq replace (if (featurep 'xemacs)
2130                                        (get-char-table (following-char) table)
2131                                      (aref table (following-char)))))
2132                 (forward-char 1)
2133               (if (prog1
2134                       (setq props (text-properties-at (point)))
2135                     (delete-char 1))
2136                   (add-text-properties (point) (progn (insert replace) (point))
2137                                        props)
2138                 (insert replace)))))))))
2139
2140 (defun article-translate-characters (from to)
2141   "Translate all characters in the body of the article according to FROM and TO.
2142 FROM is a string of characters to translate from; to is a string of
2143 characters to translate to."
2144   (save-excursion
2145     (when (article-goto-body)
2146       (let ((inhibit-read-only t)
2147             (x (make-string 225 ?x))
2148             (i -1))
2149         (while (< (incf i) (length x))
2150           (aset x i i))
2151         (setq i 0)
2152         (while (< i (length from))
2153           (aset x (aref from i) (aref to i))
2154           (incf i))
2155         (translate-region (point) (point-max) x)))))
2156
2157 (defun article-translate-strings (map)
2158   "Translate all string in the body of the article according to MAP.
2159 MAP is an alist where the elements are on the form (\"from\" \"to\")."
2160   (save-excursion
2161     (when (article-goto-body)
2162       (let ((inhibit-read-only t))
2163         (dolist (elem map)
2164           (let ((from (car elem))
2165                 (to (cadr elem)))
2166             (save-excursion
2167               (if (stringp from)
2168                   (while (search-forward from nil t)
2169                     (replace-match to))
2170                 (while (not (eobp))
2171                   (if (eq (following-char) from)
2172                       (progn
2173                         (delete-char 1)
2174                         (insert to))
2175                     (forward-char 1)))))))))))
2176
2177 (defun article-treat-overstrike ()
2178   "Translate overstrikes into bold text."
2179   (interactive)
2180   (save-excursion
2181     (when (article-goto-body)
2182       (let ((inhibit-read-only t))
2183         (while (search-forward "\b" nil t)
2184           (let ((next (char-after))
2185                 (previous (char-after (- (point) 2))))
2186             ;; We do the boldification/underlining by hiding the
2187             ;; overstrikes and putting the proper text property
2188             ;; on the letters.
2189             (cond
2190              ((eq next previous)
2191               (gnus-article-hide-text-type (- (point) 2) (point) 'overstrike)
2192               (put-text-property (point) (1+ (point)) 'face 'bold))
2193              ((eq next ?_)
2194               (gnus-article-hide-text-type
2195                (1- (point)) (1+ (point)) 'overstrike)
2196               (put-text-property
2197                (- (point) 2) (1- (point)) 'face 'underline))
2198              ((eq previous ?_)
2199               (gnus-article-hide-text-type (- (point) 2) (point) 'overstrike)
2200               (put-text-property
2201                (point) (1+ (point)) 'face 'underline)))))))))
2202
2203 (defun article-treat-ansi-sequences ()
2204   "Translate ANSI SGR control sequences into overlays or extents."
2205   (interactive)
2206   (save-excursion
2207     (when (article-goto-body)
2208       (let ((inhibit-read-only t))
2209         (ansi-color-apply-on-region (point) (point-max))))))
2210
2211 (defun gnus-article-treat-unfold-headers ()
2212   "Unfold folded message headers.
2213 Only the headers that fit into the current window width will be
2214 unfolded."
2215   (interactive)
2216   (gnus-with-article-headers
2217     (let (length)
2218       (while (not (eobp))
2219         (save-restriction
2220           (mail-header-narrow-to-field)
2221           (let* ((header (buffer-string))
2222                  (unfoldable
2223                   (or (equal gnus-article-unfold-long-headers t)
2224                       (and (stringp gnus-article-unfold-long-headers)
2225                            (string-match gnus-article-unfold-long-headers header)))))
2226             (with-temp-buffer
2227               (insert header)
2228               (goto-char (point-min))
2229               (while (re-search-forward "\n[\t ]" nil t)
2230                 (replace-match " " t t)))
2231             (setq length (- (point-max) (point-min) 1))
2232             (when (or unfoldable
2233                       (< length (window-width)))
2234               (while (re-search-forward "\n[\t ]" nil t)
2235                 (replace-match " " t t))))
2236           (goto-char (point-max)))))))
2237
2238 (defun gnus-article-treat-fold-headers ()
2239   "Fold message headers."
2240   (interactive)
2241   (gnus-with-article-headers
2242     (while (not (eobp))
2243       (save-restriction
2244         (mail-header-narrow-to-field)
2245         (mail-header-fold-field)
2246         (goto-char (point-max))))))
2247
2248 (defun gnus-treat-smiley ()
2249   "Toggle display of textual emoticons (\"smileys\") as small graphical icons."
2250   (interactive)
2251   (gnus-with-article-buffer
2252     (if (memq 'smiley gnus-article-wash-types)
2253         (gnus-delete-images 'smiley)
2254       (article-goto-body)
2255       (let ((images (smiley-region (point) (point-max))))
2256         (when images
2257           (gnus-add-wash-type 'smiley)
2258           (dolist (image images)
2259             (gnus-add-image 'smiley image)))))))
2260
2261 (defun gnus-article-remove-images ()
2262   "Remove all images from the article buffer."
2263   (interactive)
2264   (gnus-with-article-buffer
2265     (save-restriction
2266       (widen)
2267       (dolist (elem gnus-article-image-alist)
2268         (gnus-delete-images (car elem))))))
2269
2270 (defun gnus-article-show-images ()
2271   "Show any images that are in the HTML-rendered article buffer.
2272 This only works if the article in question is HTML."
2273   (interactive)
2274   (gnus-with-article-buffer
2275     (save-restriction
2276       (widen)
2277       (dolist (region (gnus-find-text-property-region (point-min) (point-max)
2278                                                       'image-displayer))
2279         (destructuring-bind (start end function) region
2280           (funcall function (get-text-property start 'image-url)
2281                    start end))))))
2282
2283 (defun gnus-article-treat-fold-newsgroups ()
2284   "Unfold folded message headers.
2285 Only the headers that fit into the current window width will be
2286 unfolded."
2287   (interactive)
2288   (gnus-with-article-headers
2289     (while (gnus-article-goto-header "newsgroups\\|followup-to")
2290       (save-restriction
2291         (mail-header-narrow-to-field)
2292         (while (re-search-forward ", *" nil t)
2293           (replace-match ", " t t))
2294         (mail-header-fold-field)
2295         (goto-char (point-max))))))
2296
2297 (defcustom gnus-article-truncate-lines (default-value 'truncate-lines)
2298   "Value of `truncate-lines' in Gnus Article buffer.
2299 Valid values are nil, t, `head', `first', `last', an integer or a
2300 predicate.  See Info node `(gnus)Customizing Articles'."
2301   :version "23.1" ;; No Gnus
2302   :group 'gnus-article
2303   ;; :link '(custom-manual "(gnus)Customizing Articles")
2304   :type 'boolean)
2305
2306 (defun gnus-article-toggle-truncate-lines (&optional arg)
2307   "Toggle whether to fold or truncate long lines in article the buffer.
2308 If ARG is non-nil and not a number, toggle
2309 `gnus-article-truncate-lines' too.  If ARG is a number, truncate
2310 long lines if and only if arg is positive."
2311   (interactive "P")
2312   (cond
2313    ((and (numberp arg) (> arg 0))
2314     (setq gnus-article-truncate-lines t))
2315    ((numberp arg)
2316     (setq gnus-article-truncate-lines nil))
2317    (arg
2318     (setq gnus-article-truncate-lines
2319           (not gnus-article-truncate-lines))))
2320   (gnus-with-article-buffer
2321     (cond
2322      ((and (numberp arg) (> arg 0))
2323       (setq truncate-lines nil))
2324      ((numberp arg)
2325       (setq truncate-lines t)))
2326     ;; In versions of Emacs 22 (CVS) before 2006-05-26,
2327     ;; `toggle-truncate-lines' needs an argument.
2328     (toggle-truncate-lines)))
2329
2330 (defun gnus-article-treat-body-boundary ()
2331   "Place a boundary line at the end of the headers."
2332   (interactive)
2333   (when (and gnus-body-boundary-delimiter
2334              (> (length gnus-body-boundary-delimiter) 0))
2335     (gnus-with-article-headers
2336       (goto-char (point-max))
2337       (let ((start (point)))
2338         (insert "X-Boundary: ")
2339         (gnus-add-text-properties start (point) '(invisible t intangible t))
2340        (insert (let (str (max (window-width)))
2341                  (if (featurep 'xemacs)
2342                      (setq max (1- max)))
2343                  (while (>= max (length str))
2344                     (setq str (concat str gnus-body-boundary-delimiter)))
2345                  (substring str 0 max))
2346                 "\n")
2347         (gnus-put-text-property start (point) 'gnus-decoration 'header)))))
2348
2349 (defun article-fill-long-lines ()
2350   "Fill lines that are wider than the window width."
2351   (interactive)
2352   (save-excursion
2353     (let ((inhibit-read-only t)
2354           (width (window-width (get-buffer-window (current-buffer)))))
2355       (save-restriction
2356         (article-goto-body)
2357         (let ((adaptive-fill-mode nil)) ;Why?  -sm
2358           (while (not (eobp))
2359             (end-of-line)
2360             (when (>= (current-column) (min fill-column width))
2361               (narrow-to-region (min (1+ (point)) (point-max))
2362                                 (point-at-bol))
2363               (let ((goback (point-marker)))
2364                 (fill-paragraph nil)
2365                 (goto-char (marker-position goback)))
2366               (widen))
2367             (forward-line 1)))))))
2368
2369 (defun article-capitalize-sentences ()
2370   "Capitalize the first word in each sentence."
2371   (interactive)
2372   (save-excursion
2373     (let ((inhibit-read-only t)
2374           (paragraph-start "^[\n\^L]"))
2375       (article-goto-body)
2376       (while (not (eobp))
2377         (capitalize-word 1)
2378         (forward-sentence)))))
2379
2380 (defun article-remove-cr ()
2381   "Remove trailing CRs and then translate remaining CRs into LFs."
2382   (interactive)
2383   (save-excursion
2384     (let ((inhibit-read-only t))
2385       (goto-char (point-min))
2386       (while (re-search-forward "\r+$" nil t)
2387         (replace-match "" t t))
2388       (goto-char (point-min))
2389       (while (search-forward "\r" nil t)
2390         (replace-match "\n" t t)))))
2391
2392 (defun article-remove-trailing-blank-lines ()
2393   "Remove all trailing blank lines from the article."
2394   (interactive)
2395   (save-excursion
2396     (let ((inhibit-read-only t))
2397       (goto-char (point-max))
2398       (delete-region
2399        (point)
2400        (progn
2401          (while (and (not (bobp))
2402                      (looking-at "^[ \t]*$")
2403                      (not (gnus-annotation-in-region-p
2404                            (point) (point-at-eol))))
2405            (forward-line -1))
2406          (forward-line 1)
2407          (point))))))
2408
2409 (defvar gnus-face-properties-alist)
2410
2411 (defun article-display-face (&optional force)
2412   "Display any Face headers in the header."
2413   (interactive (list 'force))
2414   (let ((wash-face-p buffer-read-only))
2415     (gnus-with-article-headers
2416       ;; When displaying parts, this function can be called several times on
2417       ;; the same article, without any intended toggle semantic (as typing `W
2418       ;; D d' would have). So face deletion must occur only when we come from
2419       ;; an interactive command, that is when the *Article* buffer is
2420       ;; read-only.
2421       (if (and wash-face-p (memq 'face gnus-article-wash-types))
2422           (gnus-delete-images 'face)
2423         (let ((from (message-fetch-field "from"))
2424               face faces)
2425           (save-current-buffer
2426             (when (and wash-face-p
2427                        (gnus-buffer-live-p gnus-original-article-buffer)
2428                        (not (re-search-forward "^Face:[\t ]*" nil t)))
2429               (set-buffer gnus-original-article-buffer))
2430             (save-restriction
2431               (mail-narrow-to-head)
2432               (when (or force
2433                         ;; Check whether this face is censored.
2434                         (not (and gnus-article-x-face-too-ugly
2435                                   (or from
2436                                       (setq from (message-fetch-field "from")))
2437                                   (string-match gnus-article-x-face-too-ugly
2438                                                 from))))
2439                 (while (gnus-article-goto-header "Face")
2440                   (push (mail-header-field-value) faces)))))
2441           (when faces
2442             (goto-char (point-min))
2443             (let (png image)
2444               (unless (setq from (gnus-article-goto-header "from"))
2445                 (insert "From:")
2446                 (setq from (point))
2447                 (insert " [no `from' set]\n"))
2448               (while faces
2449                 (when (setq png (gnus-convert-face-to-png (pop faces)))
2450                   (setq image
2451                         (apply 'gnus-create-image png 'png t
2452                                (cdr (assq 'png gnus-face-properties-alist))))
2453                   (goto-char from)
2454                   (gnus-add-wash-type 'face)
2455                   (gnus-add-image 'face image)
2456                   (gnus-put-image image nil 'face))))))))))
2457
2458 (defun article-display-x-face (&optional force)
2459   "Look for an X-Face header and display it if present."
2460   (interactive (list 'force))
2461   (let ((wash-face-p buffer-read-only)) ;; When type `W f'
2462     (gnus-with-article-headers
2463       ;; Delete the old process, if any.
2464       (when (process-status "article-x-face")
2465         (delete-process "article-x-face"))
2466       ;; See the comment in `article-display-face'.
2467       (if (and wash-face-p (memq 'xface gnus-article-wash-types))
2468           ;; We have already displayed X-Faces, so we remove them
2469           ;; instead.
2470           (gnus-delete-images 'xface)
2471         ;; Display X-Faces.
2472         (let ((from (message-fetch-field "from"))
2473               x-faces face)
2474           (save-current-buffer
2475             (when (and wash-face-p
2476                        (gnus-buffer-live-p gnus-original-article-buffer)
2477                        (not (re-search-forward "^X-Face:[\t ]*" nil t)))
2478               ;; If type `W f', use gnus-original-article-buffer,
2479               ;; otherwise use the current buffer because displaying
2480               ;; RFC822 parts calls this function too.
2481               (set-buffer gnus-original-article-buffer))
2482             (save-restriction
2483               (mail-narrow-to-head)
2484               (and gnus-article-x-face-command
2485                    (or force
2486                        ;; Check whether this face is censored.
2487                        (not (and gnus-article-x-face-too-ugly
2488                                  (or from
2489                                      (setq from (message-fetch-field "from")))
2490                                  (string-match gnus-article-x-face-too-ugly
2491                                                from))))
2492                    (while (gnus-article-goto-header "X-Face")
2493                      (push (mail-header-field-value) x-faces)))))
2494           (when x-faces
2495             ;; We display the face.
2496             (cond ((functionp gnus-article-x-face-command)
2497                    ;; The command is a lisp function, so we call it.
2498                    (mapc gnus-article-x-face-command x-faces))
2499                   ((stringp gnus-article-x-face-command)
2500                    ;; The command is a string, so we interpret the command
2501                    ;; as a, well, command, and fork it off.
2502                    (let ((process-connection-type nil))
2503                      (gnus-set-process-query-on-exit-flag
2504                       (start-process
2505                        "article-x-face" nil shell-file-name
2506                        shell-command-switch gnus-article-x-face-command)
2507                       nil)
2508                      ;; Sending multiple EOFs to xv doesn't work,
2509                      ;; so we only do a single external face.
2510                      (with-temp-buffer
2511                        (insert (car x-faces))
2512                        (process-send-region "article-x-face"
2513                                             (point-min) (point-max)))
2514                      (process-send-eof "article-x-face")))
2515                   (t
2516                    (error "`%s' set to `%s' is not a function"
2517                           gnus-article-x-face-command
2518                           'gnus-article-x-face-command)))))))))
2519
2520 (defun article-decode-mime-words ()
2521   "Decode all MIME-encoded words in the article."
2522   (interactive)
2523   (gnus-with-article-buffer
2524     (let ((inhibit-point-motion-hooks t)
2525           (mail-parse-charset gnus-newsgroup-charset)
2526           (mail-parse-ignored-charsets
2527            (with-current-buffer gnus-summary-buffer
2528              gnus-newsgroup-ignored-charsets)))
2529       (mail-decode-encoded-word-region (point-min) (point-max)))))
2530
2531 (defun article-decode-charset (&optional prompt)
2532   "Decode charset-encoded text in the article.
2533 If PROMPT (the prefix), prompt for a coding system to use."
2534   (interactive "P")
2535   (let ((inhibit-point-motion-hooks t) (case-fold-search t)
2536         (inhibit-read-only t)
2537         (mail-parse-charset gnus-newsgroup-charset)
2538         (mail-parse-ignored-charsets
2539          (save-excursion (condition-case nil
2540                              (set-buffer gnus-summary-buffer)
2541                            (error))
2542                          gnus-newsgroup-ignored-charsets))
2543         ct cte ctl charset format)
2544     (save-excursion
2545       (save-restriction
2546         (article-narrow-to-head)
2547         (setq ct (message-fetch-field "Content-Type" t)
2548               cte (message-fetch-field "Content-Transfer-Encoding" t)
2549               ctl (and ct (mail-header-parse-content-type ct))
2550               charset (cond
2551                        (prompt
2552                         (mm-read-coding-system "Charset to decode: "))
2553                        (ctl
2554                         (mail-content-type-get ctl 'charset)))
2555               format (and ctl (mail-content-type-get ctl 'format)))
2556         (when cte
2557           (setq cte (mail-header-strip cte)))
2558         (if (and ctl (not (string-match "/" (car ctl))))
2559             (setq ctl nil))
2560         (goto-char (point-max)))
2561       (forward-line 1)
2562       (save-restriction
2563         (narrow-to-region (point) (point-max))
2564         (when (and (eq mail-parse-charset 'gnus-decoded)
2565                    (eq (mm-body-7-or-8) '8bit))
2566           ;; The text code could have been decoded.
2567           (setq charset mail-parse-charset))
2568         (when (and (or (not ctl)
2569                        (equal (car ctl) "text/plain"))
2570                    (not format)) ;; article with format will decode later.
2571           (mm-decode-body
2572            charset (and cte (intern (downcase
2573                                      (gnus-strip-whitespace cte))))
2574            (car ctl)))))))
2575
2576 (defun article-decode-encoded-words ()
2577   "Remove encoded-word encoding from headers."
2578   (let ((inhibit-point-motion-hooks t)
2579         (mail-parse-charset gnus-newsgroup-charset)
2580         (mail-parse-ignored-charsets
2581          (save-excursion (condition-case nil
2582                              (set-buffer gnus-summary-buffer)
2583                            (error))
2584                          gnus-newsgroup-ignored-charsets))
2585         (inhibit-read-only t)
2586         end start)
2587     (goto-char (point-min))
2588     (when (search-forward "\n\n" nil 'move)
2589       (forward-line -1))
2590     (setq end (point))
2591     (while (not (bobp))
2592       (while (progn
2593                (forward-line -1)
2594                (and (not (bobp))
2595                     (memq (char-after) '(?\t ? )))))
2596       (setq start (point))
2597       (if (looking-at "\
2598 \\(?:Resent-\\)?\\(?:From\\|Cc\\|To\\|Bcc\\|\\(?:In-\\)?Reply-To\\|Sender\
2599 \\|Mail-Followup-To\\|Mail-Copies-To\\|Approved\\):")
2600           (funcall gnus-decode-address-function start end)
2601         (funcall gnus-decode-header-function start end))
2602       (goto-char (setq end start)))))
2603
2604 (defun article-decode-group-name ()
2605   "Decode group names in Newsgroups, Followup-To and Xref headers."
2606   (let ((inhibit-point-motion-hooks t)
2607         (inhibit-read-only t)
2608         (method (gnus-find-method-for-group gnus-newsgroup-name))
2609         regexp)
2610     (when (and (or gnus-group-name-charset-method-alist
2611                    gnus-group-name-charset-group-alist)
2612                (gnus-buffer-live-p gnus-original-article-buffer))
2613       (save-restriction
2614         (article-narrow-to-head)
2615         (dolist (header '("Newsgroups" "Followup-To" "Xref"))
2616           (with-current-buffer gnus-original-article-buffer
2617             (goto-char (point-min)))
2618           (setq regexp (concat "^" header
2619                                ":\\([^\n]*\\(?:\n[\t ]+[^\n]+\\)*\\)\n"))
2620           (while (re-search-forward regexp nil t)
2621             (replace-match (save-match-data
2622                              (gnus-decode-newsgroups
2623                               ;; XXX how to use data in article buffer?
2624                               (with-current-buffer gnus-original-article-buffer
2625                                 (re-search-forward regexp nil t)
2626                                 (match-string 1))
2627                               gnus-newsgroup-name method))
2628                            t t nil 1))
2629           (goto-char (point-min)))))))
2630
2631 (autoload 'idna-to-unicode "idna")
2632
2633 (defun article-decode-idna-rhs ()
2634   "Decode IDNA strings in RHS in various headers in current buffer.
2635 The following headers are decoded: From:, To:, Cc:, Reply-To:,
2636 Mail-Reply-To: and Mail-Followup-To:."
2637   (when gnus-use-idna
2638     (save-restriction
2639       (let ((inhibit-point-motion-hooks t)
2640             (inhibit-read-only t))
2641         (article-narrow-to-head)
2642         (goto-char (point-min))
2643         (while (re-search-forward "@[^ \t\n\r,>]*\\(xn--[-A-Za-z0-9.]*\\)[ \t\n\r,>]" nil t)
2644           (let (ace unicode)
2645             (when (save-match-data
2646                     (and (setq ace (match-string 1))
2647                          (save-excursion
2648                            (and (re-search-backward "^[^ \t]" nil t)
2649                                 (looking-at "From\\|To\\|Cc\\|Reply-To\\|Mail-Reply-To\\|Mail-Followup-To")))
2650                          (setq unicode (idna-to-unicode ace))))
2651               (unless (string= ace unicode)
2652                 (replace-match unicode nil nil nil 1)))))))))
2653
2654 (defun article-de-quoted-unreadable (&optional force read-charset)
2655   "Translate a quoted-printable-encoded article.
2656 If FORCE, decode the article whether it is marked as quoted-printable
2657 or not.
2658 If READ-CHARSET, ask for a coding system."
2659   (interactive (list 'force current-prefix-arg))
2660   (save-excursion
2661     (let ((inhibit-read-only t) type charset)
2662       (if (gnus-buffer-live-p gnus-original-article-buffer)
2663           (with-current-buffer gnus-original-article-buffer
2664             (setq type
2665                   (gnus-fetch-field "content-transfer-encoding"))
2666             (let* ((ct (gnus-fetch-field "content-type"))
2667                    (ctl (and ct (mail-header-parse-content-type ct))))
2668               (setq charset (and ctl
2669                                  (mail-content-type-get ctl 'charset)))
2670               (if (stringp charset)
2671                   (setq charset (intern (downcase charset)))))))
2672       (if read-charset
2673           (setq charset (mm-read-coding-system "Charset: " charset)))
2674       (unless charset
2675         (setq charset gnus-newsgroup-charset))
2676       (when (or force
2677                 (and type (let ((case-fold-search t))
2678                             (string-match "quoted-printable" type))))
2679         (article-goto-body)
2680         (quoted-printable-decode-region
2681          (point) (point-max) (mm-charset-to-coding-system charset))))))
2682
2683 (defun article-de-base64-unreadable (&optional force read-charset)
2684   "Translate a base64 article.
2685 If FORCE, decode the article whether it is marked as base64 not.
2686 If READ-CHARSET, ask for a coding system."
2687   (interactive (list 'force current-prefix-arg))
2688   (save-excursion
2689     (let ((inhibit-read-only t) type charset)
2690       (if (gnus-buffer-live-p gnus-original-article-buffer)
2691           (with-current-buffer gnus-original-article-buffer
2692             (setq type
2693                   (gnus-fetch-field "content-transfer-encoding"))
2694             (let* ((ct (gnus-fetch-field "content-type"))
2695                    (ctl (and ct (mail-header-parse-content-type ct))))
2696               (setq charset (and ctl
2697                                  (mail-content-type-get ctl 'charset)))
2698               (if (stringp charset)
2699                   (setq charset (intern (downcase charset)))))))
2700       (if read-charset
2701           (setq charset (mm-read-coding-system "Charset: " charset)))
2702       (unless charset
2703         (setq charset gnus-newsgroup-charset))
2704       (when (or force
2705                 (and type (let ((case-fold-search t))
2706                             (string-match "base64" type))))
2707         (article-goto-body)
2708         (save-restriction
2709           (narrow-to-region (point) (point-max))
2710           (base64-decode-region (point-min) (point-max))
2711           (mm-decode-coding-region
2712            (point-min) (point-max) (mm-charset-to-coding-system charset)))))))
2713
2714 (eval-when-compile
2715   (require 'rfc1843))
2716
2717 (defun article-decode-HZ ()
2718   "Translate a HZ-encoded article."
2719   (interactive)
2720   (require 'rfc1843)
2721   (save-excursion
2722     (let ((inhibit-read-only t))
2723       (rfc1843-decode-region (point-min) (point-max)))))
2724
2725 (defun article-unsplit-urls ()
2726   "Remove the newlines that some other mailers insert into URLs."
2727   (interactive)
2728   (save-excursion
2729     (let ((inhibit-read-only t))
2730       (goto-char (point-min))
2731       (while (re-search-forward
2732               "\\(\\(https?\\|ftp\\)://\\S-+\\) *\n\\(\\S-+\\)" nil t)
2733         (replace-match "\\1\\3" t)))
2734     (when (interactive-p)
2735       (gnus-treat-article nil))))
2736
2737 (defun article-wash-html ()
2738   "Format an HTML article."
2739   (interactive)
2740   (let ((handles nil)
2741         (buffer-read-only nil))
2742     (when (gnus-buffer-live-p gnus-original-article-buffer)
2743       (setq handles (mm-dissect-buffer t t)))
2744     (article-goto-body)
2745     (delete-region (point) (point-max))
2746     (mm-inline-text-html handles)))
2747
2748 (defvar gnus-article-browse-html-temp-list nil
2749   "List of temporary files created by `gnus-article-browse-html-parts'.
2750 Internal variable.")
2751
2752 (defcustom gnus-article-browse-delete-temp 'ask
2753   "What to do with temporary files from `gnus-article-browse-html-parts'.
2754 If nil, don't delete temporary files.  If it is t, delete them on
2755 exit from the summary buffer.  If it is the symbol `file', query
2756 on each file, if it is `ask' ask once when exiting from the
2757 summary buffer."
2758   :group 'gnus-article
2759   :version "23.1" ;; No Gnus
2760   :type '(choice (const :tag "Don't delete" nil)
2761                  (const :tag "Don't ask" t)
2762                  (const :tag "Ask" ask)
2763                  (const :tag "Ask for each file" file)))
2764
2765 ;; Cf. mm-postponed-undisplay-list / mm-destroy-postponed-undisplay-list.
2766
2767 (defun gnus-article-browse-delete-temp-files (&optional how)
2768   "Delete temp-files created by `gnus-article-browse-html-parts'."
2769   (when (and gnus-article-browse-html-temp-list
2770              (progn
2771                (or how (setq how gnus-article-browse-delete-temp))
2772                (if (eq how 'ask)
2773                    (let ((files (length gnus-article-browse-html-temp-list)))
2774                      (gnus-y-or-n-p (format
2775                                      "Delete all %s temporary HTML file%s? "
2776                                      files
2777                                      (if (> files 1) "s" ""))))
2778                  how)))
2779     (dolist (file gnus-article-browse-html-temp-list)
2780       (cond ((file-directory-p file)
2781              (when (or (not (eq how 'file))
2782                        (gnus-y-or-n-p
2783                         (format
2784                          "Delete temporary HTML file(s) in directory `%s'? "
2785                          (file-name-as-directory file))))
2786                (gnus-delete-directory file)))
2787             ((file-exists-p file)
2788              (when (or (not (eq how 'file))
2789                        (gnus-y-or-n-p
2790                         (format "Delete temporary HTML file `%s'? " file)))
2791                (delete-file file)))))
2792     ;; Also remove file from the list when not deleted or if file doesn't
2793     ;; exist anymore.
2794     (setq gnus-article-browse-html-temp-list nil))
2795   gnus-article-browse-html-temp-list)
2796
2797 (defun gnus-article-browse-html-save-cid-content (cid handles directory)
2798   "Find CID content in HANDLES and save it in a file in DIRECTORY.
2799 Return file name."
2800   (save-match-data
2801     (let (file type)
2802       (catch 'found
2803         (dolist (handle handles)
2804           (cond
2805            ((not (listp handle)))
2806            ((equal (mm-handle-media-supertype handle) "multipart")
2807             (when (setq file (gnus-article-browse-html-save-cid-content
2808                               cid handle directory))
2809               (throw 'found file)))
2810            ((equal (concat "<" cid ">") (mm-handle-id handle))
2811             (setq file
2812                   (expand-file-name
2813                    (or (mail-content-type-get
2814                         (mm-handle-disposition handle) 'filename)
2815                        (mail-content-type-get
2816                         (setq type (mm-handle-type handle)) 'name)
2817                        (concat
2818                         (make-temp-name "cid")
2819                         (car (rassoc (car type) mailcap-mime-extensions))))
2820                    directory))
2821             (mm-save-part-to-file handle file)
2822             (throw 'found file))))))))
2823
2824 (defun gnus-article-browse-html-parts (list &optional header)
2825   "View all \"text/html\" parts from LIST.
2826 Recurse into multiparts.  The optional HEADER that should be a decoded
2827 message header will be added to the bodies of the \"text/html\" parts."
2828   ;; Internal function used by `gnus-article-browse-html-article'.
2829   (let (type file charset content cid-dir tmp-file showed)
2830     ;; Find and show the html-parts.
2831     (dolist (handle list)
2832       ;; If HTML, show it:
2833       (cond ((not (listp handle)))
2834             ((or (equal (car (setq type (mm-handle-type handle))) "text/html")
2835                  (and (equal (car type) "message/external-body")
2836                       (or header
2837                           (setq file (or (mail-content-type-get type 'name)
2838                                          (mail-content-type-get
2839                                           (mm-handle-disposition handle)
2840                                           'filename))))
2841                       (or (mm-handle-cache handle)
2842                           (condition-case code
2843                               (progn (mm-extern-cache-contents handle) t)
2844                             (error
2845                              (gnus-message 3 "%s" (error-message-string code))
2846                              (when (>= gnus-verbose 3) (sit-for 2))
2847                              nil)))
2848                       (progn
2849                         (setq handle (mm-handle-cache handle)
2850                               type (mm-handle-type handle))
2851                         (equal (car type) "text/html"))))
2852              (setq charset (mail-content-type-get type 'charset)
2853                    content (mm-get-part handle))
2854              (with-temp-buffer
2855                (if (eq charset 'gnus-decoded)
2856                    (mm-enable-multibyte)
2857                  (mm-disable-multibyte))
2858                (insert content)
2859                ;; resolve cid contents
2860                (let ((case-fold-search t)
2861                      cid-file)
2862                  (goto-char (point-min))
2863                  (while (re-search-forward "\
2864 <img[\t\n ]+\\(?:[^\t\n >]+[\t\n ]+\\)*src=\"\\(cid:\\([^\"]+\\)\\)\""
2865                                            nil t)
2866                    (unless cid-dir
2867                      (setq cid-dir (mm-make-temp-file "cid" t))
2868                      (add-to-list 'gnus-article-browse-html-temp-list cid-dir))
2869                    (setq file nil
2870                          content nil)
2871                    (when (setq cid-file
2872                                (gnus-article-browse-html-save-cid-content
2873                                 (match-string 2)
2874                                 (with-current-buffer gnus-article-buffer
2875                                   gnus-article-mime-handles)
2876                                 cid-dir))
2877                      (replace-match (concat "file://" cid-file)
2878                                     nil nil nil 1))))
2879                (unless content (setq content (buffer-string))))
2880              (when (or charset header (not file))
2881                (setq tmp-file (mm-make-temp-file
2882                                ;; Do we need to care for 8.3 filenames?
2883                                "mm-" nil ".html")))
2884              ;; Add a meta html tag to specify charset and a header.
2885              (cond
2886               (header
2887                (let (title eheader body hcharset coding force-charset)
2888                  (with-temp-buffer
2889                    (mm-enable-multibyte)
2890                    (setq case-fold-search t)
2891                    (insert header "\n")
2892                    (setq title (message-fetch-field "subject"))
2893                    (goto-char (point-min))
2894                    (while (re-search-forward "\\(<\\)\\|\\(>\\)\\|&" nil t)
2895                      (replace-match (cond ((match-beginning 1) "&lt;")
2896                                           ((match-beginning 2) "&gt;")
2897                                           (t "&amp;"))))
2898                    (goto-char (point-min))
2899                    (insert "<pre>\n")
2900                    (goto-char (point-max))
2901                    (insert "</pre>\n<hr>\n")
2902                    ;; We have to examine charset one by one since
2903                    ;; charset specified in parts might be different.
2904                    (if (eq charset 'gnus-decoded)
2905                        (setq charset 'utf-8
2906                              eheader (mm-encode-coding-string (buffer-string)
2907                                                               charset)
2908                              title (when title
2909                                      (mm-encode-coding-string title charset))
2910                              body (mm-encode-coding-string content charset)
2911                              force-charset t)
2912                      (setq hcharset (mm-find-mime-charset-region (point-min)
2913                                                                  (point-max)))
2914                      (cond ((= (length hcharset) 1)
2915                             (setq hcharset (car hcharset)
2916                                   coding (mm-charset-to-coding-system
2917                                           hcharset)))
2918                            ((> (length hcharset) 1)
2919                             (setq hcharset 'utf-8
2920                                   coding hcharset)))
2921                      (if coding
2922                          (if charset
2923                              (progn
2924                                (setq body
2925                                      (mm-charset-to-coding-system charset))
2926                                (if (eq coding body)
2927                                    (setq eheader (mm-encode-coding-string
2928                                                   (buffer-string) coding)
2929                                          title (when title
2930                                                  (mm-encode-coding-string
2931                                                   title coding))
2932                                          body content)
2933                                  (setq charset 'utf-8
2934                                        eheader (mm-encode-coding-string
2935                                                 (buffer-string) charset)
2936                                        title (when title
2937                                                (mm-encode-coding-string
2938                                                 title charset))
2939                                        body (mm-encode-coding-string
2940                                              (mm-decode-coding-string
2941                                               content body)
2942                                              charset)
2943                                        force-charset t)))
2944                            (setq charset hcharset
2945                                  eheader (mm-encode-coding-string
2946                                           (buffer-string) coding)
2947                                  title (when title
2948                                          (mm-encode-coding-string
2949                                           title coding))
2950                                  body content))
2951                        (setq eheader (mm-string-as-unibyte (buffer-string))
2952                              body content)))
2953                    (erase-buffer)
2954                    (mm-disable-multibyte)
2955                    (insert body)
2956                    (when charset
2957                      (mm-add-meta-html-tag handle charset force-charset))
2958                    (when title
2959                      (goto-char (point-min))
2960                      (unless (search-forward "<title>" nil t)
2961                        (re-search-forward "<head>\\s-*" nil t)
2962                        (insert "<title>" title "</title>\n")))
2963                    (goto-char (point-min))
2964                    (or (re-search-forward
2965                         "<body\\(?:\\s-+[^>]+\\|\\s-*\\)>\\s-*" nil t)
2966                        (re-search-forward
2967                         "</head\\(?:\\s-+[^>]+\\|\\s-*\\)>\\s-*" nil t))
2968                    (insert eheader)
2969                    (mm-write-region (point-min) (point-max)
2970                                     tmp-file nil nil nil 'binary t))))
2971               (charset
2972                (mm-with-unibyte-buffer
2973                  (insert (if (eq charset 'gnus-decoded)
2974                              (mm-encode-coding-string content
2975                                                       (setq charset 'utf-8))
2976                            content))
2977                  (if (or (mm-add-meta-html-tag handle charset)
2978                          (not file))
2979                      (mm-write-region (point-min) (point-max)
2980                                       tmp-file nil nil nil 'binary t)
2981                    (setq tmp-file nil))))
2982               (tmp-file
2983                (mm-save-part-to-file handle tmp-file)))
2984              (when tmp-file
2985                (add-to-list 'gnus-article-browse-html-temp-list tmp-file))
2986              (add-hook 'gnus-summary-prepare-exit-hook
2987                        'gnus-article-browse-delete-temp-files)
2988              (add-hook 'gnus-exit-gnus-hook
2989                        (lambda  ()
2990                          (gnus-article-browse-delete-temp-files t)))
2991              ;; FIXME: Warn if there's an <img> tag?
2992              (browse-url-of-file (or tmp-file (expand-file-name file)))
2993              (setq showed t))
2994             ;; If multipart, recurse
2995             ((equal (mm-handle-media-supertype handle) "multipart")
2996              (when (gnus-article-browse-html-parts handle header)
2997                (setq showed t)))
2998             ((equal (mm-handle-media-type handle) "message/rfc822")
2999              (mm-with-multibyte-buffer
3000                (mm-insert-part handle)
3001                (setq handle (mm-dissect-buffer t t))
3002                (when (and (bufferp (car handle))
3003                           (stringp (car (mm-handle-type handle))))
3004                  (setq handle (list handle)))
3005                (when header
3006                  (article-decode-encoded-words)
3007                  (let ((gnus-visible-headers
3008                         (or (get 'gnus-visible-headers 'standard-value)
3009                             gnus-visible-headers)))
3010                    (article-hide-headers))
3011                  (goto-char (point-min))
3012                  (search-forward "\n\n" nil 'move)
3013                  (skip-chars-backward "\t\n ")
3014                  (setq header (buffer-substring (point-min) (point)))))
3015              (when (prog1
3016                        (gnus-article-browse-html-parts handle header)
3017                      (mm-destroy-parts handle))
3018                (setq showed t)))))
3019     showed))
3020
3021 (defun gnus-article-browse-html-article (&optional arg)
3022   "View \"text/html\" parts of the current article with a WWW browser.
3023 Inline images embedded in a message using the cid scheme, as they are
3024 generally considered to be safe, will be processed properly.
3025 The message header is added to the beginning of every html part unless
3026 the prefix argument ARG is given.
3027
3028 Warning: Spammers use links to images (using the http scheme) in HTML
3029 articles to verify whether you have read the message.  As
3030 `gnus-article-browse-html-article' passes the HTML content to the
3031 browser without eliminating these \"web bugs\" you should only
3032 use it for mails from trusted senders.
3033
3034 If you always want to display HTML parts in the browser, set
3035 `mm-text-html-renderer' to nil.
3036
3037 This command creates temporary files to pass HTML contents including
3038 images if any to the browser, and deletes them when exiting the group
3039 \(if you want)."
3040   ;; Cf. `mm-w3m-safe-url-regexp'
3041   (interactive "P")
3042   (if arg
3043       (gnus-summary-show-article)
3044     (let ((gnus-visible-headers (or (get 'gnus-visible-headers 'standard-value)
3045                                     gnus-visible-headers))
3046           ;; As we insert a <hr>, there's no need for the body boundary.
3047           (gnus-treat-body-boundary nil))
3048       (gnus-summary-show-article)))
3049   (with-current-buffer gnus-article-buffer
3050     (let ((header (unless arg
3051                     (save-restriction
3052                       (widen)
3053                       (buffer-substring-no-properties
3054                        (goto-char (point-min))
3055                        (if (search-forward "\n\n" nil t)
3056                            (match-beginning 0)
3057                          (goto-char (point-max))
3058                          (skip-chars-backward "\t\n ")
3059                          (point))))))
3060           parts)
3061       (set-buffer gnus-original-article-buffer)
3062       (setq parts (mm-dissect-buffer t t))
3063       ;; If singlepart, enforce a list.
3064       (when (and (bufferp (car parts))
3065                  (stringp (car (mm-handle-type parts))))
3066         (setq parts (list parts)))
3067       ;; Process the list
3068       (unless (gnus-article-browse-html-parts parts header)
3069         (gnus-error 3 "Mail doesn't contain a \"text/html\" part!"))
3070       (mm-destroy-parts parts)
3071       (unless arg
3072         (gnus-summary-show-article)))))
3073
3074 (defun article-hide-list-identifiers ()
3075   "Remove list identifies from the Subject header.
3076 The `gnus-list-identifiers' variable specifies what to do."
3077   (interactive)
3078   (let ((inhibit-point-motion-hooks t)
3079         (regexp (or (gnus-parameter-list-identifier gnus-newsgroup-name)
3080                     (if (consp gnus-list-identifiers)
3081                         (mapconcat 'identity gnus-list-identifiers " *\\|")
3082                       gnus-list-identifiers)))
3083         (inhibit-read-only t))
3084     (when regexp
3085       (save-excursion
3086         (save-restriction
3087           (article-narrow-to-head)
3088           (goto-char (point-min))
3089           (while (re-search-forward
3090                   (concat "^Subject: +\\(R[Ee]: +\\)*\\(" regexp " *\\)")
3091                   nil t)
3092             (delete-region (match-beginning 2) (match-end 0))
3093             (beginning-of-line))
3094           (when (re-search-forward
3095                  "^Subject: +\\(\\(R[Ee]: +\\)+\\)R[Ee]: +" nil t)
3096             (delete-region (match-beginning 1) (match-end 1))))))))
3097
3098 (defun article-hide-pem (&optional arg)
3099   "Toggle hiding of any PEM headers and signatures in the current article.
3100 If given a negative prefix, always show; if given a positive prefix,
3101 always hide."
3102   (interactive (gnus-article-hidden-arg))
3103   (unless (gnus-article-check-hidden-text 'pem arg)
3104     (save-excursion
3105       (let ((inhibit-read-only t) end)
3106         (goto-char (point-min))
3107         ;; Hide the horrendously ugly "header".
3108         (when (and (search-forward
3109                     "\n-----BEGIN PRIVACY-ENHANCED MESSAGE-----\n"
3110                     nil t)
3111                    (setq end (1+ (match-beginning 0))))
3112           (gnus-add-wash-type 'pem)
3113           (gnus-article-hide-text-type
3114            end
3115            (if (search-forward "\n\n" nil t)
3116                (match-end 0)
3117              (point-max))
3118            'pem)
3119           ;; Hide the trailer as well
3120           (when (search-forward "\n-----END PRIVACY-ENHANCED MESSAGE-----\n"
3121                                 nil t)
3122             (gnus-article-hide-text-type
3123              (match-beginning 0) (match-end 0) 'pem)))))))
3124
3125 (defun article-strip-banner ()
3126   "Strip the banners specified by the `banner' group parameter and by
3127 `gnus-article-address-banner-alist'."
3128   (interactive)
3129   (save-excursion
3130     (save-restriction
3131       (let ((inhibit-point-motion-hooks t))
3132         (when (gnus-parameter-banner gnus-newsgroup-name)
3133           (article-really-strip-banner
3134            (gnus-parameter-banner gnus-newsgroup-name)))
3135         (when gnus-article-address-banner-alist
3136           ;; Note that the From header is decoded here, so it is
3137           ;; required that the *-extract-address-components function
3138           ;; supports non-ASCII text.
3139           (let ((from (save-restriction
3140                         (widen)
3141                         (article-narrow-to-head)
3142                         (mail-fetch-field "from"))))
3143             (when (and from
3144                        (setq from
3145                              (cadr (funcall gnus-extract-address-components
3146                                             from))))
3147               (catch 'found
3148                 (dolist (pair gnus-article-address-banner-alist)
3149                   (when (string-match (car pair) from)
3150                     (throw 'found
3151                            (article-really-strip-banner (cdr pair)))))))))))))
3152
3153 (defun article-really-strip-banner (banner)
3154   "Strip the banner specified by the argument."
3155   (save-excursion
3156     (save-restriction
3157       (let ((inhibit-point-motion-hooks t)
3158             (gnus-signature-limit nil)
3159             (inhibit-read-only t))
3160         (article-goto-body)
3161         (cond
3162          ((eq banner 'signature)
3163           (when (gnus-article-narrow-to-signature)
3164             (widen)
3165             (forward-line -1)
3166             (delete-region (point) (point-max))))
3167          ((symbolp banner)
3168           (if (setq banner (cdr (assq banner gnus-article-banner-alist)))
3169               (while (re-search-forward banner nil t)
3170                 (delete-region (match-beginning 0) (match-end 0)))))
3171          ((stringp banner)
3172           (while (re-search-forward banner nil t)
3173             (delete-region (match-beginning 0) (match-end 0)))))))))
3174
3175 (defun article-babel ()
3176   "Translate article using an online translation service."
3177   (interactive)
3178   (require 'babel)
3179   (gnus-with-article-buffer
3180     (when (article-goto-body)
3181       (let* ((start (point))
3182              (end (point-max))
3183              (orig (buffer-substring start end))
3184              (trans (babel-as-string orig)))
3185         (save-restriction
3186           (narrow-to-region start end)
3187           (delete-region start end)
3188           (insert trans))))))
3189
3190 (defun article-hide-signature (&optional arg)
3191   "Hide the signature in the current article.
3192 If given a negative prefix, always show; if given a positive prefix,
3193 always hide."
3194   (interactive (gnus-article-hidden-arg))
3195   (unless (gnus-article-check-hidden-text 'signature arg)
3196     (save-excursion
3197       (save-restriction
3198         (let ((inhibit-read-only t))
3199           (when (gnus-article-narrow-to-signature)
3200             (gnus-article-hide-text-type
3201              (point-min) (point-max) 'signature))))))
3202   (gnus-set-mode-line 'article))
3203
3204 (defun article-strip-headers-in-body ()
3205   "Strip offensive headers from bodies."
3206   (interactive)
3207   (save-excursion
3208     (article-goto-body)
3209     (let ((case-fold-search t))
3210       (when (looking-at "x-no-archive:")
3211         (gnus-delete-line)))))
3212
3213 (defun article-strip-leading-blank-lines ()
3214   "Remove all blank lines from the beginning of the article."
3215   (interactive)
3216   (save-excursion
3217     (let ((inhibit-point-motion-hooks t)
3218           (inhibit-read-only t))
3219       (when (article-goto-body)
3220         (while (and (not (eobp))
3221                     (looking-at "[ \t]*$"))
3222           (gnus-delete-line))))))
3223
3224 (defun article-narrow-to-head ()
3225   "Narrow the buffer to the head of the message.
3226 Point is left at the beginning of the narrowed-to region."
3227   (narrow-to-region
3228    (goto-char (point-min))
3229    (if (search-forward "\n\n" nil 1)
3230        (1- (point))
3231      (point-max)))
3232   (goto-char (point-min)))
3233
3234 (defun article-goto-body ()
3235   "Place point at the start of the body."
3236   (goto-char (point-min))
3237   (cond
3238    ;; This variable is only bound when dealing with separate
3239    ;; MIME body parts.
3240    (article-goto-body-goes-to-point-min-p
3241     t)
3242    ((search-forward "\n\n" nil t)
3243     t)
3244    (t
3245     (goto-char (point-max))
3246     nil)))
3247
3248 (defun article-strip-multiple-blank-lines ()
3249   "Replace consecutive blank lines with one empty line."
3250   (interactive)
3251   (save-excursion
3252     (let ((inhibit-point-motion-hooks t)
3253           (inhibit-read-only t))
3254       ;; First make all blank lines empty.
3255       (article-goto-body)
3256       (while (re-search-forward "^[ \t]+$" nil t)
3257         (unless (gnus-annotation-in-region-p
3258                  (match-beginning 0) (match-end 0))
3259           (replace-match "" nil t)))
3260       ;; Then replace multiple empty lines with a single empty line.
3261       (article-goto-body)
3262       (while (re-search-forward "\n\n\\(\n+\\)" nil t)
3263         (unless (gnus-annotation-in-region-p
3264                  (match-beginning 0) (match-end 0))
3265           (delete-region (match-beginning 1) (match-end 1)))))))
3266
3267 (defun article-strip-leading-space ()
3268   "Remove all white space from the beginning of the lines in the article."
3269   (interactive)
3270   (save-excursion
3271     (let ((inhibit-point-motion-hooks t)
3272           (inhibit-read-only t))
3273       (article-goto-body)
3274       (while (re-search-forward "^[ \t]+" nil t)
3275         (replace-match "" t t)))))
3276
3277 (defun article-strip-trailing-space ()
3278   "Remove all white space from the end of the lines in the article."
3279   (interactive)
3280   (save-excursion
3281     (let ((inhibit-point-motion-hooks t)
3282           (inhibit-read-only t))
3283       (article-goto-body)
3284       (while (re-search-forward "[ \t]+$" nil t)
3285         (replace-match "" t t)))))
3286
3287 (defun article-strip-blank-lines ()
3288   "Strip leading, trailing and multiple blank lines."
3289   (interactive)
3290   (article-strip-leading-blank-lines)
3291   (article-remove-trailing-blank-lines)
3292   (article-strip-multiple-blank-lines))
3293
3294 (defun article-strip-all-blank-lines ()
3295   "Strip all blank lines."
3296   (interactive)
3297   (save-excursion
3298     (let ((inhibit-point-motion-hooks t)
3299           (inhibit-read-only t))
3300       (article-goto-body)
3301       (while (re-search-forward "^[ \t]*\n" nil t)
3302         (replace-match "" t t)))))
3303
3304 (defun gnus-article-narrow-to-signature ()
3305   "Narrow to the signature; return t if a signature is found, else nil."
3306   (let ((inhibit-point-motion-hooks t))
3307     (when (gnus-article-search-signature)
3308       (forward-line 1)
3309       ;; Check whether we have some limits to what we consider
3310       ;; to be a signature.
3311       (let ((limits (if (listp gnus-signature-limit) gnus-signature-limit
3312                       (list gnus-signature-limit)))
3313             limit limited)
3314         (while (setq limit (pop limits))
3315           (if (or (and (integerp limit)
3316                        (< (- (point-max) (point)) limit))
3317                   (and (floatp limit)
3318                        (< (count-lines (point) (point-max)) limit))
3319                   (and (functionp limit)
3320                        (funcall limit))
3321                   (and (stringp limit)
3322                        (not (re-search-forward limit nil t))))
3323               ()                        ; This limit did not succeed.
3324             (setq limited t
3325                   limits nil)))
3326         (unless limited
3327           (narrow-to-region (point) (point-max))
3328           t)))))
3329
3330 (defun gnus-article-search-signature ()
3331   "Search the current buffer for the signature separator.
3332 Put point at the beginning of the signature separator."
3333   (let ((cur (point)))
3334     (goto-char (point-max))
3335     (if (if (stringp gnus-signature-separator)
3336             (re-search-backward gnus-signature-separator nil t)
3337           (let ((seps gnus-signature-separator))
3338             (while (and seps
3339                         (not (re-search-backward (car seps) nil t)))
3340               (pop seps))
3341             seps))
3342         t
3343       (goto-char cur)
3344       nil)))
3345
3346 (defun gnus-article-hidden-arg ()
3347   "Return the current prefix arg as a number, or 0 if no prefix."
3348   (list (if current-prefix-arg
3349             (prefix-numeric-value current-prefix-arg)
3350           0)))
3351
3352 (defun gnus-article-check-hidden-text (type arg)
3353   "Return nil if hiding is necessary.
3354 Arg can be nil or a number.  nil and positive means hide, negative
3355 means show, 0 means toggle."
3356   (save-excursion
3357     (save-restriction
3358       (let ((hide (gnus-article-hidden-text-p type)))
3359         (cond
3360          ((or (null arg)
3361               (> arg 0))
3362           nil)
3363          ((< arg 0)
3364           (gnus-article-show-hidden-text type)
3365           t)
3366          (t
3367           (if (eq hide 'hidden)
3368               (progn
3369                 (gnus-article-show-hidden-text type)
3370                 t)
3371             nil)))))))
3372
3373 (defun gnus-article-hidden-text-p (type)
3374   "Say whether the current buffer contains hidden text of type TYPE."
3375   (let ((pos (text-property-any (point-min) (point-max) 'article-type type)))
3376     (while (and pos
3377                 (not (get-text-property pos 'invisible))
3378                 (not (get-text-property pos 'dummy-invisible)))
3379       (setq pos
3380             (text-property-any (1+ pos) (point-max) 'article-type type)))
3381     (if pos
3382         'hidden
3383       nil)))
3384
3385 (defun gnus-article-show-hidden-text (type &optional dummy)
3386   "Show all hidden text of type TYPE.
3387 Originally it is hide instead of DUMMY."
3388   (let ((inhibit-read-only t)
3389         (inhibit-point-motion-hooks t))
3390     (gnus-remove-text-properties-when
3391      'article-type type
3392      (point-min) (point-max)
3393      (cons 'article-type (cons type
3394                                gnus-hidden-properties)))
3395     (gnus-delete-wash-type type)))
3396
3397 (defconst article-time-units
3398   `((year . ,(* 365.25 24 60 60))
3399     (week . ,(* 7 24 60 60))
3400     (day . ,(* 24 60 60))
3401     (hour . ,(* 60 60))
3402     (minute . 60)
3403     (second . 1))
3404   "Mapping from time units to seconds.")
3405
3406 (defun gnus-article-forward-header ()
3407   "Move point to the start of the next header.
3408 If the current header is a continuation header, this can be several
3409 lines forward."
3410   (let ((ended nil))
3411     (while (not ended)
3412       (forward-line 1)
3413       (if (looking-at "[ \t]+[^ \t]")
3414           (forward-line 1)
3415         (setq ended t)))))
3416
3417 (defun article-treat-date ()
3418   (article-date-ut gnus-article-date-headers t))
3419
3420 (defun article-date-ut (&optional type highlight date-position)
3421   "Convert DATE date to TYPE in the current article.
3422 The default type is `ut'.  See `gnus-article-date-headers' for
3423 possible values."
3424   (interactive (list 'ut t))
3425   (let* ((case-fold-search t)
3426          (inhibit-read-only t)
3427          (inhibit-point-motion-hooks t)
3428          (first t)
3429          (visible-date (mail-fetch-field "Date"))
3430          pos date bface eface)
3431     (save-excursion
3432       (save-restriction
3433         (goto-char (point-min))
3434         (when (re-search-forward "^Date:" nil t)
3435           (setq bface (get-text-property (point-at-bol) 'face)
3436                 eface (get-text-property (1- (point-at-eol)) 'face)))
3437         (goto-char (point-min))
3438         ;; Delete any old Date headers.
3439         (if date-position
3440             (progn
3441               (goto-char date-position)
3442               (setq date (get-text-property (point) 'original-date))
3443               (delete-region (point)
3444                              (progn
3445                                (gnus-article-forward-header)
3446                                (point)))
3447               (article-transform-date date type bface eface))
3448           (while (re-search-forward "^Date:" nil t)
3449             (setq date (get-text-property (match-beginning 0) 'original-date))
3450             (delete-region (point-at-bol) (progn
3451                                             (gnus-article-forward-header)
3452                                             (point))))
3453           (when (and (not date)
3454                      visible-date)
3455             (setq date visible-date))
3456           (when date
3457             (article-transform-date date type bface eface)))))))
3458
3459 (defun article-transform-date (date type bface eface)
3460   (dolist (this-type (cond
3461                       ((null type)
3462                        (list 'ut))
3463                       ((atom type)
3464                        (list type))
3465                       (t
3466                        type)))
3467     (insert (article-make-date-line date (or this-type 'ut)) "\n")
3468     (forward-line -1)
3469     (beginning-of-line)
3470     (put-text-property (point) (1+ (point))
3471                        'original-date date)
3472     (put-text-property (point) (1+ (point))
3473                        'gnus-date-type this-type)
3474     ;; Do highlighting.
3475     (when (looking-at "\\([^:]+\\): *\\(.*\\)$")
3476       (put-text-property (match-beginning 1) (1+ (match-end 1))
3477                          'face bface)
3478       (put-text-property (match-beginning 2) (match-end 2)
3479                          'face eface))
3480     (forward-line 1)))
3481
3482 (defun article-make-date-line (date type)
3483   "Return a DATE line of TYPE."
3484   (unless (memq type '(local ut original user-defined iso8601 lapsed english
3485                              combined-lapsed))
3486     (error "Unknown conversion type: %s" type))
3487   (condition-case ()
3488       (let ((time (ignore-errors (date-to-time date))))
3489         (cond
3490          ;; Convert to the local timezone.
3491          ((eq type 'local)
3492           (concat "Date: " (message-make-date time)))
3493          ;; Convert to Universal Time.
3494          ((eq type 'ut)
3495           (concat "Date: "
3496                   (substring
3497                    (message-make-date
3498                     (let* ((e (parse-time-string date))
3499                            (tm (apply 'encode-time e))
3500                            (ms (car tm))
3501                            (ls (- (cadr tm) (car (current-time-zone time)))))
3502                       (cond ((< ls 0) (list (1- ms) (+ ls 65536)))
3503                             ((> ls 65535) (list (1+ ms) (- ls 65536)))
3504                             (t (list ms ls)))))
3505                    0 -5)
3506                   "UT"))
3507          ;; Get the original date from the article.
3508          ((eq type 'original)
3509           (concat "Date: " (if (string-match "\n+$" date)
3510                                (substring date 0 (match-beginning 0))
3511                              date)))
3512          ;; Let the user define the format.
3513          ((eq type 'user-defined)
3514           (let ((format (or (condition-case nil
3515                                 (with-current-buffer gnus-summary-buffer
3516                                   gnus-article-time-format)
3517                               (error nil))
3518                             gnus-article-time-format)))
3519             (if (functionp format)
3520                 (funcall format time)
3521               (concat "Date: " (format-time-string format time)))))
3522          ;; ISO 8601.
3523          ((eq type 'iso8601)
3524           (let ((tz (car (current-time-zone time))))
3525             (concat
3526              "Date: "
3527              (format-time-string "%Y%m%dT%H%M%S" time)
3528              (format "%s%02d%02d"
3529                      (if (> tz 0) "+" "-") (/ (abs tz) 3600)
3530                      (/ (% (abs tz) 3600) 60)))))
3531          ;; Do a lapsed format.
3532          ((eq type 'lapsed)
3533           (concat "Date: " (article-lapsed-string time)))
3534          ;; A combined date/lapsed format.
3535          ((eq type 'combined-lapsed)
3536           (let ((date-string (article-make-date-line date 'original))
3537                 (segments 3)
3538                 lapsed-string)
3539             (while (and
3540                     time
3541                     (setq lapsed-string
3542                           (concat " (" (article-lapsed-string time segments) ")"))
3543                     (> (+ (length date-string)
3544                           (length lapsed-string))
3545                        (+ fill-column 6))
3546                     (> segments 0))
3547               (setq segments (1- segments)))
3548             (if (> segments 0)
3549                 (concat date-string lapsed-string)
3550               date-string)))
3551          ;; Display the date in proper English
3552          ((eq type 'english)
3553           (let ((dtime (decode-time time)))
3554             (concat
3555              "Date: the "
3556              (number-to-string (nth 3 dtime))
3557              (let ((digit (% (nth 3 dtime) 10)))
3558                (cond
3559                 ((memq (nth 3 dtime) '(11 12 13)) "th")
3560                 ((= digit 1) "st")
3561                 ((= digit 2) "nd")
3562                 ((= digit 3) "rd")
3563                 (t "th")))
3564              " of "
3565              (nth (1- (nth 4 dtime)) gnus-english-month-names)
3566              " "
3567              (number-to-string (nth 5 dtime))
3568              " at "
3569              (format "%02d" (nth 2 dtime))
3570              ":"
3571              (format "%02d" (nth 1 dtime)))))))
3572     (foo
3573      (format "Date: %s (from Gnus)" date))))
3574
3575 (defun article-lapsed-string (time &optional max-segments)
3576   ;; If the date is seriously mangled, the timezone functions are
3577   ;; liable to bug out, so we ignore all errors.
3578   (let* ((now (current-time))
3579          (real-time (subtract-time now time))
3580          (real-sec (and real-time
3581                         (+ (* (float (car real-time)) 65536)
3582                            (cadr real-time))))
3583          (sec (and real-time (abs real-sec)))
3584          (segments 0)
3585          num prev)
3586     (unless max-segments
3587       (setq max-segments (length article-time-units)))
3588     (cond
3589      ((null real-time)
3590       "Unknown")
3591      ((zerop sec)
3592       "Now")
3593      (t
3594       (concat
3595        ;; This is a bit convoluted, but basically we go
3596        ;; through the time units for years, weeks, etc,
3597        ;; and divide things to see whether that results
3598        ;; in positive answers.
3599        (mapconcat
3600         (lambda (unit)
3601           (if (or (zerop (setq num (ffloor (/ sec (cdr unit)))))
3602                   (>= segments max-segments))
3603               ;; The (remaining) seconds are too few to
3604               ;; be divided into this time unit.
3605               ""
3606             ;; It's big enough, so we output it.
3607             (setq sec (- sec (* num (cdr unit))))
3608             (prog1
3609                 (concat (if prev ", " "") (int-to-string
3610                                            (floor num))
3611                         " " (symbol-name (car unit))
3612                         (if (> num 1) "s" ""))
3613               (setq prev t
3614                     segments (1+ segments)))))
3615         article-time-units "")
3616        ;; If dates are odd, then it might appear like the
3617        ;; article was sent in the future.
3618        (if (> real-sec 0)
3619            " ago"
3620          " in the future"))))))
3621
3622 (defun article-date-local (&optional highlight)
3623   "Convert the current article date to the local timezone."
3624   (interactive (list t))
3625   (article-date-ut 'local highlight))
3626
3627 (defun article-date-english (&optional highlight)
3628   "Convert the current article date to something that is proper English."
3629   (interactive (list t))
3630   (article-date-ut 'english highlight))
3631
3632 (defun article-date-original (&optional highlight)
3633   "Convert the current article date to what it was originally.
3634 This is only useful if you have used some other date conversion
3635 function and want to see what the date was before converting."
3636   (interactive (list t))
3637   (article-date-ut 'original highlight))
3638
3639 (defun article-date-lapsed (&optional highlight)
3640   "Convert the current article date to time lapsed since it was sent."
3641   (interactive (list t))
3642   (article-date-ut 'lapsed highlight))
3643
3644 (defun article-date-combined-lapsed (&optional highlight)
3645   "Convert the current article date to time lapsed since it was sent."
3646   (interactive (list t))
3647   (article-date-ut 'combined-lapsed highlight))
3648
3649 (defun article-update-date-lapsed ()
3650   "Function to be run from a timer to update the lapsed time line."
3651   (save-match-data
3652     (let ((buffer (current-buffer)))
3653       (ignore-errors
3654         (walk-windows
3655          (lambda (w)
3656            (set-buffer (window-buffer w))
3657            (when (eq major-mode 'gnus-article-mode)
3658              (let ((old-line (count-lines (point-min) (point)))
3659                    (old-column (- (point) (line-beginning-position)))
3660                    (window-start
3661                     (window-start (get-buffer-window (current-buffer)))))
3662                (goto-char (point-min))
3663                (while (re-search-forward "^Date:" nil t)
3664                  (let ((type (get-text-property (match-beginning 0)
3665                                                 'gnus-date-type)))
3666                    (when (memq type '(lapsed combined-lapsed user-format))
3667                      (when (and window-start
3668                                 (not (= window-start
3669                                         (save-excursion
3670                                           (forward-line 1)
3671                                           (point)))))
3672                        (setq window-start nil))
3673                      (save-excursion
3674                        (article-date-ut type t (match-beginning 0)))
3675                      (forward-line 1)
3676                      (when window-start
3677                        (set-window-start (get-buffer-window (current-buffer))
3678                                          (point))))))
3679                (goto-char (point-min))
3680                (when (> old-column 0)
3681                  (setq old-line (1- old-line)))
3682                (forward-line old-line)
3683                (end-of-line)
3684                (when (> (current-column) old-column)
3685                  (beginning-of-line)
3686                  (forward-char old-column)))))
3687          nil 'visible))
3688       (set-buffer buffer))))
3689
3690 (defun gnus-start-date-timer (&optional n)
3691   "Start a timer to update the Date headers in the article buffers.
3692 The numerical prefix says how frequently (in seconds) the function
3693 is to run."
3694   (interactive "p")
3695   (unless n
3696     (setq n 1))
3697   (gnus-stop-date-timer)
3698   (setq article-lapsed-timer
3699         (run-at-time 1 n 'article-update-date-lapsed)))
3700
3701 (defun gnus-stop-date-timer ()
3702   "Stop the Date timer."
3703   (interactive)
3704   (when article-lapsed-timer
3705     (nnheader-cancel-timer article-lapsed-timer)
3706     (setq article-lapsed-timer nil)))
3707
3708 (defun article-date-user (&optional highlight)
3709   "Convert the current article date to the user-defined format.
3710 This format is defined by the `gnus-article-time-format' variable."
3711   (interactive (list t))
3712   (article-date-ut 'user highlight))
3713
3714 (defun article-date-iso8601 (&optional highlight)
3715   "Convert the current article date to ISO8601."
3716   (interactive (list t))
3717   (article-date-ut 'iso8601 highlight))
3718
3719 (defmacro gnus-article-save-original-date (&rest forms)
3720   "Save the original date as a text property and evaluate FORMS."
3721   `(let* ((case-fold-search t)
3722           (start (progn
3723                    (goto-char (point-min))
3724                    (when (and (re-search-forward "^date:[\t\n ]+" nil t)
3725                               (not (bolp)))
3726                      (match-end 0))))
3727           (date (when (and start
3728                            (re-search-forward "[\t ]*\n\\(?:[^\t ]\\|\\'\\)"
3729                                               nil t))
3730                   (buffer-substring-no-properties start
3731                                                   (match-beginning 0)))))
3732      (goto-char (point-max))
3733      (skip-chars-backward "\n")
3734      (put-text-property (point-min) (point) 'original-date date)
3735      ,@forms
3736      (goto-char (point-max))
3737      (skip-chars-backward "\n")
3738      (put-text-property (point-min) (point) 'original-date date)))
3739
3740 ;; (defun article-show-all ()
3741 ;;   "Show all hidden text in the article buffer."
3742 ;;   (interactive)
3743 ;;   (save-excursion
3744 ;;     (let ((inhibit-read-only t))
3745 ;;       (gnus-article-unhide-text (point-min) (point-max)))))
3746
3747 (defun article-remove-leading-whitespace ()
3748   "Remove excessive whitespace from all headers."
3749   (interactive)
3750   (save-excursion
3751     (save-restriction
3752       (let ((inhibit-read-only t))
3753         (article-narrow-to-head)
3754         (goto-char (point-min))
3755         (while (re-search-forward "^[^ :]+: \\([ \t]+\\)" nil t)
3756           (delete-region (match-beginning 1) (match-end 1)))))))
3757
3758 (defun article-emphasize (&optional arg)
3759   "Emphasize text according to `gnus-emphasis-alist'."
3760   (interactive (gnus-article-hidden-arg))
3761   (unless (gnus-article-check-hidden-text 'emphasis arg)
3762     (save-excursion
3763       (let ((alist (or
3764                     (condition-case nil
3765                         (with-current-buffer gnus-summary-buffer
3766                           gnus-article-emphasis-alist)
3767                       (error))
3768                     gnus-emphasis-alist))
3769             (inhibit-read-only t)
3770             (props (append '(article-type emphasis)
3771                            gnus-hidden-properties))
3772             regexp elem beg invisible visible face)
3773         (article-goto-body)
3774         (setq beg (point))
3775         (while (setq elem (pop alist))
3776           (goto-char beg)
3777           (setq regexp (car elem)
3778                 invisible (nth 1 elem)
3779                 visible (nth 2 elem)
3780                 face (nth 3 elem))
3781           (while (re-search-forward regexp nil t)
3782             (when (and (match-beginning visible) (match-beginning invisible))
3783               (gnus-article-hide-text
3784                (match-beginning invisible) (match-end invisible) props)
3785               (gnus-article-unhide-text-type
3786                (match-beginning visible) (match-end visible) 'emphasis)
3787               (gnus-put-overlay-excluding-newlines
3788                (match-beginning visible) (match-end visible) 'face face)
3789               (gnus-add-wash-type 'emphasis)
3790               (goto-char (match-end invisible)))))))))
3791
3792 (defun gnus-article-setup-highlight-words (&optional highlight-words)
3793   "Setup newsgroup emphasis alist."
3794   (unless gnus-article-emphasis-alist
3795     (let ((name (and gnus-newsgroup-name
3796                      (gnus-group-real-name gnus-newsgroup-name))))
3797       (make-local-variable 'gnus-article-emphasis-alist)
3798       (setq gnus-article-emphasis-alist
3799             (nconc
3800              (let ((alist gnus-group-highlight-words-alist) elem highlight)
3801                (while (setq elem (pop alist))
3802                  (when (and name (string-match (car elem) name))
3803                    (setq alist nil
3804                          highlight (copy-sequence (cdr elem)))))
3805                highlight)
3806              (copy-sequence highlight-words)
3807              (if gnus-newsgroup-name
3808                  (copy-sequence (gnus-group-find-parameter
3809                                  gnus-newsgroup-name 'highlight-words t)))
3810              gnus-emphasis-alist)))))
3811
3812 (defvar gnus-summary-article-menu)
3813 (defvar gnus-summary-post-menu)
3814
3815 ;;; Saving functions.
3816
3817 (defun gnus-article-save (save-buffer file &optional num)
3818   "Save the currently selected article."
3819   (when (or (get gnus-default-article-saver :headers)
3820             (not gnus-save-all-headers))
3821     ;; Remove headers according to `gnus-saved-headers' or the value
3822     ;; of the `:headers' property that the saver function might have.
3823     (let ((gnus-visible-headers
3824            (or (symbol-value (get gnus-default-article-saver :headers))
3825                gnus-saved-headers gnus-visible-headers))
3826           ;; Ignore group parameter.  See `article-hide-headers'.
3827           (gnus-summary-buffer nil))
3828       (with-current-buffer save-buffer
3829         (article-hide-headers 1 t))))
3830   (save-window-excursion
3831     (if (not gnus-default-article-saver)
3832         (error "No default saver is defined")
3833       ;; !!! Magic!  The saving functions all save
3834       ;; `gnus-save-article-buffer' (or so they think), but we
3835       ;; bind that variable to our save-buffer.
3836       (set-buffer gnus-article-buffer)
3837       (let* ((gnus-save-article-buffer save-buffer)
3838              (filename
3839               (cond
3840                ((not gnus-prompt-before-saving) 'default)
3841                ((eq gnus-prompt-before-saving 'always) nil)
3842                (t file)))
3843              (gnus-number-of-articles-to-be-saved
3844               (when (eq gnus-prompt-before-saving t)
3845                 num)))                  ; Magic
3846         (set-buffer gnus-article-current-summary)
3847         (funcall gnus-default-article-saver filename)))))
3848
3849 (defun gnus-read-save-file-name (prompt &optional filename
3850                                         function group headers variable
3851                                         dir-var)
3852   (let ((default-name
3853           (funcall function group headers (symbol-value variable)))
3854         result)
3855     (setq result
3856           (expand-file-name
3857            (cond
3858             ((eq filename 'default)
3859              default-name)
3860             ((eq filename t)
3861              default-name)
3862             (filename filename)
3863             (t
3864              (when (symbol-value dir-var)
3865                (setq default-name (expand-file-name
3866                                    (file-name-nondirectory default-name)
3867                                    (symbol-value dir-var))))
3868              (let* ((split-name (gnus-get-split-value gnus-split-methods))
3869                     (prompt
3870                      (format prompt
3871                              (if (and gnus-number-of-articles-to-be-saved
3872                                       (> gnus-number-of-articles-to-be-saved 1))
3873                                  (format "these %d articles"
3874                                          gnus-number-of-articles-to-be-saved)
3875                                "this article")))
3876                     (file
3877                      ;; Let the split methods have their say.
3878                      (cond
3879                       ;; No split name was found.
3880                       ((null split-name)
3881                        (read-file-name
3882                         (concat prompt " (default "
3883                                 (file-name-nondirectory default-name) "): ")
3884                         (file-name-directory default-name)
3885                         default-name))
3886                       ;; A single group name is returned.
3887                       ((stringp split-name)
3888                        (setq default-name
3889                              (funcall function split-name headers
3890                                       (symbol-value variable)))
3891                        (read-file-name
3892                         (concat prompt " (default "
3893                                 (file-name-nondirectory default-name) "): ")
3894                         (file-name-directory default-name)
3895                         default-name))
3896                       ;; A single split name was found
3897                       ((= 1 (length split-name))
3898                        (let* ((name (expand-file-name
3899                                      (car split-name)
3900                                      gnus-article-save-directory))
3901                               (dir (cond ((file-directory-p name)
3902                                           (file-name-as-directory name))
3903                                          ((file-exists-p name) name)
3904                                          (t gnus-article-save-directory))))
3905                          (read-file-name
3906                           (concat prompt " (default " name "): ")
3907                           dir name)))
3908                       ;; A list of splits was found.
3909                       (t
3910                        (setq split-name (nreverse split-name))
3911                        (let (result)
3912                          (let ((file-name-history
3913                                 (nconc split-name file-name-history)))
3914                            (setq result
3915                                  (expand-file-name
3916                                   (read-file-name
3917                                    (concat prompt " (`M-p' for defaults): ")
3918                                    gnus-article-save-directory
3919                                    (car split-name))
3920                                   gnus-article-save-directory)))
3921                          (car (push result file-name-history)))))))
3922                ;; Create the directory.
3923                (gnus-make-directory (file-name-directory file))
3924                ;; If we have read a directory, we append the default file name.
3925                (when (file-directory-p file)
3926                  (setq file (expand-file-name (file-name-nondirectory
3927                                                default-name)
3928                                               (file-name-as-directory file))))
3929                ;; Possibly translate some characters.
3930                (nnheader-translate-file-chars file))))))
3931     (gnus-make-directory (file-name-directory result))
3932     (when variable
3933       (set variable result))
3934     (when dir-var
3935       (set dir-var (file-name-directory result)))
3936     result))
3937
3938 (defun gnus-article-archive-name (group)
3939   "Return the first instance of an \"Archive-name\" in the current buffer."
3940   (let ((case-fold-search t))
3941     (when (re-search-forward "archive-name: *\\([^ \n\t]+\\)[ \t]*$" nil t)
3942       (nnheader-concat gnus-article-save-directory
3943                        (match-string 1)))))
3944
3945 (defun gnus-article-nndoc-name (group)
3946   "If GROUP is an nndoc group, return the name of the parent group."
3947   (when (eq (car (gnus-find-method-for-group group)) 'nndoc)
3948     (gnus-group-get-parameter group 'save-article-group)))
3949
3950 (defun gnus-summary-save-in-rmail (&optional filename)
3951   "Append this article to Rmail file.
3952 Optional argument FILENAME specifies file name.
3953 Directory to save to is default to `gnus-article-save-directory'."
3954   (setq filename (gnus-read-save-file-name
3955                   "Save %s in rmail file" filename
3956                   gnus-rmail-save-name gnus-newsgroup-name
3957                   gnus-current-headers 'gnus-newsgroup-last-rmail))
3958   (with-current-buffer gnus-save-article-buffer
3959     (save-excursion
3960       (save-restriction
3961         (widen)
3962         ;; Note that unlike gnus-summary-save-in-mail, there is no
3963         ;; check to see if filename is Babyl.  Rmail in Emacs 23 does
3964         ;; not use Babyl.
3965         (gnus-output-to-rmail filename))))
3966   filename)
3967
3968 (defun gnus-summary-save-in-mail (&optional filename)
3969   "Append this article to Unix mail file.
3970 Optional argument FILENAME specifies file name.
3971 Directory to save to is default to `gnus-article-save-directory'."
3972   (setq filename (gnus-read-save-file-name
3973                   "Save %s in Unix mail file" filename
3974                   gnus-mail-save-name gnus-newsgroup-name
3975                   gnus-current-headers 'gnus-newsgroup-last-mail))
3976   (with-current-buffer gnus-save-article-buffer
3977     (save-excursion
3978       (save-restriction
3979         (widen)
3980         (if (and (file-readable-p filename)
3981                  (file-regular-p filename)
3982                  (mail-file-babyl-p filename))
3983             (gnus-output-to-rmail filename)
3984           (gnus-output-to-mail filename)))))
3985   filename)
3986
3987 (put 'gnus-summary-save-in-file :decode t)
3988 (put 'gnus-summary-save-in-file :headers 'gnus-saved-headers)
3989 (defun gnus-summary-save-in-file (&optional filename overwrite)
3990   "Append this article to file.
3991 Optional argument FILENAME specifies file name.
3992 Directory to save to is default to `gnus-article-save-directory'."
3993   (setq filename (gnus-read-save-file-name
3994                   "Save %s in file" filename
3995                   gnus-file-save-name gnus-newsgroup-name
3996                   gnus-current-headers 'gnus-newsgroup-last-file))
3997   (with-current-buffer gnus-save-article-buffer
3998     (save-excursion
3999       (save-restriction
4000         (widen)
4001         (when (and overwrite
4002                    (file-exists-p filename))
4003           (delete-file filename))
4004         (gnus-output-to-file filename))))
4005   filename)
4006
4007 (put 'gnus-summary-write-to-file :decode t)
4008 (put 'gnus-summary-write-to-file :function 'gnus-summary-save-in-file)
4009 (put 'gnus-summary-write-to-file :headers 'gnus-saved-headers)
4010 (defun gnus-summary-write-to-file (&optional filename)
4011   "Write this article to a file, overwriting it if the file exists.
4012 Optional argument FILENAME specifies file name.
4013 The directory to save in defaults to `gnus-article-save-directory'."
4014   (setq filename (gnus-read-save-file-name
4015                   "Save %s in file" filename
4016                   gnus-file-save-name gnus-newsgroup-name
4017                   gnus-current-headers nil 'gnus-newsgroup-last-directory))
4018   (gnus-summary-save-in-file filename t))
4019
4020 (put 'gnus-summary-save-body-in-file :decode t)
4021 (defun gnus-summary-save-body-in-file (&optional filename overwrite)
4022   "Append this article body to a file.
4023 Optional argument FILENAME specifies file name.
4024 The directory to save in defaults to `gnus-article-save-directory'."
4025   (setq filename (gnus-read-save-file-name
4026                   "Save %s body in file" filename
4027                   gnus-file-save-name gnus-newsgroup-name
4028                   gnus-current-headers 'gnus-newsgroup-last-file))
4029   (with-current-buffer gnus-save-article-buffer
4030     (save-excursion
4031       (save-restriction
4032         (widen)
4033         (when (article-goto-body)
4034           (narrow-to-region (point) (point-max)))
4035         (when (and overwrite
4036                    (file-exists-p filename))
4037           (delete-file filename))
4038         (gnus-output-to-file filename))))
4039   filename)
4040
4041 (put 'gnus-summary-write-body-to-file :decode t)
4042 (put 'gnus-summary-write-body-to-file
4043      :function 'gnus-summary-save-body-in-file)
4044 (defun gnus-summary-write-body-to-file (&optional filename)
4045   "Write this article body to a file, overwriting it if the file exists.
4046 Optional argument FILENAME specifies file name.
4047 The directory to save in defaults to `gnus-article-save-directory'."
4048   (setq filename (gnus-read-save-file-name
4049                   "Save %s body in file" filename
4050                   gnus-file-save-name gnus-newsgroup-name
4051                   gnus-current-headers nil 'gnus-newsgroup-last-directory))
4052   (gnus-summary-save-body-in-file filename t))
4053
4054 (put 'gnus-summary-save-in-pipe :decode t)
4055 (put 'gnus-summary-save-in-pipe :headers 'gnus-saved-headers)
4056 (defun gnus-summary-save-in-pipe (&optional command raw)
4057   "Pipe this article to subprocess COMMAND.
4058 Valid values for COMMAND include:
4059   a string
4060     The executable command name and possibly arguments.
4061   nil
4062     You will be prompted for the command in the minibuffer.
4063   the symbol `default'
4064     It will be replaced with the command which the variable
4065     `gnus-summary-pipe-output-default-command' holds or the command
4066     last used for saving.
4067 Non-nil value for RAW overrides `:decode' and `:headers' properties
4068 and the raw article including all headers will be piped."
4069   (let ((article (gnus-summary-article-number))
4070         (decode (unless raw
4071                   (get 'gnus-summary-save-in-pipe :decode)))
4072         save-buffer default)
4073     (if article
4074         (if (vectorp (gnus-summary-article-header article))
4075             (save-current-buffer
4076               (gnus-summary-select-article decode decode nil article)
4077               (insert-buffer-substring
4078                (prog1
4079                    (if decode
4080                        gnus-article-buffer
4081                      gnus-original-article-buffer)
4082                  (setq save-buffer
4083                        (nnheader-set-temp-buffer " *Gnus Save*"))))
4084               ;; Remove unwanted headers.
4085               (when (and (not raw)
4086                          (or (get 'gnus-summary-save-in-pipe :headers)
4087                              (not gnus-save-all-headers)))
4088                 (let ((gnus-visible-headers
4089                        (or (symbol-value (get 'gnus-summary-save-in-pipe
4090                                               :headers))
4091                            gnus-saved-headers gnus-visible-headers))
4092                       (gnus-summary-buffer nil))
4093                   (article-hide-headers 1 t))))
4094           (error "%d is not a real article" article))
4095       (error "No article to pipe"))
4096     (setq default (or gnus-summary-pipe-output-default-command
4097                       gnus-last-shell-command))
4098     (unless (stringp command)
4099       (setq command
4100             (if (and (eq command 'default) default)
4101                 default
4102               (gnus-read-shell-command "Shell command on this article: "
4103                                        default))))
4104     (when (string-equal command "")
4105       (if default
4106           (setq command default)
4107         (error "A command is required")))
4108     (with-current-buffer save-buffer
4109       (save-restriction
4110         (widen)
4111         (shell-command-on-region (point-min) (point-max) command nil)))
4112     (gnus-kill-buffer save-buffer))
4113   (setq gnus-summary-pipe-output-default-command command))
4114
4115 (defun gnus-summary-pipe-to-muttprint (&optional command)
4116   "Pipe this article to muttprint."
4117   (unless (stringp command)
4118     (setq command (read-string
4119                    "Print using command: " gnus-summary-muttprint-program
4120                    nil gnus-summary-muttprint-program)))
4121   (let ((gnus-summary-pipe-output-default-command
4122          gnus-summary-pipe-output-default-command))
4123     (gnus-summary-save-in-pipe command))
4124   (setq gnus-summary-muttprint-program command))
4125
4126 ;;; Article file names when saving.
4127
4128 (defun gnus-capitalize-newsgroup (newsgroup)
4129   "Capitalize NEWSGROUP name."
4130   (when (not (zerop (length newsgroup)))
4131     (concat (char-to-string (upcase (aref newsgroup 0)))
4132             (substring newsgroup 1))))
4133
4134 (defun gnus-Numeric-save-name (newsgroup headers &optional last-file)
4135   "Generate file name from NEWSGROUP, HEADERS, and optional LAST-FILE.
4136 If variable `gnus-use-long-file-name' is non-nil, it is ~/News/News.group/num.
4137 Otherwise, it is like ~/News/news/group/num."
4138   (let ((default
4139           (expand-file-name
4140            (concat (if (gnus-use-long-file-name 'not-save)
4141                        (gnus-capitalize-newsgroup newsgroup)
4142                      (gnus-newsgroup-directory-form newsgroup))
4143                    "/" (int-to-string (mail-header-number headers)))
4144            gnus-article-save-directory)))
4145     (if (and last-file
4146              (string-equal (file-name-directory default)
4147                            (file-name-directory last-file))
4148              (string-match "^[0-9]+$" (file-name-nondirectory last-file)))
4149         default
4150       (or last-file default))))
4151
4152 (defun gnus-numeric-save-name (newsgroup headers &optional last-file)
4153   "Generate file name from NEWSGROUP, HEADERS, and optional LAST-FILE.
4154 If variable `gnus-use-long-file-name' is non-nil, it is
4155 ~/News/news.group/num.  Otherwise, it is like ~/News/news/group/num."
4156   (let ((default
4157           (expand-file-name
4158            (concat (if (gnus-use-long-file-name 'not-save)
4159                        newsgroup
4160                      (gnus-newsgroup-directory-form newsgroup))
4161                    "/" (int-to-string (mail-header-number headers)))
4162            gnus-article-save-directory)))
4163     (if (and last-file
4164              (string-equal (file-name-directory default)
4165                            (file-name-directory last-file))
4166              (string-match "^[0-9]+$" (file-name-nondirectory last-file)))
4167         default
4168       (or last-file default))))
4169
4170 (defun gnus-plain-save-name (newsgroup headers &optional last-file)
4171   "Generate file name from NEWSGROUP, HEADERS, and optional LAST-FILE.
4172 If variable `gnus-use-long-file-name' is non-nil, it is
4173 ~/News/news.group.  Otherwise, it is like ~/News/news/group/news."
4174   (or last-file
4175       (expand-file-name
4176        (if (gnus-use-long-file-name 'not-save)
4177            newsgroup
4178          (file-relative-name
4179           (expand-file-name "news" (gnus-newsgroup-directory-form newsgroup))
4180           default-directory))
4181        gnus-article-save-directory)))
4182
4183 (defun gnus-sender-save-name (newsgroup headers &optional last-file)
4184   "Generate file name from sender."
4185   (let ((from (mail-header-from headers)))
4186     (expand-file-name
4187      (if (and from (string-match "\\([^ <]+\\)@" from))
4188          (match-string 1 from)
4189        "nobody")
4190      gnus-article-save-directory)))
4191
4192 (defun article-verify-x-pgp-sig ()
4193   "Verify X-PGP-Sig."
4194   ;; <ftp://ftp.isc.org/pub/pgpcontrol/FORMAT>
4195   (interactive)
4196   (if (gnus-buffer-live-p gnus-original-article-buffer)
4197       (let ((sig (with-current-buffer gnus-original-article-buffer
4198                    (gnus-fetch-field "X-PGP-Sig")))
4199             items info headers)
4200         (when (and sig
4201                    mml2015-use
4202                    (mml2015-clear-verify-function))
4203           (with-temp-buffer
4204             (insert-buffer-substring gnus-original-article-buffer)
4205             (setq items (split-string sig))
4206             (message-narrow-to-head)
4207             (let ((inhibit-point-motion-hooks t)
4208                   (case-fold-search t))
4209               ;; Don't verify multiple headers.
4210               (setq headers (mapconcat (lambda (header)
4211                                          (concat header ": "
4212                                                  (mail-fetch-field header)
4213                                                  "\n"))
4214                                        (split-string (nth 1 items) ",") "")))
4215             (delete-region (point-min) (point-max))
4216             (insert "-----BEGIN PGP SIGNED MESSAGE-----\n\n")
4217             (insert "X-Signed-Headers: " (nth 1 items) "\n")
4218             (insert headers)
4219             (widen)
4220             (forward-line)
4221             (while (not (eobp))
4222               (if (looking-at "^-")
4223                   (insert "- "))
4224               (forward-line))
4225             (insert "\n-----BEGIN PGP SIGNATURE-----\n")
4226             (insert "Version: " (car items) "\n\n")
4227             (insert (mapconcat 'identity (cddr items) "\n"))
4228             (insert "\n-----END PGP SIGNATURE-----\n")
4229             (let ((mm-security-handle (list (format "multipart/signed"))))
4230               (mml2015-clean-buffer)
4231               (let ((coding-system-for-write (or gnus-newsgroup-charset
4232                                                  'iso-8859-1)))
4233                 (funcall (mml2015-clear-verify-function)))
4234               (setq info
4235                     (or (mm-handle-multipart-ctl-parameter
4236                          mm-security-handle 'gnus-details)
4237                         (mm-handle-multipart-ctl-parameter
4238                          mm-security-handle 'gnus-info)))))
4239           (when info
4240             (let ((inhibit-read-only t) bface eface)
4241               (save-restriction
4242                 (message-narrow-to-head)
4243                 (goto-char (point-max))
4244                 (forward-line -1)
4245                 (setq bface (get-text-property (point-at-bol) 'face)
4246                       eface (get-text-property (1- (point-at-eol)) 'face))
4247                 (message-remove-header "X-Gnus-PGP-Verify")
4248                 (if (re-search-forward "^X-PGP-Sig:" nil t)
4249                     (forward-line)
4250                   (goto-char (point-max)))
4251                 (narrow-to-region (point) (point))
4252                 (insert "X-Gnus-PGP-Verify: " info "\n")
4253                 (goto-char (point-min))
4254                 (forward-line)
4255                 (while (not (eobp))
4256                   (if (not (looking-at "^[ \t]"))
4257                       (insert " "))
4258                   (forward-line))
4259                 ;; Do highlighting.
4260                 (goto-char (point-min))
4261                 (when (looking-at "\\([^:]+\\): *")
4262                   (put-text-property (match-beginning 1) (1+ (match-end 1))
4263                                      'face bface)
4264                   (put-text-property (match-end 0) (point-max)
4265                                      'face eface)))))))))
4266
4267 (autoload 'canlock-verify "canlock" nil t) ;; for XEmacs.
4268
4269 (defun article-verify-cancel-lock ()
4270   "Verify Cancel-Lock header."
4271   (interactive)
4272   (if (gnus-buffer-live-p gnus-original-article-buffer)
4273       (canlock-verify gnus-original-article-buffer)))
4274
4275 (eval-and-compile
4276   (mapc
4277    (lambda (func)
4278      (let (afunc gfunc)
4279        (if (consp func)
4280            (setq afunc (car func)
4281                  gfunc (cdr func))
4282          (setq afunc func
4283                gfunc (intern (format "gnus-%s" func))))
4284        (defalias gfunc
4285          (when (fboundp afunc)
4286            `(lambda (&optional interactive &rest args)
4287               ,(documentation afunc t)
4288               (interactive (list t))
4289               (with-current-buffer gnus-article-buffer
4290                 (if interactive
4291                     (call-interactively ',afunc)
4292                   (apply ',afunc args))))))))
4293    '(article-hide-headers
4294      article-verify-x-pgp-sig
4295      article-verify-cancel-lock
4296      article-hide-boring-headers
4297      article-treat-overstrike
4298      article-treat-ansi-sequences
4299      article-fill-long-lines
4300      article-capitalize-sentences
4301      article-remove-cr
4302      article-remove-leading-whitespace
4303      article-display-x-face
4304      article-display-face
4305      article-de-quoted-unreadable
4306      article-de-base64-unreadable
4307      article-decode-HZ
4308      article-wash-html
4309      article-unsplit-urls
4310      article-hide-list-identifiers
4311      article-strip-banner
4312      article-babel
4313      article-hide-pem
4314      article-hide-signature
4315      article-strip-headers-in-body
4316      article-remove-trailing-blank-lines
4317      article-strip-leading-blank-lines
4318      article-strip-multiple-blank-lines
4319      article-strip-leading-space
4320      article-strip-trailing-space
4321      article-strip-blank-lines
4322      article-strip-all-blank-lines
4323      article-date-local
4324      article-date-english
4325      article-date-iso8601
4326      article-date-original
4327      article-treat-date
4328      article-date-ut
4329      article-decode-mime-words
4330      article-decode-charset
4331      article-decode-encoded-words
4332      article-date-user
4333      article-date-lapsed
4334      article-date-combined-lapsed
4335      article-emphasize
4336      article-treat-dumbquotes
4337      article-treat-non-ascii
4338      article-normalize-headers
4339      ;;(article-show-all . gnus-article-show-all-headers)
4340      )))
4341 \f
4342 ;;;
4343 ;;; Gnus article mode
4344 ;;;
4345
4346 (put 'gnus-article-mode 'mode-class 'special)
4347
4348 (set-keymap-parent gnus-article-mode-map widget-keymap)
4349
4350 (gnus-define-keys gnus-article-mode-map
4351   " " gnus-article-goto-next-page
4352   "\177" gnus-article-goto-prev-page
4353   [delete] gnus-article-goto-prev-page
4354   [backspace] gnus-article-goto-prev-page
4355   "\C-c^" gnus-article-refer-article
4356   "h" gnus-article-show-summary
4357   "s" gnus-article-show-summary
4358   "\C-c\C-m" gnus-article-mail
4359   "?" gnus-article-describe-briefly
4360   "<" beginning-of-buffer
4361   ">" end-of-buffer
4362   "\C-c\C-i" gnus-info-find-node
4363   "\C-c\C-b" gnus-bug
4364   "R" gnus-article-reply-with-original
4365   "F" gnus-article-followup-with-original
4366   "\C-hk" gnus-article-describe-key
4367   "\C-hc" gnus-article-describe-key-briefly
4368   "\C-hb" gnus-article-describe-bindings
4369
4370   "e" gnus-article-read-summary-keys
4371   "\C-d" gnus-article-read-summary-keys
4372   "\M-*" gnus-article-read-summary-keys
4373   "\M-#" gnus-article-read-summary-keys
4374   "\M-^" gnus-article-read-summary-keys
4375   "\M-g" gnus-article-read-summary-keys)
4376
4377 (substitute-key-definition
4378  'undefined 'gnus-article-read-summary-keys gnus-article-mode-map)
4379
4380 (gnus-define-keys (gnus-article-send-map "S" gnus-article-mode-map)
4381   "W" gnus-article-wide-reply-with-original)
4382 (if (featurep 'xemacs)
4383     (set-keymap-default-binding gnus-article-send-map
4384                                 'gnus-article-read-summary-send-keys)
4385   (define-key gnus-article-send-map [t] 'gnus-article-read-summary-send-keys))
4386
4387 (defun gnus-article-make-menu-bar ()
4388   (unless (boundp 'gnus-article-commands-menu)
4389     (gnus-summary-make-menu-bar))
4390   (unless (boundp 'gnus-article-article-menu)
4391     (easy-menu-define
4392      gnus-article-article-menu gnus-article-mode-map ""
4393      '("Article"
4394        ["Scroll forwards" gnus-article-goto-next-page t]
4395        ["Scroll backwards" gnus-article-goto-prev-page t]
4396        ["Show summary" gnus-article-show-summary t]
4397        ["Fetch Message-ID at point" gnus-article-refer-article t]
4398        ["Mail to address at point" gnus-article-mail t]
4399        ["Send a bug report" gnus-bug t]))
4400
4401     (easy-menu-define
4402      gnus-article-treatment-menu gnus-article-mode-map ""
4403      ;; Fixme: this should use :active (and maybe :visible).
4404      '("Treatment"
4405        ["Hide headers" gnus-article-hide-headers t]
4406        ["Hide signature" gnus-article-hide-signature t]
4407        ["Hide citation" gnus-article-hide-citation t]
4408        ["Treat overstrike" gnus-article-treat-overstrike t]
4409        ["Treat ANSI sequences" gnus-article-treat-ansi-sequences t]
4410        ["Remove carriage return" gnus-article-remove-cr t]
4411        ["Remove leading whitespace" gnus-article-remove-leading-whitespace t]
4412        ["Remove quoted-unreadable" gnus-article-de-quoted-unreadable t]
4413        ["Remove base64" gnus-article-de-base64-unreadable t]
4414        ["Treat html" gnus-article-wash-html t]
4415        ["Remove newlines from within URLs" gnus-article-unsplit-urls t]
4416        ["Decode HZ" gnus-article-decode-HZ t]))
4417
4418     ;; Note "Commands" menu is defined in gnus-sum.el for consistency
4419
4420     ;; Note "Post" menu is defined in gnus-sum.el for consistency
4421
4422     (gnus-run-hooks 'gnus-article-menu-hook)))
4423
4424 (defvar bookmark-make-record-function)
4425
4426 (defun gnus-article-mode ()
4427   "Major mode for displaying an article.
4428
4429 All normal editing commands are switched off.
4430
4431 The following commands are available in addition to all summary mode
4432 commands:
4433 \\<gnus-article-mode-map>
4434 \\[gnus-article-next-page]\t Scroll the article one page forwards
4435 \\[gnus-article-prev-page]\t Scroll the article one page backwards
4436 \\[gnus-article-refer-article]\t Go to the article referred to by an article id near point
4437 \\[gnus-article-show-summary]\t Display the summary buffer
4438 \\[gnus-article-mail]\t Send a reply to the address near point
4439 \\[gnus-article-describe-briefly]\t Describe the current mode briefly
4440 \\[gnus-info-find-node]\t Go to the Gnus info node"
4441   (interactive)
4442   (kill-all-local-variables)
4443   (gnus-simplify-mode-line)
4444   (setq mode-name "Article")
4445   (setq major-mode 'gnus-article-mode)
4446   (make-local-variable 'minor-mode-alist)
4447   (use-local-map gnus-article-mode-map)
4448   (when (gnus-visual-p 'article-menu 'menu)
4449     (gnus-article-make-menu-bar)
4450     (when gnus-summary-tool-bar-map
4451       (set (make-local-variable 'tool-bar-map) gnus-summary-tool-bar-map)))
4452   (gnus-update-format-specifications nil 'article-mode)
4453   (set (make-local-variable 'page-delimiter) gnus-page-delimiter)
4454   (set (make-local-variable 'gnus-page-broken) nil)
4455   (make-local-variable 'gnus-article-current-summary)
4456   (make-local-variable 'gnus-article-mime-handles)
4457   (make-local-variable 'gnus-article-decoded-p)
4458   (make-local-variable 'gnus-article-mime-handle-alist)
4459   (make-local-variable 'gnus-article-wash-types)
4460   (make-local-variable 'gnus-article-image-alist)
4461   (make-local-variable 'gnus-article-charset)
4462   (make-local-variable 'gnus-article-ignored-charsets)
4463   (set (make-local-variable 'bookmark-make-record-function)
4464        'gnus-summary-bookmark-make-record)
4465   ;; Prevent Emacs 22 from displaying non-break space with `nobreak-space'
4466   ;; face.
4467   (set (make-local-variable 'nobreak-char-display) nil)
4468   (setq cursor-in-non-selected-windows nil)
4469   (gnus-set-default-directory)
4470   (buffer-disable-undo)
4471   (setq buffer-read-only t
4472         show-trailing-whitespace nil)
4473   (set-syntax-table gnus-article-mode-syntax-table)
4474   (mm-enable-multibyte)
4475   (gnus-run-mode-hooks 'gnus-article-mode-hook))
4476
4477 (defun gnus-article-setup-buffer ()
4478   "Initialize the article buffer."
4479   (let* ((name (if gnus-single-article-buffer "*Article*"
4480                  (concat "*Article " gnus-newsgroup-name "*")))
4481          (original
4482           (progn (string-match "\\*Article" name)
4483                  (concat " *Original Article"
4484                          (substring name (match-end 0))))))
4485     (setq gnus-article-buffer name)
4486     (setq gnus-original-article-buffer original)
4487     (setq gnus-article-mime-handle-alist nil)
4488     (with-current-buffer gnus-summary-buffer
4489       ;; This might be a variable local to the summary buffer.
4490       (unless gnus-single-article-buffer
4491         (setq gnus-article-buffer name)
4492         (setq gnus-original-article-buffer original)
4493         (gnus-set-global-variables)))
4494     (gnus-article-setup-highlight-words)
4495     ;; Init original article buffer.
4496     (with-current-buffer (gnus-get-buffer-create gnus-original-article-buffer)
4497       (mm-enable-multibyte)
4498       (setq major-mode 'gnus-original-article-mode)
4499       (make-local-variable 'gnus-original-article))
4500     (if (and (get-buffer name)
4501              (with-current-buffer name
4502                (if gnus-article-edit-mode
4503                    (if (y-or-n-p "Article mode edit in progress; discard? ")
4504                        (progn
4505                          (set-buffer-modified-p nil)
4506                          (gnus-kill-buffer name)
4507                          (message "")
4508                          nil)
4509                      (error "Action aborted"))
4510                  t)))
4511         (with-current-buffer name
4512           (set (make-local-variable 'gnus-article-edit-mode) nil)
4513           (when gnus-article-mime-handles
4514             (mm-destroy-parts gnus-article-mime-handles)
4515             (setq gnus-article-mime-handles nil))
4516           ;; Set it to nil in article-buffer!
4517           (setq gnus-article-mime-handle-alist nil)
4518           (buffer-disable-undo)
4519           (setq buffer-read-only t)
4520           (unless (eq major-mode 'gnus-article-mode)
4521             (gnus-article-mode))
4522           (setq truncate-lines gnus-article-truncate-lines)
4523           (current-buffer))
4524       (with-current-buffer (gnus-get-buffer-create name)
4525         (gnus-article-mode)
4526         (setq truncate-lines gnus-article-truncate-lines)
4527         (make-local-variable 'gnus-summary-buffer)
4528         (setq gnus-summary-buffer
4529               (gnus-summary-buffer-name gnus-newsgroup-name))
4530         (gnus-summary-set-local-parameters gnus-newsgroup-name)
4531         (when article-lapsed-timer
4532           (gnus-stop-date-timer))
4533         (when gnus-article-update-date-headers
4534           (gnus-start-date-timer gnus-article-update-date-headers))
4535         (current-buffer)))))
4536
4537 ;; Set article window start at LINE, where LINE is the number of lines
4538 ;; from the head of the article.
4539 (defun gnus-article-set-window-start (&optional line)
4540   (let ((article-window (gnus-get-buffer-window gnus-article-buffer t)))
4541     (when article-window
4542       (set-window-start
4543        article-window
4544        (with-current-buffer gnus-article-buffer
4545          (goto-char (point-min))
4546          (if (not line)
4547              (point-min)
4548            (gnus-message 6 "Moved to bookmark")
4549            (search-forward "\n\n" nil t)
4550            (forward-line line)
4551            (point)))))))
4552
4553 (defun gnus-article-prepare (article &optional all-headers header)
4554   "Prepare ARTICLE in article mode buffer.
4555 ARTICLE should either be an article number or a Message-ID.
4556 If ARTICLE is an id, HEADER should be the article headers.
4557 If ALL-HEADERS is non-nil, no headers are hidden."
4558   (save-excursion
4559     ;; Make sure we start in a summary buffer.
4560     (unless (eq major-mode 'gnus-summary-mode)
4561       (set-buffer gnus-summary-buffer))
4562     (setq gnus-summary-buffer (current-buffer))
4563     (let* ((gnus-article (if header (mail-header-number header) article))
4564            (summary-buffer (current-buffer))
4565            (gnus-tmp-internal-hook gnus-article-internal-prepare-hook)
4566            (group gnus-newsgroup-name)
4567            result)
4568       (save-excursion
4569         (gnus-article-setup-buffer)
4570         (set-buffer gnus-article-buffer)
4571         ;; Deactivate active regions.
4572         (when (and (boundp 'transient-mark-mode)
4573                    transient-mark-mode)
4574           (setq mark-active nil))
4575         (if (not (setq result (let ((inhibit-read-only t))
4576                                 (gnus-request-article-this-buffer
4577                                  article group))))
4578             ;; There is no such article.
4579             (save-excursion
4580               (when (and (numberp article)
4581                          (not (memq article gnus-newsgroup-sparse)))
4582                 (setq gnus-article-current
4583                       (cons gnus-newsgroup-name article))
4584                 (set-buffer gnus-summary-buffer)
4585                 (setq gnus-current-article article)
4586                 (if (and (memq article gnus-newsgroup-undownloaded)
4587                          (not (gnus-online (gnus-find-method-for-group
4588                                             gnus-newsgroup-name))))
4589                     (progn
4590                       (gnus-summary-set-agent-mark article)
4591                       (message "Message marked for downloading"))
4592                   (gnus-summary-mark-article article gnus-canceled-mark)
4593                   (unless (memq article gnus-newsgroup-sparse)
4594                     (gnus-error 1 "No such article (may have expired or been canceled)")))))
4595           (if (or (eq result 'pseudo)
4596                   (eq result 'nneething))
4597               (progn
4598                 (with-current-buffer summary-buffer
4599                   (push article gnus-newsgroup-history)
4600                   (setq gnus-last-article gnus-current-article
4601                         gnus-current-article 0
4602                         gnus-current-headers nil
4603                         gnus-article-current nil)
4604                   (if (eq result 'nneething)
4605                       (gnus-configure-windows 'summary)
4606                     (gnus-configure-windows 'article))
4607                   (gnus-set-global-variables))
4608                 (let ((gnus-article-mime-handle-alist-1
4609                        gnus-article-mime-handle-alist))
4610                   (gnus-set-mode-line 'article)))
4611             ;; The result from the `request' was an actual article -
4612             ;; or at least some text that is now displayed in the
4613             ;; article buffer.
4614             (when (and (numberp article)
4615                        (not (eq article gnus-current-article)))
4616               ;; Seems like a new article has been selected.
4617               ;; `gnus-current-article' must be an article number.
4618               (with-current-buffer summary-buffer
4619                 (push article gnus-newsgroup-history)
4620                 (setq gnus-last-article gnus-current-article
4621                       gnus-current-article article
4622                       gnus-current-headers
4623                       (gnus-summary-article-header gnus-current-article)
4624                       gnus-article-current
4625                       (cons gnus-newsgroup-name gnus-current-article))
4626                 (unless (vectorp gnus-current-headers)
4627                   (setq gnus-current-headers nil))
4628                 (gnus-summary-goto-subject gnus-current-article)
4629                 (when (gnus-summary-show-thread)
4630                   ;; If the summary buffer really was folded, the
4631                   ;; previous goto may not actually have gone to
4632                   ;; the right article, but the thread root instead.
4633                   ;; So we go again.
4634                   (gnus-summary-goto-subject gnus-current-article))
4635                 (gnus-run-hooks 'gnus-mark-article-hook)
4636                 (gnus-set-mode-line 'summary)
4637                 (when (gnus-visual-p 'article-highlight 'highlight)
4638                   (gnus-run-hooks 'gnus-visual-mark-article-hook))
4639                 ;; Set the global newsgroup variables here.
4640                 (gnus-set-global-variables)
4641                 (setq gnus-have-all-headers
4642                       (or all-headers gnus-show-all-headers))))
4643             (save-excursion
4644               (gnus-configure-windows 'article))
4645             (when (or (numberp article)
4646                       (stringp article))
4647               (gnus-article-prepare-display)
4648               ;; Do page break.
4649               (goto-char (point-min))
4650               (when gnus-break-pages
4651                 (gnus-narrow-to-page)))
4652             (let ((gnus-article-mime-handle-alist-1
4653                    gnus-article-mime-handle-alist))
4654               (gnus-set-mode-line 'article))
4655             (article-goto-body)
4656             (unless (bobp)
4657               (forward-line -1))
4658             (set-window-point (get-buffer-window (current-buffer)) (point))
4659             (gnus-configure-windows 'article)
4660             (gnus-run-hooks 'gnus-article-prepare-hook)
4661             t))))))
4662
4663 ;;;###autoload
4664 (defun gnus-article-prepare-display ()
4665   "Make the current buffer look like a nice article."
4666   ;; Hooks for getting information from the article.
4667   ;; This hook must be called before being narrowed.
4668   (let ((gnus-article-buffer (current-buffer))
4669         buffer-read-only
4670         (inhibit-read-only t))
4671     (unless (eq major-mode 'gnus-article-mode)
4672       (gnus-article-mode))
4673     (setq buffer-read-only nil
4674           gnus-article-wash-types nil
4675           gnus-article-image-alist nil)
4676     (gnus-run-hooks 'gnus-tmp-internal-hook)
4677     (when gnus-display-mime-function
4678       (funcall gnus-display-mime-function))))
4679
4680 ;;;
4681 ;;; Gnus Sticky Article Mode
4682 ;;;
4683
4684 (define-derived-mode gnus-sticky-article-mode gnus-article-mode "StickyArticle"
4685   "Mode for sticky articles."
4686   ;; Release bindings that won't work.
4687   (substitute-key-definition 'gnus-article-read-summary-keys 'undefined
4688                              gnus-sticky-article-mode-map)
4689   (substitute-key-definition 'gnus-article-refer-article 'undefined
4690                              gnus-sticky-article-mode-map)
4691   (dolist (k '("e" "h" "s" "F" "R"))
4692     (define-key gnus-sticky-article-mode-map k nil))
4693   (define-key gnus-sticky-article-mode-map "k" 'gnus-kill-sticky-article-buffer)
4694   (define-key gnus-sticky-article-mode-map "q" 'bury-buffer)
4695   (define-key gnus-sticky-article-mode-map "\C-hc" 'describe-key-briefly)
4696   (define-key gnus-sticky-article-mode-map "\C-hk" 'describe-key))
4697
4698 (defun gnus-sticky-article (arg)
4699   "Make the current article sticky.
4700 If a prefix ARG is given, ask for a name for this sticky article buffer."
4701   (interactive "P")
4702   (gnus-summary-show-thread)
4703   (gnus-summary-select-article nil nil 'pseudo)
4704   (let (new-art-buf-name)
4705     (gnus-eval-in-buffer-window gnus-article-buffer
4706       (setq new-art-buf-name
4707             (concat
4708              "*Sticky Article: "
4709              (if arg
4710                  (read-from-minibuffer "Sticky article buffer name: ")
4711                (gnus-with-article-headers
4712                  (gnus-article-goto-header "subject")
4713                  (setq new-art-buf-name
4714                        (buffer-substring-no-properties
4715                         (line-beginning-position) (line-end-position)))
4716                  (goto-char (point-min))
4717                  (gnus-article-goto-header "from")
4718                  (setq new-art-buf-name
4719                        (concat
4720                         new-art-buf-name ", "
4721                         (buffer-substring-no-properties
4722                          (line-beginning-position) (line-end-position))))
4723                  (goto-char (point-min))
4724                  (gnus-article-goto-header "date")
4725                  (setq new-art-buf-name
4726                        (concat
4727                         new-art-buf-name ", "
4728                         (buffer-substring-no-properties
4729                          (line-beginning-position) (line-end-position))))))
4730              "*"))
4731       (if (and (gnus-buffer-live-p new-art-buf-name)
4732                (with-current-buffer new-art-buf-name
4733                  (eq major-mode 'gnus-sticky-article-mode)))
4734           (switch-to-buffer new-art-buf-name)
4735         (setq new-art-buf-name (rename-buffer new-art-buf-name t)))
4736       (gnus-sticky-article-mode))
4737     (setq gnus-article-buffer new-art-buf-name))
4738   (gnus-summary-recenter)
4739   (gnus-summary-position-point))
4740
4741 (defun gnus-kill-sticky-article-buffer (&optional buffer)
4742   "Kill the given sticky article BUFFER.
4743 If none is given, assume the current buffer and kill it if it has
4744 `gnus-sticky-article-mode'."
4745   (interactive)
4746   (unless buffer
4747     (setq buffer (current-buffer)))
4748   (with-current-buffer buffer
4749     (when (eq major-mode 'gnus-sticky-article-mode)
4750       (gnus-kill-buffer buffer))))
4751
4752 (defun gnus-kill-sticky-article-buffers (arg)
4753   "Kill all sticky article buffers.
4754 If a prefix ARG is given, ask for confirmation."
4755   (interactive "P")
4756   (dolist (buf (gnus-buffers))
4757     (with-current-buffer buf
4758       (when (eq major-mode 'gnus-sticky-article-mode)
4759         (if (not arg)
4760             (gnus-kill-buffer buf)
4761           (when (yes-or-no-p (concat "Kill buffer " (buffer-name buf) "? "))
4762             (gnus-kill-buffer buf)))))))
4763
4764 ;;;
4765 ;;; Gnus MIME viewing functions
4766 ;;;
4767
4768 (defvar gnus-mime-button-line-format "%{%([%p. %d%T]%)%}%e\n"
4769   "Format of the MIME buttons.
4770
4771 Valid specifiers include:
4772 %t  The MIME type
4773 %T  MIME type, along with additional info
4774 %n  The `name' parameter
4775 %d  The description, if any
4776 %l  The length of the encoded part
4777 %p  The part identifier number
4778 %e  Dots if the part isn't displayed
4779
4780 General format specifiers can also be used.  See Info node
4781 `(gnus)Formatting Variables'.")
4782
4783 (defvar gnus-mime-button-line-format-alist
4784   '((?t gnus-tmp-type ?s)
4785     (?T gnus-tmp-type-long ?s)
4786     (?n gnus-tmp-name ?s)
4787     (?d gnus-tmp-description ?s)
4788     (?p gnus-tmp-id ?s)
4789     (?l gnus-tmp-length ?d)
4790     (?e gnus-tmp-dots ?s)))
4791
4792 (defvar gnus-mime-button-commands
4793   '((gnus-article-press-button "\r" "Toggle Display")
4794     (gnus-mime-view-part "v" "View Interactively...")
4795     (gnus-mime-view-part-as-type "t" "View As Type...")
4796     (gnus-mime-view-part-as-charset "C" "View As charset...")
4797     (gnus-mime-save-part "o" "Save...")
4798     (gnus-mime-save-part-and-strip "\C-o" "Save and Strip")
4799     (gnus-mime-replace-part "r" "Replace part")
4800     (gnus-mime-delete-part "d" "Delete part")
4801     (gnus-mime-copy-part "c" "View As Text, In Other Buffer")
4802     (gnus-mime-inline-part "i" "View As Text, In This Buffer")
4803     (gnus-mime-view-part-internally "E" "View Internally") ;; Why `E'?
4804     (gnus-mime-view-part-externally "e" "View Externally")
4805     (gnus-mime-print-part "p" "Print")
4806     (gnus-mime-pipe-part "|" "Pipe To Command...")
4807     (gnus-mime-action-on-part "." "Take action on the part...")))
4808
4809 (defun gnus-article-mime-part-status ()
4810   (if gnus-article-mime-handle-alist-1
4811       (if (eq 1 (length gnus-article-mime-handle-alist-1))
4812           " (1 part)"
4813         (format " (%d parts)" (length gnus-article-mime-handle-alist-1)))
4814     ""))
4815
4816 (defvar gnus-mime-button-map
4817   (let ((map (make-sparse-keymap)))
4818     (define-key map gnus-mouse-2 'gnus-article-push-button)
4819     (define-key map gnus-down-mouse-3 'gnus-mime-button-menu)
4820     (dolist (c gnus-mime-button-commands)
4821       (define-key map (cadr c) (car c)))
4822     map))
4823
4824 (easy-menu-define
4825   gnus-mime-button-menu gnus-mime-button-map "MIME button menu."
4826   `("MIME Part"
4827     ,@(mapcar (lambda (c)
4828                 (vector (caddr c) (car c) :active t))
4829               gnus-mime-button-commands)))
4830
4831 (defvar gnus-url-button-commands
4832   '((gnus-article-copy-string "u" "Copy URL to kill ring")))
4833
4834 (defvar gnus-url-button-map
4835   (let ((map (make-sparse-keymap)))
4836     (dolist (c gnus-url-button-commands)
4837       (define-key map (cadr c) (car c)))
4838     map))
4839
4840 (easy-menu-define
4841   gnus-url-button-menu gnus-url-button-map "URL button menu."
4842   `("Url Button"
4843     ,@(mapcar (lambda (c)
4844                 (vector (caddr c) (car c) :active t))
4845               gnus-url-button-commands)))
4846
4847 (defmacro gnus-bind-safe-url-regexp (&rest body)
4848   "Bind `mm-w3m-safe-url-regexp' according to `gnus-safe-html-newsgroups'."
4849   `(let ((mm-w3m-safe-url-regexp
4850           (let ((group (if (and (eq major-mode 'gnus-article-mode)
4851                                 (gnus-buffer-live-p
4852                                  gnus-article-current-summary))
4853                            (with-current-buffer gnus-article-current-summary
4854                              gnus-newsgroup-name)
4855                          gnus-newsgroup-name)))
4856             (if (cond ((not group)
4857                        ;; Maybe we're in a mml-preview buffer
4858                        ;; and no group is selected.
4859                        t)
4860                       ((stringp gnus-safe-html-newsgroups)
4861                        (string-match gnus-safe-html-newsgroups group))
4862                       ((consp gnus-safe-html-newsgroups)
4863                        (member group gnus-safe-html-newsgroups)))
4864                 nil
4865               mm-w3m-safe-url-regexp))))
4866      ,@body))
4867
4868 (defun gnus-mime-button-menu (event prefix)
4869  "Construct a context-sensitive menu of MIME commands."
4870  (interactive "e\nP")
4871  (save-window-excursion
4872    (let ((pos (event-start event)))
4873      (select-window (posn-window pos))
4874      (goto-char (posn-point pos))
4875      (gnus-article-check-buffer)
4876      (popup-menu gnus-mime-button-menu nil prefix))))
4877
4878 (defun gnus-mime-view-all-parts (&optional handles)
4879   "View all the MIME parts."
4880   (interactive)
4881   (with-current-buffer gnus-article-buffer
4882     (let ((handles (or handles gnus-article-mime-handles))
4883           (mail-parse-charset gnus-newsgroup-charset)
4884           (mail-parse-ignored-charsets
4885            (with-current-buffer gnus-summary-buffer
4886              gnus-newsgroup-ignored-charsets)))
4887       (when handles
4888         (mm-remove-parts handles)
4889         (goto-char (point-min))
4890         (or (search-forward "\n\n") (goto-char (point-max)))
4891         (let ((inhibit-read-only t))
4892           (delete-region (point) (point-max))
4893           (gnus-bind-safe-url-regexp (mm-display-parts handles)))))))
4894
4895 (defun gnus-article-jump-to-part (n)
4896   "Jump to MIME part N."
4897   (interactive "P")
4898   (let ((parts (with-current-buffer gnus-article-buffer
4899                  (length gnus-article-mime-handle-alist))))
4900     (when (zerop parts)
4901       (error "No such part"))
4902     (pop-to-buffer gnus-article-buffer)
4903     (or n
4904         (setq n (if (= parts 1)
4905                     1
4906                   (read-number (format "Jump to part (1..%s): " parts)))))
4907     (unless (and (integerp n) (<= n parts) (>= n 1))
4908       (setq n
4909             (progn
4910               (gnus-message 7 "Invalid part `%s', using %s instead."
4911                             n parts)
4912               parts)))
4913     (gnus-message 9 "Jumping to part %s." n)
4914     (cond ((>= gnus-auto-select-part 1)
4915            (while (and (<= n parts)
4916                        (not (gnus-article-goto-part n)))
4917              (setq n (1+ n))))
4918           ((< gnus-auto-select-part 0)
4919            (while (and (>= n 1)
4920                        (not (gnus-article-goto-part n)))
4921              (setq n (1- n))))
4922           (t
4923            (gnus-article-goto-part n)))))
4924
4925 (defvar gnus-mime-buttonized-part-id nil
4926   "ID of a mime part that should be buttonized.
4927 `gnus-mime-save-part-and-strip' and `gnus-mime-delete-part' bind it.")
4928
4929 (eval-when-compile
4930   (defsubst gnus-article-edit-part (handles &optional current-id)
4931     "Edit an article in order to delete a mime part.
4932 This function is exclusively used by `gnus-mime-save-part-and-strip'
4933 and `gnus-mime-delete-part', and not provided at run-time normally."
4934     (gnus-article-edit-article
4935      `(lambda ()
4936         (buffer-disable-undo)
4937         (erase-buffer)
4938         (let ((mail-parse-charset (or gnus-article-charset
4939                                       ',gnus-newsgroup-charset))
4940               (mail-parse-ignored-charsets
4941                (or gnus-article-ignored-charsets
4942                    ',gnus-newsgroup-ignored-charsets))
4943               (mbl mml-buffer-list))
4944           (setq mml-buffer-list nil)
4945           (insert-buffer-substring gnus-original-article-buffer)
4946           (mime-to-mml ',handles)
4947           (setq gnus-article-mime-handles nil)
4948           (let ((mbl1 mml-buffer-list))
4949             (setq mml-buffer-list mbl)
4950             (set (make-local-variable 'mml-buffer-list) mbl1))
4951           (gnus-make-local-hook 'kill-buffer-hook)
4952           (add-hook 'kill-buffer-hook 'mml-destroy-buffers t t)))
4953      `(lambda (no-highlight)
4954         (let ((mail-parse-charset (or gnus-article-charset
4955                                       ',gnus-newsgroup-charset))
4956               (message-options message-options)
4957               (message-options-set-recipient)
4958               (mail-parse-ignored-charsets
4959                (or gnus-article-ignored-charsets
4960                    ',gnus-newsgroup-ignored-charsets)))
4961           (mml-to-mime)
4962           (mml-destroy-buffers)
4963           (remove-hook 'kill-buffer-hook
4964                        'mml-destroy-buffers t)
4965           (kill-local-variable 'mml-buffer-list))
4966         (gnus-summary-edit-article-done
4967          ,(or (mail-header-references gnus-current-headers) "")
4968          ,(gnus-group-read-only-p)
4969          ,gnus-summary-buffer no-highlight))
4970      t)
4971     ;; Force buttonizing this part.
4972     (let ((gnus-mime-buttonized-part-id current-id))
4973       (gnus-article-edit-done))
4974     (gnus-configure-windows 'article)
4975     (when (and current-id (integerp gnus-auto-select-part))
4976       (gnus-article-jump-to-part
4977        (min (max (+ current-id gnus-auto-select-part) 1)
4978             (with-current-buffer gnus-article-buffer
4979               (length gnus-article-mime-handle-alist)))))))
4980
4981 (defun gnus-mime-replace-part (file)
4982   "Replace MIME part under point with an external body."
4983   ;; Useful if file has already been saved to disk
4984   (interactive
4985    (list
4986     (read-file-name "Replace MIME part with file: "
4987                     (or mm-default-directory default-directory)
4988                     nil nil)))
4989   (gnus-mime-save-part-and-strip file))
4990
4991 (defun gnus-mime-save-part-and-strip (&optional file)
4992   "Save the MIME part under point then replace it with an external body.
4993 If FILE is given, use it for the external part."
4994   (interactive)
4995   (gnus-article-check-buffer)
4996   (when (gnus-group-read-only-p)
4997     (error "The current group does not support deleting of parts"))
4998   (when (mm-complicated-handles gnus-article-mime-handles)
4999     (error "\
5000 The current article has a complicated MIME structure, giving up..."))
5001   (let* ((data (get-text-property (point) 'gnus-data))
5002          (id (get-text-property (point) 'gnus-part))
5003          param
5004          (handles gnus-article-mime-handles))
5005     (unless file
5006       (setq file
5007             (and data (mm-save-part data "Delete MIME part and save to: "))))
5008     (when file
5009       (with-current-buffer (mm-handle-buffer data)
5010         (erase-buffer)
5011         (insert "Content-Type: " (mm-handle-media-type data))
5012         (mml-insert-parameter-string (cdr (mm-handle-type data))
5013                                      '(charset))
5014         ;; Add a filename for the sake of saving the part again.
5015         (mml-insert-parameter
5016          (mail-header-encode-parameter "name" (file-name-nondirectory file)))
5017         (insert "\n")
5018         (insert "Content-ID: " (message-make-message-id) "\n")
5019         (insert "Content-Transfer-Encoding: binary\n")
5020         (insert "\n"))
5021       (setcdr data
5022               (cdr (mm-make-handle nil
5023                                    `("message/external-body"
5024                                      (access-type . "LOCAL-FILE")
5025                                      (name . ,file)))))
5026       ;; (set-buffer gnus-summary-buffer)
5027       (gnus-article-edit-part handles id))))
5028
5029 ;; A function like `gnus-summary-save-parts' (`X m', `<MIME> <Extract all
5030 ;; parts...>') but with stripping would be nice.
5031
5032 (defun gnus-mime-delete-part ()
5033   "Delete the MIME part under point.
5034 Replace it with some information about the removed part."
5035   (interactive)
5036   (gnus-article-check-buffer)
5037   (when (gnus-group-read-only-p)
5038     (error "The current group does not support deleting of parts"))
5039   (when (mm-complicated-handles gnus-article-mime-handles)
5040     (error "\
5041 The current article has a complicated MIME structure, giving up..."))
5042   (when (or gnus-expert-user
5043             (gnus-yes-or-no-p "\
5044 Deleting parts may malfunction or destroy the article; continue? "))
5045     (let* ((data (get-text-property (point) 'gnus-data))
5046            (id (get-text-property (point) 'gnus-part))
5047            (handles gnus-article-mime-handles)
5048            (none "(none)")
5049            (description
5050             (let ((desc (mm-handle-description data)))
5051               (when desc
5052                 (mail-decode-encoded-word-string desc))))
5053            (filename
5054             (or (mail-content-type-get (mm-handle-disposition data) 'filename)
5055                 none))
5056            (type (mm-handle-media-type data)))
5057       (unless data
5058         (error "No MIME part under point"))
5059       (with-current-buffer (mm-handle-buffer data)
5060         (let ((bsize (buffer-size)))
5061           (erase-buffer)
5062           (insert
5063            (concat
5064             ",----\n"
5065             "| The following attachment has been deleted:\n"
5066             "|\n"
5067             "| Type:           " type "\n"
5068             "| Filename:       " filename "\n"
5069             "| Size (encoded): " (format "%s byte%s\n"
5070                                          bsize (if (= bsize 1)
5071                                                    ""
5072                                                  "s"))
5073             (when description
5074               (concat    "| Description:    " description "\n"))
5075             "`----\n"))
5076           (setcdr data
5077                   (cdr (mm-make-handle
5078                         nil `("text/plain" (charset . gnus-decoded)) nil nil
5079                         (list "attachment")
5080                         (format "Deleted attachment (%s bytes)" bsize))))))
5081       ;; (set-buffer gnus-summary-buffer)
5082       (gnus-article-edit-part handles id))))
5083
5084 (defun gnus-mime-save-part ()
5085   "Save the MIME part under point."
5086   (interactive)
5087   (gnus-article-check-buffer)
5088   (let ((data (get-text-property (point) 'gnus-data)))
5089     (when data
5090       (mm-save-part data))))
5091
5092 (defun gnus-mime-pipe-part (&optional cmd)
5093   "Pipe the MIME part under point to a process.
5094 Use CMD as the process."
5095   (interactive)
5096   (gnus-article-check-buffer)
5097   (let ((data (get-text-property (point) 'gnus-data)))
5098     (when data
5099       (mm-pipe-part data cmd))))
5100
5101 (defun gnus-mime-view-part ()
5102   "Interactively choose a viewing method for the MIME part under point."
5103   (interactive)
5104   (gnus-article-check-buffer)
5105   (let ((data (get-text-property (point) 'gnus-data)))
5106     (when data
5107       (setq gnus-article-mime-handles
5108             (mm-merge-handles
5109              gnus-article-mime-handles (setq data (copy-sequence data))))
5110       (mm-interactively-view-part data))))
5111
5112 (defun gnus-mime-view-part-as-type-internal ()
5113   (gnus-article-check-buffer)
5114   (let* ((handle (get-text-property (point) 'gnus-data))
5115          (name (or
5116                 ;; Content-Type: foo/bar; name=...
5117                 (mail-content-type-get (mm-handle-type handle) 'name)
5118                 ;; Content-Disposition: attachment; filename=...
5119                 (cdr (assq 'filename (cdr (mm-handle-disposition handle))))))
5120          (def-type (and name (mm-default-file-encoding name))))
5121     (or (and def-type (cons def-type 0))
5122         (and handle
5123              (equal (mm-handle-media-supertype handle) "text")
5124              '("text/plain" . 0))
5125         '("application/octet-stream" . 0))))
5126
5127 (defun gnus-mime-view-part-as-type (&optional mime-type pred)
5128   "Choose a MIME media type, and view the part as such.
5129 If non-nil, PRED is a predicate to use during completion to limit the
5130 available media-types."
5131   (interactive)
5132   (unless mime-type
5133     (setq mime-type
5134           (let ((default (gnus-mime-view-part-as-type-internal)))
5135             (gnus-completing-read
5136              "View as MIME type"
5137              (if pred
5138                  (gnus-remove-if-not pred (mailcap-mime-types))
5139                (mailcap-mime-types))
5140              nil nil nil
5141              (car default)))))
5142   (gnus-article-check-buffer)
5143   (let ((handle (get-text-property (point) 'gnus-data)))
5144     (when handle
5145       (when (equal (mm-handle-media-type handle) "message/external-body")
5146         (unless (mm-handle-cache handle)
5147           (mm-extern-cache-contents handle))
5148         (setq handle (mm-handle-cache handle)))
5149       (setq handle
5150             (mm-make-handle (mm-handle-buffer handle)
5151                             (cons mime-type (cdr (mm-handle-type handle)))
5152                             (mm-handle-encoding handle)
5153                             (mm-handle-undisplayer handle)
5154                             (mm-handle-disposition handle)
5155                             (mm-handle-description handle)
5156                             nil
5157                             (mm-handle-id handle)))
5158       (setq gnus-article-mime-handles
5159             (mm-merge-handles gnus-article-mime-handles handle))
5160       (when (mm-handle-displayed-p handle)
5161         (mm-remove-part handle))
5162       (gnus-mm-display-part handle))))
5163
5164 (defun gnus-mime-copy-part (&optional handle arg)
5165   "Put the MIME part under point into a new buffer.
5166 If `auto-compression-mode' is enabled, compressed files like .gz and .bz2
5167 are decompressed."
5168   (interactive (list nil current-prefix-arg))
5169   (gnus-article-check-buffer)
5170   (unless handle
5171     (setq handle (get-text-property (point) 'gnus-data)))
5172   (when handle
5173     (let ((filename (or (mail-content-type-get (mm-handle-type handle)
5174                                                'name)
5175                         (mail-content-type-get (mm-handle-disposition handle)
5176                                                'filename)))
5177           contents dont-decode charset coding-system)
5178       (mm-with-unibyte-buffer
5179         (mm-insert-part handle)
5180         (setq contents (or (condition-case nil
5181                                (mm-decompress-buffer filename nil 'sig)
5182                              (error
5183                               (setq dont-decode t)
5184                               nil))
5185                            (buffer-string))))
5186       (setq filename (cond (filename (file-name-nondirectory filename))
5187                            (dont-decode "*raw data*")
5188                            (t "*decoded*")))
5189       (cond
5190        (dont-decode)
5191        ((not arg)
5192         (unless (setq charset (mail-content-type-get
5193                                (mm-handle-type handle) 'charset))
5194           (unless (setq coding-system (mm-with-unibyte-buffer
5195                                         (insert contents)
5196                                         (mm-find-buffer-file-coding-system)))
5197             (setq charset gnus-newsgroup-charset))))
5198        ((numberp arg)
5199         (setq charset (or (cdr (assq arg
5200                                      gnus-summary-show-article-charset-alist))
5201                           (mm-read-coding-system "Charset: ")))))
5202       (switch-to-buffer (generate-new-buffer filename))
5203       (if (or coding-system
5204               (and charset
5205                    (setq coding-system (mm-charset-to-coding-system charset))
5206                    (not (eq coding-system 'ascii))))
5207           (progn
5208             (mm-enable-multibyte)
5209             (insert (mm-decode-coding-string contents coding-system))
5210             (setq buffer-file-coding-system
5211                   (if (boundp 'last-coding-system-used)
5212                       (symbol-value 'last-coding-system-used)
5213                     coding-system)))
5214         (mm-disable-multibyte)
5215         (insert contents)
5216         (setq buffer-file-coding-system mm-binary-coding-system))
5217       ;; We do it this way to make `normal-mode' set the appropriate mode.
5218       (unwind-protect
5219           (progn
5220             (setq buffer-file-name (expand-file-name filename))
5221             (normal-mode))
5222         (setq buffer-file-name nil))
5223       (goto-char (point-min)))))
5224
5225 (defun gnus-mime-print-part (&optional handle filename)
5226   "Print the MIME part under point."
5227   (interactive (list nil (ps-print-preprint current-prefix-arg)))
5228   (gnus-article-check-buffer)
5229   (let* ((handle (or handle (get-text-property (point) 'gnus-data)))
5230          (contents (and handle (mm-get-part handle)))
5231          (file (mm-make-temp-file (expand-file-name "mm." mm-tmp-directory)))
5232          (printer (mailcap-mime-info (mm-handle-media-type handle) "print")))
5233     (when contents
5234         (if printer
5235             (unwind-protect
5236                 (progn
5237                   (mm-save-part-to-file handle file)
5238                   (call-process shell-file-name nil
5239                                 (generate-new-buffer " *mm*")
5240                                 nil
5241                                 shell-command-switch
5242                                 (mm-mailcap-command
5243                                  printer file (mm-handle-type handle))))
5244               (delete-file file))
5245           (with-temp-buffer
5246             (insert contents)
5247             (gnus-print-buffer))
5248           (ps-despool filename)))))
5249
5250 (defun gnus-mime-inline-part (&optional handle arg)
5251   "Insert the MIME part under point into the current buffer.
5252 Compressed files like .gz and .bz2 are decompressed."
5253   (interactive (list nil current-prefix-arg))
5254   (gnus-article-check-buffer)
5255   (unless handle
5256     (setq handle (get-text-property (point) 'gnus-data)))
5257   (when handle
5258     (let ((b (point))
5259           (inhibit-read-only t)
5260           contents charset coding-system)
5261       (if (and (not arg) (mm-handle-undisplayer handle))
5262           (mm-remove-part handle)
5263         (mm-with-unibyte-buffer
5264           (mm-insert-part handle)
5265           (setq contents
5266                 (or (mm-decompress-buffer
5267                      (or (mail-content-type-get (mm-handle-type handle)
5268                                                 'name)
5269                          (mail-content-type-get (mm-handle-disposition handle)
5270                                                 'filename))
5271                      nil t)
5272                     (buffer-string))))
5273         (cond
5274          ((not arg)
5275           (unless (setq charset (mail-content-type-get
5276                                  (mm-handle-type handle) 'charset))
5277             (unless (setq coding-system
5278                           (mm-with-unibyte-buffer
5279                             (insert contents)
5280                             (mm-find-buffer-file-coding-system)))
5281               (setq charset gnus-newsgroup-charset))))
5282          ((numberp arg)
5283           (if (mm-handle-undisplayer handle)
5284               (mm-remove-part handle))
5285           (setq charset
5286                 (or (cdr (assq arg
5287                                gnus-summary-show-article-charset-alist))
5288                     (mm-read-coding-system "Charset: "))))
5289          (t
5290           (if (mm-handle-undisplayer handle)
5291               (mm-remove-part handle))))
5292         (forward-line 2)
5293         (mm-display-inline handle)
5294         (goto-char b)))))
5295
5296 (defun gnus-mime-set-charset-parameters (handle charset)
5297   "Set CHARSET to parameters in HANDLE.
5298 CHARSET may either be a string or a symbol."
5299   (unless (stringp charset)
5300     (setq charset (symbol-name charset)))
5301   (if (stringp (car handle))
5302       (dolist (h (cdr handle))
5303         (gnus-mime-set-charset-parameters h charset))
5304     (let* ((type (mm-handle-type (if (equal (mm-handle-media-type handle)
5305                                             "message/external-body")
5306                                      (progn
5307                                        (unless (mm-handle-cache handle)
5308                                          (mm-extern-cache-contents handle))
5309                                        (mm-handle-cache handle))
5310                                    handle)))
5311            (param (assq 'charset (cdr type))))
5312       (if param
5313           (setcdr param charset)
5314         (setcdr type (cons (cons 'charset charset) (cdr type)))))))
5315
5316 (defun gnus-mime-view-part-as-charset (&optional handle arg)
5317   "Insert the MIME part under point into the current buffer using the
5318 specified charset."
5319   (interactive (list nil current-prefix-arg))
5320   (gnus-article-check-buffer)
5321   (let ((handle (or handle (get-text-property (point) 'gnus-data)))
5322         (fun (get-text-property (point) 'gnus-callback))
5323         (gnus-newsgroup-ignored-charsets 'gnus-all)
5324         charset form preferred parts)
5325     (when handle
5326       (when (prog1
5327                 (and fun
5328                      (setq charset
5329                            (or (cdr (assq
5330                                      arg
5331                                      gnus-summary-show-article-charset-alist))
5332                                (mm-read-coding-system "Charset: "))))
5333               (if (mm-handle-undisplayer handle)
5334                   (mm-remove-part handle)))
5335         (gnus-mime-set-charset-parameters handle charset)
5336         (when (and (consp (setq form (cdr-safe fun)))
5337                    (setq form (ignore-errors
5338                                 (assq 'gnus-mime-display-alternative form)))
5339                    (setq preferred (caddr form))
5340                    (progn
5341                      (when (eq (car preferred) 'quote)
5342                        (setq preferred (cadr preferred)))
5343                      (not (equal preferred
5344                                  (get-text-property (point) 'gnus-data))))
5345                    (setq parts (get-text-property (point) 'gnus-part))
5346                    (setq parts (cdr (assq parts
5347                                           gnus-article-mime-handle-alist)))
5348                    (equal (mm-handle-media-type parts) "multipart/alternative")
5349                    (setq parts (reverse (cdr parts))))
5350           (setcar (cddr form)
5351                   (list 'quote (or (cadr (member preferred parts))
5352                                    (car parts)))))
5353         (funcall fun handle)))))
5354
5355 (defun gnus-mime-view-part-externally (&optional handle)
5356   "View the MIME part under point with an external viewer."
5357   (interactive)
5358   (gnus-article-check-buffer)
5359   (let* ((handle (or handle (get-text-property (point) 'gnus-data)))
5360          (mm-user-display-methods nil)
5361          (mm-inlined-types nil)
5362          (mail-parse-charset gnus-newsgroup-charset)
5363          (mail-parse-ignored-charsets
5364           (with-current-buffer gnus-summary-buffer
5365             gnus-newsgroup-ignored-charsets))
5366          (type (mm-handle-media-type handle))
5367          (method (mailcap-mime-info type))
5368          (mm-enable-external t))
5369     (if (not (stringp method))
5370         (gnus-mime-view-part-as-type
5371          nil (lambda (type) (stringp (mailcap-mime-info type))))
5372       (when handle
5373         (mm-display-part handle nil t)))))
5374
5375 (defun gnus-mime-view-part-internally (&optional handle)
5376   "View the MIME part under point with an internal viewer.
5377 If no internal viewer is available, use an external viewer."
5378   (interactive)
5379   (gnus-article-check-buffer)
5380   (let* ((handle (or handle (get-text-property (point) 'gnus-data)))
5381          (mm-inlined-types '(".*"))
5382          (mm-inline-large-images t)
5383          (mail-parse-charset gnus-newsgroup-charset)
5384          (mail-parse-ignored-charsets
5385           (with-current-buffer gnus-summary-buffer
5386             gnus-newsgroup-ignored-charsets))
5387          (inhibit-read-only t))
5388     (if (not (mm-inlinable-p handle))
5389         (gnus-mime-view-part-as-type
5390          nil (lambda (type) (mm-inlinable-p handle type)))
5391       (when handle
5392         (gnus-bind-safe-url-regexp (mm-display-part handle))))))
5393
5394 (defun gnus-mime-action-on-part (&optional action)
5395   "Do something with the MIME attachment at \(point\)."
5396   (interactive
5397    (list (gnus-completing-read "Action" (mapcar 'car gnus-mime-action-alist) t)))
5398   (gnus-article-check-buffer)
5399   (let ((action-pair (assoc action gnus-mime-action-alist)))
5400     (if action-pair
5401         (funcall (cdr action-pair)))))
5402
5403 (defun gnus-article-part-wrapper (n function &optional no-handle interactive)
5404   "Call FUNCTION on MIME part N.
5405 Unless NO-HANDLE, call FUNCTION with N-th MIME handle as it's only argument.
5406 If INTERACTIVE, call FUNCTION interactivly."
5407   (let (window frame)
5408     ;; Check whether the article is displayed.
5409     (unless (and (gnus-buffer-live-p gnus-article-buffer)
5410                  (setq window (get-buffer-window gnus-article-buffer t))
5411                  (frame-visible-p (setq frame (window-frame window))))
5412       (error "No article is displayed"))
5413     (with-current-buffer gnus-article-buffer
5414       ;; Check whether the article displays the right contents.
5415       (unless (with-current-buffer gnus-summary-buffer
5416                 (eq gnus-current-article (gnus-summary-article-number)))
5417         (error "You should select the right article first"))
5418       (if n
5419           (setq n (prefix-numeric-value n))
5420         (let ((pt (point)))
5421           (setq n (or (get-text-property pt 'gnus-part)
5422                       (and (not (bobp))
5423                            (get-text-property (1- pt) 'gnus-part))
5424                       (get-text-property (prog2
5425                                              (forward-line 1)
5426                                              (point)
5427                                            (goto-char pt))
5428                                          'gnus-part)
5429                       (get-text-property
5430                        (or (and (setq pt (previous-single-property-change
5431                                           pt 'gnus-part))
5432                                 (1- pt))
5433                            (next-single-property-change (point) 'gnus-part)
5434                            (point))
5435                        'gnus-part)
5436                       1))))
5437       ;; Check whether the specified part exists.
5438       (when (> n (length gnus-article-mime-handle-alist))
5439         (error "No such part")))
5440     (unless
5441         (progn
5442           ;; To select the window is needed so that the cursor
5443           ;; might be visible on the MIME button.
5444           (select-window (prog1
5445                              window
5446                            (setq window (selected-window))
5447                            ;; Article may be displayed in the other frame.
5448                            (gnus-select-frame-set-input-focus
5449                             (prog1
5450                                 frame
5451                               (setq frame (selected-frame))))))
5452           (when (gnus-article-goto-part n)
5453             ;; We point the cursor and the arrow at the MIME button
5454             ;; when the `function' prompt the user for something.
5455             (unless (and (pos-visible-in-window-p)
5456                          (> (count-lines (point) (window-end))
5457                             (/ (1- (window-height)) 3)))
5458               (recenter (/ (1- (window-height)) 3)))
5459             (let ((cursor-in-non-selected-windows t)
5460                   (overlay-arrow-string "=>")
5461                   (overlay-arrow-position (point-marker)))
5462               (unwind-protect
5463                   (cond
5464                    ((and no-handle interactive)
5465                     (call-interactively function))
5466                    (no-handle
5467                     (funcall function))
5468                    (interactive
5469                     (call-interactively
5470                      function (get-text-property (point) 'gnus-data)))
5471                    (t
5472                     (funcall function
5473                              (get-text-property (point) 'gnus-data))))
5474                 (set-marker overlay-arrow-position nil)
5475                 (unless gnus-auto-select-part
5476                   (gnus-select-frame-set-input-focus frame)
5477                   (select-window window))))
5478             t))
5479       (if gnus-inhibit-mime-unbuttonizing
5480           ;; This is the default though the program shouldn't reach here.
5481           (error "No such part")
5482         ;; The part which doesn't have the MIME button is selected.
5483         ;; So, we display all the buttons and redo it.
5484         (let ((gnus-inhibit-mime-unbuttonizing t))
5485           (gnus-summary-show-article)
5486           (gnus-article-part-wrapper n function no-handle))))))
5487
5488 (defun gnus-article-pipe-part (n)
5489   "Pipe MIME part N, which is the numerical prefix."
5490   (interactive "P")
5491   (gnus-article-part-wrapper n 'mm-pipe-part))
5492
5493 (defun gnus-article-save-part (n)
5494   "Save MIME part N, which is the numerical prefix."
5495   (interactive "P")
5496   (gnus-article-part-wrapper n 'mm-save-part))
5497
5498 (defun gnus-article-interactively-view-part (n)
5499   "View MIME part N interactively, which is the numerical prefix."
5500   (interactive "P")
5501   (gnus-article-part-wrapper n 'mm-interactively-view-part))
5502
5503 (defun gnus-article-copy-part (n)
5504   "Copy MIME part N, which is the numerical prefix."
5505   (interactive "P")
5506   (gnus-article-part-wrapper n 'gnus-mime-copy-part))
5507
5508 (defun gnus-article-view-part-as-charset (n)
5509   "View MIME part N using a specified charset.
5510 N is the numerical prefix."
5511   (interactive "P")
5512   (gnus-article-part-wrapper n 'gnus-mime-view-part-as-charset))
5513
5514 (defun gnus-article-view-part-externally (n)
5515   "View MIME part N externally, which is the numerical prefix."
5516   (interactive "P")
5517   (gnus-article-part-wrapper n 'gnus-mime-view-part-externally))
5518
5519 (defun gnus-article-inline-part (n)
5520   "Inline MIME part N, which is the numerical prefix."
5521   (interactive "P")
5522   (gnus-article-part-wrapper n 'gnus-mime-inline-part))
5523
5524 (defun gnus-article-save-part-and-strip (n)
5525   "Save MIME part N and replace it with an external body.
5526 N is the numerical prefix."
5527   (interactive "P")
5528   (gnus-article-part-wrapper n 'gnus-mime-save-part-and-strip t))
5529
5530 (defun gnus-article-replace-part (n)
5531   "Replace MIME part N with an external body.
5532 N is the numerical prefix."
5533   (interactive "P")
5534   (gnus-article-part-wrapper n 'gnus-mime-replace-part t t))
5535
5536 (defun gnus-article-delete-part (n)
5537   "Delete MIME part N and add some information about the removed part.
5538 N is the numerical prefix."
5539   (interactive "P")
5540   (gnus-article-part-wrapper n 'gnus-mime-delete-part t))
5541
5542 (defun gnus-article-view-part-as-type (n)
5543   "Choose a MIME media type, and view part N as such.
5544 N is the numerical prefix."
5545   (interactive "P")
5546   (gnus-article-part-wrapper n 'gnus-mime-view-part-as-type t))
5547
5548 (defun gnus-article-mime-match-handle-first (condition)
5549   (if condition
5550       (let (n)
5551         (dolist (ihandle gnus-article-mime-handle-alist)
5552           (if (and (cond
5553                     ((functionp condition)
5554                      (funcall condition (cdr ihandle)))
5555                     ((eq condition 'undisplayed)
5556                      (not (or (mm-handle-undisplayer (cdr ihandle))
5557                               (equal (mm-handle-media-type (cdr ihandle))
5558                                      "multipart/alternative"))))
5559                     ((eq condition 'undisplayed-alternative)
5560                      (not (mm-handle-undisplayer (cdr ihandle))))
5561                     (t t))
5562                    (gnus-article-goto-part (car ihandle))
5563                    (or (not n) (< (car ihandle) n)))
5564               (setq n (car ihandle))))
5565         (or n 1))
5566     1))
5567
5568 (defun gnus-article-view-part (&optional n)
5569   "View MIME part N, which is the numerical prefix.
5570 If the part is already shown, hide the part.  If N is nil, view
5571 all parts."
5572   (interactive "P")
5573   (with-current-buffer gnus-article-buffer
5574     (or (numberp n) (setq n (gnus-article-mime-match-handle-first
5575                              gnus-article-mime-match-handle-function)))
5576     (when (> n (length gnus-article-mime-handle-alist))
5577       (error "No such part"))
5578     (let ((handle (cdr (assq n gnus-article-mime-handle-alist))))
5579       (when (gnus-article-goto-part n)
5580         (if (equal (car handle) "multipart/alternative")
5581             (gnus-article-press-button)
5582           (when (eq (gnus-mm-display-part handle) 'internal)
5583             (gnus-set-window-start)))))))
5584
5585 (defsubst gnus-article-mime-total-parts ()
5586   (if (bufferp (car gnus-article-mime-handles))
5587       1 ;; single part
5588     (1- (length gnus-article-mime-handles))))
5589
5590 (defun gnus-mm-display-part (handle)
5591   "Display HANDLE and fix MIME button."
5592   (let ((id (get-text-property (point) 'gnus-part))
5593         (point (point))
5594         (inhibit-read-only t))
5595     (forward-line 1)
5596     (prog1
5597         (let ((window (selected-window))
5598               (mail-parse-charset gnus-newsgroup-charset)
5599               (mail-parse-ignored-charsets
5600                (if (gnus-buffer-live-p gnus-summary-buffer)
5601                    (with-current-buffer gnus-summary-buffer
5602                      gnus-newsgroup-ignored-charsets)
5603                  nil)))
5604           (save-excursion
5605             (unwind-protect
5606                 (let ((win (gnus-get-buffer-window (current-buffer) t))
5607                       (beg (point)))
5608                   (when win
5609                     (select-window win))
5610                   (goto-char point)
5611                   (forward-line)
5612                   (if (mm-handle-displayed-p handle)
5613                       ;; This will remove the part.
5614                       (mm-display-part handle)
5615                     (save-restriction
5616                       (narrow-to-region (point)
5617                                         (if (eobp) (point) (1+ (point))))
5618                       (gnus-bind-safe-url-regexp (mm-display-part handle))
5619                       ;; We narrow to the part itself and
5620                       ;; then call the treatment functions.
5621                       (goto-char (point-min))
5622                       (forward-line 1)
5623                       (narrow-to-region (point) (point-max))
5624                       (gnus-treat-article
5625                        nil id
5626                        (gnus-article-mime-total-parts)
5627                        (mm-handle-media-type handle)))))
5628               (if (window-live-p window)
5629                   (select-window window)))))
5630       (goto-char point)
5631       (gnus-delete-line)
5632       (gnus-insert-mime-button
5633        handle id (list (mm-handle-displayed-p handle)))
5634       (goto-char point))))
5635
5636 (defun gnus-article-goto-part (n)
5637   "Go to MIME part N."
5638   (when gnus-break-pages
5639     (widen))
5640   (prog1
5641       (let ((start (text-property-any (point-min) (point-max) 'gnus-part n))
5642             part handle end next handles)
5643         (when start
5644           (goto-char start)
5645           (if (setq handle (get-text-property start 'gnus-data))
5646               start
5647             ;; Go to the displayed subpart, assuming this is
5648             ;; multipart/alternative.
5649             (setq part start
5650                   end (point-at-eol))
5651             (while (and (not handle)
5652                         part
5653                         (< part end)
5654                         (setq next (text-property-not-all part end
5655                                                           'gnus-data nil)))
5656               (setq part next
5657                     handle (get-text-property part 'gnus-data))
5658               (push (cons handle part) handles)
5659               (unless (mm-handle-displayed-p handle)
5660                 (setq handle nil
5661                       part (text-property-any part end 'gnus-data nil))))
5662             (unless handle
5663               ;; No subpart is displayed, so we find preferred one.
5664               (setq part
5665                     (cdr (assq (mm-preferred-alternative
5666                                 (nreverse (mapcar 'car handles)))
5667                                handles))))
5668             (if part
5669                 (goto-char (1+ part))
5670               start))))
5671     (when gnus-break-pages
5672       (gnus-narrow-to-page))))
5673
5674 (defun gnus-insert-mime-button (handle gnus-tmp-id &optional displayed)
5675   (let ((gnus-tmp-name
5676          (or (mail-content-type-get (mm-handle-type handle) 'name)
5677              (mail-content-type-get (mm-handle-disposition handle) 'filename)
5678              (mail-content-type-get (mm-handle-type handle) 'url)
5679              ""))
5680         (gnus-tmp-type (mm-handle-media-type handle))
5681         (gnus-tmp-description (or (mm-handle-description handle) ""))
5682         (gnus-tmp-dots
5683          (if (if displayed (car displayed)
5684                (mm-handle-displayed-p handle))
5685              "" "..."))
5686         (gnus-tmp-length (with-current-buffer (mm-handle-buffer handle)
5687                            (buffer-size)))
5688         gnus-tmp-type-long b e)
5689     (when (string-match ".*/" gnus-tmp-name)
5690       (setq gnus-tmp-name (replace-match "" t t gnus-tmp-name)))
5691     (setq gnus-tmp-type-long (concat gnus-tmp-type
5692                                      (and (not (equal gnus-tmp-name ""))
5693                                           (concat "; " gnus-tmp-name))))
5694     (unless (equal gnus-tmp-description "")
5695       (setq gnus-tmp-type-long (concat " --- " gnus-tmp-type-long)))
5696     (unless (bolp)
5697       (insert "\n"))
5698     (setq b (point))
5699     (gnus-eval-format
5700      gnus-mime-button-line-format gnus-mime-button-line-format-alist
5701      `(keymap ,gnus-mime-button-map
5702               gnus-callback gnus-mm-display-part
5703               gnus-part ,gnus-tmp-id
5704               article-type annotation
5705               gnus-data ,handle))
5706     (setq e (if (bolp)
5707                 ;; Exclude a newline.
5708                 (1- (point))
5709               (point)))
5710     (when gnus-article-button-face
5711       (gnus-overlay-put (gnus-make-overlay b e nil t)
5712                         'face gnus-article-button-face))
5713     (widget-convert-button
5714      'link b e
5715      :mime-handle handle
5716      :action 'gnus-widget-press-button
5717      :button-keymap gnus-mime-button-map
5718      :help-echo
5719      (lambda (widget)
5720        ;; Needed to properly clear the message due to a bug in
5721        ;; wid-edit (XEmacs only).
5722        (if (boundp 'help-echo-owns-message)
5723            (setq help-echo-owns-message t))
5724        (format
5725         "%S: %s the MIME part; %S: more options"
5726         (aref gnus-mouse-2 0)
5727         (if (mm-handle-displayed-p (widget-get widget :mime-handle))
5728             "hide" "show")
5729         (aref gnus-down-mouse-3 0))))))
5730
5731 (defun gnus-widget-press-button (elems el)
5732   (goto-char (widget-get elems :from))
5733   (gnus-article-press-button))
5734
5735 (defvar gnus-displaying-mime nil)
5736
5737 (defun gnus-display-mime (&optional ihandles)
5738   "Display the MIME parts."
5739   (save-excursion
5740     (save-selected-window
5741       (let ((window (get-buffer-window gnus-article-buffer))
5742             (point (point)))
5743         (when window
5744           (select-window window)
5745           ;; We have to do this since selecting the window
5746           ;; may change the point.  So we set the window point.
5747           (set-window-point window point)))
5748       (let ((handles ihandles)
5749             (inhibit-read-only t)
5750             handle)
5751         (cond (handles)
5752               ((setq handles (mm-dissect-buffer nil gnus-article-loose-mime))
5753                (when gnus-article-emulate-mime
5754                  (mm-uu-dissect-text-parts handles)))
5755               (gnus-article-emulate-mime
5756                (setq handles (mm-uu-dissect))))
5757         (when (and (not ihandles)
5758                    (not gnus-displaying-mime))
5759           ;; Top-level call; we clean up.
5760           (when gnus-article-mime-handles
5761             (mm-destroy-parts gnus-article-mime-handles)
5762             (setq gnus-article-mime-handle-alist nil));; A trick.
5763           (setq gnus-article-mime-handles handles)
5764           ;; We allow users to glean info from the handles.
5765           (when gnus-article-mime-part-function
5766             (gnus-mime-part-function handles)))
5767         (if (and handles
5768                  (or (not (stringp (car handles)))
5769                      (cdr handles)))
5770             (progn
5771               (when (and (not ihandles)
5772                          (not gnus-displaying-mime))
5773                 ;; Clean up for mime parts.
5774                 (article-goto-body)
5775                 (delete-region (point) (point-max)))
5776               (let ((gnus-displaying-mime t))
5777                 (gnus-mime-display-part handles)))
5778           (save-restriction
5779             (article-goto-body)
5780             (narrow-to-region (point) (point-max))
5781             (gnus-treat-article nil 1 1 "text/plain")
5782             (widen)))
5783         (unless ihandles
5784           ;; Highlight the headers.
5785           (save-excursion
5786             (save-restriction
5787               (article-goto-body)
5788               (narrow-to-region (point-min) (point))
5789               (gnus-article-save-original-date
5790                (gnus-treat-article 'head)))))))
5791     ;; Cope with broken MIME messages.
5792     (goto-char (point-max))
5793     (unless (bolp)
5794       (insert "\n"))))
5795
5796 (defcustom gnus-mime-display-multipart-as-mixed nil
5797   "Display \"multipart\" parts as  \"multipart/mixed\".
5798
5799 If t, it overrides nil values of
5800 `gnus-mime-display-multipart-alternative-as-mixed' and
5801 `gnus-mime-display-multipart-related-as-mixed'."
5802   :group 'gnus-article-mime
5803   :type 'boolean)
5804
5805 (defcustom gnus-mime-display-multipart-alternative-as-mixed nil
5806   "Display \"multipart/alternative\" parts as  \"multipart/mixed\"."
5807   :version "22.1"
5808   :group 'gnus-article-mime
5809   :type 'boolean)
5810
5811 (defcustom gnus-mime-display-multipart-related-as-mixed nil
5812   "Display \"multipart/related\" parts as  \"multipart/mixed\".
5813
5814 If displaying \"text/html\" is discouraged \(see
5815 `mm-discouraged-alternatives'\) images or other material inside a
5816 \"multipart/related\" part might be overlooked when this variable is nil."
5817   :version "22.1"
5818   :group 'gnus-article-mime
5819   :type 'boolean)
5820
5821 (defun gnus-mime-display-part (handle)
5822   (cond
5823    ;; Maybe a broken MIME message.
5824    ((null handle))
5825    ;; Single part.
5826    ((not (stringp (car handle)))
5827     (gnus-mime-display-single handle))
5828    ;; User-defined multipart
5829    ((cdr (assoc (car handle) gnus-mime-multipart-functions))
5830     (funcall (cdr (assoc (car handle) gnus-mime-multipart-functions))
5831              handle))
5832    ;; multipart/alternative
5833    ((and (equal (car handle) "multipart/alternative")
5834          (not (or gnus-mime-display-multipart-as-mixed
5835                   gnus-mime-display-multipart-alternative-as-mixed)))
5836     (let ((id (1+ (length gnus-article-mime-handle-alist))))
5837       (push (cons id handle) gnus-article-mime-handle-alist)
5838       (gnus-mime-display-alternative (cdr handle) nil nil id)))
5839    ;; multipart/related
5840    ((and (equal (car handle) "multipart/related")
5841          (not (or gnus-mime-display-multipart-as-mixed
5842                   gnus-mime-display-multipart-related-as-mixed)))
5843     ;;;!!!We should find the start part, but we just default
5844     ;;;!!!to the first part.
5845     ;;(gnus-mime-display-part (cadr handle))
5846     ;;;!!! Most multipart/related is an HTML message plus images.
5847     ;;;!!! Unfortunately we are unable to let W3 display those
5848     ;;;!!! included images, so we just display it as a mixed multipart.
5849     ;;(gnus-mime-display-mixed (cdr handle))
5850     ;;;!!! No, w3 can display everything just fine.
5851     (gnus-mime-display-part (cadr handle)))
5852    ((equal (car handle) "multipart/signed")
5853     (gnus-add-wash-type 'signed)
5854     (gnus-mime-display-security handle))
5855    ((equal (car handle) "multipart/encrypted")
5856     (gnus-add-wash-type 'encrypted)
5857     (gnus-mime-display-security handle))
5858    ;; Other multiparts are handled like multipart/mixed.
5859    (t
5860     (gnus-mime-display-mixed (cdr handle)))))
5861
5862 (defun gnus-mime-part-function (handles)
5863   (if (stringp (car handles))
5864       (mapcar 'gnus-mime-part-function (cdr handles))
5865     (funcall gnus-article-mime-part-function handles)))
5866
5867 (defun gnus-mime-display-mixed (handles)
5868   (mapcar 'gnus-mime-display-part handles))
5869
5870 (defun gnus-mime-display-single (handle)
5871   (let ((type (mm-handle-media-type handle))
5872         (ignored gnus-ignored-mime-types)
5873         (not-attachment t)
5874         (move nil)
5875         display text)
5876     (catch 'ignored
5877       (progn
5878         (while ignored
5879           (when (string-match (pop ignored) type)
5880             (throw 'ignored nil)))
5881         (if (and (not (and (if (gnus-buffer-live-p gnus-summary-buffer)
5882                                (with-current-buffer gnus-summary-buffer
5883                                  gnus-inhibit-images)
5884                              gnus-inhibit-images)
5885                            (string-match "\\`image/" type)))
5886                  (setq not-attachment
5887                        (and (not (mm-inline-override-p handle))
5888                             (or (not (mm-handle-disposition handle))
5889                                 (equal (car (mm-handle-disposition handle))
5890                                        "inline")
5891                                 (mm-attachment-override-p handle))))
5892                  (mm-automatic-display-p handle)
5893                  (or (and
5894                       (mm-inlinable-p handle)
5895                       (mm-inlined-p handle))
5896                      (mm-automatic-external-display-p type)))
5897             (setq display t)
5898           (when (equal (mm-handle-media-supertype handle) "text")
5899             (setq text t)))
5900         (let ((id (1+ (length gnus-article-mime-handle-alist)))
5901               beg)
5902           (push (cons id handle) gnus-article-mime-handle-alist)
5903           (when (and display
5904                      (equal (mm-handle-media-supertype handle) "message"))
5905             (insert-char
5906              ?\n
5907              (cond ((not (bolp)) 2)
5908                    ((or (bobp) (eq (char-before (1- (point))) ?\n)) 0)
5909                    (t 1))))
5910           (when (or (not display)
5911                     (not (gnus-unbuttonized-mime-type-p type))
5912                     (eq id gnus-mime-buttonized-part-id))
5913             (gnus-insert-mime-button
5914              handle id (list (or display (and not-attachment text))))
5915             (gnus-article-insert-newline)
5916             ;; Remember modify the number of forward lines.
5917             (setq move t))
5918           (setq beg (point))
5919           (cond
5920            (display
5921             (when move
5922               (forward-line -1)
5923               (setq beg (point)))
5924             (let ((mail-parse-charset gnus-newsgroup-charset)
5925                   (mail-parse-ignored-charsets
5926                    (save-excursion (condition-case ()
5927                                        (set-buffer gnus-summary-buffer)
5928                                      (error))
5929                                    gnus-newsgroup-ignored-charsets)))
5930               (gnus-bind-safe-url-regexp (mm-display-part handle t)))
5931             (goto-char (point-max)))
5932            ((and text not-attachment)
5933             (when move
5934               (forward-line -1)
5935               (setq beg (point)))
5936             (gnus-article-insert-newline)
5937             (mm-display-inline handle)
5938             (goto-char (point-max))))
5939           ;; Do highlighting.
5940           (save-excursion
5941             (save-restriction
5942               (narrow-to-region beg (point))
5943               (if (eq handle gnus-article-mime-handles)
5944                   ;; The format=flowed case.
5945                   (gnus-treat-article nil 1 1 (mm-handle-media-type handle))
5946                 ;; Don't count signature parts that are never displayed.
5947                 ;; The part number should be re-calculated supposing this
5948                 ;; might be a message/rfc822 part.
5949                 (let (handles)
5950                   (dolist (part gnus-article-mime-handles)
5951                     (unless (or (stringp part)
5952                                 (equal (car (mm-handle-type part))
5953                                        "application/pgp-signature"))
5954                       (push part handles)))
5955                   (gnus-treat-article
5956                    nil (length (memq handle handles)) (length handles)
5957                    (mm-handle-media-type handle)))))))))))
5958
5959 (defun gnus-unbuttonized-mime-type-p (type)
5960   "Say whether TYPE is to be unbuttonized."
5961   (unless gnus-inhibit-mime-unbuttonizing
5962     (when (catch 'found
5963             (let ((types gnus-unbuttonized-mime-types))
5964               (while types
5965                 (when (string-match (pop types) type)
5966                   (throw 'found t)))))
5967       (not (catch 'found
5968              (let ((types gnus-buttonized-mime-types))
5969                (while types
5970                  (when (string-match (pop types) type)
5971                    (throw 'found t)))))))))
5972
5973 (defun gnus-article-insert-newline ()
5974   "Insert a newline, but mark it as undeletable."
5975   (gnus-put-text-property
5976    (point) (progn (insert "\n") (point)) 'gnus-undeletable t))
5977
5978 (defun gnus-mime-display-alternative (handles &optional preferred ibegend id)
5979   (let* ((preferred (or preferred (mm-preferred-alternative handles)))
5980          (ihandles handles)
5981          (point (point))
5982          handle (inhibit-read-only t) from props begend not-pref)
5983     (save-window-excursion
5984       (save-restriction
5985         (when ibegend
5986           (narrow-to-region (car ibegend)
5987                             (or (cdr ibegend)
5988                                 (progn
5989                                   (goto-char (car ibegend))
5990                                   (forward-line 2)
5991                                   (point))))
5992           (delete-region (point-min) (point-max))
5993           (mm-remove-parts handles))
5994         (setq begend (list (point-marker)))
5995         ;; Do the toggle.
5996         (unless (setq not-pref (cadr (member preferred ihandles)))
5997           (setq not-pref (car ihandles)))
5998         (when (or ibegend
5999                   (not preferred)
6000                   (not (gnus-unbuttonized-mime-type-p
6001                         "multipart/alternative")))
6002           (gnus-add-text-properties
6003            (setq from (point))
6004            (progn
6005              (insert (format "%d.  " id))
6006              (point))
6007            `(gnus-callback
6008              (lambda (handles)
6009                (unless ,(not ibegend)
6010                  (setq gnus-article-mime-handle-alist
6011                        ',gnus-article-mime-handle-alist))
6012                (gnus-mime-display-alternative
6013                 ',ihandles ',not-pref ',begend ,id))
6014              keymap ,gnus-mime-button-map
6015              ,gnus-mouse-face-prop ,gnus-article-mouse-face
6016              face ,gnus-article-button-face
6017              gnus-part ,id
6018              article-type multipart))
6019           (widget-convert-button 'link from (point)
6020                                  :action 'gnus-widget-press-button
6021                                  :button-keymap gnus-widget-button-keymap)
6022           ;; Do the handles
6023           (while (setq handle (pop handles))
6024             (gnus-add-text-properties
6025              (setq from (point))
6026              (progn
6027                (insert (format "(%c) %-18s"
6028                                (if (equal handle preferred) ?* ? )
6029                                (mm-handle-media-type handle)))
6030                (point))
6031              `(gnus-callback
6032                (lambda (handles)
6033                  (unless ,(not ibegend)
6034                    (setq gnus-article-mime-handle-alist
6035                          ',gnus-article-mime-handle-alist))
6036                  (gnus-mime-display-alternative
6037                   ',ihandles ',handle ',begend ,id))
6038                keymap ,gnus-mime-button-map
6039                ,gnus-mouse-face-prop ,gnus-article-mouse-face
6040                face ,gnus-article-button-face
6041                gnus-part ,id
6042                gnus-data ,handle))
6043             (widget-convert-button 'link from (point)
6044                                    :action 'gnus-widget-press-button
6045                                    :button-keymap gnus-widget-button-keymap)
6046             (insert "  "))
6047           (insert "\n\n"))
6048         (when preferred
6049           (if (stringp (car preferred))
6050               (gnus-display-mime preferred)
6051             (let ((mail-parse-charset gnus-newsgroup-charset)
6052                   (mail-parse-ignored-charsets
6053                    (with-current-buffer gnus-summary-buffer
6054                      gnus-newsgroup-ignored-charsets)))
6055               (gnus-bind-safe-url-regexp (mm-display-part preferred))
6056               ;; Do highlighting.
6057               (save-excursion
6058                 (save-restriction
6059                   (narrow-to-region (car begend) (point-max))
6060                   (gnus-treat-article
6061                    nil (length gnus-article-mime-handle-alist)
6062                    (gnus-article-mime-total-parts)
6063                    (mm-handle-media-type preferred))))))
6064           (goto-char (point-max))
6065           (setcdr begend (point-marker)))))
6066     (when ibegend
6067       (goto-char point))))
6068
6069 (defconst gnus-article-wash-status-strings
6070   (let ((alist '((cite "c" "Possible hidden citation text"
6071                        " " "All citation text visible")
6072                  (headers "h" "Hidden headers"
6073                           " " "All headers visible.")
6074                  (pgp "p" "Encrypted or signed message status hidden"
6075                       " " "No hidden encryption nor digital signature status")
6076                  (signature "s" "Signature has been hidden"
6077                             " " "Signature is visible")
6078                  (overstrike "o" "Overstrike (^H) characters applied"
6079                              " " "No overstrike characters applied")
6080                  (emphasis "e" "/*_Emphasis_*/ characters applied"
6081                            " " "No /*_emphasis_*/ characters applied")))
6082         result)
6083     (dolist (entry alist result)
6084       (let ((key (nth 0 entry))
6085             (on (copy-sequence (nth 1 entry)))
6086             (on-help (nth 2 entry))
6087             (off (copy-sequence (nth 3 entry)))
6088             (off-help (nth 4 entry)))
6089         (put-text-property 0 1 'help-echo on-help on)
6090         (put-text-property 0 1 'help-echo off-help off)
6091         (push (list key on off) result))))
6092   "Alist of strings describing wash status in the mode line.
6093 Each entry has the form (KEY ON OF), where the KEY is a symbol
6094 representing the particular washing function, ON is the string to use
6095 in the article mode line when the washing function is active, and OFF
6096 is the string to use when it is inactive.")
6097
6098 (defun gnus-article-wash-status-entry (key value)
6099   (let ((entry (assoc key gnus-article-wash-status-strings)))
6100     (if value (nth 1 entry) (nth 2 entry))))
6101
6102 (defun gnus-article-wash-status ()
6103   "Return a string which display status of article washing."
6104   (with-current-buffer gnus-article-buffer
6105     (let ((cite (memq 'cite gnus-article-wash-types))
6106           (headers (memq 'headers gnus-article-wash-types))
6107           (boring (memq 'boring-headers gnus-article-wash-types))
6108           (pgp (memq 'pgp gnus-article-wash-types))
6109           (pem (memq 'pem gnus-article-wash-types))
6110           (signed (memq 'signed gnus-article-wash-types))
6111           (encrypted (memq 'encrypted gnus-article-wash-types))
6112           (signature (memq 'signature gnus-article-wash-types))
6113           (overstrike (memq 'overstrike gnus-article-wash-types))
6114           (emphasis (memq 'emphasis gnus-article-wash-types)))
6115       (concat
6116        (gnus-article-wash-status-entry 'cite cite)
6117        (gnus-article-wash-status-entry 'headers (or headers boring))
6118        (gnus-article-wash-status-entry 'pgp (or pgp pem signed encrypted))
6119        (gnus-article-wash-status-entry 'signature signature)
6120        (gnus-article-wash-status-entry 'overstrike overstrike)
6121        (gnus-article-wash-status-entry 'emphasis emphasis)))))
6122
6123 (defun gnus-add-wash-type (type)
6124   "Add a washing of TYPE to the current status."
6125   (add-to-list 'gnus-article-wash-types type))
6126
6127 (defun gnus-delete-wash-type (type)
6128   "Add a washing of TYPE to the current status."
6129   (setq gnus-article-wash-types (delq type gnus-article-wash-types)))
6130
6131 (defun gnus-add-image (category image)
6132   "Add IMAGE of CATEGORY to the list of displayed images."
6133   (let ((entry (assq category gnus-article-image-alist)))
6134     (unless entry
6135       (setq entry (list category))
6136       (push entry gnus-article-image-alist))
6137     (nconc entry (list image))))
6138
6139 (defun gnus-delete-images (category)
6140   "Delete all images in CATEGORY."
6141   (let ((entry (assq category gnus-article-image-alist)))
6142     (dolist (image (cdr entry))
6143       (gnus-remove-image image category))
6144     (setq gnus-article-image-alist (delq entry gnus-article-image-alist))
6145     (gnus-delete-wash-type category)))
6146
6147 (defalias 'gnus-article-hide-headers-if-wanted 'gnus-article-maybe-hide-headers)
6148
6149 (defun gnus-article-maybe-hide-headers ()
6150   "Hide unwanted headers if `gnus-have-all-headers' is nil.
6151 Provided for backwards compatibility."
6152   (when (and (or (not (gnus-buffer-live-p gnus-summary-buffer))
6153                  (not (with-current-buffer gnus-summary-buffer
6154                         gnus-have-all-headers)))
6155              (not gnus-inhibit-hiding))
6156     (gnus-article-hide-headers)))
6157
6158 ;;; Article savers.
6159
6160 (defun gnus-output-to-file (file-name)
6161   "Append the current article to a file named FILE-NAME.
6162 If `gnus-article-save-coding-system' is non-nil, it is used to encode
6163 text and used as the value of the coding cookie which is added to the
6164 top of a file.  Otherwise, this function saves a raw article without
6165 the coding cookie."
6166   (let* ((artbuf (current-buffer))
6167          (file-name-coding-system nnmail-pathname-coding-system)
6168          (coding gnus-article-save-coding-system)
6169          (coding-system-for-read (if coding
6170                                      nil ;; Rely on the coding cookie.
6171                                    mm-text-coding-system))
6172          (coding-system-for-write (or coding
6173                                       mm-text-coding-system-for-write
6174                                       mm-text-coding-system))
6175          (exists (file-exists-p file-name)))
6176     (with-temp-buffer
6177       (when exists
6178         (insert-file-contents file-name)
6179         (goto-char (point-min))
6180         ;; Remove the existing coding cookie.
6181         (when (looking-at "X-Gnus-Coding-System: .+\n\n")
6182           (delete-region (match-beginning 0) (match-end 0))))
6183       (goto-char (point-max))
6184       (insert-buffer-substring artbuf)
6185       ;; Append newline at end of the buffer as separator, and then
6186       ;; save it to file.
6187       (goto-char (point-max))
6188       (insert "\n")
6189       (when coding
6190         ;; If the coding system is not suitable to encode the text,
6191         ;; ask a user for a proper one.
6192         (when (fboundp 'select-safe-coding-system)
6193           (setq coding (coding-system-base
6194                         (save-window-excursion
6195                           (select-safe-coding-system (point-min) (point-max)
6196                                                      coding))))
6197           (setq coding-system-for-write
6198                 (or (cdr (assq coding '((mule-utf-8 . utf-8))))
6199                     coding)))
6200         (goto-char (point-min))
6201         ;; Add the coding cookie.
6202         (insert (format "X-Gnus-Coding-System: -*- coding: %s; -*-\n\n"
6203                         coding-system-for-write)))
6204       (if exists
6205           (progn
6206             (write-region (point-min) (point-max) file-name nil 'no-message)
6207             (message "Appended to %s" file-name))
6208         (write-region (point-min) (point-max) file-name))))
6209   t)
6210
6211 (defun gnus-narrow-to-page (&optional arg)
6212   "Narrow the article buffer to a page.
6213 If given a numerical ARG, move forward ARG pages."
6214   (interactive "P")
6215   (setq arg (if arg (prefix-numeric-value arg) 0))
6216   (with-current-buffer gnus-article-buffer
6217     (widen)
6218     ;; Remove any old next/prev buttons.
6219     (when (gnus-visual-p 'page-marker)
6220       (let ((inhibit-read-only t))
6221         (gnus-remove-text-with-property 'gnus-prev)
6222         (gnus-remove-text-with-property 'gnus-next)))
6223     (let (st nd pt)
6224       (when (save-excursion
6225               (cond ((< arg 0)
6226                      (if (re-search-backward page-delimiter nil 'move (abs arg))
6227                          (prog1
6228                              (setq nd (match-beginning 0)
6229                                    pt nd)
6230                            (when (re-search-backward page-delimiter nil t)
6231                              (setq st (match-end 0))))
6232                        (when (re-search-forward page-delimiter nil t)
6233                          (setq nd (match-beginning 0)
6234                                pt (point-min)))))
6235                     ((> arg 0)
6236                      (if (re-search-forward page-delimiter nil 'move arg)
6237                          (prog1
6238                              (setq st (match-end 0)
6239                                    pt st)
6240                            (when (re-search-forward page-delimiter nil t)
6241                              (setq nd (match-beginning 0))))
6242                        (when (re-search-backward page-delimiter nil t)
6243                          (setq st (match-end 0)
6244                                pt (point-max)))))
6245                     (t
6246                      (when (re-search-backward page-delimiter nil t)
6247                        (goto-char (setq st (match-end 0))))
6248                      (when (re-search-forward page-delimiter nil t)
6249                        (setq nd (match-beginning 0)))
6250                      (or st nd))))
6251         (setq gnus-page-broken t)
6252         (when pt (goto-char pt))
6253         (narrow-to-region (or st (point-min)) (or nd (point-max)))
6254         (when (gnus-visual-p 'page-marker)
6255           (save-excursion
6256             (when nd
6257               (goto-char nd)
6258               (gnus-insert-next-page-button))
6259             (when st
6260               (goto-char st)
6261               (gnus-insert-prev-page-button))))))))
6262
6263 ;; Article mode commands
6264
6265 (defun gnus-article-goto-next-page ()
6266   "Show the next page of the article."
6267   (interactive)
6268   (when (gnus-article-next-page)
6269     (goto-char (point-min))
6270     (gnus-article-read-summary-keys nil (gnus-character-to-event ?n))))
6271
6272
6273 (defun gnus-article-goto-prev-page ()
6274   "Show the previous page of the article."
6275   (interactive)
6276   (if (save-restriction (widen) (bobp)) ;; Real beginning-of-buffer?
6277       (gnus-article-read-summary-keys nil (gnus-character-to-event ?p))
6278     (gnus-article-prev-page nil)))
6279
6280 ;; This is cleaner but currently breaks `gnus-pick-mode':
6281 ;;
6282 ;; (defun gnus-article-goto-next-page ()
6283 ;;   "Show the next page of the article."
6284 ;;   (interactive)
6285 ;;   (gnus-eval-in-buffer-window gnus-summary-buffer
6286 ;;     (gnus-summary-next-page)))
6287 ;;
6288 ;; (defun gnus-article-goto-prev-page ()
6289 ;;   "Show the next page of the article."
6290 ;;   (interactive)
6291 ;;   (gnus-eval-in-buffer-window gnus-summary-buffer
6292 ;;     (gnus-summary-prev-page)))
6293
6294 (defun gnus-article-next-page (&optional lines)
6295   "Show the next page of the current article.
6296 If end of article, return non-nil.  Otherwise return nil.
6297 Argument LINES specifies lines to be scrolled up."
6298   (interactive "p")
6299   (move-to-window-line (if (featurep 'xemacs) -1 (- -1 scroll-margin)))
6300   (if (and (not (and gnus-article-over-scroll
6301                      (> (count-lines (window-start) (point-max))
6302                         (if (featurep 'xemacs)
6303                             (or lines (1- (window-height)))
6304                           (+ (or lines (1- (window-height))) scroll-margin)))))
6305            (save-excursion
6306              (end-of-line)
6307              (and (pos-visible-in-window-p)     ;Not continuation line.
6308                   (>= (point) (point-max)))))
6309       ;; Nothing in this page.
6310       (if (or (not gnus-page-broken)
6311               (save-excursion
6312                 (save-restriction
6313                   (widen)
6314                   (forward-line)
6315                   (eobp)))) ;Real end-of-buffer?
6316           (progn
6317             (when gnus-article-over-scroll
6318               (gnus-article-next-page-1 lines))
6319             t)                  ;Nothing more.
6320         (gnus-narrow-to-page 1)         ;Go to next page.
6321         nil)
6322     ;; More in this page.
6323     (gnus-article-next-page-1 lines)
6324     nil))
6325
6326 (defun gnus-article-beginning-of-window ()
6327   "Move point to the beginning of the window.
6328 In Emacs, the point is placed at the line number which `scroll-margin'
6329 specifies."
6330   (if (featurep 'xemacs)
6331       (move-to-window-line 0)
6332     ;; There is an obscure bug in Emacs that makes it impossible to
6333     ;; scroll past big pictures in the article buffer.  Try to fix
6334     ;; this by adding a sanity check by counting the lines visible.
6335     (when (> (count-lines (window-start) (window-end)) 30)
6336       (move-to-window-line
6337        (min (max 0 scroll-margin)
6338             (max 1 (- (window-height)
6339                       (if mode-line-format 1 0)
6340                       (if header-line-format 1 0)
6341                       2)))))))
6342
6343 (defun gnus-article-next-page-1 (lines)
6344   (condition-case ()
6345       (let ((scroll-in-place nil)
6346             (auto-window-vscroll nil))
6347         (scroll-up lines))
6348     (end-of-buffer
6349      ;; Long lines may cause an end-of-buffer error.
6350      (goto-char (point-max))))
6351   (gnus-article-beginning-of-window))
6352
6353 (defun gnus-article-prev-page (&optional lines)
6354   "Show previous page of current article.
6355 Argument LINES specifies lines to be scrolled down."
6356   (interactive "p")
6357   (move-to-window-line 0)
6358   (if (and gnus-page-broken
6359            (bobp)
6360            (not (save-restriction (widen) (bobp)))) ;Real beginning-of-buffer?
6361       (progn
6362         (gnus-narrow-to-page -1)        ;Go to previous page.
6363         (goto-char (point-max))
6364         (recenter (if gnus-article-over-scroll
6365                       (if lines
6366                           (max (if (featurep 'xemacs)
6367                                    lines
6368                                  (+ lines scroll-margin))
6369                                3)
6370                         (- (window-height) 2))
6371                     -1)))
6372     (prog1
6373         (condition-case ()
6374             (let ((scroll-in-place nil))
6375               (scroll-down lines))
6376           (beginning-of-buffer
6377            (goto-char (point-min))))
6378       (gnus-article-beginning-of-window))))
6379
6380 (defun gnus-article-only-boring-p ()
6381   "Decide whether there is only boring text remaining in the article.
6382 Something \"interesting\" is a word of at least two letters that does
6383 not have a face in `gnus-article-boring-faces'."
6384   (when (and gnus-article-skip-boring
6385              (boundp 'gnus-article-boring-faces)
6386              (symbol-value 'gnus-article-boring-faces))
6387     (save-excursion
6388       (let ((inhibit-point-motion-hooks t))
6389         (catch 'only-boring
6390           (while (re-search-forward "\\b\\w\\w" nil t)
6391             (forward-char -1)
6392             (when (not (gnus-intersection
6393                         (gnus-faces-at (point))
6394                         (symbol-value 'gnus-article-boring-faces)))
6395               (throw 'only-boring nil)))
6396           (throw 'only-boring t))))))
6397
6398 (defun gnus-article-refer-article ()
6399   "Read article specified by message-id around point."
6400   (interactive)
6401   (save-excursion
6402     (re-search-backward "[ \t]\\|^" (point-at-bol) t)
6403     (re-search-forward "<?news:<?\\|<" (point-at-eol) t)
6404     (if (re-search-forward "[^@ ]+@[^ \t>]+" (point-at-eol) t)
6405         (let ((msg-id (concat "<" (match-string 0) ">")))
6406           (set-buffer gnus-summary-buffer)
6407           (gnus-summary-refer-article msg-id))
6408       (error "No references around point"))))
6409
6410 (defun gnus-article-show-summary ()
6411   "Reconfigure windows to show summary buffer."
6412   (interactive)
6413   (if (not (gnus-buffer-live-p gnus-summary-buffer))
6414       (error "There is no summary buffer for this article buffer")
6415     (gnus-article-set-globals)
6416     (gnus-configure-windows 'article)
6417     (gnus-summary-goto-subject gnus-current-article)
6418     (gnus-summary-position-point)))
6419
6420 (defun gnus-article-describe-briefly ()
6421   "Describe article mode commands briefly."
6422   (interactive)
6423   (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")))
6424
6425 (defun gnus-article-check-buffer ()
6426   "Beep if not in an article buffer."
6427   (unless (equal major-mode 'gnus-article-mode)
6428     (error "Command invoked outside of a Gnus article buffer")))
6429
6430 (defun gnus-article-read-summary-keys (&optional arg key not-restore-window)
6431   "Read a summary buffer key sequence and execute it from the article buffer."
6432   (interactive "P")
6433   (gnus-article-check-buffer)
6434   (let ((nosaves
6435          '("q" "Q"  "c" "r" "\C-c\C-f" "m"  "a" "f"
6436            "Zc" "ZC" "ZE" "ZQ" "ZZ" "Zn" "ZR" "ZG" "ZN" "ZP"
6437            "=" "^" "\M-^" "|"))
6438         (nosave-but-article
6439          '("A " "A<" "A>" "AM" "AP" "AR" "AT" "A\C-?" "A\M-\r" "A\r" "Ab" "Ae"
6440            "An" "Ap" [?A (meta return)] [?A delete]))
6441         (nosave-in-article
6442          '("AS" "\C-d"))
6443         (up-to-top
6444          '("n" "Gn" "p" "Gp"))
6445         keys new-sum-point)
6446     (with-current-buffer gnus-article-current-summary
6447       (let (gnus-pick-mode)
6448         (setq unread-command-events (nconc unread-command-events
6449                                            (list (or key last-command-event)))
6450               keys (if (featurep 'xemacs)
6451                        (events-to-keys (read-key-sequence nil t))
6452                      (read-key-sequence nil t)))))
6453
6454     (message "")
6455
6456     (cond
6457      ((eq (aref keys (1- (length keys))) ?\C-h)
6458       (gnus-article-describe-bindings (substring keys 0 -1)))
6459      ((or (member keys nosaves)
6460           (member keys nosave-but-article)
6461           (member keys nosave-in-article))
6462       (let (func)
6463         (save-window-excursion
6464           (pop-to-buffer gnus-article-current-summary)
6465           ;; We disable the pick minor mode commands.
6466           (let (gnus-pick-mode)
6467             (setq func (key-binding keys t))))
6468         (if (or (not func)
6469                 (numberp func))
6470             (ding)
6471           (unless (member keys nosave-in-article)
6472             (set-buffer gnus-article-current-summary))
6473           (when (get func 'disabled)
6474             (error "Function %s disabled" func))
6475           (call-interactively func)
6476           (setq new-sum-point (point)))
6477         (when (member keys nosave-but-article)
6478           (pop-to-buffer gnus-article-buffer))))
6479      (t
6480       ;; These commands should restore window configuration.
6481       (let ((obuf (current-buffer))
6482             (owin (current-window-configuration))
6483             win func in-buffer selected new-sum-start new-sum-hscroll err)
6484         (cond (not-restore-window
6485                (pop-to-buffer gnus-article-current-summary)
6486                (setq win (selected-window)))
6487               ((setq win (get-buffer-window gnus-article-current-summary))
6488                (select-window win))
6489               (t
6490                (let ((summary-buffer gnus-article-current-summary))
6491                  (gnus-configure-windows 'article)
6492                  (unless (setq win (get-buffer-window summary-buffer 'visible))
6493                    (let ((gnus-buffer-configuration
6494                           '((article ((vertical 1.0
6495                                                 (summary 0.25 point)
6496                                                 (article 1.0)))))))
6497                      (gnus-configure-windows 'article))
6498                    (setq win (get-buffer-window summary-buffer 'visible)))
6499                  (gnus-select-frame-set-input-focus (window-frame win))
6500                  (select-window win))))
6501         (setq in-buffer (current-buffer))
6502         ;; We disable the pick minor mode commands.
6503         (setq func (let (gnus-pick-mode)
6504                      (key-binding keys t)))
6505         (when (get func 'disabled)
6506           (error "Function %s disabled" func))
6507         (if (and func
6508                  (functionp func)
6509                  (condition-case code
6510                      (progn
6511                        (call-interactively func)
6512                        t)
6513                    (error
6514                     (setq err code)
6515                     nil)))
6516             (progn
6517               (when (eq win (selected-window))
6518                 (setq new-sum-point (point)
6519                       new-sum-start (window-start win)
6520                       new-sum-hscroll (window-hscroll win)))
6521               (when (or (eq in-buffer (current-buffer))
6522                         (when (eq obuf (current-buffer))
6523                           (set-buffer in-buffer)
6524                           t))
6525                 (setq selected (gnus-summary-select-article))
6526                 (set-buffer obuf)
6527                 (unless not-restore-window
6528                   (set-window-configuration owin))
6529                 (when (and (eq selected 'old)
6530                            new-sum-point)
6531                   (set-window-start (get-buffer-window (current-buffer))
6532                                     1)
6533                   (set-window-point (get-buffer-window (current-buffer))
6534                                     (if (article-goto-body)
6535                                         (1- (point))
6536                                       (point))))
6537                 (when (and (not not-restore-window)
6538                            new-sum-point
6539                            (window-live-p win)
6540                            (with-current-buffer (window-buffer win)
6541                              (eq major-mode 'gnus-summary-mode)))
6542                   (set-window-point win new-sum-point)
6543                   (set-window-start win new-sum-start)
6544                   (set-window-hscroll win new-sum-hscroll))))
6545           (set-window-configuration owin)
6546           (if err
6547               (signal (car err) (cdr err))
6548             (ding))))))))
6549
6550 (defun gnus-article-read-summary-send-keys ()
6551   (interactive)
6552   (let ((unread-command-events (list (gnus-character-to-event ?S))))
6553     (gnus-article-read-summary-keys)))
6554
6555 (defun gnus-article-describe-key (key)
6556   "Display documentation of the function invoked by KEY.
6557 KEY is a string or a vector."
6558   (interactive (list (let ((cursor-in-echo-area t)) ;; better for XEmacs.
6559                        (read-key-sequence "Describe key: "))))
6560   (gnus-article-check-buffer)
6561   (if (memq (key-binding key t) '(gnus-article-read-summary-keys
6562                                   gnus-article-read-summary-send-keys))
6563       (with-current-buffer gnus-article-current-summary
6564         (setq unread-command-events
6565               (if (featurep 'xemacs)
6566                   (append key nil)
6567                 (mapcar (lambda (x) (if (and (integerp x) (>= x 128))
6568                                         (list 'meta (- x 128))
6569                                       x))
6570                         key)))
6571         (let ((cursor-in-echo-area t)
6572               gnus-pick-mode)
6573           (describe-key (read-key-sequence nil t))))
6574     (describe-key key)))
6575
6576 (defun gnus-article-describe-key-briefly (key &optional insert)
6577   "Display documentation of the function invoked by KEY.
6578 KEY is a string or a vector."
6579   (interactive (list (let ((cursor-in-echo-area t)) ;; better for XEmacs.
6580                        (read-key-sequence "Describe key: "))
6581                      current-prefix-arg))
6582   (gnus-article-check-buffer)
6583   (if (memq (key-binding key t) '(gnus-article-read-summary-keys
6584                                   gnus-article-read-summary-send-keys))
6585       (with-current-buffer gnus-article-current-summary
6586         (setq unread-command-events
6587               (if (featurep 'xemacs)
6588                   (append key nil)
6589                 (mapcar (lambda (x) (if (and (integerp x) (>= x 128))
6590                                         (list 'meta (- x 128))
6591                                       x))
6592                         key)))
6593         (let ((cursor-in-echo-area t)
6594               gnus-pick-mode)
6595           (describe-key-briefly (read-key-sequence nil t) insert)))
6596     (describe-key-briefly key insert)))
6597
6598 ;;`gnus-agent-mode' in gnus-agent.el will define it.
6599 (defvar gnus-agent-summary-mode)
6600 (defvar gnus-draft-mode)
6601 ;; Calling help-buffer will autoload help-mode.
6602 (defvar help-xref-stack-item)
6603 ;; Emacs 22 doesn't load it in the batch mode.
6604 (eval-when-compile
6605   (autoload 'help-buffer "help-mode"))
6606
6607 (defun gnus-article-describe-bindings (&optional prefix)
6608   "Show a list of all defined keys, and their definitions.
6609 The optional argument PREFIX, if non-nil, should be a key sequence;
6610 then we display only bindings that start with that prefix."
6611   (interactive)
6612   (gnus-article-check-buffer)
6613   (let ((keymap (copy-keymap gnus-article-mode-map))
6614         (map (copy-keymap gnus-article-send-map))
6615         (sumkeys (where-is-internal 'gnus-article-read-summary-keys))
6616         parent agent draft)
6617     (define-key keymap "S" map)
6618     (define-key map [t] nil)
6619     (with-current-buffer gnus-article-current-summary
6620       (set-keymap-parent
6621        keymap
6622        (if (setq parent (keymap-parent gnus-article-mode-map))
6623            (prog1
6624                (setq parent (copy-keymap parent))
6625              (set-keymap-parent parent (current-local-map)))
6626          (current-local-map)))
6627       (set-keymap-parent map (key-binding "S"))
6628       (let (key def gnus-pick-mode)
6629         (while sumkeys
6630           (setq key (pop sumkeys))
6631           (cond ((and (vectorp key) (= (length key) 1)
6632                       (consp (setq def (aref key 0)))
6633                       (numberp (car def)) (numberp (cdr def)))
6634                  (when (< (max (car def) (cdr def)) 128)
6635                    (setq sumkeys
6636                          (append (mapcar
6637                                   #'vector
6638                                   (nreverse (gnus-uncompress-range def)))
6639                                  sumkeys))))
6640                 ((setq def (key-binding key))
6641                  (unless (eq def 'undefined)
6642                    (define-key keymap key def))))))
6643       (when (boundp 'gnus-agent-summary-mode)
6644         (setq agent gnus-agent-summary-mode))
6645       (when (boundp 'gnus-draft-mode)
6646         (setq draft gnus-draft-mode)))
6647     (with-temp-buffer
6648       (use-local-map keymap)
6649       (set (make-local-variable 'gnus-agent-summary-mode) agent)
6650       (set (make-local-variable 'gnus-draft-mode) draft)
6651       (describe-bindings prefix))
6652     (let ((item `((lambda (prefix)
6653                     (with-current-buffer ,(current-buffer)
6654                       (gnus-article-describe-bindings prefix)))
6655                   ,prefix)))
6656       (with-current-buffer (let (help-xref-following) (help-buffer))
6657         (setq help-xref-stack-item item)))))
6658
6659 (defun gnus-article-reply-with-original (&optional wide)
6660   "Start composing a reply mail to the current message.
6661 The text in the region will be yanked.  If the region isn't active,
6662 the entire article will be yanked."
6663   (interactive)
6664   (let ((article (cdr gnus-article-current))
6665         contents)
6666     (if (not (gnus-region-active-p))
6667         (with-current-buffer gnus-summary-buffer
6668           (gnus-summary-reply (list (list article)) wide))
6669       (setq contents (buffer-substring (point) (mark t)))
6670       ;; Deactivate active regions.
6671       (when (and (boundp 'transient-mark-mode)
6672                  transient-mark-mode)
6673         (setq mark-active nil))
6674       (with-current-buffer gnus-summary-buffer
6675         (gnus-summary-reply
6676          (list (list article contents)) wide)))))
6677
6678 (defun gnus-article-wide-reply-with-original ()
6679   "Start composing a wide reply mail to the current message.
6680 The text in the region will be yanked.  If the region isn't active,
6681 the entire article will be yanked."
6682   (interactive)
6683   (gnus-article-reply-with-original t))
6684
6685 (defun gnus-article-followup-with-original ()
6686   "Compose a followup to the current article.
6687 The text in the region will be yanked.  If the region isn't active,
6688 the entire article will be yanked."
6689   (interactive)
6690   (let ((article (cdr gnus-article-current))
6691         contents)
6692       (if (not (gnus-region-active-p))
6693           (with-current-buffer gnus-summary-buffer
6694             (gnus-summary-followup (list (list article))))
6695         (setq contents (buffer-substring (point) (mark t)))
6696         ;; Deactivate active regions.
6697         (when (and (boundp 'transient-mark-mode)
6698                    transient-mark-mode)
6699           (setq mark-active nil))
6700         (with-current-buffer gnus-summary-buffer
6701           (gnus-summary-followup
6702            (list (list article contents)))))))
6703
6704 (defun gnus-article-hide (&optional arg force)
6705   "Hide all the gruft in the current article.
6706 This means that signatures, cited text and (some) headers will be
6707 hidden.
6708 If given a prefix, show the hidden text instead."
6709   (interactive (append (gnus-article-hidden-arg) (list 'force)))
6710   (gnus-article-hide-headers arg)
6711   (gnus-article-hide-list-identifiers arg)
6712   (gnus-article-hide-citation-maybe arg force)
6713   (gnus-article-hide-signature arg))
6714
6715 (defun gnus-article-maybe-highlight ()
6716   "Do some article highlighting if article highlighting is requested."
6717   (when (gnus-visual-p 'article-highlight 'highlight)
6718     (gnus-article-highlight-some)))
6719
6720 (defun gnus-check-group-server ()
6721   ;; Make sure the connection to the server is alive.
6722   (unless (gnus-server-opened
6723            (gnus-find-method-for-group gnus-newsgroup-name))
6724     (gnus-check-server (gnus-find-method-for-group gnus-newsgroup-name))
6725     (gnus-request-group gnus-newsgroup-name t)))
6726
6727 (eval-when-compile
6728   (autoload 'nneething-get-file-name "nneething"))
6729
6730 (defun gnus-request-article-this-buffer (article group)
6731   "Get an article and insert it into this buffer."
6732   (let (do-update-line sparse-header)
6733     (prog1
6734         (save-excursion
6735           (erase-buffer)
6736           (gnus-kill-all-overlays)
6737           (setq group (or group gnus-newsgroup-name))
6738
6739           ;; Using `gnus-request-article' directly will insert the article into
6740           ;; `nntp-server-buffer' - so we'll save some time by not having to
6741           ;; copy it from the server buffer into the article buffer.
6742
6743           ;; We only request an article by message-id when we do not have the
6744           ;; headers for it, so we'll have to get those.
6745           (when (stringp article)
6746             (gnus-read-header article))
6747
6748           ;; If the article number is negative, that means that this article
6749           ;; doesn't belong in this newsgroup (possibly), so we find its
6750           ;; message-id and request it by id instead of number.
6751           (when (and (numberp article)
6752                      gnus-summary-buffer
6753                      (get-buffer gnus-summary-buffer)
6754                      (gnus-buffer-exists-p gnus-summary-buffer))
6755             (with-current-buffer gnus-summary-buffer
6756               (let ((header (gnus-summary-article-header article)))
6757                 (when (< article 0)
6758                   (cond
6759                    ((memq article gnus-newsgroup-sparse)
6760                     ;; This is a sparse gap article.
6761                     (setq do-update-line article)
6762                     (setq article (mail-header-id header))
6763                     (setq sparse-header (gnus-read-header article))
6764                     (setq gnus-newsgroup-sparse
6765                           (delq article gnus-newsgroup-sparse)))
6766                    ((vectorp header)
6767                     ;; It's a real article.
6768                     (setq article (mail-header-id header)))
6769                    (t
6770                     ;; It is an extracted pseudo-article.
6771                     (setq article 'pseudo)
6772                     (gnus-request-pseudo-article header))))
6773
6774                 (let ((method (gnus-find-method-for-group
6775                                gnus-newsgroup-name)))
6776                   (when (and (eq (car method) 'nneething)
6777                              (vectorp header))
6778                     (let ((dir (nneething-get-file-name
6779                                 (mail-header-id header))))
6780                       (when (and (stringp dir)
6781                                  (file-directory-p dir))
6782                         (setq article 'nneething)
6783                         (gnus-group-enter-directory dir))))))))
6784
6785           (cond
6786            ;; Refuse to select canceled articles.
6787            ((and (numberp article)
6788                  gnus-summary-buffer
6789                  (get-buffer gnus-summary-buffer)
6790                  (gnus-buffer-exists-p gnus-summary-buffer)
6791                  (eq (cdr (with-current-buffer gnus-summary-buffer
6792                             (assq article gnus-newsgroup-reads)))
6793                      gnus-canceled-mark))
6794             nil)
6795            ;; We first check `gnus-original-article-buffer'.
6796            ((and (get-buffer gnus-original-article-buffer)
6797                  (numberp article)
6798                  (with-current-buffer gnus-original-article-buffer
6799                    (and (equal (car gnus-original-article) group)
6800                         (eq (cdr gnus-original-article) article))))
6801             ;; `insert-buffer-substring' would incorrectly use the
6802             ;; equivalent of string-make-multibyte which amount to decoding
6803             ;; with locale-coding-system, causing failure of
6804             ;; subsequent decoding.
6805             (insert (mm-string-to-multibyte
6806                      (with-current-buffer gnus-original-article-buffer
6807                        (buffer-substring (point-min) (point-max)))))
6808             'article)
6809            ;; Check the backlog.
6810            ((and gnus-keep-backlog
6811                  (gnus-backlog-request-article group article (current-buffer)))
6812             'article)
6813            ;; Check asynchronous pre-fetch.
6814            ((gnus-async-request-fetched-article group article (current-buffer))
6815             (gnus-async-prefetch-next group article gnus-summary-buffer)
6816             (when (and (numberp article) gnus-keep-backlog)
6817               (gnus-backlog-enter-article group article (current-buffer)))
6818             'article)
6819            ;; Check the cache.
6820            ((and gnus-use-cache
6821                  (numberp article)
6822                  (gnus-cache-request-article article group))
6823             'article)
6824            ;; Check the agent cache.
6825            ((gnus-agent-request-article article group)
6826             'article)
6827            ;; Get the article and put into the article buffer.
6828            ((or (stringp article)
6829                 (numberp article))
6830             (let ((gnus-override-method gnus-override-method)
6831                   (methods (and (stringp article)
6832                                 gnus-refer-article-method))
6833                   (backend (car (gnus-find-method-for-group
6834                                  gnus-newsgroup-name)))
6835                   result
6836                   (inhibit-read-only t))
6837               (if (or (not (listp methods))
6838                       (and (symbolp (car methods))
6839                            (assq (car methods) nnoo-definition-alist)))
6840                   (setq methods (list methods)))
6841               (when (and (null gnus-override-method)
6842                          methods)
6843                 (setq gnus-override-method (pop methods)))
6844               (while (not result)
6845                 (when (eq gnus-override-method 'current)
6846                   (setq gnus-override-method
6847                         (with-current-buffer gnus-summary-buffer
6848                           gnus-current-select-method)))
6849                 (erase-buffer)
6850                 (gnus-kill-all-overlays)
6851                 (let ((gnus-newsgroup-name group))
6852                   (gnus-check-group-server))
6853                 (cond
6854                  ((gnus-request-article article group (current-buffer))
6855                   (when (numberp article)
6856                     (gnus-async-prefetch-next group article
6857                                               gnus-summary-buffer)
6858                     (when gnus-keep-backlog
6859                       (gnus-backlog-enter-article
6860                        group article (current-buffer))))
6861                   (setq result 'article))
6862                  (methods
6863                   (setq gnus-override-method (pop methods)))
6864                  ((not (string-match "^400 "
6865                                      (nnheader-get-report backend)))
6866                   ;; If we get 400 server disconnect, reconnect and
6867                   ;; retry; otherwise, assume the article has expired.
6868                   (setq result 'done))))
6869               (and (eq result 'article) 'article)))
6870            ;; It was a pseudo.
6871            (t article)))
6872
6873       ;; Associate this article with the current summary buffer.
6874       (setq gnus-article-current-summary gnus-summary-buffer)
6875
6876       ;; Take the article from the original article buffer
6877       ;; and place it in the buffer it's supposed to be in.
6878       (when (and (get-buffer gnus-article-buffer)
6879                  (equal (buffer-name (current-buffer))
6880                         (buffer-name (get-buffer gnus-article-buffer))))
6881         (save-excursion
6882           (if (get-buffer gnus-original-article-buffer)
6883               (set-buffer gnus-original-article-buffer)
6884             (set-buffer (gnus-get-buffer-create gnus-original-article-buffer))
6885             (buffer-disable-undo)
6886             (setq major-mode 'gnus-original-article-mode)
6887             (setq buffer-read-only t))
6888           (let ((inhibit-read-only t))
6889             (erase-buffer)
6890             (insert-buffer-substring gnus-article-buffer))
6891           (setq gnus-original-article (cons group article)))
6892
6893         ;; Decode charsets.
6894         (run-hooks 'gnus-article-decode-hook)
6895         ;; Mark article as decoded or not.
6896         (setq gnus-article-decoded-p gnus-article-decode-hook))
6897
6898       ;; Update sparse articles.
6899       (when (and do-update-line
6900                  (or (numberp article)
6901                      (stringp article)))
6902         (let ((buf (current-buffer)))
6903           (set-buffer gnus-summary-buffer)
6904           (gnus-summary-update-article do-update-line sparse-header)
6905           (gnus-summary-goto-subject do-update-line nil t)
6906           (set-window-point (gnus-get-buffer-window (current-buffer) t)
6907                             (point))
6908           (set-buffer buf))))))
6909
6910 (defun gnus-block-private-groups (group)
6911   (if (gnus-news-group-p group)
6912       ;; Block nothing in news groups.
6913       nil
6914     ;; Block everything anywhere else.
6915     "."))
6916
6917 (defun gnus-blocked-images ()
6918   (if (functionp gnus-blocked-images)
6919       (funcall gnus-blocked-images gnus-newsgroup-name)
6920     gnus-blocked-images))
6921
6922 ;;;
6923 ;;; Article editing
6924 ;;;
6925
6926 (defcustom gnus-article-edit-mode-hook nil
6927   "Hook run in article edit mode buffers."
6928   :group 'gnus-article-various
6929   :type 'hook)
6930
6931 (defvar gnus-article-edit-done-function nil)
6932
6933 (defvar gnus-article-edit-mode-map nil)
6934
6935 ;; Should we be using derived.el for this?
6936 (unless gnus-article-edit-mode-map
6937   (setq gnus-article-edit-mode-map (make-keymap))
6938   (set-keymap-parent gnus-article-edit-mode-map text-mode-map)
6939
6940   (gnus-define-keys gnus-article-edit-mode-map
6941     "\C-c?"    describe-mode
6942     "\C-c\C-c" gnus-article-edit-done
6943     "\C-c\C-k" gnus-article-edit-exit
6944     "\C-c\C-f\C-t" message-goto-to
6945     "\C-c\C-f\C-o" message-goto-from
6946     "\C-c\C-f\C-b" message-goto-bcc
6947     ;;"\C-c\C-f\C-w" message-goto-fcc
6948     "\C-c\C-f\C-c" message-goto-cc
6949     "\C-c\C-f\C-s" message-goto-subject
6950     "\C-c\C-f\C-r" message-goto-reply-to
6951     "\C-c\C-f\C-n" message-goto-newsgroups
6952     "\C-c\C-f\C-d" message-goto-distribution
6953     "\C-c\C-f\C-f" message-goto-followup-to
6954     "\C-c\C-f\C-m" message-goto-mail-followup-to
6955     "\C-c\C-f\C-k" message-goto-keywords
6956     "\C-c\C-f\C-u" message-goto-summary
6957     "\C-c\C-f\C-i" message-insert-or-toggle-importance
6958     "\C-c\C-f\C-a" message-generate-unsubscribed-mail-followup-to
6959     "\C-c\C-b" message-goto-body
6960     "\C-c\C-i" message-goto-signature
6961
6962     "\C-c\C-t" message-insert-to
6963     "\C-c\C-n" message-insert-newsgroups
6964     "\C-c\C-o" message-sort-headers
6965     "\C-c\C-e" message-elide-region
6966     "\C-c\C-v" message-delete-not-region
6967     "\C-c\C-z" message-kill-to-signature
6968     "\M-\r" message-newline-and-reformat
6969     "\C-c\C-a" mml-attach-file
6970     "\C-a" message-beginning-of-line
6971     "\t" message-tab
6972     "\M-;" comment-region)
6973
6974   (gnus-define-keys (gnus-article-edit-wash-map
6975                      "\C-c\C-w" gnus-article-edit-mode-map)
6976     "f" gnus-article-edit-full-stops))
6977
6978 (easy-menu-define
6979   gnus-article-edit-mode-field-menu gnus-article-edit-mode-map ""
6980   '("Field"
6981     ["Fetch To" message-insert-to t]
6982     ["Fetch Newsgroups" message-insert-newsgroups t]
6983     "----"
6984     ["To" message-goto-to t]
6985     ["From" message-goto-from t]
6986     ["Subject" message-goto-subject t]
6987     ["Cc" message-goto-cc t]
6988     ["Reply-To" message-goto-reply-to t]
6989     ["Summary" message-goto-summary t]
6990     ["Keywords" message-goto-keywords t]
6991     ["Newsgroups" message-goto-newsgroups t]
6992     ["Followup-To" message-goto-followup-to t]
6993     ["Mail-Followup-To" message-goto-mail-followup-to t]
6994     ["Distribution" message-goto-distribution t]
6995     ["Body" message-goto-body t]
6996     ["Signature" message-goto-signature t]))
6997
6998 (define-derived-mode gnus-article-edit-mode message-mode "Article Edit"
6999   "Major mode for editing articles.
7000 This is an extended text-mode.
7001
7002 \\{gnus-article-edit-mode-map}"
7003   (make-local-variable 'gnus-article-edit-done-function)
7004   (make-local-variable 'gnus-prev-winconf)
7005   (set (make-local-variable 'font-lock-defaults)
7006        '(message-font-lock-keywords t))
7007   (set (make-local-variable 'mail-header-separator) "")
7008   (set (make-local-variable 'gnus-article-edit-mode) t)
7009   (easy-menu-add message-mode-field-menu message-mode-map)
7010   (mml-mode)
7011   (setq buffer-read-only nil)
7012   (buffer-enable-undo)
7013   (widen))
7014
7015 (defun gnus-article-edit (&optional force)
7016   "Edit the current article.
7017 This will have permanent effect only in mail groups.
7018 If FORCE is non-nil, allow editing of articles even in read-only
7019 groups."
7020   (interactive "P")
7021   (when (and (not force)
7022              (gnus-group-read-only-p))
7023     (error "The current newsgroup does not support article editing"))
7024   (gnus-article-date-original)
7025   (gnus-article-edit-article
7026    'ignore
7027    `(lambda (no-highlight)
7028       'ignore
7029       (gnus-summary-edit-article-done
7030        ,(or (mail-header-references gnus-current-headers) "")
7031        ,(gnus-group-read-only-p) ,gnus-summary-buffer no-highlight))))
7032
7033 (defun gnus-article-edit-article (start-func exit-func &optional quiet)
7034   "Start editing the contents of the current article buffer."
7035   (let ((winconf (current-window-configuration)))
7036     (set-buffer gnus-article-buffer)
7037     (let ((message-auto-save-directory
7038            ;; Don't associate the article buffer with a draft file.
7039            nil))
7040       (gnus-article-edit-mode))
7041     (funcall start-func)
7042     (set-buffer-modified-p nil)
7043     (gnus-configure-windows 'edit-article)
7044     (setq gnus-article-edit-done-function exit-func)
7045     (setq gnus-prev-winconf winconf)
7046     (unless quiet
7047       (gnus-message 6 "C-c C-c to end edits"))))
7048
7049 (defun gnus-article-edit-done (&optional arg)
7050   "Update the article edits and exit."
7051   (interactive "P")
7052   (let ((func gnus-article-edit-done-function)
7053         (buf (current-buffer))
7054         (start (window-start))
7055         (p (point))
7056         (winconf gnus-prev-winconf))
7057     (widen) ;; Widen it in case that users narrowed the buffer.
7058     (funcall func arg)
7059     (set-buffer buf)
7060     ;; The cache and backlog have to be flushed somewhat.
7061     (when gnus-keep-backlog
7062       (gnus-backlog-remove-article
7063        (car gnus-article-current) (cdr gnus-article-current)))
7064     ;; Flush original article as well.
7065     (gnus-flush-original-article-buffer)
7066     (when gnus-use-cache
7067       (gnus-cache-update-article
7068        (car gnus-article-current) (cdr gnus-article-current)))
7069     ;; We remove all text props from the article buffer.
7070     (kill-all-local-variables)
7071     (set-text-properties (point-min) (point-max) nil)
7072     (gnus-article-mode)
7073     (set-window-configuration winconf)
7074     (set-buffer buf)
7075     (set-window-start (get-buffer-window buf) start)
7076     (set-window-point (get-buffer-window buf) (point)))
7077   (gnus-summary-show-article))
7078
7079 (defun gnus-flush-original-article-buffer ()
7080   (when (get-buffer gnus-original-article-buffer)
7081     (with-current-buffer gnus-original-article-buffer
7082       (setq gnus-original-article nil))))
7083
7084 (defun gnus-article-edit-exit ()
7085   "Exit the article editing without updating."
7086   (interactive)
7087   (when (or (not (buffer-modified-p))
7088             (yes-or-no-p "Article modified; kill anyway? "))
7089     (let ((curbuf (current-buffer))
7090           (p (point))
7091           (window-start (window-start)))
7092       (erase-buffer)
7093       (if (gnus-buffer-live-p gnus-original-article-buffer)
7094           (insert-buffer-substring gnus-original-article-buffer))
7095       (let ((winconf gnus-prev-winconf))
7096         (kill-all-local-variables)
7097         (gnus-article-mode)
7098         (set-window-configuration winconf)
7099         ;; Tippy-toe some to make sure that point remains where it was.
7100         (save-current-buffer
7101           (set-buffer curbuf)
7102           (set-window-start (get-buffer-window (current-buffer)) window-start)
7103           (goto-char p))))
7104     (gnus-summary-show-article)))
7105
7106 (defun gnus-article-edit-full-stops ()
7107   "Interactively repair spacing at end of sentences."
7108   (interactive)
7109   (save-excursion
7110     (goto-char (point-min))
7111     (search-forward-regexp "^$" nil t)
7112     (let ((case-fold-search nil))
7113       (query-replace-regexp "\\([.!?][])}]* \\)\\([[({A-Z]\\)" "\\1 \\2"))))
7114
7115 ;;;
7116 ;;; Article highlights
7117 ;;;
7118
7119 ;; Written by Per Abrahamsen <abraham@iesd.auc.dk>.
7120
7121 ;;; Internal Variables:
7122
7123 (defcustom gnus-button-url-regexp
7124   (concat
7125    "\\b\\(\\(www\\.\\|\\(s?https?\\|ftp\\|file\\|gopher\\|"
7126    "nntp\\|news\\|telnet\\|wais\\|mailto\\|info\\):\\)"
7127    "\\(//[-a-z0-9_.]+:[0-9]*\\)?"
7128    (if (string-match "[[:digit:]]" "1") ;; Support POSIX?
7129        (let ((chars "-a-z0-9_=#$@~%&*+\\/[:word:]")
7130              (punct "!?:;.,"))
7131          (concat
7132           "\\(?:"
7133           ;; Match paired parentheses, e.g. in Wikipedia URLs:
7134           ;; http://thread.gmane.org/47B4E3B2.3050402@gmail.com
7135           "[" chars punct "]+" "(" "[" chars punct "]+" "[" chars "]*)" "[" chars "]*"
7136           "\\|"
7137           "[" chars punct     "]+" "[" chars "]"
7138           "\\)"))
7139      (concat ;; XEmacs 21.4 doesn't support POSIX.
7140       "\\([-a-z0-9_=!?#$@~%&*+\\/:;.,]\\|\\w\\)+"
7141       "\\([-a-z0-9_=#$@~%&*+\\/]\\|\\w\\)"))
7142    "\\)")
7143   "Regular expression that matches URLs."
7144   :group 'gnus-article-buttons
7145   :type 'regexp)
7146
7147 (defcustom gnus-button-valid-fqdn-regexp
7148   message-valid-fqdn-regexp
7149   "Regular expression that matches a valid FQDN."
7150   :version "22.1"
7151   :group 'gnus-article-buttons
7152   :type 'regexp)
7153
7154 ;; Regexp suggested by Felix Wiemann in <87oeuomcz9.fsf@news2.ososo.de>
7155 (defcustom gnus-button-valid-localpart-regexp
7156   "[a-z0-9$%(*-=?[_][^<>\")!;:,{}\n\t @]*"
7157   "Regular expression that matches a localpart of mail addresses or MIDs."
7158   :version "22.1"
7159   :group 'gnus-article-buttons
7160   :type 'regexp)
7161
7162 (defcustom gnus-button-man-handler 'manual-entry
7163   "Function to use for displaying man pages.
7164 The function must take at least one argument with a string naming the
7165 man page."
7166   :version "22.1"
7167   :type '(choice (function-item :tag "Man" manual-entry)
7168                  (function-item :tag "Woman" woman)
7169                  (function :tag "Other"))
7170   :group 'gnus-article-buttons)
7171
7172 (defcustom gnus-button-mid-or-mail-regexp
7173   (concat "\\b\\(<?" gnus-button-valid-localpart-regexp "@"
7174           gnus-button-valid-fqdn-regexp
7175           ">?\\)\\b")
7176   "Regular expression that matches a message ID or a mail address."
7177   :version "22.1"
7178   :group 'gnus-article-buttons
7179   :type 'regexp)
7180
7181 (defcustom gnus-button-prefer-mid-or-mail 'gnus-button-mid-or-mail-heuristic
7182   "What to do when the button on a string as \"foo123@bar.invalid\" is pushed.
7183 Strings like this can be either a message ID or a mail address.  If it is one
7184 of the symbols `mid' or `mail', Gnus will always assume that the string is a
7185 message ID or a mail address, respectively.  If this variable is set to the
7186 symbol `ask', always query the user what do do.  If it is a function, this
7187 function will be called with the string as its only argument.  The function
7188 must return `mid', `mail', `invalid' or `ask'."
7189   :version "22.1"
7190   :group 'gnus-article-buttons
7191   :type '(choice (function-item :tag "Heuristic function"
7192                                 gnus-button-mid-or-mail-heuristic)
7193                  (const ask)
7194                  (const mid)
7195                  (const mail)))
7196
7197 (defcustom gnus-button-mid-or-mail-heuristic-alist
7198   '((-10.0 . ".+\\$.+@")
7199     (-10.0 . "#")
7200     (-10.0 . "\\*")
7201     (-5.0  . "\\+[^+]*\\+.*@") ;; # two plus signs
7202     (-5.0  . "@[Nn][Ee][Ww][Ss]") ;; /\@news/i
7203     (-5.0  . "@.*[Dd][Ii][Aa][Ll][Uu][Pp]") ;; /\@.*dialup/i;
7204     (-1.0  . "^[^a-z]+@")
7205     ;;
7206     (-5.0  . "\\.[0-9][0-9]+.*@") ;; "\.[0-9]{2,}.*\@"
7207     (-5.0  . "[a-z].*[A-Z].*[a-z].*[A-Z].*@") ;; "([a-z].*[A-Z].*){2,}\@"
7208     (-3.0  . "[A-Z][A-Z][a-z][a-z].*@")
7209     (-5.0  . "\\...?.?@") ;; (-5.0 . "\..{1,3}\@")
7210     ;;
7211     (-2.0  . "^[0-9]")
7212     (-1.0  . "^[0-9][0-9]")
7213     ;;
7214     ;; -3.0 /^[0-9][0-9a-fA-F]{2,2}/;
7215     (-3.0  . "^[0-9][0-9a-fA-F][0-9a-fA-F][^0-9a-fA-F]")
7216     ;; -5.0 /^[0-9][0-9a-fA-F]{3,3}/;
7217     (-5.0  . "^[0-9][0-9a-fA-F][0-9a-fA-F][0-9a-fA-F][^0-9a-fA-F]")
7218     ;;
7219     (-3.0  .  "[0-9][0-9][0-9][0-9][0-9][^0-9].*@") ;; "[0-9]{5,}.*\@"
7220     (-3.0  .  "[0-9][0-9][0-9][0-9][0-9][0-9][0-9][0-9][^0-9].*@")
7221     ;;       "[0-9]{8,}.*\@"
7222     (-3.0
7223      . "[0-9][0-9][0-9][0-9][0-9][0-9][0-9][0-9][0-9][0-9][0-9][0-9].*@")
7224     ;; "[0-9]{12,}.*\@"
7225     ;; compensation for TDMA dated mail addresses:
7226     (25.0  . "-dated-[0-9][0-9][0-9][0-9][0-9][0-9][0-9][0-9]+.*@")
7227     ;;
7228     (-20.0 . "\\.fsf@") ;; Gnus
7229     (-20.0 . "^slrn")
7230     (-20.0 . "^Pine")
7231     (-20.0 . "^alpine\\.")
7232     (-20.0 . "_-_") ;; Subject change in thread
7233     ;;
7234     (-20.0 . "\\.ln@") ;; leafnode
7235     (-30.0 . "@ID-[0-9]+\\.[a-zA-Z]+\\.dfncis\\.de")
7236     (-30.0 . "@4[Aa][Xx]\\.com") ;; Forte Agent
7237     ;;
7238     ;; (5.0 . "") ;; $local_part_len <= 7
7239     (10.0  . "^[^0-9]+@")
7240     (3.0   . "^[^0-9]+[0-9][0-9]?[0-9]?@")
7241     ;;      ^[^0-9]+[0-9]{1,3}\@ digits only at end of local part
7242     (3.0   . "\@stud")
7243     ;;
7244     (2.0   . "[a-z][a-z][._-][A-Z][a-z].*@")
7245     ;;
7246     (0.5   . "^[A-Z][a-z]")
7247     (0.5   . "^[A-Z][a-z][a-z]")
7248     (1.5   . "^[A-Z][a-z][A-Z][a-z][^a-z]") ;; ^[A-Z][a-z]{3,3}
7249     (2.0   . "^[A-Z][a-z][A-Z][a-z][a-z][^a-z]")) ;; ^[A-Z][a-z]{4,4}
7250   "An alist of \(RATE . REGEXP\) pairs for `gnus-button-mid-or-mail-heuristic'.
7251
7252 A negative RATE indicates a message IDs, whereas a positive indicates a mail
7253 address.  The REGEXP is processed with `case-fold-search' set to nil."
7254   :version "22.1"
7255   :group 'gnus-article-buttons
7256   :type '(repeat (cons (number :tag "Rate")
7257                        (regexp :tag "Regexp"))))
7258
7259 (defun gnus-button-mid-or-mail-heuristic (mid-or-mail)
7260   "Guess whether MID-OR-MAIL is a message ID or a mail address.
7261 Returns `mid' if MID-OR-MAIL is a message IDs, `mail' if it's a mail
7262 address, `ask' if unsure and `invalid' if the string is invalid."
7263   (let ((case-fold-search nil)
7264         (list gnus-button-mid-or-mail-heuristic-alist)
7265         (result 0) rate regexp lpartlen elem)
7266     (setq lpartlen
7267           (length (gnus-replace-in-string mid-or-mail "^\\(.*\\)@.*$" "\\1")))
7268     (gnus-message 8 "`%s', length of local part=`%s'." mid-or-mail lpartlen)
7269     ;; Certain special cases...
7270     (when (string-match
7271            (concat
7272             "^0[0-9]+-[0-9][0-9][0-9][0-9]@t-online\\.de$\\|"
7273             "^[0-9]+\\.[0-9]+@compuserve\\|"
7274             "@public\\.gmane\\.org")
7275            mid-or-mail)
7276       (gnus-message 8 "`%s' is a known mail address." mid-or-mail)
7277       (setq result 'mail))
7278     (when (string-match "@.*@\\| " mid-or-mail)
7279       (gnus-message 8 "`%s' is invalid." mid-or-mail)
7280       (setq result 'invalid))
7281     ;; Nothing more to do, if result is not a number here...
7282     (when (numberp result)
7283       (while list
7284         (setq elem (car list)
7285               rate (car elem)
7286               regexp (cdr elem)
7287               list (cdr list))
7288         (when (string-match regexp mid-or-mail)
7289           (setq result (+ result rate))
7290           (gnus-message
7291            9 "`%s' matched `%s', rate `%s', result `%s'."
7292            mid-or-mail regexp rate result)))
7293       (when (<= lpartlen 7)
7294         (setq result (+ result 5.0))
7295         (gnus-message 9 "`%s' matched (<= lpartlen 7), result `%s'."
7296                       mid-or-mail result))
7297       (when (>= lpartlen 12)
7298         (gnus-message 9 "`%s' matched (>= lpartlen 12)" mid-or-mail)
7299         (cond
7300          ((string-match "[0-9][^0-9]+[0-9].*@" mid-or-mail)
7301           ;; Long local part should contain realname if e-mail address,
7302           ;; too many digits: message-id.
7303           ;; $score -= 5.0 + 0.1 * $local_part_len;
7304           (setq rate (* -1.0 (+ 5.0 (* 0.1 lpartlen))))
7305           (setq result (+ result rate))
7306           (gnus-message
7307            9 "Many digits in `%s', rate `%s', result `%s'."
7308            mid-or-mail rate result))
7309          ((string-match "[^aeiouy][^aeiouy][^aeiouy][^aeiouy]+.*\@"
7310                         mid-or-mail)
7311           ;; Too few vowels [^aeiouy]{4,}.*\@
7312           (setq result (+ result -5.0))
7313           (gnus-message
7314            9 "Few vowels in `%s', rate `%s', result `%s'."
7315            mid-or-mail -5.0 result))
7316          (t
7317           (setq result (+ result 5.0))
7318           (gnus-message
7319            9 "`%s', rate `%s', result `%s'." mid-or-mail 5.0 result)))))
7320     (gnus-message 8 "`%s': Final rate is `%s'." mid-or-mail result)
7321     ;; Maybe we should make this a customizable alist: (condition . 'result)
7322     (cond
7323      ((symbolp result) result)
7324      ;; Now convert number into proper results:
7325      ((< result -10.0) 'mid)
7326      ((> result  10.0) 'mail)
7327      (t 'ask))))
7328
7329 (defun gnus-button-handle-mid-or-mail (mid-or-mail)
7330   (let* ((pref gnus-button-prefer-mid-or-mail) guessed
7331          (url-mid (concat "news" ":" mid-or-mail))
7332          (url-mailto (concat "mailto" ":" mid-or-mail)))
7333     (gnus-message 9 "mid-or-mail=%s" mid-or-mail)
7334     (when (fboundp pref)
7335       (setq guessed
7336             ;; get rid of surrounding angles...
7337             (funcall pref
7338                      (gnus-replace-in-string mid-or-mail "^<\\|>$" "")))
7339       (if (or (eq 'mid guessed) (eq 'mail guessed))
7340           (setq pref guessed)
7341         (setq pref 'ask)))
7342     (if (eq pref 'ask)
7343         (save-window-excursion
7344           (if (y-or-n-p (concat "Is <" mid-or-mail "> a mail address? "))
7345               (setq pref 'mail)
7346             (setq pref 'mid))))
7347     (cond ((eq pref 'mid)
7348            (gnus-message 8 "calling `gnus-button-handle-news' %s" url-mid)
7349            (gnus-button-handle-news url-mid))
7350           ((eq pref 'mail)
7351            (gnus-message 8 "calling `gnus-url-mailto'  %s" url-mailto)
7352            (gnus-url-mailto url-mailto))
7353           (t (gnus-message 3 "Invalid string.")))))
7354
7355 (defun gnus-button-handle-custom (fun arg)
7356   "Call function FUN on argument ARG.
7357 Both FUN and ARG are supposed to be strings.  ARG will be passed
7358 as a symbol to FUN."
7359   (funcall (intern fun)
7360            (if (string-match "^customize-apropos" fun)
7361                arg
7362              (intern arg))))
7363
7364 (defvar gnus-button-handle-describe-prefix "^\\(C-h\\|<?[Ff]1>?\\)")
7365
7366 (defun gnus-button-handle-describe-function (url)
7367   "Call `describe-function' when pushing the corresponding URL button."
7368   (describe-function
7369    (intern
7370     (gnus-replace-in-string url gnus-button-handle-describe-prefix ""))))
7371
7372 (defun gnus-button-handle-describe-variable (url)
7373   "Call `describe-variable' when pushing the corresponding URL button."
7374   (describe-variable
7375    (intern
7376     (gnus-replace-in-string url gnus-button-handle-describe-prefix ""))))
7377
7378 (defun gnus-button-handle-symbol (url)
7379 "Display help on variable or function.
7380 Calls `describe-variable' or `describe-function'."
7381   (let ((sym (intern url)))
7382     (cond
7383      ((fboundp sym) (describe-function sym))
7384      ((boundp sym) (describe-variable sym))
7385      (t (gnus-message 3 "`%s' is not a known function of variable." url)))))
7386
7387 (defun gnus-button-handle-describe-key (url)
7388   "Call `describe-key' when pushing the corresponding URL button."
7389   (let* ((key-string
7390           (gnus-replace-in-string url gnus-button-handle-describe-prefix ""))
7391          (keys (ignore-errors (eval `(kbd ,key-string)))))
7392     (if keys
7393         (describe-key keys)
7394       (gnus-message 3 "Invalid key sequence in button: %s" key-string))))
7395
7396 (defun gnus-button-handle-apropos (url)
7397   "Call `apropos' when pushing the corresponding URL button."
7398   (apropos (gnus-replace-in-string url gnus-button-handle-describe-prefix "")))
7399
7400 (defun gnus-button-handle-apropos-command (url)
7401   "Call `apropos' when pushing the corresponding URL button."
7402   (apropos-command
7403    (gnus-replace-in-string url gnus-button-handle-describe-prefix "")))
7404
7405 (defun gnus-button-handle-apropos-variable (url)
7406   "Call `apropos' when pushing the corresponding URL button."
7407   (funcall
7408    (if (fboundp 'apropos-variable) 'apropos-variable 'apropos)
7409    (gnus-replace-in-string url gnus-button-handle-describe-prefix "")))
7410
7411 (defun gnus-button-handle-apropos-documentation (url)
7412   "Call `apropos' when pushing the corresponding URL button."
7413   (funcall
7414    (if (fboundp 'apropos-documentation) 'apropos-documentation 'apropos)
7415    (gnus-replace-in-string url gnus-button-handle-describe-prefix "")))
7416
7417 (defun gnus-button-handle-library (url)
7418   "Call `locate-library' when pushing the corresponding URL button."
7419   (gnus-message 9 "url=`%s'" url)
7420   (let* ((lib (locate-library url))
7421          (file (gnus-replace-in-string (or lib "") "\.elc" ".el")))
7422     (if (not lib)
7423         (gnus-message 1 "Cannot locale library `%s'." url)
7424       (find-file-read-only file))))
7425
7426 (defcustom gnus-button-man-level 5
7427   "*Integer that says how many man-related buttons Gnus will show.
7428 The higher the number, the more buttons will appear and the more false
7429 positives are possible.  Note that you can set this variable local to
7430 specific groups.  Setting it higher in Unix groups is probably a good idea.
7431 See Info node `(gnus)Group Parameters' and the variable `gnus-parameters' on
7432 how to set variables in specific groups."
7433   :version "22.1"
7434   :group 'gnus-article-buttons
7435   :link '(custom-manual "(gnus)Group Parameters")
7436   :type 'integer)
7437
7438 (defcustom gnus-button-emacs-level 5
7439   "*Integer that says how many emacs-related buttons Gnus will show.
7440 The higher the number, the more buttons will appear and the more false
7441 positives are possible.  Note that you can set this variable local to
7442 specific groups.  Setting it higher in Emacs or Gnus related groups is
7443 probably a good idea.  See Info node `(gnus)Group Parameters' and the variable
7444 `gnus-parameters' on how to set variables in specific groups."
7445   :version "22.1"
7446   :group 'gnus-article-buttons
7447   :link '(custom-manual "(gnus)Group Parameters")
7448   :type 'integer)
7449
7450 (defcustom gnus-button-message-level 5
7451   "*Integer that says how many buttons for news or mail messages will appear.
7452 The higher the number, the more buttons will appear and the more false
7453 positives are possible."
7454   ;; mail addresses, MIDs, URLs for news, ...
7455   :version "22.1"
7456   :group 'gnus-article-buttons
7457   :type 'integer)
7458
7459 (defcustom gnus-button-browse-level 5
7460   "*Integer that says how many buttons for browsing will appear.
7461 The higher the number, the more buttons will appear and the more false
7462 positives are possible."
7463   ;; stuff handled by `browse-url' or `gnus-button-embedded-url'
7464   :version "22.1"
7465   :group 'gnus-article-buttons
7466   :type 'integer)
7467
7468 (defcustom gnus-button-alist
7469   '(("<\\(url:[>\n\t ]*?\\)?\\(nntp\\|news\\):[>\n\t ]*\\([^>\n\t ]*@[^>\n\t ]*\\)>"
7470      0 (>= gnus-button-message-level 0) gnus-button-handle-news 3)
7471     ((concat "\\b\\(nntp\\|news\\):\\("
7472              gnus-button-valid-localpart-regexp "@[a-z0-9.-]+[a-z]\\)")
7473      0 t gnus-button-handle-news 2)
7474     ("\\(\\b<\\(url:[>\n\t ]*\\)?\\(nntp\\|news\\):[>\n\t ]*\\(//\\)?\\([^>\n\t ]*\\)>\\)"
7475      1 (>= gnus-button-message-level 0) gnus-button-fetch-group 5)
7476     ("\\b\\(nntp\\|news\\):\\(//\\)?\\([^'\">\n\t ]+\\)"
7477      0 (>= gnus-button-message-level 0) gnus-button-fetch-group 3)
7478     ;; RFC 2392 (Don't allow `/' in domain part --> CID)
7479     ("\\bmid:\\(//\\)?\\([^'\">\n\t ]+@[^'\">\n\t /]+\\)"
7480      0 (>= gnus-button-message-level 0) gnus-button-message-id 2)
7481     ("\\bin\\( +article\\| +message\\)? +\\(<\\([^\n @<>]+@[^\n @<>]+\\)>\\)"
7482      2 (>= gnus-button-message-level 0) gnus-button-message-id 3)
7483     ("\\b\\(mid\\|message-id\\):? +\\(<\\([^\n @<>]+@[^\n @<>]+\\)>\\)"
7484      2 (>= gnus-button-message-level 0) gnus-button-message-id 3)
7485     ("\\(<URL: *\\)mailto: *\\([^> \n\t]+\\)>"
7486      0 (>= gnus-button-message-level 0) gnus-url-mailto 2)
7487     ;; RFC 2368 (The mailto URL scheme)
7488     ("\\bmailto:\\([-a-z.@_+0-9%=?&/]+\\)"
7489      0 (>= gnus-button-message-level 0) gnus-url-mailto 1)
7490     ("\\bmailto:\\([^ \n\t]+\\)"
7491      0 (>= gnus-button-message-level 0) gnus-url-mailto 1)
7492     ;; Info Konqueror style <info:/foo/bar baz>.
7493     ;; Must come before " Gnus home-grown style".
7494     ("\\binfo://?\\([^'\">\n\t]+\\)"
7495      0 (>= gnus-button-emacs-level 1) gnus-button-handle-info-url 1)
7496    ;; Info, Gnus home-grown style (deprecated) <info://foo/bar+baz>
7497     ("\\binfo://\\([^'\">\n\t ]+\\)"
7498      0 (>= gnus-button-emacs-level 1) gnus-button-handle-info-url 1)
7499     ;; Info GNOME style <info:foo#bar_baz>
7500     ("\\binfo:\\([^('\n\t\r \"><][^'\n\t\r \"><]*\\)"
7501      0 (>= gnus-button-emacs-level 1) gnus-button-handle-info-url-gnome 1)
7502     ;; Info KDE style <info:(foo)bar baz>
7503     ("<\\(info:\\(([^)]+)[^>\n\r]*\\)\\)>"
7504      1 (>= gnus-button-emacs-level 1) gnus-button-handle-info-url-kde 2)
7505     ("\\((Info-goto-node\\|(info\\)[ \t\n]*\\(\"[^\"]*\"\\))" 0
7506      (>= gnus-button-emacs-level 1) gnus-button-handle-info-url 2)
7507     ("\\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,]*\\)\\)?"
7508      ;; Info links like `C-h i d m Gnus RET' or `C-h i d m Gnus RET i partial RET'
7509      0 (>= gnus-button-emacs-level 1) gnus-button-handle-info-keystrokes 0)
7510     ;; This is custom
7511     ("M-x[ \t\n]\\(customize-[^ ]+\\)[ \t\n]RET[ \t\n]\\([^ ]+\\)[ \t\n]RET\\>" 0
7512      (>= gnus-button-emacs-level 1) gnus-button-handle-custom 1 2)
7513     ;; Emacs help commands
7514     ("M-x[ \t\n]+apropos[ \t\n]+RET[ \t\n]+\\([^ \t\n]+\\)[ \t\n]+RET\\>"
7515      ;; regexp doesn't match arguments containing ` '.
7516      0 (>= gnus-button-emacs-level 1) gnus-button-handle-apropos 1)
7517     ("M-x[ \t\n]+apropos-command[ \t\n]+RET[ \t\n]+\\([^ \t\n]+\\)[ \t\n]+RET\\>"
7518      0 (>= gnus-button-emacs-level 1) gnus-button-handle-apropos-command 1)
7519     ("M-x[ \t\n]+apropos-variable[ \t\n]+RET[ \t\n]+\\([^ \t\n]+\\)[ \t\n]+RET\\>"
7520      0 (>= gnus-button-emacs-level 1) gnus-button-handle-apropos-variable 1)
7521     ("M-x[ \t\n]+apropos-documentation[ \t\n]+RET[ \t\n]+\\([^ \t\n]+\\)[ \t\n]+RET\\>"
7522      0 (>= gnus-button-emacs-level 1) gnus-button-handle-apropos-documentation 1)
7523     ;; The following entries may lead to many false positives so don't enable
7524     ;; them by default (use a high button level).
7525     ("/\\([a-z][-a-z0-9]+\\.el\\)\\>[^.?]"
7526      ;; Exclude [.?] for URLs in gmane.emacs.cvs
7527      1 (>= gnus-button-emacs-level 8) gnus-button-handle-library 1)
7528     ("`\\([a-z][-a-z0-9]+\\.el\\)'"
7529      1 (>= gnus-button-emacs-level 8) gnus-button-handle-library 1)
7530     ("`\\([a-z][a-z0-9]+-[a-z0-9]+-[-a-z0-9]*[a-z]\\|\\(gnus\\|message\\)-[-a-z]+\\)'"
7531      0 (>= gnus-button-emacs-level 8) gnus-button-handle-symbol 1)
7532     ("`\\([a-z][a-z0-9]+-[a-z]+\\)'"
7533      0 (>= gnus-button-emacs-level 9) gnus-button-handle-symbol 1)
7534     ("(setq[ \t\n]+\\([a-z][a-z0-9]+-[-a-z0-9]+\\)[ \t\n]+.+)"
7535      1 (>= gnus-button-emacs-level 7) gnus-button-handle-describe-variable 1)
7536     ("\\bM-x[ \t\n]+\\([^ \t\n]+\\)[ \t\n]+RET\\>"
7537      1 (>= gnus-button-emacs-level 7) gnus-button-handle-describe-function 1)
7538     ("\\b\\(C-h\\|<?[Ff]1>?\\)[ \t\n]+f[ \t\n]+\\([^ \t\n]+\\)[ \t\n]+RET\\>"
7539      0 (>= gnus-button-emacs-level 1) gnus-button-handle-describe-function 2)
7540     ("\\b\\(C-h\\|<?[Ff]1>?\\)[ \t\n]+v[ \t\n]+\\([^ \t\n]+\\)[ \t\n]+RET\\>"
7541      0 (>= gnus-button-emacs-level 1) gnus-button-handle-describe-variable 2)
7542     ("`\\(\\(C-h\\|<?[Ff]1>?\\)[ \t\n]+k[ \t\n]+\\([^']+\\)\\)'"
7543      ;; Unlike the other regexps we really have to require quoting
7544      ;; here to determine where it ends.
7545      1 (>= gnus-button-emacs-level 1) gnus-button-handle-describe-key 3)
7546     ;; This is how URLs _should_ be embedded in text (RFC 1738, RFC 2396)...
7547     ("<URL: *\\([^\n<>]*\\)>"
7548      1 (>= gnus-button-browse-level 0) gnus-button-embedded-url 1)
7549     ;; RFC 2396 (2.4.3., delims) ...
7550     ("\"URL: *\\([^\n\"]*\\)\""
7551      1 (>= gnus-button-browse-level 0) gnus-button-embedded-url 1)
7552     ;; Raw URLs.
7553     (gnus-button-url-regexp
7554      0 (>= gnus-button-browse-level 0) browse-url 0)
7555     ;; man pages
7556     ("\\b\\([a-z][a-z]+([1-9])\\)\\W"
7557      0 (and (>= gnus-button-man-level 1) (< gnus-button-man-level 3))
7558      gnus-button-handle-man 1)
7559     ;; more man pages: resolv.conf(5), iso_8859-1(7), xterm(1x)
7560     ("\\b\\([a-z][-_.a-z0-9]+([1-9])\\)\\W"
7561      0 (and (>= gnus-button-man-level 3) (< gnus-button-man-level 5))
7562      gnus-button-handle-man 1)
7563     ;; even more: Apache::PerlRun(3pm), PDL::IO::FastRaw(3pm),
7564     ;; SoWWWAnchor(3iv), XSelectInput(3X11), X(1), X(7)
7565     ("\\b\\(\\(?:[a-z][-+_.:a-z0-9]+([1-9][X1a-z]*)\\)\\|\\b\\(?:X([1-9])\\)\\)\\W"
7566      0 (>= gnus-button-man-level 5) gnus-button-handle-man 1)
7567     ;; Recognizing patches to .el files.  This is somewhat obscure,
7568     ;; but considering the percentage of Gnus users who hack Emacs
7569     ;; Lisp files...
7570     ("^--- \\([^ .]+\\.el\\).*\n.*\n@@ -?\\([0-9]+\\)" 1
7571      (>= gnus-button-message-level 4) gnus-button-patch 1 2)
7572     ("^\\*\\*\\* \\([^ .]+\\.el\\).*\n.*\n\\*+\n\\*\\*\\* \\([0-9]+\\)" 1
7573      (>= gnus-button-message-level 4) gnus-button-patch 1 2)
7574     ;; MID or mail: To avoid too many false positives we don't try to catch
7575     ;; all kind of allowed MIDs or mail addresses.  Domain part must contain
7576     ;; at least one dot.  TLD must contain two or three chars or be a know TLD
7577     ;; (info|name|...).  Put this entry near the _end_ of `gnus-button-alist'
7578     ;; so that non-ambiguous entries (see above) match first.
7579     (gnus-button-mid-or-mail-regexp
7580      0 (>= gnus-button-message-level 5) gnus-button-handle-mid-or-mail 1))
7581   "*Alist of regexps matching buttons in article bodies.
7582
7583 Each entry has the form (REGEXP BUTTON FORM CALLBACK PAR...), where
7584 REGEXP: is the string (case insensitive) matching text around the button (can
7585 also be Lisp expression evaluating to a string),
7586 BUTTON: is the number of the regexp grouping actually matching the button,
7587 FORM: is a Lisp expression which must eval to true for the button to
7588 be added,
7589 CALLBACK: is the function to call when the user push this button, and each
7590 PAR: is a number of a regexp grouping whose text will be passed to CALLBACK.
7591
7592 CALLBACK can also be a variable, in that case the value of that
7593 variable it the real callback function."
7594   :group 'gnus-article-buttons
7595   :type '(repeat (list (choice regexp variable sexp)
7596                        (integer :tag "Button")
7597                        (sexp :tag "Form")
7598                        (function :tag "Callback")
7599                        (repeat :tag "Par"
7600                                :inline t
7601                                (integer :tag "Regexp group")))))
7602 (put 'gnus-button-alist 'risky-local-variable t)
7603
7604 (defcustom gnus-header-button-alist
7605   '(("^\\(References\\|Message-I[Dd]\\|^In-Reply-To\\):" "<[^<>]+>"
7606      0 (>= gnus-button-message-level 0) gnus-button-message-id 0)
7607     ("^\\(From\\|Reply-To\\):" ": *\\(.+\\)$"
7608      1 (>= gnus-button-message-level 0) gnus-button-reply 1)
7609     ("^\\(Cc\\|To\\):" "[^ \t\n<>,()\"]+@[^ \t\n<>,()\"]+"
7610      0 (>= gnus-button-message-level 0) gnus-msg-mail 0)
7611     ("^X-[Uu][Rr][Ll]:" gnus-button-url-regexp
7612      0 (>= gnus-button-browse-level 0) browse-url 0)
7613     ("^Subject:" gnus-button-url-regexp
7614      0 (>= gnus-button-browse-level 0) browse-url 0)
7615     ("^[^:]+:" gnus-button-url-regexp
7616      0 (>= gnus-button-browse-level 0) browse-url 0)
7617     ("^OpenPGP:.*url=" gnus-button-url-regexp
7618      0 (>= gnus-button-browse-level 0) gnus-button-openpgp 0)
7619     ("^[^:]+:" "\\bmailto:\\([-a-z.@_+0-9%=?&/]+\\)"
7620      0 (>= gnus-button-message-level 0) gnus-url-mailto 1)
7621     ("^[^:]+:" "\\(<\\(url: \\)?\\(nntp\\|news\\):\\([^>\n ]*\\)>\\)"
7622      1 (>= gnus-button-message-level 0) gnus-button-message-id 4))
7623   "*Alist of headers and regexps to match buttons in article heads.
7624
7625 This alist is very similar to `gnus-button-alist', except that each
7626 alist has an additional HEADER element first in each entry:
7627
7628 \(HEADER REGEXP BUTTON FORM CALLBACK PAR)
7629
7630 HEADER is a regexp to match a header.  For a fuller explanation, see
7631 `gnus-button-alist'."
7632   :group 'gnus-article-buttons
7633   :group 'gnus-article-headers
7634   :type '(repeat (list (regexp :tag "Header")
7635                        (choice regexp variable)
7636                        (integer :tag "Button")
7637                        (sexp :tag "Form")
7638                        (function :tag "Callback")
7639                        (repeat :tag "Par"
7640                                :inline t
7641                                (integer :tag "Regexp group")))))
7642 (put 'gnus-header-button-alist 'risky-local-variable t)
7643
7644 ;;; Commands:
7645
7646 (defun gnus-article-push-button (event)
7647   "Check text under the mouse pointer for a callback function.
7648 If the text under the mouse pointer has a `gnus-callback' property,
7649 call it with the value of the `gnus-data' text property."
7650   (interactive "e")
7651   (set-buffer (window-buffer (posn-window (event-start event))))
7652   (let* ((pos (posn-point (event-start event)))
7653          (data (get-text-property pos 'gnus-data))
7654          (fun (get-text-property pos 'gnus-callback)))
7655     (goto-char pos)
7656     (when fun
7657       (funcall fun data))))
7658
7659 (defun gnus-article-press-button ()
7660   "Check text at point for a callback function.
7661 If the text at point has a `gnus-callback' property,
7662 call it with the value of the `gnus-data' text property."
7663   (interactive)
7664   (let ((data (get-text-property (point) 'gnus-data))
7665         (fun (get-text-property (point) 'gnus-callback)))
7666     (when fun
7667       (funcall fun data))))
7668
7669 (defun gnus-article-highlight (&optional force)
7670   "Highlight current article.
7671 This function calls `gnus-article-highlight-headers',
7672 `gnus-article-highlight-citation',
7673 `gnus-article-highlight-signature', and `gnus-article-add-buttons' to
7674 do the highlighting.  See the documentation for those functions."
7675   (interactive (list 'force))
7676   (gnus-article-highlight-headers)
7677   (gnus-article-highlight-citation force)
7678   (gnus-article-highlight-signature)
7679   (gnus-article-add-buttons)
7680   (gnus-article-add-buttons-to-head))
7681
7682 (defun gnus-article-highlight-some (&optional force)
7683   "Highlight current article.
7684 This function calls `gnus-article-highlight-headers',
7685 `gnus-article-highlight-signature', and `gnus-article-add-buttons' to
7686 do the highlighting.  See the documentation for those functions."
7687   (interactive (list 'force))
7688   (gnus-article-highlight-headers)
7689   (gnus-article-highlight-signature)
7690   (gnus-article-add-buttons))
7691
7692 (defun gnus-article-highlight-headers ()
7693   "Highlight article headers as specified by `gnus-header-face-alist'."
7694   (interactive)
7695   (gnus-with-article-headers
7696     (let (regexp header-face field-face from hpoints fpoints)
7697       (dolist (entry gnus-header-face-alist)
7698         (goto-char (point-min))
7699         (setq regexp (concat "^\\("
7700                              (if (string-equal "" (nth 0 entry))
7701                                  "[^\t ]"
7702                                (nth 0 entry))
7703                              "\\)")
7704               header-face (nth 1 entry)
7705               field-face (nth 2 entry))
7706         (while (and (re-search-forward regexp nil t)
7707                     (not (eobp)))
7708           (beginning-of-line)
7709           (setq from (point))
7710           (unless (search-forward ":" nil t)
7711             (forward-char 1))
7712           (when (and header-face
7713                      (not (memq (point) hpoints)))
7714             (push (point) hpoints)
7715             (gnus-put-text-property from (point) 'face header-face))
7716           (when (and field-face
7717                      (not (memq (setq from (point)) fpoints)))
7718             (push from fpoints)
7719             (if (re-search-forward "^[^ \t]" nil t)
7720                 (forward-char -2)
7721               (goto-char (point-max)))
7722             (gnus-put-text-property from (point) 'face field-face)))))))
7723
7724 (defun gnus-article-highlight-signature ()
7725   "Highlight the signature in an article.
7726 It does this by highlighting everything after
7727 `gnus-signature-separator' using the face `gnus-signature'."
7728   (interactive)
7729   (gnus-with-article-buffer
7730     (let ((inhibit-point-motion-hooks t))
7731       (save-restriction
7732         (when (and gnus-signature-face
7733                    (gnus-article-narrow-to-signature))
7734           (gnus-overlay-put (gnus-make-overlay (point-min) (point-max) nil t)
7735                             'face gnus-signature-face)
7736           (widen)
7737           (gnus-article-search-signature)
7738           (let ((start (match-beginning 0))
7739                 (end (set-marker (make-marker) (1+ (match-end 0)))))
7740             (gnus-article-add-button start (1- end) 'gnus-signature-toggle
7741                                      end)))))))
7742
7743 (defun gnus-button-in-region-p (b e prop)
7744   "Say whether PROP exists in the region."
7745   (text-property-not-all b e prop nil))
7746
7747 (defun gnus-article-add-buttons ()
7748   "Find external references in the article and make buttons of them.
7749 \"External references\" are things like Message-IDs and URLs, as
7750 specified by `gnus-button-alist'."
7751   (interactive)
7752   (gnus-with-article-buffer
7753     (let ((inhibit-point-motion-hooks t)
7754           (case-fold-search t)
7755           (alist gnus-button-alist)
7756           beg entry regexp)
7757       ;; We skip the headers.
7758       (article-goto-body)
7759       (setq beg (point))
7760       (while (setq entry (pop alist))
7761         (setq regexp (eval (car entry)))
7762         (goto-char beg)
7763         (while (re-search-forward regexp nil t)
7764           (let ((start (match-beginning (nth 1 entry)))
7765                 (end (match-end (nth 1 entry)))
7766                 (from (match-beginning 0)))
7767             (when (and (eval (nth 2 entry))
7768                        (not (gnus-button-in-region-p
7769                              start end 'gnus-callback)))
7770               ;; That optional form returned non-nil, so we add the
7771               ;; button.
7772               (setq from (set-marker (make-marker) from))
7773               (unless (and (eq (car entry) 'gnus-button-url-regexp)
7774                            (gnus-article-extend-url-button from start end))
7775                 (gnus-article-add-button start end
7776                                          'gnus-button-push (list from entry))
7777                 (gnus-put-text-property
7778                  start end
7779                  'gnus-string (buffer-substring-no-properties
7780                                start end))))))))))
7781
7782 (defun gnus-article-extend-url-button (beg start end)
7783   "Extend url button if url is folded into two or more lines.
7784 Return non-nil if button is extended.  BEG is a marker that points to
7785 the beginning position of a text containing url.  START and END are
7786 the endpoints of a url button before it is extended.  The concatenated
7787 url is put as the `gnus-button-url' overlay property on the button."
7788   (let ((opoint (point))
7789         (points (list start end))
7790         url delim regexp)
7791     (prog1
7792         (when (and (progn
7793                      (goto-char end)
7794                      (not (looking-at "[\t ]*[\">]")))
7795                    (progn
7796                      (goto-char start)
7797                      (string-match
7798                       "\\(?:\"\\|\\(<\\)\\)[\t ]*\\(?:url[\t ]*:[\t ]*\\)?\\'"
7799                       (buffer-substring (point-at-bol) start)))
7800                    (progn
7801                      (setq url (list (buffer-substring start end))
7802                            delim (if (match-beginning 1) ">" "\""))
7803                      (beginning-of-line)
7804                      (setq regexp (concat
7805                                    (when (and (looking-at
7806                                                message-cite-prefix-regexp)
7807                                               (< (match-end 0) start))
7808                                      (regexp-quote (match-string 0)))
7809                                    "\
7810 \[\t ]*\\(?:\\([^\t\n \">]+\\)[\t ]*$\\|\\([^\t\n \">]*\\)[\t ]*"
7811                                    delim "\\)"))
7812                      (while (progn
7813                               (forward-line 1)
7814                               (and (looking-at regexp)
7815                                    (prog1
7816                                        (match-beginning 1)
7817                                      (push (or (match-string 2)
7818                                                (match-string 1))
7819                                            url)
7820                                      (push (setq end (or (match-end 2)
7821                                                          (match-end 1)))
7822                                            points)
7823                                      (push (or (match-beginning 2)
7824                                                (match-beginning 1))
7825                                            points)))))
7826                      (match-beginning 2)))
7827           (let (gnus-article-mouse-face widget-mouse-face)
7828             (while points
7829               (gnus-article-add-button (pop points) (pop points)
7830                                        'gnus-button-push beg)))
7831           (let ((overlay (gnus-make-overlay start end)))
7832             (gnus-overlay-put overlay 'evaporate t)
7833             (gnus-overlay-put overlay 'gnus-button-url
7834                               (list (mapconcat 'identity (nreverse url) "")))
7835             (when gnus-article-mouse-face
7836               (gnus-overlay-put overlay 'mouse-face gnus-article-mouse-face)))
7837           t)
7838       (goto-char opoint))))
7839
7840 ;; Add buttons to the head of an article.
7841 (defun gnus-article-add-buttons-to-head ()
7842   "Add buttons to the head of the article."
7843   (interactive)
7844   (gnus-with-article-headers
7845     (let (beg end)
7846       (dolist (entry gnus-header-button-alist)
7847         ;; Each alist entry.
7848         (goto-char (point-min))
7849         (while (re-search-forward (car entry) nil t)
7850           ;; Each header matching the entry.
7851           (setq beg (match-beginning 0))
7852           (setq end (or (and (re-search-forward "^[^ \t]" nil t)
7853                              (match-beginning 0))
7854                         (point-max)))
7855           (goto-char beg)
7856           (while (re-search-forward (eval (nth 1 entry)) end t)
7857             ;; Each match within a header.
7858             (let* ((entry (cdr entry))
7859                    (start (match-beginning (nth 1 entry)))
7860                    (end (match-end (nth 1 entry)))
7861                    (form (nth 2 entry)))
7862               (goto-char (match-end 0))
7863               (when (eval form)
7864                 (gnus-article-add-button
7865                  start end (nth 3 entry)
7866                  (buffer-substring (match-beginning (nth 4 entry))
7867                                    (match-end (nth 4 entry)))))))
7868           (goto-char end))))))
7869
7870 ;;; External functions:
7871
7872 (defun gnus-article-add-button (from to fun &optional data text)
7873   "Create a button between FROM and TO with callback FUN and data DATA."
7874   (when gnus-article-button-face
7875     (gnus-overlay-put (gnus-make-overlay from to nil t)
7876                       'face gnus-article-button-face))
7877   (gnus-add-text-properties
7878    from to
7879    (nconc (and gnus-article-mouse-face
7880                (list gnus-mouse-face-prop gnus-article-mouse-face))
7881           (list 'gnus-callback fun)
7882           (and data (list 'gnus-data data))))
7883   (widget-convert-button 'link from to :action 'gnus-widget-press-button
7884                          :help-echo (or text "Follow the link")
7885                          :keymap gnus-url-button-map
7886                          :button-keymap gnus-widget-button-keymap))
7887
7888 (defun gnus-article-copy-string ()
7889   "Copy the string in the button to the kill ring."
7890   (interactive)
7891   (gnus-article-check-buffer)
7892   (let ((data (get-text-property (point) 'gnus-string)))
7893     (when data
7894       (with-temp-buffer
7895         (insert data)
7896         (copy-region-as-kill (point-min) (point-max))
7897         (message "Copied %s" data)))))
7898
7899 ;;; Internal functions:
7900
7901 (defun gnus-article-set-globals ()
7902   (with-current-buffer gnus-summary-buffer
7903     (gnus-set-global-variables)))
7904
7905 (defun gnus-signature-toggle (end)
7906   (gnus-with-article-buffer
7907     (let ((inhibit-point-motion-hooks t))
7908       (if (text-property-any end (point-max) 'article-type 'signature)
7909           (progn
7910             (gnus-delete-wash-type 'signature)
7911             (gnus-remove-text-properties-when
7912              'article-type 'signature end (point-max)
7913              (cons 'article-type (cons 'signature
7914                                        gnus-hidden-properties))))
7915         (gnus-add-wash-type 'signature)
7916         (gnus-add-text-properties-when
7917          'article-type nil end (point-max)
7918          (cons 'article-type (cons 'signature
7919                                    gnus-hidden-properties)))))
7920     (let ((gnus-article-mime-handle-alist-1 gnus-article-mime-handle-alist))
7921       (gnus-set-mode-line 'article))))
7922
7923 (defun gnus-button-push (marker-and-entry)
7924   ;; Push button starting at MARKER.
7925   (save-excursion
7926     (let* ((marker (car marker-and-entry))
7927            (entry (cadr marker-and-entry))
7928            (regexp (car entry))
7929            (inhibit-point-motion-hooks t))
7930       (goto-char marker)
7931       ;; This is obviously true, or something bad is happening :)
7932       ;; But we need it to have the match-data
7933       (when (looking-at (or (if (symbolp regexp)
7934                                 (symbol-value regexp)
7935                               regexp)))
7936         (let ((fun (nth 3 entry))
7937               (args (or (and (eq (car entry) 'gnus-button-url-regexp)
7938                              (get-char-property marker 'gnus-button-url))
7939                         (mapcar (lambda (group)
7940                                   (let ((string (match-string group)))
7941                                     (set-text-properties
7942                                      0 (length string) nil string)
7943                                     string))
7944                                 (nthcdr 4 entry)))))
7945
7946           (cond
7947            ((fboundp fun)
7948             (apply fun args))
7949            ((and (boundp fun)
7950                  (fboundp (symbol-value fun)))
7951             (apply (symbol-value fun) args))
7952            (t
7953             (gnus-message 1 "You must define `%S' to use this button"
7954                           (cons fun args)))))))))
7955
7956 (defun gnus-parse-news-url (url)
7957   (let (scheme server port group message-id articles)
7958     (with-temp-buffer
7959       (insert url)
7960       (goto-char (point-min))
7961       (when (looking-at "\\([A-Za-z]+\\):")
7962         (setq scheme (match-string 1))
7963         (goto-char (match-end 0)))
7964       (when (looking-at "//\\([^:/]+\\)\\(:?\\)\\([0-9]+\\)?/")
7965         (setq server (match-string 1))
7966         (setq port (if (stringp (match-string 3))
7967                        (string-to-number (match-string 3))
7968                      (match-string 3)))
7969         (goto-char (match-end 0)))
7970
7971       (cond
7972        ((looking-at "\\(.*@.*\\)")
7973         (setq message-id (match-string 1)))
7974        ((looking-at "\\([^/]+\\)/\\([-0-9]+\\)")
7975         (setq group (match-string 1)
7976               articles (split-string (match-string 2) "-")))
7977        ((looking-at "\\([^/]+\\)/?")
7978         (setq group (match-string 1)))
7979        (t
7980         (error "Unknown news URL syntax"))))
7981     (list scheme server port group message-id articles)))
7982
7983 (defun gnus-button-handle-news (url)
7984   "Fetch a news URL."
7985   (destructuring-bind (scheme server port group message-id articles)
7986       (gnus-parse-news-url url)
7987     (cond
7988      (message-id
7989       (with-current-buffer gnus-summary-buffer
7990         (if server
7991             (let ((gnus-refer-article-method
7992                    (nconc (list (list 'nntp server))
7993                           gnus-refer-article-method))
7994                   (nntp-port-number (or port "nntp")))
7995               (gnus-message 7 "Fetching %s with %s"
7996                             message-id gnus-refer-article-method)
7997               (gnus-summary-refer-article message-id))
7998           (gnus-summary-refer-article message-id))))
7999      (group
8000       (gnus-button-fetch-group url)))))
8001
8002 (defun gnus-button-patch (library line)
8003   "Visit an Emacs Lisp library LIBRARY on line LINE."
8004   (interactive)
8005   (let ((file (locate-library (file-name-nondirectory library))))
8006     (unless file
8007       (error "Couldn't find library %s" library))
8008     (find-file file)
8009     (goto-char (point-min))
8010     (forward-line (1- (string-to-number line)))))
8011
8012 (defun gnus-button-handle-man (url)
8013   "Fetch a man page."
8014   (gnus-message 9 "`%s' `%s'" gnus-button-man-handler url)
8015   (when (eq gnus-button-man-handler 'woman)
8016     (setq url (gnus-replace-in-string url "([1-9][X1a-z]*).*\\'" "")))
8017   (gnus-message 9 "`%s' `%s'" gnus-button-man-handler url)
8018   (funcall gnus-button-man-handler url))
8019
8020 (defun gnus-button-handle-info-url (url)
8021   "Fetch an info URL."
8022   (setq url (mm-subst-char-in-string ?+ ?\  url))
8023   (cond
8024    ((string-match "^\\([^:/]+\\)?/\\(.*\\)" url)
8025     (gnus-info-find-node
8026      (concat "(" (or (gnus-url-unhex-string (match-string 1 url))
8027                      "Gnus")
8028              ")" (gnus-url-unhex-string (match-string 2 url)))))
8029    ((string-match "([^)\"]+)[^\"]+" url)
8030     (setq url
8031           (gnus-replace-in-string
8032            (gnus-replace-in-string url "[\n\t ]+" " ") "\"" ""))
8033     (gnus-info-find-node url))
8034    (t (error "Can't parse %s" url))))
8035
8036 (defun gnus-button-handle-info-url-gnome (url)
8037   "Fetch GNOME style info URL."
8038   (setq url (mm-subst-char-in-string ?_ ?\  url))
8039   (if (string-match "\\([^#]+\\)#?\\(.*\\)" url)
8040       (gnus-info-find-node
8041        (concat "("
8042                (gnus-url-unhex-string
8043                  (match-string 1 url))
8044                ")"
8045                (or (gnus-url-unhex-string
8046                     (match-string 2 url))
8047                    "Top")))
8048     (error "Can't parse %s" url)))
8049
8050 (defun gnus-button-handle-info-url-kde (url)
8051   "Fetch KDE style info URL."
8052   (gnus-info-find-node (gnus-url-unhex-string url)))
8053
8054 ;; (info) will autoload info.el
8055 (declare-function Info-menu "info" (menu-item &optional fork))
8056 (declare-function Info-index-next "info" (num))
8057
8058 (defun gnus-button-handle-info-keystrokes (url)
8059   "Call `info' when pushing the corresponding URL button."
8060   ;; For links like `C-h i d m gnus RET part RET , ,', `C-h i d m CC Mode RET'.
8061   (let (node indx comma)
8062     (if (string-match
8063          (concat "\\b\\(C-h\\|<?[Ff]1>?\\)[ \t\n]+i[ \t\n]+d?[ \t\n]?m[ \t\n]+"
8064                  "\\([^ ]+ ?[^ ]+\\)[ \t\n]+RET"
8065                  "\\([ \t\n]+i[ \t\n]+[^ ]+ ?[^ ]+[ \t\n]+RET\\>"
8066                  "\\(?:[ \t\n,]*\\)\\)?")
8067          url)
8068         (setq node (match-string 2 url)
8069               indx (match-string 3 url))
8070       (error "Can't parse %s" url))
8071     (info)
8072     (Info-directory)
8073     (Info-menu node)
8074     (when (> (length indx) 0)
8075       (string-match (concat "[ \t\n]+i[ \t\n]+\\([^ ]+ ?[^ ]+\\)[ \t\n]+RET\\>"
8076                             "\\([ \t\n,]*\\)")
8077                     indx)
8078       (setq comma (match-string 2 indx))
8079       (setq indx  (match-string 1 indx))
8080       (Info-index indx)
8081       (when comma
8082         (dotimes (i (with-temp-buffer
8083                       (insert comma)
8084                       ;; Note: the XEmacs version of `how-many' takes
8085                       ;; no optional argument.
8086                       (goto-char (point-min))
8087                       (how-many ",")))
8088           (Info-index-next 1)))
8089       nil)))
8090
8091 (autoload 'pgg-snarf-keys-region "pgg")
8092 ;; Called after pgg-snarf-keys-region, which autoloads pgg.el.
8093 (declare-function pgg-display-output-buffer "pgg" (start end status))
8094
8095 (defun gnus-button-openpgp (url)
8096   "Retrieve and add an OpenPGP key given URL from an OpenPGP header."
8097   (with-temp-buffer
8098     (mm-url-insert-file-contents-external url)
8099     (pgg-snarf-keys-region (point-min) (point-max))
8100     (pgg-display-output-buffer nil nil nil)))
8101
8102 (defun gnus-button-message-id (message-id)
8103   "Fetch MESSAGE-ID."
8104   (with-current-buffer gnus-summary-buffer
8105     (gnus-summary-refer-article message-id)))
8106
8107 (defun gnus-button-fetch-group (address &rest ignore)
8108   "Fetch GROUP specified by ADDRESS."
8109   (when (string-match "\\`\\(nntp\\|news\\):\\(//\\)?\\(.*\\)\\'"
8110                       address)
8111     ;; Allow to use `gnus-button-fetch-group' in `browse-url-browser-function'
8112     ;; for nntp:// and news://
8113     (setq address (match-string 3 address)))
8114   (if (not (string-match "[:/]" address))
8115       ;; This is just a simple group url.
8116       (gnus-group-read-ephemeral-group address gnus-select-method)
8117     (if (not
8118          (string-match
8119           "^\\([^:/]+\\)\\(:\\([^/]+\\)\\)?/\\([^/]+\\)\\(/\\([0-9]+\\)\\)?"
8120           address))
8121         (error "Can't parse %s" address)
8122       (gnus-group-read-ephemeral-group
8123        (match-string 4 address)
8124        `(nntp ,(match-string 1 address)
8125               (nntp-address ,(match-string 1 address))
8126               (nntp-port-number ,(if (match-end 3)
8127                                      (match-string 3 address)
8128                                    "nntp")))
8129        nil nil nil
8130        (and (match-end 6) (list (string-to-number (match-string 6 address))))))))
8131
8132 (defun gnus-url-parse-query-string (query &optional downcase)
8133   (let (retval pairs cur key val)
8134     (setq pairs (split-string query "&"))
8135     (while pairs
8136       (setq cur (car pairs)
8137             pairs (cdr pairs))
8138       (if (not (string-match "=" cur))
8139           nil                           ; Grace
8140         (setq key (gnus-url-unhex-string (substring cur 0 (match-beginning 0)))
8141               val (gnus-url-unhex-string (substring cur (match-end 0) nil) t))
8142         (if downcase
8143             (setq key (downcase key)))
8144         (setq cur (assoc key retval))
8145         (if cur
8146             (setcdr cur (cons val (cdr cur)))
8147           (setq retval (cons (list key val) retval)))))
8148     retval))
8149
8150 (defun gnus-url-mailto (url)
8151   ;; Send mail to someone
8152   (setq url (replace-regexp-in-string "\n" " " url))
8153   (when (string-match "mailto:/*\\(.*\\)" url)
8154     (setq url (substring url (match-beginning 1) nil)))
8155   (let (to args subject func)
8156     (setq args (gnus-url-parse-query-string
8157                 (if (string-match "^\\?" url)
8158                     (substring url 1)
8159                   (if (string-match "^\\([^?]+\\)\\?\\(.*\\)" url)
8160                       (concat "to=" (match-string 1 url) "&"
8161                               (match-string 2 url))
8162                     (concat "to=" url))))
8163           subject (cdr-safe (assoc "subject" args)))
8164     (gnus-msg-mail)
8165     (while args
8166       (setq func (intern-soft (concat "message-goto-" (downcase (caar args)))))
8167       (if (fboundp func)
8168           (funcall func)
8169         (message-position-on-field (caar args)))
8170       (insert (gnus-replace-in-string
8171                (mapconcat 'identity (reverse (cdar args)) ", ")
8172                "\r\n" "\n" t))
8173       (setq args (cdr args)))
8174     (if subject
8175         (message-goto-body)
8176       (message-goto-subject))))
8177
8178 (defun gnus-button-embedded-url (address)
8179   "Activate ADDRESS with `browse-url'."
8180   (browse-url (gnus-strip-whitespace address)))
8181
8182 ;;; Next/prev buttons in the article buffer.
8183
8184 (defvar gnus-next-page-line-format "%{%(Next page...%)%}\n")
8185 (defvar gnus-prev-page-line-format "%{%(Previous page...%)%}\n")
8186
8187 (defvar gnus-prev-page-map
8188   (let ((map (make-sparse-keymap)))
8189     (define-key map gnus-mouse-2 'gnus-button-prev-page)
8190     (define-key map "\r" 'gnus-button-prev-page)
8191     map))
8192
8193 (defvar gnus-next-page-map
8194   (let ((map (make-sparse-keymap)))
8195     (define-key map gnus-mouse-2 'gnus-button-next-page)
8196     (define-key map "\r" 'gnus-button-next-page)
8197     map))
8198
8199 (defun gnus-insert-prev-page-button ()
8200   (let ((b (point)) e
8201         (inhibit-read-only t))
8202     (gnus-eval-format
8203      gnus-prev-page-line-format nil
8204      `(keymap ,gnus-prev-page-map
8205               gnus-prev t
8206               gnus-callback gnus-article-button-prev-page
8207               article-type annotation))
8208     (setq e (if (bolp)
8209                 ;; Exclude a newline.
8210                 (1- (point))
8211               (point)))
8212     (when gnus-article-button-face
8213       (gnus-overlay-put (gnus-make-overlay b e nil t)
8214                         'face gnus-article-button-face))
8215     (widget-convert-button
8216      'link b e
8217      :action 'gnus-button-prev-page
8218      :button-keymap gnus-prev-page-map)))
8219
8220 (defun gnus-button-next-page (&optional args more-args)
8221   "Go to the next page."
8222   (interactive)
8223   (let ((win (selected-window)))
8224     (select-window (gnus-get-buffer-window gnus-article-buffer t))
8225     (gnus-article-next-page)
8226     (select-window win)))
8227
8228 (defun gnus-button-prev-page (&optional args more-args)
8229   "Go to the prev page."
8230   (interactive)
8231   (let ((win (selected-window)))
8232     (select-window (gnus-get-buffer-window gnus-article-buffer t))
8233     (gnus-article-prev-page)
8234     (select-window win)))
8235
8236 (defun gnus-insert-next-page-button ()
8237   (let ((b (point)) e
8238         (inhibit-read-only t))
8239     (gnus-eval-format gnus-next-page-line-format nil
8240                       `(keymap ,gnus-next-page-map
8241                                gnus-next t
8242                                gnus-callback gnus-article-button-next-page
8243                                article-type annotation))
8244     (setq e (if (bolp)
8245                 ;; Exclude a newline.
8246                 (1- (point))
8247               (point)))
8248     (when gnus-article-button-face
8249       (gnus-overlay-put (gnus-make-overlay b e nil t)
8250                         'face gnus-article-button-face))
8251     (widget-convert-button
8252      'link b e
8253      :action 'gnus-button-next-page
8254      :button-keymap gnus-next-page-map)))
8255
8256 (defun gnus-article-button-next-page (arg)
8257   "Go to the next page."
8258   (interactive "P")
8259   (let ((win (selected-window)))
8260     (select-window (gnus-get-buffer-window gnus-article-buffer t))
8261     (gnus-article-next-page)
8262     (select-window win)))
8263
8264 (defun gnus-article-button-prev-page (arg)
8265   "Go to the prev page."
8266   (interactive "P")
8267   (let ((win (selected-window)))
8268     (select-window (gnus-get-buffer-window gnus-article-buffer t))
8269     (gnus-article-prev-page)
8270     (select-window win)))
8271
8272 (defvar gnus-decode-header-methods
8273   '(mail-decode-encoded-word-region)
8274   "List of methods used to decode headers.
8275
8276 This variable is a list of FUNCTION or (REGEXP . FUNCTION).  If item
8277 is FUNCTION, FUNCTION will be applied to all newsgroups.  If item is a
8278 \(REGEXP . FUNCTION), FUNCTION will be only apply to the newsgroups
8279 whose names match REGEXP.
8280
8281 For example:
8282 \((\"chinese\" . gnus-decode-encoded-word-region-by-guess)
8283  mail-decode-encoded-word-region
8284  (\"chinese\" . rfc1843-decode-region))
8285 ")
8286
8287 (defvar gnus-decode-header-methods-cache nil)
8288
8289 (defun gnus-multi-decode-header (start end)
8290   "Apply the functions from `gnus-encoded-word-methods' that match."
8291   (unless (and gnus-decode-header-methods-cache
8292                (eq gnus-newsgroup-name
8293                    (car gnus-decode-header-methods-cache)))
8294     (setq gnus-decode-header-methods-cache (list gnus-newsgroup-name))
8295     (dolist (x gnus-decode-header-methods)
8296       (if (symbolp x)
8297           (nconc gnus-decode-header-methods-cache (list x))
8298         (if (and gnus-newsgroup-name
8299                  (string-match (car x) gnus-newsgroup-name))
8300             (nconc gnus-decode-header-methods-cache
8301                    (list (cdr x)))))))
8302   (let ((xlist gnus-decode-header-methods-cache))
8303     (pop xlist)
8304     (save-restriction
8305       (narrow-to-region start end)
8306       (while xlist
8307         (funcall (pop xlist) (point-min) (point-max))))))
8308
8309 ;;;
8310 ;;; Treatment top-level handling.
8311 ;;;
8312
8313 (defvar gnus-inhibit-article-treatments nil)
8314
8315 (defun gnus-treat-article (gnus-treat-condition
8316                            &optional part-number total-parts gnus-treat-type)
8317   (let ((gnus-treat-length (- (point-max) (point-min)))
8318         (alist gnus-treatment-function-alist)
8319         (article-goto-body-goes-to-point-min-p t)
8320         (treated-type
8321          (or (not gnus-treat-type)
8322              (catch 'found
8323                (let ((list gnus-article-treat-types))
8324                  (while list
8325                    (when (string-match (pop list) gnus-treat-type)
8326                      (throw 'found t)))))))
8327         (highlightp (gnus-visual-p 'article-highlight 'highlight))
8328         val elem)
8329     (gnus-run-hooks 'gnus-part-display-hook)
8330     (dolist (elem alist)
8331       (setq val
8332             (save-excursion
8333               (when (gnus-buffer-live-p gnus-summary-buffer)
8334                 (set-buffer gnus-summary-buffer))
8335               (symbol-value (car elem))))
8336       (when (and (or (consp val)
8337                      treated-type)
8338                  (or (not gnus-inhibit-article-treatments)
8339                      (eq gnus-treat-condition 'head))
8340                  (gnus-treat-predicate val)
8341                  (or (not (get (car elem) 'highlight))
8342                      highlightp))
8343         (save-restriction
8344           (funcall (cadr elem)))))))
8345
8346 ;; Dynamic variables.
8347 (defvar part-number)
8348 (defvar total-parts)
8349 (defvar gnus-treat-type)
8350 (defvar gnus-treat-condition)
8351 (defvar gnus-treat-length)
8352
8353 (defun gnus-treat-predicate (val)
8354   (cond
8355    ((null val)
8356     nil)
8357    (gnus-treat-condition
8358     (eq gnus-treat-condition val))
8359    ((and (listp val)
8360          (stringp (car val)))
8361     (apply 'gnus-or (mapcar `(lambda (s)
8362                                (string-match s ,(or gnus-newsgroup-name "")))
8363                             val)))
8364    ((listp val)
8365     (let ((pred (pop val)))
8366       (cond
8367        ((eq pred 'or)
8368         (apply 'gnus-or (mapcar 'gnus-treat-predicate val)))
8369        ((eq pred 'and)
8370         (apply 'gnus-and (mapcar 'gnus-treat-predicate val)))
8371        ((eq pred 'not)
8372         (not (gnus-treat-predicate (car val))))
8373        ((eq pred 'typep)
8374         (equal (car val) gnus-treat-type))
8375        (t
8376         (error "%S is not a valid predicate" pred)))))
8377    ((eq val t)
8378     t)
8379    ((eq val 'head)
8380     nil)
8381    ((eq val 'first)
8382     (eq part-number 1))
8383    ((eq val 'last)
8384     (eq part-number total-parts))
8385    ((numberp val)
8386     (< gnus-treat-length val))
8387    (t
8388     (error "%S is not a valid value" val))))
8389
8390 (defun gnus-article-encrypt-body (protocol &optional n)
8391   "Encrypt the article body."
8392   (interactive
8393    (list
8394     (or gnus-article-encrypt-protocol
8395         (gnus-completing-read "Encrypt protocol"
8396                               (mapcar 'car gnus-article-encrypt-protocol-alist)
8397                               t))
8398     current-prefix-arg))
8399   ;; User might hit `K E' instead of `K e', so prompt once.
8400   (when (and gnus-article-encrypt-protocol
8401              gnus-novice-user)
8402     (unless (gnus-y-or-n-p "Really encrypt article(s)? ")
8403       (error "Encrypt aborted")))
8404   (let ((func (cdr (assoc protocol gnus-article-encrypt-protocol-alist))))
8405     (unless func
8406       (error "Can't find the encrypt protocol %s" protocol))
8407     (if (member gnus-newsgroup-name '("nndraft:delayed"
8408                                       "nndraft:drafts"
8409                                       "nndraft:queue"))
8410         (error "Can't encrypt the article in group %s"
8411                gnus-newsgroup-name))
8412     (gnus-summary-iterate n
8413       (with-current-buffer gnus-summary-buffer
8414         (let ((mail-parse-charset gnus-newsgroup-charset)
8415               (mail-parse-ignored-charsets gnus-newsgroup-ignored-charsets)
8416               (summary-buffer gnus-summary-buffer)
8417               references point)
8418           (gnus-set-global-variables)
8419           (when (gnus-group-read-only-p)
8420             (error "The current newsgroup does not support article encrypt"))
8421           (gnus-summary-show-article t)
8422           (setq references
8423               (or (mail-header-references gnus-current-headers) ""))
8424           (set-buffer gnus-article-buffer)
8425           (let* ((inhibit-read-only t)
8426                  (headers
8427                   (mapcar (lambda (field)
8428                             (and (save-restriction
8429                                    (message-narrow-to-head)
8430                                    (goto-char (point-min))
8431                                    (search-forward field nil t))
8432                                  (prog2
8433                                      (message-narrow-to-field)
8434                                      (buffer-string)
8435                                    (delete-region (point-min) (point-max))
8436                                    (widen))))
8437                           '("Content-Type:" "Content-Transfer-Encoding:"
8438                             "Content-Disposition:"))))
8439             (message-narrow-to-head)
8440             (message-remove-header "MIME-Version")
8441             (goto-char (point-max))
8442             (setq point (point))
8443             (insert (apply 'concat headers))
8444             (widen)
8445             (narrow-to-region point (point-max))
8446             (let ((message-options message-options))
8447               (message-options-set 'message-sender user-mail-address)
8448               (message-options-set 'message-recipients user-mail-address)
8449               (message-options-set 'message-sign-encrypt 'not)
8450               (funcall func))
8451             (goto-char (point-min))
8452             (insert "MIME-Version: 1.0\n")
8453             (widen)
8454             (gnus-summary-edit-article-done
8455              references nil summary-buffer t))
8456           (when gnus-keep-backlog
8457             (gnus-backlog-remove-article
8458              (car gnus-article-current) (cdr gnus-article-current)))
8459           (gnus-flush-original-article-buffer)
8460           (when gnus-use-cache
8461             (gnus-cache-update-article
8462              (car gnus-article-current) (cdr gnus-article-current))))))))
8463
8464 (defvar gnus-mime-security-button-line-format "%{%([[%t:%i]%D]%)%}\n"
8465   "The following specs can be used:
8466 %t  The security MIME type
8467 %i  Additional info
8468 %d  Details
8469 %D  Details if button is pressed")
8470
8471 (defvar gnus-mime-security-button-end-line-format "%{%([[End of %t]%D]%)%}\n"
8472   "The following specs can be used:
8473 %t  The security MIME type
8474 %i  Additional info
8475 %d  Details
8476 %D  Details if button is pressed")
8477
8478 (defvar gnus-mime-security-button-line-format-alist
8479   '((?t gnus-tmp-type ?s)
8480     (?i gnus-tmp-info ?s)
8481     (?d gnus-tmp-details ?s)
8482     (?D gnus-tmp-pressed-details ?s)))
8483
8484 (defvar gnus-mime-security-button-commands
8485   '((gnus-article-press-button "\r" "Show Detail")
8486     (undefined "v")
8487     (undefined "t")
8488     (undefined "C")
8489     (gnus-mime-security-save-part "o" "Save...")
8490     (undefined "\C-o")
8491     (undefined "r")
8492     (undefined "d")
8493     (undefined "c")
8494     (undefined "i")
8495     (undefined "E")
8496     (undefined "e")
8497     (undefined "p")
8498     (gnus-mime-security-pipe-part "|" "Pipe To Command...")
8499     (undefined ".")))
8500
8501 (defvar gnus-mime-security-button-map
8502   (let ((map (make-sparse-keymap)))
8503     (define-key map gnus-mouse-2 'gnus-article-push-button)
8504     (define-key map gnus-down-mouse-3 'gnus-mime-security-button-menu)
8505     (dolist (c gnus-mime-security-button-commands)
8506       (define-key map (cadr c) (car c)))
8507     map))
8508
8509 (easy-menu-define
8510   gnus-mime-security-button-menu gnus-mime-security-button-map
8511   "Security button menu."
8512   `("Security Part"
8513     ,@(delq nil
8514             (mapcar (lambda (c)
8515                       (unless (eq (car c) 'undefined)
8516                         (vector (caddr c) (car c) :active t)))
8517                     gnus-mime-security-button-commands))))
8518
8519 (defun gnus-mime-security-button-menu (event prefix)
8520   "Construct a context-sensitive menu of security commands."
8521   (interactive "e\nP")
8522   (save-window-excursion
8523     (let ((pos (event-start event)))
8524       (select-window (posn-window pos))
8525       (goto-char (posn-point pos))
8526       (gnus-article-check-buffer)
8527       (popup-menu gnus-mime-security-button-menu nil prefix))))
8528
8529 (defvar gnus-mime-security-details-buffer nil)
8530
8531 (defvar gnus-mime-security-button-pressed nil)
8532
8533 (defvar gnus-mime-security-show-details-inline t
8534   "If non-nil, show details in the article buffer.")
8535
8536 (defun gnus-mime-security-verify-or-decrypt (handle)
8537   (mm-remove-parts (cdr handle))
8538   (let ((region (mm-handle-multipart-ctl-parameter handle 'gnus-region))
8539         point (inhibit-read-only t))
8540     (if region
8541         (goto-char (car region)))
8542     (setq point (point))
8543     (with-current-buffer (mm-handle-multipart-original-buffer handle)
8544       (let* ((mm-verify-option 'known)
8545              (mm-decrypt-option 'known)
8546              (nparts (mm-possibly-verify-or-decrypt (cdr handle) handle)))
8547         (unless (eq nparts (cdr handle))
8548           (mm-destroy-parts (cdr handle))
8549           (setcdr handle nparts))))
8550     (gnus-mime-display-security handle)
8551     (when region
8552       (delete-region (point) (cdr region))
8553       (set-marker (car region) nil)
8554       (set-marker (cdr region) nil))
8555     (goto-char point)))
8556
8557 (defun gnus-mime-security-show-details (handle)
8558   (let ((details (mm-handle-multipart-ctl-parameter handle 'gnus-details)))
8559     (if (not details)
8560         (gnus-message 5 "No details.")
8561       (if gnus-mime-security-show-details-inline
8562           (let ((gnus-mime-security-button-pressed
8563                  (not (get-text-property (point) 'gnus-mime-details)))
8564                 (gnus-mime-security-button-line-format
8565                  (get-text-property (point) 'gnus-line-format))
8566                 (inhibit-read-only t))
8567             (forward-char -1)
8568             (while (eq (get-text-property (point) 'gnus-line-format)
8569                        gnus-mime-security-button-line-format)
8570               (forward-char -1))
8571             (forward-char)
8572             (save-restriction
8573               (narrow-to-region (point) (point))
8574               (gnus-insert-mime-security-button handle))
8575             (delete-region (point)
8576                            (or (text-property-not-all
8577                                 (point) (point-max)
8578                                 'gnus-line-format
8579                                 gnus-mime-security-button-line-format)
8580                                (point-max))))
8581         ;; Not inlined.
8582         (if (gnus-buffer-live-p gnus-mime-security-details-buffer)
8583             (with-current-buffer gnus-mime-security-details-buffer
8584               (erase-buffer)
8585               t)
8586           (setq gnus-mime-security-details-buffer
8587                 (gnus-get-buffer-create "*MIME Security Details*")))
8588         (with-current-buffer gnus-mime-security-details-buffer
8589           (insert details)
8590           (goto-char (point-min)))
8591         (pop-to-buffer gnus-mime-security-details-buffer)))))
8592
8593 (defun gnus-mime-security-press-button (handle)
8594   (save-excursion
8595     (if (mm-handle-multipart-ctl-parameter handle 'gnus-info)
8596         (gnus-mime-security-show-details handle)
8597       (gnus-mime-security-verify-or-decrypt handle))))
8598
8599 (defun gnus-insert-mime-security-button (handle &optional displayed)
8600   (let* ((protocol (mm-handle-multipart-ctl-parameter handle 'protocol))
8601          (gnus-tmp-type
8602           (concat
8603            (or (nth 2 (assoc protocol mm-verify-function-alist))
8604                (nth 2 (assoc protocol mm-decrypt-function-alist))
8605                "Unknown")
8606            (if (equal (car handle) "multipart/signed")
8607                " Signed" " Encrypted")
8608            " Part"))
8609          (gnus-tmp-info
8610           (or (mm-handle-multipart-ctl-parameter handle 'gnus-info)
8611               "Undecided"))
8612          (gnus-tmp-details
8613           (mm-handle-multipart-ctl-parameter handle 'gnus-details))
8614          gnus-tmp-pressed-details
8615          b e)
8616     (setq gnus-tmp-details
8617           (if gnus-tmp-details
8618               (concat "\n" gnus-tmp-details)
8619             ""))
8620     (setq gnus-tmp-pressed-details
8621           (if gnus-mime-security-button-pressed gnus-tmp-details ""))
8622     (unless (bolp)
8623       (insert "\n"))
8624     (setq b (point))
8625     (gnus-eval-format
8626      gnus-mime-security-button-line-format
8627      gnus-mime-security-button-line-format-alist
8628      `(keymap ,gnus-mime-security-button-map
8629          gnus-callback gnus-mime-security-press-button
8630          gnus-line-format ,gnus-mime-security-button-line-format
8631          gnus-mime-details ,gnus-mime-security-button-pressed
8632          article-type annotation
8633          gnus-data ,handle))
8634     (setq e (if (bolp)
8635                 ;; Exclude a newline.
8636                 (1- (point))
8637               (point)))
8638     (when gnus-article-button-face
8639       (gnus-overlay-put (gnus-make-overlay b e nil t)
8640                         'face gnus-article-button-face))
8641     (widget-convert-button
8642      'link b e
8643      :mime-handle handle
8644      :action 'gnus-widget-press-button
8645      :button-keymap gnus-mime-security-button-map
8646      :help-echo
8647      (lambda (widget)
8648        ;; Needed to properly clear the message due to a bug in
8649        ;; wid-edit (XEmacs only).
8650        (when (boundp 'help-echo-owns-message)
8651          (setq help-echo-owns-message t))
8652        (format
8653         "%S: show detail; %S: more options"
8654         (aref gnus-mouse-2 0)
8655         (aref gnus-down-mouse-3 0))))))
8656
8657 (defun gnus-mime-display-security (handle)
8658   (save-restriction
8659     (narrow-to-region (point) (point))
8660     (unless (gnus-unbuttonized-mime-type-p (car handle))
8661       (gnus-insert-mime-security-button handle))
8662     (gnus-mime-display-part (cadr handle))
8663     (unless (bolp)
8664       (insert "\n"))
8665     (unless (gnus-unbuttonized-mime-type-p (car handle))
8666       (let ((gnus-mime-security-button-line-format
8667              gnus-mime-security-button-end-line-format))
8668         (gnus-insert-mime-security-button handle)))
8669     (mm-set-handle-multipart-parameter
8670      handle 'gnus-region
8671      (cons (set-marker (make-marker) (point-min))
8672            (set-marker (make-marker) (point-max))))
8673     (goto-char (point-max))))
8674
8675 (defun gnus-mime-security-run-function (function)
8676   "Run FUNCTION with the security part under point."
8677   (gnus-article-check-buffer)
8678   (let ((data (get-text-property (point) 'gnus-data))
8679         buffer handle)
8680     (when (and (stringp (car-safe data))
8681                (setq buffer (mm-handle-multipart-original-buffer data))
8682                (setq handle (cadr data)))
8683       (if (bufferp (mm-handle-buffer handle))
8684           (progn
8685             (setq handle (cons buffer (copy-sequence (cdr handle))))
8686             (mm-handle-set-undisplayer handle nil))
8687         (setq handle (mm-make-handle
8688                       buffer
8689                       (mm-handle-multipart-ctl-parameter handle 'protocol)
8690                       nil nil nil nil nil nil)))
8691       (funcall function handle))))
8692
8693 (defun gnus-mime-security-save-part ()
8694   "Save the security part under point."
8695   (interactive)
8696   (gnus-mime-security-run-function 'mm-save-part))
8697
8698 (defun gnus-mime-security-pipe-part ()
8699   "Pipe the security part under point to a process."
8700   (interactive)
8701   (gnus-mime-security-run-function 'mm-pipe-part))
8702
8703 (gnus-ems-redefine)
8704
8705 (provide 'gnus-art)
8706
8707 (run-hooks 'gnus-art-load-hook)
8708
8709 ;;; gnus-art.el ends here