| blob | 55e51d8c128d9b38a6b756aee0ff1224aa30edb5 |
1 ;;; gnus-art.el --- article mode commands for Gnus
2 ;; Copyright (C) 1996, 1997, 1998, 1999, 2000 Free Software Foundation, Inc.
4 ;; Author: Lars Magne Ingebrigtsen <larsi@gnus.org>
5 ;; Keywords: news
7 ;; This file is part of GNU Emacs.
9 ;; GNU Emacs is free software; you can redistribute it and/or modify
10 ;; it under the terms of the GNU General Public License as published by
11 ;; the Free Software Foundation; either version 2, or (at your option)
12 ;; any later version.
14 ;; GNU Emacs is distributed in the hope that it will be useful,
15 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
16 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 ;; GNU General Public License for more details.
19 ;; You should have received a copy of the GNU General Public License
20 ;; along with GNU Emacs; see the file COPYING. If not, write to the
21 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
22 ;; Boston, MA 02111-1307, USA.
24 ;;; Commentary:
26 ;;; Code:
42 "Article display."
47 "Treating article parts."
52 "Hiding article parts."
57 "Article highlighting."
63 "Article signatures."
68 "Article headers."
73 "Special commands on articles."
78 "Fontisizing articles."
83 "Saving articles."
88 "Worshiping the MIME wonder."
93 "Pushable buttons in the article buffer."
98 "Other article options."
130 "*All headers that start with this regexp will be hidden.
131 This variable can also be a list of regexps of headers to be ignored.
132 If `gnus-visible-headers' is non-nil, this variable will be ignored."
134 regexp
139 "^From:\\|^Newsgroups:\\|^Subject:\\|^Date:\\|^Followup-To:\\|^Reply-To:\\|^Organization:\\|^Summary:\\|^Keywords:\\|^To:\\|^[BGF]?Cc:\\|^Posted-To:\\|^Mail-Copies-To:\\|^Apparently-To:\\|^Gnus-Warning:\\|^Resent-From:\\|^X-Sent:"
140 "*All headers that do not match this regexp will be hidden.
141 This variable can also be a list of regexp of headers to remain visible.
142 If this variable is non-nil, `gnus-ignored-headers' will be ignored."
148 regexp)
154 "*This variable is a list of regular expressions.
155 If it is non-nil, headers that match the regular expressions will
156 be placed first in the article buffer in the sequence specified by
157 this list."
162 "Headers that are only to be displayed if they have interesting data.
163 Possible values in this list are `empty', `newsgroups', `followup-to',
164 `reply-to', `date', `long-to', and `many-to'."
175 "Regexp matching signature separator.
176 This can also be a list of regexps. In that case, it will be checked
177 from head to tail looking for a separator. Searches will be done from
178 the end of the buffer."
183 "Provide a limit to what is considered a signature.
184 If it is a number, no signature may not be longer (in characters) than
185 that number. If it is a floating point number, no signature may be
186 longer (in lines) than that number. If it is a function, the function
187 will be called without any parameters, and if it returns nil, there is
188 no signature in the buffer. If it is a string, it will be used as a
189 regexp. If it matches, the text in question is not a signature."
197 "Property list to use for hiding text."
201 ;; Fixme: This isn't the right thing for mixed graphical and and
202 ;; non-graphical frames in a session.
203 ;; gnus-xmas.el overrides this for XEmacs.
207 'gnus-article-display-xface
209 "{ echo '/* Width=48, Height=48 */'; uncompface; } | display -"
210 "{ echo '/* Width=48, Height=48 */'; uncompface; } | icontopbm | \
212 "*String or function to be executed to display an X-Face header.
213 If it is a string, the command will be executed in a sub-shell
214 asynchronously. The compressed face will be piped to this command."
217 function)
222 "Regexp matching posters whose face shouldn't be shown automatically."
227 "Banner alist for stripping.
228 For example,
229 ((egroups . \"^[ \\t\\n]*-------------------+\\\\( eGroups Sponsor -+\\\\)?....\\n\\\\(.+\\n\\\\)+\"))"
236 "\\(\\s-\\|^\\|[-\"]\\|\\s(\\)\\(%s\\(\\w+\\(\\s-+\\w+\\)*[.,]?\\)%s\\)\\(\\s-\\|[-,;:\"]\\s-\\|[?!.]+\\s-\\|\\s)\\)")
252 types)))
253 "*Alist that says how to fontify certain phrases.
254 Each item looks like this:
258 The first element is a regular expression to be matched. The second
259 is a number that says what regular expression grouping used to find
260 the entire emphasized word. The third is a number that says what
261 regexp grouping should be displayed and highlighted. The fourth
262 is the face used for highlighting."
264 regexp
267 face))
271 "A regexp to describe whitespace which should not be emphasized.
273 The former avoids underlining of leading and trailing whitespace,
274 and the latter avoids underlining any whitespace at all."
280 "Face used for displaying strong emphasized text (*word*)."
284 "Face used for displaying italic emphasized text (/word/)."
288 "Face used for displaying underlined emphasized text (_word_)."
292 "Face used for displaying underlined bold emphasized text (_*word*_)."
296 "Face used for displaying underlined italic emphasized text (_/word/_)."
300 "Face used for displaying bold italic emphasized text (/*word*/)."
305 "Face used for displaying underlined bold italic emphasized text.
306 Esample: (_/*word*/_)."
311 "Face used for displaying highlighted words."
315 "Format for display of Date headers in article bodies.
316 See `format-time-string' for the possible values.
318 The variable can also be function, which should return a complete Date
319 header. The function is called with one argument, the time, which can
320 be fed to `format-time-string'."
329 "*If non-nil, don't remove any headers before saving."
334 "*This variable says how much prompting is to be done when saving articles.
335 If it is nil, no prompting will be done, and the articles will be
336 saved to the default files. If this variable is `always', each and
337 every article that is saved will be preceded by a prompt, even when
338 saving large batches of articles. If this variable is neither nil not
339 `always', there the user will be prompted once for a file name for
340 each invocation of the saving commands."
347 "Headers to keep if `gnus-save-all-headers' is nil.
348 If `gnus-save-all-headers' is non-nil, this variable will be ignored.
349 If that variable is nil, however, all headers that match this regexp
350 will be kept while the rest will be deleted before saving."
355 "A function to save articles in your favourite format.
356 The function must be interactively callable (in other words, it must
357 be an Emacs command).
359 Gnus provides the following functions:
361 * gnus-summary-save-in-rmail (Rmail format)
362 * gnus-summary-save-in-mail (Unix mail format)
363 * gnus-summary-save-in-folder (MH folder)
364 * gnus-summary-save-in-file (article format)
365 * gnus-summary-save-in-vm (use VM's folder format)
366 * gnus-summary-write-to-file (article format -- overwrite)."
376 "A function generating a file name to save articles in Rmail format.
377 The function is called with NEWSGROUP, HEADERS, and optional LAST-FILE."
382 "A function generating a file name to save articles in Unix mail format.
383 The function is called with NEWSGROUP, HEADERS, and optional LAST-FILE."
388 "A function generating a file name to save articles in MH folder.
389 The function is called with NEWSGROUP, HEADERS, and optional LAST-FOLDER."
394 "A function generating a file name to save articles in article format.
395 The function is called with NEWSGROUP, HEADERS, and optional
396 LAST-FILE."
403 "*Variable used to suggest where articles are to be saved.
404 For instance, if you would like to save articles related to Gnus in
406 you could set this variable to something like:
411 This variable is an alist where the where the key is the match and the
412 value is a list of possible files to save in if the match is non-nil.
414 If the match is a string, it is used as a regexp match on the
415 article. If the match is a symbol, that symbol will be funcalled
416 from the buffer of the article to be saved with the newsgroup as the
417 parameter. If it is a list, it will be evaled in the same buffer.
419 If this form or function returns a string, this string will be used as
420 a possible file name; and if it returns a non-nil list, that list will
421 be used as possible file names."
428 "*Regexp describing what to use as article page delimiters.
430 beginning of a line."
435 "*The format specification for the article mode line.
436 See `gnus-summary-mode-line-format' for a closer description.
438 The following additional specs are available:
440 %w The article washing status.
441 %m The number of MIME parts in the article."
446 "*A hook for Gnus article mode."
451 "*Hook run after the creation of the article mode menu."
456 "*A hook called after an article has been prepared in the article buffer."
461 "*A hook called after successfully hiding a PGP signature."
466 "Face used for highlighting buttons in the article buffer.
468 An article button is a piece of text that you can activate by pressing
469 `RET' or `mouse-2' above it."
474 "Face used for mouse highlighting in the article buffer.
476 Article buttons will be displayed in this face when the cursor is
477 above them."
482 "Face used for highlighting a signature in the article buffer.
483 Obsolete; use the face `gnus-signature-face' for customizations instead."
491 "Face used for highlighting a signature in the article buffer."
504 "Face used for displaying from headers."
517 "Face used for displaying subject headers."
530 "Face used for displaying newsgroups headers."
543 "Face used for displaying header names."
564 "*Controls highlighting of article header.
566 An alist of the form (HEADER NAME CONTENT).
568 HEADER is a regular expression which should match the name of an
569 header header and NAME and CONTENT are either face names or nil.
571 The name of each header field will be displayed using the face
572 specified by the first element in the list where HEADER match the
573 header name and NAME is non-nil. Similarly, the content will be
574 displayed by the first non-nil matching CONTENT face."
587 "*Hook run to decode charsets in articles."
592 "Function to display MIME articles."
620 "List of MIME types that should be ignored by Gnus."
626 "List of MIME types that should not be given buttons when rendered inline."
632 "Function called with a MIME handle as the argument.
633 This is meant for people who want to do something automatic based
634 on parts -- for instance, adding Vcard info to a database."
639 "An alist of MIME types to functions to display them."
645 "Whether the X-Sent and Date headers can coexist.
648 be added below it (otherwise)."
654 "Function called with a MIME handle as the argument.
655 This is meant for people who want to view first matched part.
656 For `undisplayed-alternative' (default), the first undisplayed
657 part or alternative part is used. For `undisplayed', the first
658 undisplayed part is used. For a function, the first part which
659 the function return `t' is used. For `nil', the first part is
660 used."
679 "An alist of actions that run on the MIME attachment."
685 ;;;
686 ;;; The treatment variables
687 ;;;
712 "Highlight the signature.
713 Valid values are nil, t, `head', `last', an integer or a predicate.
714 See the manual for details."
720 "Add buttons.
721 Valid values are nil, t, `head', `last', an integer or a predicate.
722 See the manual for details."
728 "Add buttons to the head.
729 Valid values are nil, t, `head', `last', an integer or a predicate.
730 See the manual for details."
740 "Emphasize text.
741 Valid values are nil, t, `head', `last', an integer or a predicate.
742 See the manual for details."
748 "Remove carriage returns.
749 Valid values are nil, t, `head', `last', an integer or a predicate.
750 See the manual for details."
755 "Hide headers.
756 Valid values are nil, t, `head', `last', an integer or a predicate.
757 See the manual for details."
762 "Hide boring headers.
763 Valid values are nil, t, `head', `last', an integer or a predicate.
764 See the manual for details."
769 "Hide the signature.
770 Valid values are nil, t, `head', `last', an integer or a predicate.
771 See the manual for details."
776 "Fill the article.
777 Valid values are nil, t, `head', `last', an integer or a predicate.
778 See the manual for details."
783 "Hide cited text.
784 Valid values are nil, t, `head', `last', an integer or a predicate.
785 See the manual for details."
790 "Hide cited text.
791 Valid values are nil, t, `head', `last', an integer or a predicate.
792 See the manual for details."
797 "Strip list identifiers from `gnus-list-identifiers`.
798 Valid values are nil, t, `head', `last', an integer or a predicate.
799 See the manual for details."
805 "Strip PGP signatures.
806 Valid values are nil, t, `head', `last', an integer or a predicate.
807 See the manual for details."
812 "Strip PEM signatures.
813 Valid values are nil, t, `head', `last', an integer or a predicate.
814 See the manual for details."
819 "Strip banners from articles.
820 The banner to be stripped is specified in the `banner' group parameter.
821 Valid values are nil, t, `head', `last', an integer or a predicate.
822 See the manual for details."
827 "Highlight the headers.
828 Valid values are nil, t, `head', `last', an integer or a predicate.
829 See the manual for details."
835 "Highlight cited text.
836 Valid values are nil, t, `head', `last', an integer or a predicate.
837 See the manual for details."
843 "Display the Date in UT (GMT).
844 Valid values are nil, t, `head', `last', an integer or a predicate.
845 See the manual for details."
850 "Display the Date in the local timezone.
851 Valid values are nil, t, `head', `last', an integer or a predicate.
852 See the manual for details."
857 "Display the Date header in a way that says how much time has elapsed.
858 Valid values are nil, t, `head', `last', an integer or a predicate.
859 See the manual for details."
864 "Display the date in the original timezone.
865 Valid values are nil, t, `head', `last', an integer or a predicate.
866 See the manual for details."
871 "Display the date in the ISO8601 format.
872 Valid values are nil, t, `head', `last', an integer or a predicate.
873 See the manual for details."
879 "Display the date in a user-defined format.
880 The format is defined by the `gnus-article-time-format' variable.
881 Valid values are nil, t, `head', `last', an integer or a predicate.
882 See the manual for details."
887 "Strip the X-No-Archive header line from the beginning of the body.
888 Valid values are nil, t, `head', `last', an integer or a predicate.
889 See the manual for details."
895 "Strip trailing blank lines.
896 Valid values are nil, t, `head', `last', an integer or a predicate.
897 See the manual for details."
902 "Strip leading blank lines.
903 Valid values are nil, t, `head', `last', an integer or a predicate.
904 See the manual for details."
909 "Strip multiple blank lines.
910 Valid values are nil, t, `head', `last', an integer or a predicate.
911 See the manual for details."
916 "Treat overstrike highlighting.
917 Valid values are nil, t, `head', `last', an integer or a predicate.
918 See the manual for details."
929 "Display X-Face headers.
930 Valid values are nil, t, `head', `last', an integer or a predicate.
931 See the manual for details."
942 t nil)
943 "Display smileys.
944 Valid values are nil, t, `head', `last', an integer or a predicate.
945 See the manual for details."
952 "Display picons.
953 Valid values are nil, t, `head', `last', an integer or a predicate.
954 See the manual for details."
960 "Capitalize sentence-starting words.
961 Valid values are nil, t, `head', `last', an integer or a predicate.
962 See the manual for details."
968 "Fill long lines.
969 Valid values are nil, t, `head', `last', an integer or a predicate.
970 See the manual for details."
975 "Play sounds.
976 Valid values are nil, t, `head', `last', an integer or a predicate.
977 See the manual for details."
983 "Translate articles from one language to another.
984 Valid values are nil, t, `head', `last', an integer or a predicate.
985 See the manual for details."
990 ;;; Internal variables
1025 gnus-article-remove-trailing-blank-lines)
1027 gnus-article-strip-leading-blank-lines)
1029 gnus-article-strip-multiple-blank-lines)
1046 table)
1047 "Syntax table used in article mode buffers.
1055 gnus-summary-mode-line-format-alist))
1062 "Set text PROPS on the B to E region, extending `intangible' 1 past B."
1070 "Remove hidden text properties from region between B and E."
1077 "Hide text of TYPE between B and E."
1083 "Unhide text of TYPE between B and E."
1093 "Hide text of TYPE in the current buffer."
1101 "Delete text of TYPE in the current buffer."
1110 "Delete all invisible text in the current buffer."
1119 "Say whether any text of type TYPE exists in the buffer."
1123 "Give the rank of the string HEADER as given by `gnus-sorted-header-list'."
1131 i))
1134 "Hide unwanted headers and possibly sort them as well."
1136 ;; This function might be inhibited.
1145 gnus-ignored-headers)
1151 gnus-visible-headers)
1156 beg)
1157 ;; First we narrow to just the headers.
1159 ;; Hide any "From " lines at the beginning of (mail) articles.
1164 ;; Then treat the rest of the header lines.
1165 ;; Then we use the two regular expressions
1166 ;; `gnus-ignored-headers' and `gnus-visible-headers' to
1167 ;; select which header lines is to remain visible in the
1168 ;; article buffer.
1171 ;; Mark the rank of the header.
1183 ;; We delete the unwanted headers.
1190 "Toggle hiding of headers that aren't very interesting.
1191 If given a negative prefix, always show; if given a positive prefix,
1192 always hide."
1201 elem)
1207 ;; Hide empty headers.
1219 ;; Hide boring Newsgroups header.
1224 gnus-newsgroup-name
1235 from reply-to
1299 "Make all header lines 40 characters long."
1302 column)
1309 gnus-article-normalized-header-length)
1313 ? )))
1322 ;; Do nothing.
1323 ))
1327 "Translate M****s*** sm*rtq**t*s into proper text.
1328 Note that this function guesses whether a character is a sm*rtq**t* or
1329 not, so it should only be used interactively.
1331 Sm*rtq**t*s are M****s***'s unilateral extension to the character map
1332 in an attempt to provide more quoting characters. If you see
1334 apostrophe or quotation mark, then try this wash."
1339 "Translate all characters in the body of the article according to FROM and TO.
1340 FROM is a string of characters to translate from; to is a string of
1341 characters to translate to."
1356 "Translate all string in the body of the article according to MAP.
1361 elem)
1368 "Translate overstrikes into bold text."
1376 ;; We do the boldification/underlining by hiding the
1377 ;; overstrikes and putting the proper text property
1378 ;; on the letters.
1394 "Fill lines that are wider than the window width."
1412 "Capitalize the first word in each sentence."
1423 "Remove trailing CRs and then translate remaining CRs into LFs."
1435 "Remove all trailing blank lines from the article."
1452 "Look for an X-Face header and display it if present."
1455 ;; Delete the old process, if any.
1460 from last)
1469 ;; Check whether this face is censored.
1473 from))))
1474 ;; Has to be present.
1476 ;; This used to try to do multiple faces (`while' instead of
1477 ;; `when' above), but (a) sending multiple EOFs to xv doesn't
1478 ;; work (b) it can crash some versions of Emacs (c) are
1479 ;; multiple faces really something to encourage?
1482 ;; We now have the area of the buffer where the X-Face is stored.
1486 ;; We display the face.
1488 ;; The command is a lisp function, so we call it.
1492 ;; The command is a string, so we interpret the command
1493 ;; as a, well, command, and fork it off.
1497 "article-x-face" nil shell-file-name shell-command-switch
1498 gnus-article-x-face-command))
1503 "Decode all MIME-encoded words in the article."
1508 buffer-read-only
1512 gnus-newsgroup-ignored-charsets)))
1516 "Decode charset-encoded text in the article.
1517 If PROMPT (the prefix), prompt for a coding system to use."
1520 buffer-read-only
1526 gnus-newsgroup-ignored-charsets))
1527 ct cte ctl charset format)
1551 ;; The text code could have been decoded.
1562 "Remove encoded-word encoding from headers."
1569 gnus-newsgroup-ignored-charsets))
1570 buffer-read-only)
1576 "Translate a quoted-printable-encoded article.
1577 If FORCE, decode the article whether it is marked as quoted-printable
1578 or not."
1604 "Translate a base64 article.
1605 If FORCE, decode the article whether it is marked as base64 not."
1637 "Translate a HZ-encoded article."
1645 "Format an html article."
1649 charset)
1674 "Remove list identifies from the Subject header.
1675 The `gnus-list-identifiers' variable specifies what to do."
1680 buffer-read-only)
1689 nil t)
1697 "Remove any PGP headers and signatures in the current article."
1702 buffer-read-only beg end)
1704 ;; Hide the "header".
1708 ;; Remove armor headers (rfc2440 6.2)
1712 ;; Hide the actual signature.
1716 end
1719 ;; Perhaps we shouldn't hide to the end of the buffer
1720 ;; if there is no end to the signature?
1722 ;; Hide "- " PGP quotation markers.
1733 "Toggle hiding of any PEM headers and signatures in the current article.
1734 If given a negative prefix, always show; if given a positive prefix,
1735 always hide."
1741 ;; Hide the horrendously ugly "header".
1744 nil t)
1748 end
1753 ;; Hide the trailer as well
1755 nil t)
1760 "Strip the banner specified by the `banner' group parameter."
1767 buffer-read-only beg end)
1785 "Translate article using an online translation service."
1802 "Hide the signature in the current article.
1803 If given a negative prefix, always show; if given a positive prefix,
1804 always hide."
1815 "Strip offensive headers from bodies."
1824 "Remove all blank lines from the beginning of the article."
1828 buffer-read-only)
1835 "Narrow the buffer to the head of the message.
1836 Point is left at the beginning of the narrowed-to region."
1845 "Place point at the start of the body."
1848 ;; This variable is only bound when dealing with separate
1849 ;; MIME body parts.
1851 t)
1853 t)
1856 nil)))
1859 "Replace consecutive blank lines with one empty line."
1863 buffer-read-only)
1864 ;; First make all blank lines empty.
1870 ;; Then replace multiple empty lines with a single empty line.
1878 "Remove all white space from the beginning of the lines in the article."
1882 buffer-read-only)
1888 "Remove all white space from the end of the lines in the article."
1892 buffer-read-only)
1898 "Strip leading, trailing and multiple blank lines."
1905 "Strip all blank lines."
1909 buffer-read-only)
1915 "Narrow to the signature; return t if a signature is found, else nil."
1919 ;; Check whether we have some limits to what we consider
1920 ;; to be a signature.
1923 limit limited)
1935 limits nil)))
1938 t)))))
1941 "Search the current buffer for the signature separator.
1942 Put point at the beginning of the signature separator."
1951 seps))
1952 t
1954 nil)))
1957 "Return the current prefix arg as a number, or 0 if no prefix."
1963 "Return nil if hiding is necessary.
1964 Arg can be nil or a number. Nil and positive means hide, negative
1965 means show, 0 means toggle."
1972 nil)
1975 t)
1980 t)
1981 nil)))))))
1984 "Say whether the current buffer contains hidden text of type TYPE."
1992 'hidden
1993 nil)))
1996 "Show all hidden text of type TYPE.
1997 Originally it is hide instead of DUMMY."
2001 'article-type type
2004 gnus-hidden-properties)))))
2016 "Convert DATE date to universal time in the current article.
2017 If TYPE is `local', convert to local time; if it is `lapsed', output
2018 how much time has lapsed since DATE. For `lapsed', the value of
2029 tdate-regexp)
2035 header))
2037 pos
2038 bface eface)
2046 date)
2052 ;; Delete any old Date headers.
2067 ;; Do highlighting.
2078 "Return a DATE line of TYPE."
2083 ;; Convert to the local timezone. We have to slap a
2084 ;; `condition-case' round the calls to the timezone
2085 ;; functions since they aren't particularly resistant to
2086 ;; buggy dates.
2092 ;; Convert to Universal Time.
2104 ;; Get the original date from the article.
2108 date)))
2109 ;; Let the user define the format.
2114 "Date: "
2116 ;; ISO 8601.
2120 "Date: "
2125 ;; Do an X-Sent lapsed format.
2127 ;; If the date is seriously mangled, the timezone functions are
2128 ;; liable to bug out, so we ignore all errors.
2135 num prev)
2143 "X-Sent: "
2144 ;; This is a bit convoluted, but basically we go
2145 ;; through the time units for years, weeks, etc,
2146 ;; and divide things to see whether that results
2147 ;; in positive answers.
2151 ;; The (remaining) seconds are too few to
2152 ;; be divided into this time unit.
2153 ""
2154 ;; It's big enough, so we output it.
2163 ;; If dates are odd, then it might appear like the
2164 ;; article was sent in the future.
2166 " ago"
2172 "Convert the current article date to the local timezone."
2177 "Convert the current article date to what it was originally.
2178 This is only useful if you have used some other date conversion
2179 function and want to see what the date was before converting."
2184 "Convert the current article date to time lapsed since it was sent."
2189 "Function to be run from a timer to update the lapsed time line."
2203 "Start a timer to update the X-Sent header in the article buffers.
2204 The numerical prefix says how frequently (in seconds) the function
2205 is to run."
2214 "Stop the X-Sent timer."
2221 "Convert the current article date to the user-defined format.
2222 This format is defined by the `gnus-article-time-format' variable."
2227 "Convert the current article date to ISO8601."
2232 "Show all hidden text in the article buffer."
2239 "Emphasize text according to `gnus-emphasis-alist'."
2246 gnus-article-emphasis-alist)
2248 gnus-emphasis-alist))
2251 gnus-hidden-properties))
2252 regexp elem beg invisible visible face)
2273 "Setup newsgroup emphasis alist."
2285 highlight)
2290 gnus-emphasis-alist)))))
2295 ;;; Saving functions.
2298 "Save the currently selected article."
2300 ;; Remove headers according to `gnus-saved-headers'.
2310 ;; !!! Magic! The saving functions all save
2311 ;; `gnus-save-article-buffer' (or so they think), but we
2312 ;; bind that variable to our save-buffer.
2327 function group headers variable)
2330 result)
2335 default-name)
2337 default-name)
2346 gnus-number-of-articles-to-be-saved)
2349 ;; Let the split methods have their say.
2351 ;; No split name was found.
2357 default-name))
2358 ;; A single group name is returned.
2367 default-name))
2368 ;; A single split name was found
2378 dir name)))
2379 ;; A list of splits was found.
2389 gnus-article-save-directory
2391 gnus-article-save-directory)))
2393 ;; Create the directory.
2395 ;; If we have read a directory, we append the default file name.
2399 ;; Possibly translate some characters.
2412 "If GROUP is an nndoc group, return the name of the parent group."
2417 "Append this article to Rmail file.
2418 Optional argument FILENAME specifies file name.
2419 Directory to save to is default to `gnus-article-save-directory'."
2421 "Save %s in rmail file:" filename
2422 gnus-rmail-save-name gnus-newsgroup-name
2429 filename)
2432 "Append this article to Unix mail file.
2433 Optional argument FILENAME specifies file name.
2434 Directory to save to is default to `gnus-article-save-directory'."
2436 "Save %s in Unix mail file:" filename
2437 gnus-mail-save-name gnus-newsgroup-name
2447 filename)
2450 "Append this article to file.
2451 Optional argument FILENAME specifies file name.
2452 Directory to save to is default to `gnus-article-save-directory'."
2454 "Save %s in file:" filename
2455 gnus-file-save-name gnus-newsgroup-name
2465 filename)
2468 "Write this article to a file.
2469 Optional argument FILENAME specifies file name.
2470 The directory to save in defaults to `gnus-article-save-directory'."
2474 "Append this article body to a file.
2475 Optional argument FILENAME specifies file name.
2476 The directory to save in defaults to `gnus-article-save-directory'."
2478 "Save %s body in file:" filename
2479 gnus-file-save-name gnus-newsgroup-name
2488 filename)
2491 "Pipe this article to subprocess."
2494 gnus-last-shell-command)
2495 gnus-last-shell-command)
2497 command)
2500 "Shell command on %s: "
2504 gnus-number-of-articles-to-be-saved)
2506 gnus-last-shell-command))))
2517 ;;; Article file names when saving.
2520 "Capitalize NEWSGROUP name."
2526 "Generate file name from NEWSGROUP, HEADERS, and optional LAST-FILE.
2527 If variable `gnus-use-long-file-name' is non-nil, it is ~/News/News.group/num.
2528 Otherwise, it is like ~/News/news/group/num."
2535 gnus-article-save-directory)))
2540 default
2544 "Generate file name from NEWSGROUP, HEADERS, and optional LAST-FILE.
2545 If variable `gnus-use-long-file-name' is non-nil, it is
2546 ~/News/news.group/num. Otherwise, it is like ~/News/news/group/num."
2550 newsgroup
2553 gnus-article-save-directory)))
2558 default
2562 "Generate file name from NEWSGROUP, HEADERS, and optional LAST-FILE.
2563 If variable `gnus-use-long-file-name' is non-nil, it is
2564 ~/News/news.group. Otherwise, it is like ~/News/news/group/news."
2568 newsgroup
2570 gnus-article-save-directory)))
2592 article-hide-boring-headers
2593 article-treat-overstrike
2594 article-fill-long-lines
2595 article-capitalize-sentences
2596 article-remove-cr
2597 article-display-x-face
2598 article-de-quoted-unreadable
2599 article-de-base64-unreadable
2600 article-decode-HZ
2601 article-wash-html
2602 article-hide-list-identifiers
2603 article-hide-pgp
2604 article-strip-banner
2605 article-babel
2606 article-hide-pem
2607 article-hide-signature
2608 article-strip-headers-in-body
2609 article-remove-trailing-blank-lines
2610 article-strip-leading-blank-lines
2611 article-strip-multiple-blank-lines
2612 article-strip-leading-space
2613 article-strip-trailing-space
2614 article-strip-blank-lines
2615 article-strip-all-blank-lines
2616 article-date-local
2617 article-date-iso8601
2618 article-date-original
2619 article-date-ut
2620 article-decode-mime-words
2621 article-decode-charset
2622 article-decode-encoded-words
2623 article-date-user
2624 article-date-lapsed
2625 article-emphasize
2626 article-treat-dumbquotes
2627 article-normalize-headers
2629 \f
2630 ;;;
2631 ;;; Gnus article mode
2632 ;;;
2639 " " gnus-article-goto-next-page
2641 [delete] gnus-article-goto-prev-page
2642 [backspace] gnus-article-goto-prev-page
2643 "\C-c^" gnus-article-refer-article
2644 "h" gnus-article-show-summary
2645 "s" gnus-article-show-summary
2646 "\C-c\C-m" gnus-article-mail
2647 "?" gnus-article-describe-briefly
2648 "e" gnus-summary-edit-article
2649 "<" beginning-of-buffer
2650 ">" end-of-buffer
2651 "\C-c\C-i" gnus-info-find-node
2652 "\C-c\C-b" gnus-bug
2653 "\C-hk" gnus-article-describe-key
2654 "\C-hc" gnus-article-describe-key-briefly
2656 "\C-d" gnus-article-read-summary-keys
2657 "\M-*" gnus-article-read-summary-keys
2658 "\M-#" gnus-article-read-summary-keys
2659 "\M-^" gnus-article-read-summary-keys
2660 "\M-g" gnus-article-read-summary-keys)
2662 (substitute-key-definition
2663 'undefined 'gnus-article-read-summary-keys gnus-article-mode-map)
2665 (defun gnus-article-make-menu-bar ()
2666 (gnus-turn-off-edit-menu 'article)
2667 (unless (boundp 'gnus-article-article-menu)
2668 (easy-menu-define
2669 gnus-article-article-menu gnus-article-mode-map ""
2670 '("Article"
2671 ["Scroll forwards" gnus-article-goto-next-page t]
2672 ["Scroll backwards" gnus-article-goto-prev-page t]
2673 ["Show summary" gnus-article-show-summary t]
2674 ["Fetch Message-ID at point" gnus-article-refer-article t]
2675 ["Mail to address at point" gnus-article-mail t]
2676 ["Send a bug report" gnus-bug t]))
2678 (easy-menu-define
2679 gnus-article-treatment-menu gnus-article-mode-map ""
2680 ;; Fixme: this should use :active (and maybe :visible).
2681 '("Treatment"
2682 ["Hide headers" gnus-article-hide-headers t]
2683 ["Hide signature" gnus-article-hide-signature t]
2684 ["Hide citation" gnus-article-hide-citation t]
2685 ["Treat overstrike" gnus-article-treat-overstrike t]
2686 ["Remove carriage return" gnus-article-remove-cr t]
2687 ["Remove quoted-unreadable" gnus-article-de-quoted-unreadable t]
2688 ["Remove base64" gnus-article-de-base64-unreadable t]
2689 ["Treat html" gnus-article-wash-html t]
2690 ["Decode HZ" gnus-article-decode-HZ t]))
2692 ;; Note "Commands" menu is defined in gnus-sum.el for consistency
2694 (when (boundp 'gnus-summary-post-menu)
2695 (define-key gnus-article-mode-map [menu-bar post]
2696 (cons "Post" gnus-summary-post-menu)))
2698 (gnus-run-hooks 'gnus-article-menu-hook)))
2700 ;; Fixme: do something for the Emacs tool bar in Article mode a la
2701 ;; Summary.
2703 (defun gnus-article-mode ()
2704 "Major mode for displaying an article.
2706 All normal editing commands are switched off.
2708 The following commands are available in addition to all summary mode
2709 commands:
2718 (interactive)
2719 (when (gnus-visual-p 'article-menu 'menu)
2720 (gnus-article-make-menu-bar))
2721 (gnus-simplify-mode-line)
2722 (setq mode-name "Article")
2723 (setq major-mode 'gnus-article-mode)
2724 (make-local-variable 'minor-mode-alist)
2725 (use-local-map gnus-article-mode-map)
2726 (gnus-update-format-specifications nil 'article-mode)
2727 (set (make-local-variable 'page-delimiter) gnus-page-delimiter)
2728 (make-local-variable 'gnus-page-broken)
2729 (make-local-variable 'gnus-button-marker-list)
2730 (make-local-variable 'gnus-article-current-summary)
2731 (make-local-variable 'gnus-article-mime-handles)
2732 (make-local-variable 'gnus-article-decoded-p)
2733 (make-local-variable 'gnus-article-mime-handle-alist)
2734 (make-local-variable 'gnus-article-wash-types)
2735 (gnus-set-default-directory)
2736 (buffer-disable-undo)
2737 (setq buffer-read-only t)
2738 (set-syntax-table gnus-article-mode-syntax-table)
2739 (mm-enable-multibyte)
2740 (gnus-run-hooks 'gnus-article-mode-hook))
2742 (defun gnus-article-setup-buffer ()
2743 "Initialize the article buffer."
2744 (let* ((name (if gnus-single-article-buffer "*Article*"
2745 (concat "*Article " gnus-newsgroup-name "*")))
2746 (original
2748 (concat " *Original Article"
2749 (substring name (match-end 0))))))
2750 (setq gnus-article-buffer name)
2751 (setq gnus-original-article-buffer original)
2752 (setq gnus-article-mime-handle-alist nil)
2753 ;; This might be a variable local to the summary buffer.
2754 (unless gnus-single-article-buffer
2755 (save-excursion
2756 (set-buffer gnus-summary-buffer)
2757 (setq gnus-article-buffer name)
2758 (setq gnus-original-article-buffer original)
2759 (gnus-set-global-variables)))
2760 (gnus-article-setup-highlight-words)
2761 ;; Init original article buffer.
2762 (save-excursion
2763 (set-buffer (gnus-get-buffer-create gnus-original-article-buffer))
2764 (mm-enable-multibyte)
2765 (setq major-mode 'gnus-original-article-mode)
2766 (make-local-variable 'gnus-original-article))
2767 (if (get-buffer name)
2768 (save-excursion
2769 (set-buffer name)
2770 (when gnus-article-mime-handles
2771 (mm-destroy-parts gnus-article-mime-handles)
2772 (setq gnus-article-mime-handles nil))
2773 ;; Set it to nil in article-buffer!
2774 (setq gnus-article-mime-handle-alist nil)
2775 (buffer-disable-undo)
2776 (setq buffer-read-only t)
2777 (unless (eq major-mode 'gnus-article-mode)
2778 (gnus-article-mode))
2779 (current-buffer))
2780 (save-excursion
2781 (set-buffer (gnus-get-buffer-create name))
2782 (gnus-article-mode)
2783 (make-local-variable 'gnus-summary-buffer)
2784 (gnus-summary-set-local-parameters gnus-newsgroup-name)
2785 (current-buffer)))))
2787 ;; Set article window start at LINE, where LINE is the number of lines
2788 ;; from the head of the article.
2789 (defun gnus-article-set-window-start (&optional line)
2790 (set-window-start
2791 (get-buffer-window gnus-article-buffer t)
2792 (save-excursion
2793 (set-buffer gnus-article-buffer)
2794 (goto-char (point-min))
2795 (if (not line)
2796 (point-min)
2797 (gnus-message 6 "Moved to bookmark")
2799 (forward-line line)
2800 (point)))))
2802 (defun gnus-article-prepare (article &optional all-headers header)
2803 "Prepare ARTICLE in article mode buffer.
2804 ARTICLE should either be an article number or a Message-ID.
2805 If ARTICLE is an id, HEADER should be the article headers.
2806 If ALL-HEADERS is non-nil, no headers are hidden."
2807 (save-excursion
2808 ;; Make sure we start in a summary buffer.
2809 (unless (eq major-mode 'gnus-summary-mode)
2810 (set-buffer gnus-summary-buffer))
2811 (setq gnus-summary-buffer (current-buffer))
2812 (let* ((gnus-article (if header (mail-header-number header) article))
2813 (summary-buffer (current-buffer))
2814 (gnus-tmp-internal-hook gnus-article-internal-prepare-hook)
2815 (group gnus-newsgroup-name)
2816 result)
2817 (save-excursion
2818 (gnus-article-setup-buffer)
2819 (set-buffer gnus-article-buffer)
2820 ;; Deactivate active regions.
2821 (when (and (boundp 'transient-mark-mode)
2822 transient-mark-mode)
2823 (setq mark-active nil))
2824 (if (not (setq result (let ((buffer-read-only nil))
2825 (gnus-request-article-this-buffer
2826 article group))))
2827 ;; There is no such article.
2828 (save-excursion
2829 (when (and (numberp article)
2830 (not (memq article gnus-newsgroup-sparse)))
2831 (setq gnus-article-current
2832 (cons gnus-newsgroup-name article))
2833 (set-buffer gnus-summary-buffer)
2834 (setq gnus-current-article article)
2835 (if (eq (gnus-article-mark article) gnus-undownloaded-mark)
2836 (progn
2837 (gnus-summary-set-agent-mark article)
2838 (message "Message marked for downloading"))
2839 (gnus-summary-mark-article article gnus-canceled-mark)
2840 (unless (memq article gnus-newsgroup-sparse)
2841 (gnus-error 1 "No such article (may have expired or been canceled)")))))
2842 (if (or (eq result 'pseudo)
2843 (eq result 'nneething))
2844 (progn
2845 (save-excursion
2846 (set-buffer summary-buffer)
2847 (push article gnus-newsgroup-history)
2848 (setq gnus-last-article gnus-current-article
2849 gnus-current-article 0
2850 gnus-current-headers nil
2851 gnus-article-current nil)
2852 (if (eq result 'nneething)
2853 (gnus-configure-windows 'summary)
2854 (gnus-configure-windows 'article))
2855 (gnus-set-global-variables))
2856 (let ((gnus-article-mime-handle-alist-1
2857 gnus-article-mime-handle-alist))
2858 (gnus-set-mode-line 'article)))
2859 ;; The result from the `request' was an actual article -
2860 ;; or at least some text that is now displayed in the
2861 ;; article buffer.
2862 (when (and (numberp article)
2863 (not (eq article gnus-current-article)))
2864 ;; Seems like a new article has been selected.
2865 ;; `gnus-current-article' must be an article number.
2866 (save-excursion
2867 (set-buffer summary-buffer)
2868 (push article gnus-newsgroup-history)
2869 (setq gnus-last-article gnus-current-article
2870 gnus-current-article article
2871 gnus-current-headers
2872 (gnus-summary-article-header gnus-current-article)
2873 gnus-article-current
2874 (cons gnus-newsgroup-name gnus-current-article))
2875 (unless (vectorp gnus-current-headers)
2876 (setq gnus-current-headers nil))
2877 (gnus-summary-goto-subject gnus-current-article)
2878 (when (gnus-summary-show-thread)
2879 ;; If the summary buffer really was folded, the
2880 ;; previous goto may not actually have gone to
2881 ;; the right article, but the thread root instead.
2882 ;; So we go again.
2883 (gnus-summary-goto-subject gnus-current-article))
2884 (gnus-run-hooks 'gnus-mark-article-hook)
2885 (gnus-set-mode-line 'summary)
2886 (when (gnus-visual-p 'article-highlight 'highlight)
2887 (gnus-run-hooks 'gnus-visual-mark-article-hook))
2888 ;; Set the global newsgroup variables here.
2889 (gnus-set-global-variables)
2890 (setq gnus-have-all-headers
2891 (or all-headers gnus-show-all-headers))))
2892 (save-excursion
2893 (gnus-configure-windows 'article))
2894 (when (or (numberp article)
2895 (stringp article))
2896 (gnus-article-prepare-display)
2897 ;; Do page break.
2898 (goto-char (point-min))
2899 (setq gnus-page-broken
2900 (when gnus-break-pages
2901 (gnus-narrow-to-page)
2902 t)))
2903 (let ((gnus-article-mime-handle-alist-1
2904 gnus-article-mime-handle-alist))
2905 (gnus-set-mode-line 'article))
2906 (article-goto-body)
2907 (set-window-point (get-buffer-window (current-buffer)) (point))
2908 (gnus-configure-windows 'article)
2909 t))))))
2911 ;;;###autoload
2912 (defun gnus-article-prepare-display ()
2913 "Make the current buffer look like a nice article."
2914 ;; Hooks for getting information from the article.
2915 ;; This hook must be called before being narrowed.
2916 (let ((gnus-article-buffer (current-buffer))
2917 buffer-read-only)
2918 (unless (eq major-mode 'gnus-article-mode)
2919 (gnus-article-mode))
2920 (setq buffer-read-only nil
2921 gnus-article-wash-types nil)
2922 (gnus-run-hooks 'gnus-tmp-internal-hook)
2923 (when gnus-display-mime-function
2924 (funcall gnus-display-mime-function))
2925 (gnus-run-hooks 'gnus-article-prepare-hook)))
2927 ;;;
2928 ;;; Gnus MIME viewing functions
2929 ;;;
2932 "The following specs can be used:
2933 %t The MIME type
2934 %T MIME type, along with additional info
2935 %n The `name' parameter
2936 %d The description, if any
2937 %l The length of the encoded part
2938 %p The part identifier number
2939 %e Dots if the part isn't displayed")
2941 (defvar gnus-mime-button-line-format-alist
2942 '((?t gnus-tmp-type ?s)
2943 (?T gnus-tmp-type-long ?s)
2944 (?n gnus-tmp-name ?s)
2945 (?d gnus-tmp-description ?s)
2946 (?p gnus-tmp-id ?s)
2947 (?l gnus-tmp-length ?d)
2948 (?e gnus-tmp-dots ?s)))
2950 (defvar gnus-mime-button-commands
2952 (gnus-mime-view-part "v" "View Interactively...")
2953 (gnus-mime-view-part-as-type "t" "View As Type...")
2954 (gnus-mime-save-part "o" "Save...")
2955 (gnus-mime-copy-part "c" "View As Text, In Other Buffer")
2956 (gnus-mime-inline-part "i" "View As Text, In This Buffer")
2957 (gnus-mime-internalize-part "E" "View Internally")
2958 (gnus-mime-externalize-part "e" "View Externally")
2959 (gnus-mime-pipe-part "|" "Pipe To Command...")
2960 (gnus-mime-action-on-part "." "Take action on the part")))
2962 (defun gnus-article-mime-part-status ()
2963 (if gnus-article-mime-handle-alist-1
2964 (format " (%d parts)" (length gnus-article-mime-handle-alist-1))
2965 ""))
2967 (defvar gnus-mime-button-map
2968 (let ((map (make-sparse-keymap)))
2969 ;; Not for Emacs 21: fixme better.
2970 ;; (set-keymap-parent map gnus-article-mode-map)
2971 (define-key map gnus-mouse-2 'gnus-article-push-button)
2972 (define-key map gnus-down-mouse-3 'gnus-mime-button-menu)
2973 (dolist (c gnus-mime-button-commands)
2974 (define-key map (cadr c) (car c)))
2975 map))
2977 (defun gnus-mime-button-menu (event)
2978 "Construct a context-sensitive menu of MIME commands."
2979 (interactive "e")
2980 (save-excursion
2981 (mouse-set-point event)
2982 (gnus-article-check-buffer)
2983 (let ((response (x-popup-menu
2984 t `("MIME Part"
2985 ("" ,@(mapcar (lambda (c)
2986 (cons (caddr c) (car c)))
2987 gnus-mime-button-commands))))))
2988 (if response
2989 (call-interactively response)))))
2991 (defun gnus-mime-view-all-parts (&optional handles)
2992 "View all the MIME parts."
2993 (interactive)
2994 (save-current-buffer
2995 (set-buffer gnus-article-buffer)
2996 (let ((handles (or handles gnus-article-mime-handles))
2997 (mail-parse-charset gnus-newsgroup-charset)
2998 (mail-parse-ignored-charsets
2999 (save-excursion (set-buffer gnus-summary-buffer)
3000 gnus-newsgroup-ignored-charsets)))
3001 (if (stringp (car handles))
3002 (gnus-mime-view-all-parts (cdr handles))
3003 (mapcar 'mm-display-part handles)))))
3005 (defun gnus-mime-save-part ()
3006 "Save the MIME part under point."
3007 (interactive)
3008 (gnus-article-check-buffer)
3009 (let ((data (get-text-property (point) 'gnus-data)))
3010 (mm-save-part data)))
3012 (defun gnus-mime-pipe-part ()
3013 "Pipe the MIME part under point to a process."
3014 (interactive)
3015 (gnus-article-check-buffer)
3016 (let ((data (get-text-property (point) 'gnus-data)))
3017 (mm-pipe-part data)))
3019 (defun gnus-mime-view-part ()
3020 "Interactively choose a viewing method for the MIME part under point."
3021 (interactive)
3022 (gnus-article-check-buffer)
3023 (let ((data (get-text-property (point) 'gnus-data)))
3024 (push (setq data (copy-sequence data)) gnus-article-mime-handles)
3025 (mm-interactively-view-part data)))
3027 (defun gnus-mime-view-part-as-type-internal ()
3028 (gnus-article-check-buffer)
3029 (let* ((name (mail-content-type-get
3030 (mm-handle-type (get-text-property (point) 'gnus-data))
3031 'name))
3032 (def-type (and name (mm-default-file-encoding name))))
3033 (and def-type (cons def-type 0))))
3035 (defun gnus-mime-view-part-as-type (mime-type)
3036 "Choose a MIME media type, and view the part as such."
3037 (interactive
3038 (list (completing-read
3039 "View as MIME type: "
3040 (mapcar #'list (mailcap-mime-types))
3041 nil nil
3042 (gnus-mime-view-part-as-type-internal))))
3043 (gnus-article-check-buffer)
3044 (let ((handle (get-text-property (point) 'gnus-data)))
3045 (gnus-mm-display-part
3046 (mm-make-handle (mm-handle-buffer handle)
3047 (cons mime-type (cdr (mm-handle-type handle)))
3048 (mm-handle-encoding handle)
3049 (mm-handle-undisplayer handle)
3050 (mm-handle-disposition handle)
3051 (mm-handle-description handle)
3052 (mm-handle-cache handle)
3053 (mm-handle-id handle)))))
3055 (defun gnus-mime-copy-part (&optional handle)
3056 "Put the the MIME part under point into a new buffer."
3057 (interactive)
3058 (gnus-article-check-buffer)
3059 (let* ((handle (or handle (get-text-property (point) 'gnus-data)))
3060 (contents (mm-get-part handle))
3061 (base (file-name-nondirectory
3062 (or
3063 (mail-content-type-get (mm-handle-type handle) 'name)
3064 (mail-content-type-get (mm-handle-type handle)
3065 'filename)
3066 "*decoded*")))
3067 (buffer (generate-new-buffer base)))
3068 (switch-to-buffer buffer)
3069 (insert contents)
3070 ;; We do it this way to make `normal-mode' set the appropriate mode.
3071 (unwind-protect
3072 (progn
3073 (setq buffer-file-name (expand-file-name base))
3074 (normal-mode))
3075 (setq buffer-file-name nil))
3076 (goto-char (point-min))))
3078 (defun gnus-mime-inline-part (&optional handle arg)
3079 "Insert the MIME part under point into the current buffer."
3080 (interactive (list nil current-prefix-arg))
3081 (gnus-article-check-buffer)
3082 (let* ((handle (or handle (get-text-property (point) 'gnus-data)))
3083 contents charset
3084 (b (point))
3085 buffer-read-only)
3086 (if (mm-handle-undisplayer handle)
3087 (mm-remove-part handle)
3088 (setq contents (mm-get-part handle))
3089 (cond
3090 ((not arg)
3091 (setq charset (or (mail-content-type-get
3092 (mm-handle-type handle) 'charset)
3093 gnus-newsgroup-charset)))
3094 ((numberp arg)
3095 (setq charset
3096 (or (cdr (assq arg
3097 gnus-summary-show-article-charset-alist))
3098 (read-coding-system "Charset: ")))))
3099 (forward-line 2)
3100 (mm-insert-inline handle
3101 (if (and charset
3102 (setq charset (mm-charset-to-coding-system
3103 charset))
3104 (not (eq charset 'ascii)))
3105 (mm-decode-coding-string contents charset)
3106 contents))
3107 (goto-char b))))
3109 (defun gnus-mime-externalize-part (&optional handle)
3110 "View the MIME part under point with an external viewer."
3111 (interactive)
3112 (gnus-article-check-buffer)
3113 (let* ((handle (or handle (get-text-property (point) 'gnus-data)))
3114 (mm-user-display-methods nil)
3115 (mm-inlined-types nil)
3116 (mail-parse-charset gnus-newsgroup-charset)
3117 (mail-parse-ignored-charsets
3118 (save-excursion (set-buffer gnus-summary-buffer)
3119 gnus-newsgroup-ignored-charsets)))
3120 (if (mm-handle-undisplayer handle)
3121 (mm-remove-part handle)
3122 (mm-display-part handle))))
3124 (defun gnus-mime-internalize-part (&optional handle)
3125 "View the MIME part under point with an internal viewer.
3126 In no internal viewer is available, use an external viewer."
3127 (interactive)
3128 (gnus-article-check-buffer)
3129 (let* ((handle (or handle (get-text-property (point) 'gnus-data)))
3130 (mm-inlined-types '(".*"))
3131 (mm-inline-large-images t)
3132 (mail-parse-charset gnus-newsgroup-charset)
3133 (mail-parse-ignored-charsets
3134 (save-excursion (set-buffer gnus-summary-buffer)
3135 gnus-newsgroup-ignored-charsets)))
3136 (if (mm-handle-undisplayer handle)
3137 (mm-remove-part handle)
3138 (mm-display-part handle))))
3140 (defun gnus-mime-action-on-part (&optional action)
3141 "Do something with the MIME attachment at \(point\)."
3142 (interactive
3143 (list (completing-read "Action: " gnus-mime-action-alist)))
3144 (gnus-article-check-buffer)
3145 (let ((action-pair (assoc action gnus-mime-action-alist)))
3146 (if action-pair
3147 (funcall (cdr action-pair)))))
3150 (defun gnus-article-part-wrapper (n function)
3151 (save-current-buffer
3152 (set-buffer gnus-article-buffer)
3153 (when (> n (length gnus-article-mime-handle-alist))
3154 (error "No such part"))
3155 (gnus-article-goto-part n)
3156 (let ((handle (cdr (assq n gnus-article-mime-handle-alist))))
3157 (funcall function handle))))
3159 (defun gnus-article-pipe-part (n)
3160 "Pipe MIME part N, which is the numerical prefix."
3161 (interactive "p")
3162 (gnus-article-part-wrapper n 'mm-pipe-part))
3164 (defun gnus-article-save-part (n)
3165 "Save MIME part N, which is the numerical prefix."
3166 (interactive "p")
3167 (gnus-article-part-wrapper n 'mm-save-part))
3169 (defun gnus-article-interactively-view-part (n)
3170 "View MIME part N interactively, which is the numerical prefix."
3171 (interactive "p")
3172 (gnus-article-part-wrapper n 'mm-interactively-view-part))
3174 (defun gnus-article-copy-part (n)
3175 "Copy MIME part N, which is the numerical prefix."
3176 (interactive "p")
3177 (gnus-article-part-wrapper n 'gnus-mime-copy-part))
3179 (defun gnus-article-externalize-part (n)
3180 "View MIME part N externally, which is the numerical prefix."
3181 (interactive "p")
3182 (gnus-article-part-wrapper n 'gnus-mime-externalize-part))
3184 (defun gnus-article-inline-part (n)
3185 "Inline MIME part N, which is the numerical prefix."
3186 (interactive "p")
3187 (gnus-article-part-wrapper n 'gnus-mime-inline-part))
3189 (defun gnus-article-mime-match-handle-first (condition)
3190 (if condition
3191 (let ((alist gnus-article-mime-handle-alist) ihandle n)
3192 (while (setq ihandle (pop alist))
3193 (if (and (cond
3194 ((functionp condition)
3195 (funcall condition (cdr ihandle)))
3196 ((eq condition 'undisplayed)
3197 (not (or (mm-handle-undisplayer (cdr ihandle))
3198 (equal (mm-handle-media-type (cdr ihandle))
3199 "multipart/alternative"))))
3200 ((eq condition 'undisplayed-alternative)
3201 (not (mm-handle-undisplayer (cdr ihandle))))
3202 (t t))
3203 (gnus-article-goto-part (car ihandle))
3204 (or (not n) (< (car ihandle) n)))
3205 (setq n (car ihandle))))
3206 (or n 1))
3207 1))
3209 (defun gnus-article-view-part (&optional n)
3210 "View MIME part N, which is the numerical prefix."
3211 (interactive "P")
3212 (save-current-buffer
3213 (set-buffer gnus-article-buffer)
3214 (or (numberp n) (setq n (gnus-article-mime-match-handle-first
3215 gnus-article-mime-match-handle-function)))
3216 (when (> n (length gnus-article-mime-handle-alist))
3217 (error "No such part"))
3218 (let ((handle (cdr (assq n gnus-article-mime-handle-alist))))
3219 (when (gnus-article-goto-part n)
3220 (if (equal (car handle) "multipart/alternative")
3221 (gnus-article-press-button)
3222 (when (eq (gnus-mm-display-part handle) 'internal)
3223 (gnus-set-window-start)))))))
3225 (defsubst gnus-article-mime-total-parts ()
3226 (if (bufferp (car gnus-article-mime-handles))
3227 1 ;; single part
3228 (1- (length gnus-article-mime-handles))))
3230 (defun gnus-mm-display-part (handle)
3231 "Display HANDLE and fix MIME button."
3232 (let ((id (get-text-property (point) 'gnus-part))
3233 (point (point))
3234 buffer-read-only)
3235 (forward-line 1)
3236 (prog1
3237 (let ((window (selected-window))
3238 (mail-parse-charset gnus-newsgroup-charset)
3239 (mail-parse-ignored-charsets
3240 (save-excursion (set-buffer gnus-summary-buffer)
3241 gnus-newsgroup-ignored-charsets)))
3242 (save-excursion
3243 (unwind-protect
3244 (let ((win (get-buffer-window (current-buffer) t))
3245 (beg (point)))
3246 (when win
3247 (select-window win))
3248 (goto-char point)
3249 (forward-line)
3250 (if (mm-handle-displayed-p handle)
3251 ;; This will remove the part.
3252 (mm-display-part handle)
3253 (save-restriction
3254 (narrow-to-region (point) (1+ (point)))
3255 (mm-display-part handle)
3256 ;; We narrow to the part itself and
3257 ;; then call the treatment functions.
3258 (goto-char (point-min))
3259 (forward-line 1)
3260 (narrow-to-region (point) (point-max))
3261 (gnus-treat-article
3262 nil id
3263 (gnus-article-mime-total-parts)
3264 (mm-handle-media-type handle)))))
3265 (select-window window))))
3266 (goto-char point)
3267 (delete-region (gnus-point-at-bol) (progn (forward-line 1) (point)))
3268 (gnus-insert-mime-button
3269 handle id (list (mm-handle-displayed-p handle)))
3270 (goto-char point))))
3272 (defun gnus-article-goto-part (n)
3273 "Go to MIME part N."
3274 (let ((point (text-property-any (point-min) (point-max) 'gnus-part n)))
3275 (when point
3276 (goto-char point))))
3278 (defun gnus-insert-mime-button (handle gnus-tmp-id &optional displayed)
3279 (let ((gnus-tmp-name
3280 (or (mail-content-type-get (mm-handle-type handle)
3281 'name)
3282 (mail-content-type-get (mm-handle-disposition handle)
3283 'filename)
3284 ""))
3285 (gnus-tmp-type (mm-handle-media-type handle))
3286 (gnus-tmp-description
3287 (mail-decode-encoded-word-string (or (mm-handle-description handle)
3288 "")))
3289 (gnus-tmp-dots
3290 (if (if displayed (car displayed)
3291 (mm-handle-displayed-p handle))
3292 "" "..."))
3293 (gnus-tmp-length (with-current-buffer (mm-handle-buffer handle)
3294 (buffer-size)))
3295 gnus-tmp-type-long b e)
3296 (when (string-match ".*/" gnus-tmp-name)
3297 (setq gnus-tmp-name (replace-match "" t t gnus-tmp-name)))
3298 (setq gnus-tmp-type-long (concat gnus-tmp-type
3299 (and (not (equal gnus-tmp-name ""))
3300 (concat "; " gnus-tmp-name))))
3301 (or (equal gnus-tmp-description "")
3302 (setq gnus-tmp-type-long (concat " --- " gnus-tmp-type-long)))
3303 (unless (bolp)
3305 (setq b (point))
3306 (gnus-eval-format
3307 gnus-mime-button-line-format gnus-mime-button-line-format-alist
3308 `(keymap ,gnus-mime-button-map
3309 ;; Not for Emacs 21: fixme better.
3310 ;; local-map ,gnus-mime-button-map
3311 gnus-callback gnus-mm-display-part
3312 gnus-part ,gnus-tmp-id
3313 article-type annotation
3314 gnus-data ,handle))
3315 (setq e (point))
3316 (widget-convert-button
3317 'link b e
3318 :mime-handle handle
3319 :action 'gnus-widget-press-button
3320 :button-keymap gnus-mime-button-map
3321 :help-echo
3322 (lambda (widget/window &optional overlay pos)
3323 ;; Needed to properly clear the message due to a bug in
3324 ;; wid-edit (XEmacs only).
3325 (if (boundp 'help-echo-owns-message)
3326 (setq help-echo-owns-message t))
3327 (format
3328 "%S: %s the MIME part; %S: more options"
3329 (aref gnus-mouse-2 0)
3330 ;; XEmacs will get a single widget arg; Emacs 21 will get
3331 ;; window, overlay, position.
3332 (if (mm-handle-displayed-p
3333 (if overlay
3334 (with-current-buffer (gnus-overlay-buffer overlay)
3335 (widget-get (widget-at (gnus-overlay-start overlay))
3336 :mime-handle))
3337 (widget-get widget/window :mime-handle)))
3338 "hide" "show")
3339 (aref gnus-down-mouse-3 0))))))
3341 (defun gnus-widget-press-button (elems el)
3342 (goto-char (widget-get elems :from))
3343 (gnus-article-press-button))
3345 (defvar gnus-displaying-mime nil)
3347 (defun gnus-display-mime (&optional ihandles)
3348 "Display the MIME parts."
3349 (save-excursion
3350 (save-selected-window
3351 (let ((window (get-buffer-window gnus-article-buffer))
3352 (point (point)))
3353 (when window
3354 (select-window window)
3355 ;; We have to do this since selecting the window
3356 ;; may change the point. So we set the window point.
3357 (set-window-point window point)))
3358 (let* ((handles (or ihandles (mm-dissect-buffer) (mm-uu-dissect)))
3359 buffer-read-only handle name type b e display)
3360 (when (and (not ihandles)
3361 (not gnus-displaying-mime))
3362 ;; Top-level call; we clean up.
3363 (when gnus-article-mime-handles
3364 (mm-destroy-parts gnus-article-mime-handles)
3365 (setq gnus-article-mime-handle-alist nil));; A trick.
3366 (setq gnus-article-mime-handles handles)
3367 ;; We allow users to glean info from the handles.
3368 (when gnus-article-mime-part-function
3369 (gnus-mime-part-function handles)))
3370 (if (and handles
3371 (or (not (stringp (car handles)))
3372 (cdr handles)))
3373 (progn
3374 (when (and (not ihandles)
3375 (not gnus-displaying-mime))
3376 ;; Clean up for mime parts.
3377 (article-goto-body)
3378 (delete-region (point) (point-max)))
3379 (let ((gnus-displaying-mime t))
3380 (gnus-mime-display-part handles)))
3381 (save-restriction
3382 (article-goto-body)
3383 (narrow-to-region (point) (point-max))
3384 (gnus-treat-article nil 1 1)
3385 (widen)))
3386 (unless ihandles
3387 ;; Highlight the headers.
3388 (save-excursion
3389 (save-restriction
3390 (article-goto-body)
3391 (narrow-to-region (point-min) (point))
3392 (gnus-treat-article 'head))))))))
3394 (defvar gnus-mime-display-multipart-as-mixed nil)
3396 (defun gnus-mime-display-part (handle)
3397 (cond
3398 ;; Single part.
3399 ((not (stringp (car handle)))
3400 (gnus-mime-display-single handle))
3401 ;; User-defined multipart
3402 ((cdr (assoc (car handle) gnus-mime-multipart-functions))
3403 (funcall (cdr (assoc (car handle) gnus-mime-multipart-functions))
3404 handle))
3405 ;; multipart/alternative
3406 ((and (equal (car handle) "multipart/alternative")
3407 (not gnus-mime-display-multipart-as-mixed))
3408 (let ((id (1+ (length gnus-article-mime-handle-alist))))
3409 (push (cons id handle) gnus-article-mime-handle-alist)
3410 (gnus-mime-display-alternative (cdr handle) nil nil id)))
3411 ;; multipart/related
3412 ((and (equal (car handle) "multipart/related")
3413 (not gnus-mime-display-multipart-as-mixed))
3414 ;;;!!!We should find the start part, but we just default
3415 ;;;!!!to the first part.
3416 (gnus-mime-display-part (cadr handle)))
3417 ;; Other multiparts are handled like multipart/mixed.
3418 (t
3419 (gnus-mime-display-mixed (cdr handle)))))
3421 (defun gnus-mime-part-function (handles)
3422 (if (stringp (car handles))
3423 (mapcar 'gnus-mime-part-function (cdr handles))
3424 (funcall gnus-article-mime-part-function handles)))
3426 (defun gnus-mime-display-mixed (handles)
3427 (mapcar 'gnus-mime-display-part handles))
3429 (defun gnus-mime-display-single (handle)
3430 (let ((type (mm-handle-media-type handle))
3431 (ignored gnus-ignored-mime-types)
3432 (not-attachment t)
3433 (move nil)
3434 display text)
3435 (catch 'ignored
3436 (progn
3437 (while ignored
3438 (when (string-match (pop ignored) type)
3439 (throw 'ignored nil)))
3440 (if (and (setq not-attachment
3441 (and (not (mm-inline-override-p handle))
3442 (or (not (mm-handle-disposition handle))
3443 (equal (car (mm-handle-disposition handle))
3444 "inline")
3445 (mm-attachment-override-p handle))))
3446 (mm-automatic-display-p handle)
3447 (or (mm-inlined-p handle)
3448 (mm-automatic-external-display-p type)))
3449 (setq display t)
3450 (when (equal (mm-handle-media-supertype handle) "text")
3451 (setq text t)))
3452 (let ((id (1+ (length gnus-article-mime-handle-alist)))
3453 beg)
3454 (push (cons id handle) gnus-article-mime-handle-alist)
3455 (when (or (not display)
3456 (not (gnus-unbuttonized-mime-type-p type)))
3457 ;(gnus-article-insert-newline)
3458 (gnus-insert-mime-button
3459 handle id (list (or display (and not-attachment text))))
3460 (gnus-article-insert-newline)
3461 ;(gnus-article-insert-newline)
3462 (setq move t))
3463 (setq beg (point))
3464 (cond
3465 (display
3466 (when move
3467 (forward-line -2)
3468 (setq beg (point)))
3469 (let ((mail-parse-charset gnus-newsgroup-charset)
3470 (mail-parse-ignored-charsets
3471 (save-excursion (condition-case ()
3472 (set-buffer gnus-summary-buffer)
3473 (error))
3474 gnus-newsgroup-ignored-charsets)))
3475 (mm-display-part handle t))
3476 (goto-char (point-max)))
3477 ((and text not-attachment)
3478 (when move
3479 (forward-line -2)
3480 (setq beg (point)))
3481 (gnus-article-insert-newline)
3482 (mm-insert-inline handle (mm-get-part handle))
3483 (goto-char (point-max))))
3484 ;; Do highlighting.
3485 (save-excursion
3486 (save-restriction
3487 (narrow-to-region beg (point))
3488 (gnus-treat-article
3489 nil id
3490 (gnus-article-mime-total-parts)
3491 (mm-handle-media-type handle)))))))))
3493 (defun gnus-unbuttonized-mime-type-p (type)
3494 "Say whether TYPE is to be unbuttonized."
3495 (unless gnus-inhibit-mime-unbuttonizing
3496 (catch 'found
3497 (let ((types gnus-unbuttonized-mime-types))
3498 (while types
3499 (when (string-match (pop types) type)
3500 (throw 'found t)))))))
3502 (defun gnus-article-insert-newline ()
3503 "Insert a newline, but mark it as undeletable."
3504 (gnus-put-text-property
3507 (defun gnus-mime-display-alternative (handles &optional preferred ibegend id)
3508 (let* ((preferred (or preferred (mm-preferred-alternative handles)))
3509 (ihandles handles)
3510 (point (point))
3511 handle buffer-read-only from props begend not-pref)
3512 (save-window-excursion
3513 (save-restriction
3514 (when ibegend
3515 (narrow-to-region (car ibegend)
3516 (or (cdr ibegend)
3517 (progn
3518 (goto-char (car ibegend))
3519 (forward-line 2)
3520 (point))))
3521 (delete-region (point-min) (point-max))
3522 (mm-remove-parts handles))
3523 (setq begend (list (point-marker)))
3524 ;; Do the toggle.
3525 (unless (setq not-pref (cadr (member preferred ihandles)))
3526 (setq not-pref (car ihandles)))
3527 (when (or ibegend
3528 (not (gnus-unbuttonized-mime-type-p
3529 "multipart/alternative")))
3530 (gnus-add-text-properties
3531 (setq from (point))
3532 (progn
3533 (insert (format "%d. " id))
3534 (point))
3535 `(gnus-callback
3536 (lambda (handles)
3537 (unless ,(not ibegend)
3538 (setq gnus-article-mime-handle-alist
3539 ',gnus-article-mime-handle-alist))
3540 (gnus-mime-display-alternative
3541 ',ihandles ',not-pref ',begend ,id))
3542 ;; Not for Emacs 21: fixme better.
3543 ;; local-map ,gnus-mime-button-map
3544 ,gnus-mouse-face-prop ,gnus-article-mouse-face
3545 face ,gnus-article-button-face
3546 keymap ,gnus-mime-button-map
3547 gnus-part ,id
3548 gnus-data ,handle))
3549 (widget-convert-button 'link from (point)
3550 :action 'gnus-widget-press-button
3551 :button-keymap gnus-widget-button-keymap)
3552 ;; Do the handles
3553 (while (setq handle (pop handles))
3554 (gnus-add-text-properties
3555 (setq from (point))
3556 (progn
3557 (insert (format "(%c) %-18s"
3558 (if (equal handle preferred) ?* ? )
3559 (mm-handle-media-type handle)))
3560 (point))
3561 `(gnus-callback
3562 (lambda (handles)
3563 (unless ,(not ibegend)
3564 (setq gnus-article-mime-handle-alist
3565 ',gnus-article-mime-handle-alist))
3566 (gnus-mime-display-alternative
3567 ',ihandles ',handle ',begend ,id))
3568 ;; Not for Emacs 21: fixme better.
3569 ;; local-map ,gnus-mime-button-map
3570 ,gnus-mouse-face-prop ,gnus-article-mouse-face
3571 face ,gnus-article-button-face
3572 keymap ,gnus-mime-button-map
3573 gnus-part ,id
3574 gnus-data ,handle))
3575 (widget-convert-button 'link from (point)
3576 :action 'gnus-widget-press-button
3577 :button-keymap gnus-widget-button-keymap)
3578 (insert " "))
3580 (when preferred
3581 (if (stringp (car preferred))
3582 (gnus-display-mime preferred)
3583 (let ((mail-parse-charset gnus-newsgroup-charset)
3584 (mail-parse-ignored-charsets
3585 (save-excursion (set-buffer gnus-summary-buffer)
3586 gnus-newsgroup-ignored-charsets)))
3587 (mm-display-part preferred)
3588 ;; Do highlighting.
3589 (save-excursion
3590 (save-restriction
3591 (narrow-to-region (car begend) (point-max))
3592 (gnus-treat-article
3593 nil (length gnus-article-mime-handle-alist)
3594 (gnus-article-mime-total-parts)
3595 (mm-handle-media-type handle))))))
3596 (goto-char (point-max))
3597 (setcdr begend (point-marker)))))
3598 (when ibegend
3599 (goto-char point))))
3601 (defun gnus-article-wash-status ()
3602 "Return a string which display status of article washing."
3603 (save-excursion
3604 (set-buffer gnus-article-buffer)
3605 (let ((cite (memq 'cite gnus-article-wash-types))
3606 (headers (memq 'headers gnus-article-wash-types))
3607 (boring (memq 'boring-headers gnus-article-wash-types))
3608 (pgp (memq 'pgp gnus-article-wash-types))
3609 (pem (memq 'pem gnus-article-wash-types))
3610 (signature (memq 'signature gnus-article-wash-types))
3611 (overstrike (memq 'overstrike gnus-article-wash-types))
3612 (emphasis (memq 'emphasis gnus-article-wash-types)))
3613 (format "%c%c%c%c%c%c"
3614 (if cite ?c ? )
3615 (if (or headers boring) ?h ? )
3616 (if (or pgp pem) ?p ? )
3617 (if signature ?s ? )
3618 (if overstrike ?o ? )
3619 (if emphasis ?e ? )))))
3621 (defalias 'gnus-article-hide-headers-if-wanted 'gnus-article-maybe-hide-headers)
3623 (defun gnus-article-maybe-hide-headers ()
3624 "Hide unwanted headers if `gnus-have-all-headers' is nil.
3625 Provided for backwards compatibility."
3626 (when (and (or (not (gnus-buffer-live-p gnus-summary-buffer))
3627 (not (save-excursion (set-buffer gnus-summary-buffer)
3628 gnus-have-all-headers)))
3629 (not gnus-inhibit-hiding))
3630 (gnus-article-hide-headers)))
3632 ;;; Article savers.
3634 (defun gnus-output-to-file (file-name)
3635 "Append the current article to a file named FILE-NAME."
3636 (let ((artbuf (current-buffer)))
3637 (with-temp-buffer
3638 (insert-buffer-substring artbuf)
3639 ;; Append newline at end of the buffer as separator, and then
3640 ;; save it to file.
3641 (goto-char (point-max))
3643 (mm-append-to-file (point-min) (point-max) file-name)
3644 t)))
3646 (defun gnus-narrow-to-page (&optional arg)
3647 "Narrow the article buffer to a page.
3648 If given a numerical ARG, move forward ARG pages."
3649 (interactive "P")
3650 (setq arg (if arg (prefix-numeric-value arg) 0))
3651 (save-excursion
3652 (set-buffer gnus-article-buffer)
3653 (goto-char (point-min))
3654 (widen)
3655 ;; Remove any old next/prev buttons.
3656 (when (gnus-visual-p 'page-marker)
3657 (let ((buffer-read-only nil))
3658 (gnus-remove-text-with-property 'gnus-prev)
3659 (gnus-remove-text-with-property 'gnus-next)))
3660 (when
3661 (cond ((< arg 0)
3662 (re-search-backward page-delimiter nil 'move (1+ (abs arg))))
3663 ((> arg 0)
3664 (re-search-forward page-delimiter nil 'move arg)))
3665 (goto-char (match-end 0)))
3666 (narrow-to-region
3667 (point)
3668 (if (re-search-forward page-delimiter nil 'move)
3669 (match-beginning 0)
3670 (point)))
3671 (when (and (gnus-visual-p 'page-marker)
3672 (not (= (point-min) 1)))
3673 (save-excursion
3674 (goto-char (point-min))
3675 (gnus-insert-prev-page-button)))
3676 (when (and (gnus-visual-p 'page-marker)
3677 (< (+ (point-max) 2) (buffer-size)))
3678 (save-excursion
3679 (goto-char (point-max))
3680 (gnus-insert-next-page-button)))))
3682 ;; Article mode commands
3684 (defun gnus-article-goto-next-page ()
3685 "Show the next page of the article."
3686 (interactive)
3687 (when (gnus-article-next-page)
3688 (goto-char (point-min))
3689 (gnus-article-read-summary-keys nil (gnus-character-to-event ?n))))
3691 (defun gnus-article-goto-prev-page ()
3692 "Show the next page of the article."
3693 (interactive)
3694 (if (bobp) (gnus-article-read-summary-keys nil (gnus-character-to-event ?p))
3695 (gnus-article-prev-page nil)))
3697 (defun gnus-article-next-page (&optional lines)
3698 "Show the next page of the current article.
3699 If end of article, return non-nil. Otherwise return nil.
3700 Argument LINES specifies lines to be scrolled up."
3701 (interactive "p")
3702 (move-to-window-line -1)
3703 (if (save-excursion
3704 (end-of-line)
3705 (and (pos-visible-in-window-p) ;Not continuation line.
3706 (eobp)))
3707 ;; Nothing in this page.
3708 (if (or (not gnus-page-broken)
3709 (save-excursion
3710 (save-restriction
3711 (widen) (forward-line 1) (eobp)))) ;Real end-of-buffer?
3712 t ;Nothing more.
3713 (gnus-narrow-to-page 1) ;Go to next page.
3714 nil)
3715 ;; More in this page.
3716 (let ((scroll-in-place nil))
3717 (condition-case ()
3718 (scroll-up lines)
3719 (end-of-buffer
3720 ;; Long lines may cause an end-of-buffer error.
3721 (goto-char (point-max)))))
3722 (move-to-window-line 0)
3723 nil))
3725 (defun gnus-article-prev-page (&optional lines)
3726 "Show previous page of current article.
3727 Argument LINES specifies lines to be scrolled down."
3728 (interactive "p")
3729 (move-to-window-line 0)
3730 (if (and gnus-page-broken
3731 (bobp)
3732 (not (save-restriction (widen) (bobp)))) ;Real beginning-of-buffer?
3733 (progn
3734 (gnus-narrow-to-page -1) ;Go to previous page.
3735 (goto-char (point-max))
3736 (recenter -1))
3737 (let ((scroll-in-place nil))
3738 (prog1
3739 (condition-case ()
3740 (scroll-down lines)
3741 (beginning-of-buffer
3742 (goto-char (point-min))))
3743 (move-to-window-line 0)))))
3745 (defun gnus-article-refer-article ()
3746 "Read article specified by message-id around point."
3747 (interactive)
3748 (let ((point (point)))
3749 (search-forward ">" nil t) ;Move point to end of "<....>".
3751 (let ((message-id (match-string 1)))
3752 (goto-char point)
3753 (set-buffer gnus-summary-buffer)
3754 (gnus-summary-refer-article message-id))
3755 (goto-char (point))
3756 (error "No references around point"))))
3758 (defun gnus-article-show-summary ()
3759 "Reconfigure windows to show summary buffer."
3760 (interactive)
3761 (if (not (gnus-buffer-live-p gnus-summary-buffer))
3762 (error "There is no summary buffer for this article buffer")
3763 (gnus-article-set-globals)
3764 (gnus-configure-windows 'article)
3765 (gnus-summary-goto-subject gnus-current-article)
3766 (gnus-summary-position-point)))
3768 (defun gnus-article-describe-briefly ()
3769 "Describe article mode commands briefly."
3770 (interactive)
3771 (gnus-message 6 (substitute-command-keys "\\<gnus-article-mode-map>\\[gnus-article-goto-next-page]:Next page \\[gnus-article-goto-prev-page]:Prev page \\[gnus-article-show-summary]:Show summary \\[gnus-info-find-node]:Run Info \\[gnus-article-describe-briefly]:This help")))
3773 (defun gnus-article-summary-command ()
3774 "Execute the last keystroke in the summary buffer."
3775 (interactive)
3776 (let ((obuf (current-buffer))
3777 (owin (current-window-configuration))
3778 func)
3779 (switch-to-buffer gnus-article-current-summary 'norecord)
3780 (setq func (lookup-key (current-local-map) (this-command-keys)))
3781 (call-interactively func)
3782 (set-buffer obuf)
3783 (set-window-configuration owin)
3784 (set-window-point (get-buffer-window (current-buffer)) (point))))
3786 (defun gnus-article-summary-command-nosave ()
3787 "Execute the last keystroke in the summary buffer."
3788 (interactive)
3789 (let (func)
3790 (pop-to-buffer gnus-article-current-summary 'norecord)
3791 (setq func (lookup-key (current-local-map) (this-command-keys)))
3792 (call-interactively func)))
3794 (defun gnus-article-check-buffer ()
3795 "Beep if not in an article buffer."
3796 (unless (equal major-mode 'gnus-article-mode)
3797 (error "Command invoked outside of a Gnus article buffer")))
3799 (defun gnus-article-read-summary-keys (&optional arg key not-restore-window)
3800 "Read a summary buffer key sequence and execute it from the article buffer."
3801 (interactive "P")
3802 (gnus-article-check-buffer)
3803 (let ((nosaves
3804 '("q" "Q" "c" "r" "R" "\C-c\C-f" "m" "a" "f" "F"
3805 "Zc" "ZC" "ZE" "ZQ" "ZZ" "Zn" "ZR" "ZG" "ZN" "ZP"
3806 "=" "^" "\M-^" "|"))
3807 (nosave-but-article
3809 (nosave-in-article
3810 '("\C-d"))
3811 (up-to-top
3812 '("n" "Gn" "p" "Gp"))
3813 keys new-sum-point)
3814 (save-excursion
3815 (set-buffer gnus-article-current-summary)
3816 (let (gnus-pick-mode)
3817 (push (or key last-command-event) unread-command-events)
3818 (setq keys (if (featurep 'xemacs)
3819 (events-to-keys (read-key-sequence nil))
3820 (read-key-sequence nil)))))
3822 (message "")
3824 (if (or (member keys nosaves)
3825 (member keys nosave-but-article)
3826 (member keys nosave-in-article))
3827 (let (func)
3828 (save-window-excursion
3829 (pop-to-buffer gnus-article-current-summary 'norecord)
3830 ;; We disable the pick minor mode commands.
3831 (let (gnus-pick-mode)
3832 (setq func (lookup-key (current-local-map) keys))))
3833 (if (or (not func)
3834 (numberp func))
3835 (ding)
3836 (unless (member keys nosave-in-article)
3837 (set-buffer gnus-article-current-summary))
3838 (call-interactively func)
3839 (setq new-sum-point (point)))
3840 (when (member keys nosave-but-article)
3841 (pop-to-buffer gnus-article-buffer 'norecord)))
3842 ;; These commands should restore window configuration.
3843 (let ((obuf (current-buffer))
3844 (owin (current-window-configuration))
3845 (opoint (point))
3846 (summary gnus-article-current-summary)
3847 func in-buffer selected)
3848 (if not-restore-window
3849 (pop-to-buffer summary 'norecord)
3850 (switch-to-buffer summary 'norecord))
3851 (setq in-buffer (current-buffer))
3852 ;; We disable the pick minor mode commands.
3853 (if (and (setq func (let (gnus-pick-mode)
3854 (lookup-key (current-local-map) keys)))
3855 (functionp func))
3856 (progn
3857 (call-interactively func)
3858 (setq new-sum-point (point))
3859 (when (eq in-buffer (current-buffer))
3860 (setq selected (gnus-summary-select-article))
3861 (set-buffer obuf)
3862 (unless not-restore-window
3863 (set-window-configuration owin))
3864 (when (eq selected 'old)
3865 (article-goto-body)
3866 (set-window-start (get-buffer-window (current-buffer))
3867 1)
3868 (set-window-point (get-buffer-window (current-buffer))
3869 (point)))
3870 (let ((win (get-buffer-window gnus-article-current-summary)))
3871 (when win
3872 (set-window-point win new-sum-point)))) )
3873 (switch-to-buffer gnus-article-buffer)
3874 (ding))))))
3876 (defun gnus-article-describe-key (key)
3877 "Display documentation of the function invoked by KEY. KEY is a string."
3878 (interactive "kDescribe key: ")
3879 (gnus-article-check-buffer)
3880 (if (eq (key-binding key) 'gnus-article-read-summary-keys)
3881 (save-excursion
3882 (set-buffer gnus-article-current-summary)
3883 (let (gnus-pick-mode)
3884 (push (elt key 0) unread-command-events)
3885 (setq key (if (featurep 'xemacs)
3886 (events-to-keys (read-key-sequence "Describe key: "))
3887 (read-key-sequence "Describe key: "))))
3888 (describe-key key))
3889 (describe-key key)))
3891 (defun gnus-article-describe-key-briefly (key &optional insert)
3892 "Display documentation of the function invoked by KEY. KEY is a string."
3894 (gnus-article-check-buffer)
3895 (if (eq (key-binding key) 'gnus-article-read-summary-keys)
3896 (save-excursion
3897 (set-buffer gnus-article-current-summary)
3898 (let (gnus-pick-mode)
3899 (push (elt key 0) unread-command-events)
3900 (setq key (if (featurep 'xemacs)
3901 (events-to-keys (read-key-sequence "Describe key: "))
3902 (read-key-sequence "Describe key: "))))
3903 (describe-key-briefly key insert))
3904 (describe-key-briefly key insert)))
3906 (defun gnus-article-hide (&optional arg force)
3907 "Hide all the gruft in the current article.
3908 This means that PGP stuff, signatures, cited text and (some)
3909 headers will be hidden.
3910 If given a prefix, show the hidden text instead."
3911 (interactive (append (gnus-article-hidden-arg) (list 'force)))
3912 (gnus-article-hide-headers arg)
3913 (gnus-article-hide-list-identifiers arg)
3914 (gnus-article-hide-pgp arg)
3915 (gnus-article-hide-citation-maybe arg force)
3916 (gnus-article-hide-signature arg))
3918 (defun gnus-article-maybe-highlight ()
3919 "Do some article highlighting if article highlighting is requested."
3920 (when (gnus-visual-p 'article-highlight 'highlight)
3921 (gnus-article-highlight-some)))
3923 (defun gnus-check-group-server ()
3924 ;; Make sure the connection to the server is alive.
3925 (unless (gnus-server-opened
3926 (gnus-find-method-for-group gnus-newsgroup-name))
3927 (gnus-check-server (gnus-find-method-for-group gnus-newsgroup-name))
3928 (gnus-request-group gnus-newsgroup-name t)))
3930 (defun gnus-request-article-this-buffer (article group)
3931 "Get an article and insert it into this buffer."
3932 (let (do-update-line sparse-header)
3933 (prog1
3934 (save-excursion
3935 (erase-buffer)
3936 (gnus-kill-all-overlays)
3937 (setq group (or group gnus-newsgroup-name))
3939 ;; Using `gnus-request-article' directly will insert the article into
3940 ;; `nntp-server-buffer' - so we'll save some time by not having to
3941 ;; copy it from the server buffer into the article buffer.
3943 ;; We only request an article by message-id when we do not have the
3944 ;; headers for it, so we'll have to get those.
3945 (when (stringp article)
3946 (gnus-read-header article))
3948 ;; If the article number is negative, that means that this article
3949 ;; doesn't belong in this newsgroup (possibly), so we find its
3950 ;; message-id and request it by id instead of number.
3951 (when (and (numberp article)
3952 gnus-summary-buffer
3953 (get-buffer gnus-summary-buffer)
3954 (gnus-buffer-exists-p gnus-summary-buffer))
3955 (save-excursion
3956 (set-buffer gnus-summary-buffer)
3957 (let ((header (gnus-summary-article-header article)))
3958 (when (< article 0)
3959 (cond
3960 ((memq article gnus-newsgroup-sparse)
3961 ;; This is a sparse gap article.
3962 (setq do-update-line article)
3963 (setq article (mail-header-id header))
3964 (setq sparse-header (gnus-read-header article))
3965 (setq gnus-newsgroup-sparse
3966 (delq article gnus-newsgroup-sparse)))
3967 ((vectorp header)
3968 ;; It's a real article.
3969 (setq article (mail-header-id header)))
3970 (t
3971 ;; It is an extracted pseudo-article.
3972 (setq article 'pseudo)
3973 (gnus-request-pseudo-article header))))
3975 (let ((method (gnus-find-method-for-group
3976 gnus-newsgroup-name)))
3977 (when (and (eq (car method) 'nneething)
3978 (vectorp header))
3979 (let ((dir (expand-file-name
3980 (mail-header-subject header)
3981 (file-name-as-directory
3982 (or (cadr (assq 'nneething-address method))
3983 (nth 1 method))))))
3984 (when (file-directory-p dir)
3985 (setq article 'nneething)
3986 (gnus-group-enter-directory dir))))))))
3988 (cond
3989 ;; Refuse to select canceled articles.
3990 ((and (numberp article)
3991 gnus-summary-buffer
3992 (get-buffer gnus-summary-buffer)
3993 (gnus-buffer-exists-p gnus-summary-buffer)
3994 (eq (cdr (save-excursion
3995 (set-buffer gnus-summary-buffer)
3996 (assq article gnus-newsgroup-reads)))
3997 gnus-canceled-mark))
3998 nil)
3999 ;; We first check `gnus-original-article-buffer'.
4000 ((and (get-buffer gnus-original-article-buffer)
4001 (numberp article)
4002 (save-excursion
4003 (set-buffer gnus-original-article-buffer)
4004 (and (equal (car gnus-original-article) group)
4005 (eq (cdr gnus-original-article) article))))
4006 (insert-buffer-substring gnus-original-article-buffer)
4007 'article)
4008 ;; Check the backlog.
4009 ((and gnus-keep-backlog
4010 (gnus-backlog-request-article group article (current-buffer)))
4011 'article)
4012 ;; Check asynchronous pre-fetch.
4013 ((gnus-async-request-fetched-article group article (current-buffer))
4014 (gnus-async-prefetch-next group article gnus-summary-buffer)
4015 (when (and (numberp article) gnus-keep-backlog)
4016 (gnus-backlog-enter-article group article (current-buffer)))
4017 'article)
4018 ;; Check the cache.
4019 ((and gnus-use-cache
4020 (numberp article)
4021 (gnus-cache-request-article article group))
4022 'article)
4023 ;; Get the article and put into the article buffer.
4024 ((or (stringp article)
4025 (numberp article))
4026 (let ((gnus-override-method gnus-override-method)
4027 (methods (and (stringp article)
4028 gnus-refer-article-method))
4029 result
4030 (buffer-read-only nil))
4031 (if (or (not (listp methods))
4032 (and (symbolp (car methods))
4033 (assq (car methods) nnoo-definition-alist)))
4034 (setq methods (list methods)))
4035 (when (and (null gnus-override-method)
4036 methods)
4037 (setq gnus-override-method (pop methods)))
4038 (while (not result)
4039 (when (eq gnus-override-method 'current)
4040 (setq gnus-override-method gnus-current-select-method))
4041 (erase-buffer)
4042 (gnus-kill-all-overlays)
4043 (let ((gnus-newsgroup-name group))
4044 (gnus-check-group-server))
4045 (when (gnus-request-article article group (current-buffer))
4046 (when (numberp article)
4047 (gnus-async-prefetch-next group article
4048 gnus-summary-buffer)
4049 (when gnus-keep-backlog
4050 (gnus-backlog-enter-article
4051 group article (current-buffer))))
4052 (setq result 'article))
4053 (if (not result)
4054 (if methods
4055 (setq gnus-override-method (pop methods))
4056 (setq result 'done))))
4057 (and (eq result 'article) 'article)))
4058 ;; It was a pseudo.
4059 (t article)))
4061 ;; Associate this article with the current summary buffer.
4062 (setq gnus-article-current-summary gnus-summary-buffer)
4064 ;; Take the article from the original article buffer
4065 ;; and place it in the buffer it's supposed to be in.
4066 (when (and (get-buffer gnus-article-buffer)
4067 (equal (buffer-name (current-buffer))
4068 (buffer-name (get-buffer gnus-article-buffer))))
4069 (save-excursion
4070 (if (get-buffer gnus-original-article-buffer)
4071 (set-buffer gnus-original-article-buffer)
4072 (set-buffer (gnus-get-buffer-create gnus-original-article-buffer))
4073 (buffer-disable-undo)
4074 (setq major-mode 'gnus-original-article-mode)
4075 (setq buffer-read-only t))
4076 (let (buffer-read-only)
4077 (erase-buffer)
4078 (insert-buffer-substring gnus-article-buffer))
4079 (setq gnus-original-article (cons group article)))
4081 ;; Decode charsets.
4082 (run-hooks 'gnus-article-decode-hook)
4083 ;; Mark article as decoded or not.
4084 (setq gnus-article-decoded-p gnus-article-decode-hook))
4086 ;; Update sparse articles.
4087 (when (and do-update-line
4088 (or (numberp article)
4089 (stringp article)))
4090 (let ((buf (current-buffer)))
4091 (set-buffer gnus-summary-buffer)
4092 (gnus-summary-update-article do-update-line sparse-header)
4093 (gnus-summary-goto-subject do-update-line nil t)
4094 (set-window-point (get-buffer-window (current-buffer) t)
4095 (point))
4096 (set-buffer buf))))))
4098 ;;;
4099 ;;; Article editing
4100 ;;;
4102 (defcustom gnus-article-edit-mode-hook nil
4103 "Hook run in article edit mode buffers."
4104 :group 'gnus-article-various
4105 :type 'hook)
4107 (defvar gnus-article-edit-done-function nil)
4109 (defvar gnus-article-edit-mode-map nil)
4111 ;; Should we be using derived.el for this?
4112 (unless gnus-article-edit-mode-map
4113 (setq gnus-article-edit-mode-map (make-sparse-keymap))
4114 (set-keymap-parent gnus-article-edit-mode-map text-mode-map)
4116 (gnus-define-keys gnus-article-edit-mode-map
4117 "\C-c\C-c" gnus-article-edit-done
4118 "\C-c\C-k" gnus-article-edit-exit)
4120 (gnus-define-keys (gnus-article-edit-wash-map
4121 "\C-c\C-w" gnus-article-edit-mode-map)
4122 "f" gnus-article-edit-full-stops))
4124 (defun gnus-article-edit-mode ()
4125 "Major mode for editing articles.
4126 This is an extended text-mode.
4129 (interactive)
4130 (setq major-mode 'gnus-article-edit-mode)
4131 (setq mode-name "Article Edit")
4132 (use-local-map gnus-article-edit-mode-map)
4133 (make-local-variable 'gnus-article-edit-done-function)
4134 (make-local-variable 'gnus-prev-winconf)
4135 (setq buffer-read-only nil)
4136 (buffer-enable-undo)
4137 (widen)
4138 (gnus-run-hooks 'text-mode-hook 'gnus-article-edit-mode-hook))
4140 (defun gnus-article-edit (&optional force)
4141 "Edit the current article.
4142 This will have permanent effect only in mail groups.
4143 If FORCE is non-nil, allow editing of articles even in read-only
4144 groups."
4145 (interactive "P")
4146 (when (and (not force)
4147 (gnus-group-read-only-p))
4148 (error "The current newsgroup does not support article editing"))
4149 (gnus-article-date-original)
4150 (gnus-article-edit-article
4151 'ignore
4152 `(lambda (no-highlight)
4153 'ignore
4154 (gnus-summary-edit-article-done
4155 ,(or (mail-header-references gnus-current-headers) "")
4156 ,(gnus-group-read-only-p) ,gnus-summary-buffer no-highlight))))
4158 (defun gnus-article-edit-article (start-func exit-func)
4159 "Start editing the contents of the current article buffer."
4160 (let ((winconf (current-window-configuration)))
4161 (set-buffer gnus-article-buffer)
4162 (gnus-article-edit-mode)
4163 (funcall start-func)
4164 (gnus-configure-windows 'edit-article)
4165 (setq gnus-article-edit-done-function exit-func)
4166 (setq gnus-prev-winconf winconf)
4167 (gnus-message 6 "C-c C-c to end edits")))
4169 (defun gnus-article-edit-done (&optional arg)
4170 "Update the article edits and exit."
4171 (interactive "P")
4172 (save-excursion
4173 (save-restriction
4174 (widen)
4175 (when (article-goto-body)
4176 (let ((lines (count-lines (point) (point-max)))
4177 (length (- (point-max) (point)))
4178 (case-fold-search t)
4179 (body (copy-marker (point))))
4180 (goto-char (point-min))
4182 (delete-region (match-beginning 1) (match-end 1))
4183 (insert (number-to-string length)))
4184 (goto-char (point-min))
4185 (when (re-search-forward
4187 (delete-region (match-beginning 1) (match-end 1))
4188 (insert (number-to-string length)))
4189 (goto-char (point-min))
4191 (delete-region (match-beginning 1) (match-end 1))
4192 (insert (number-to-string lines)))))))
4193 (let ((func gnus-article-edit-done-function)
4194 (buf (current-buffer))
4195 (start (window-start)))
4196 (gnus-article-edit-exit)
4197 (save-excursion
4198 (set-buffer buf)
4199 (let ((buffer-read-only nil))
4200 (funcall func arg))
4201 ;; The cache and backlog have to be flushed somewhat.
4202 (when gnus-keep-backlog
4203 (gnus-backlog-remove-article
4204 (car gnus-article-current) (cdr gnus-article-current)))
4205 ;; Flush original article as well.
4206 (save-excursion
4207 (when (get-buffer gnus-original-article-buffer)
4208 (set-buffer gnus-original-article-buffer)
4209 (setq gnus-original-article nil)))
4210 (when gnus-use-cache
4211 (gnus-cache-update-article
4212 (car gnus-article-current) (cdr gnus-article-current))))
4213 (set-buffer buf)
4214 (set-window-start (get-buffer-window buf) start)
4215 (set-window-point (get-buffer-window buf) (point))))
4217 (defun gnus-article-edit-exit ()
4218 "Exit the article editing without updating."
4219 (interactive)
4220 ;; We remove all text props from the article buffer.
4221 (let ((buf (buffer-substring-no-properties (point-min) (point-max)))
4222 (curbuf (current-buffer))
4223 (p (point))
4224 (window-start (window-start)))
4225 (erase-buffer)
4226 (insert buf)
4227 (let ((winconf gnus-prev-winconf))
4228 (gnus-article-mode)
4229 (set-window-configuration winconf)
4230 ;; Tippy-toe some to make sure that point remains where it was.
4231 (save-current-buffer
4232 (set-buffer curbuf)
4233 (set-window-start (get-buffer-window (current-buffer)) window-start)
4234 (goto-char p)))))
4236 (defun gnus-article-edit-full-stops ()
4237 "Interactively repair spacing at end of sentences."
4238 (interactive)
4239 (save-excursion
4240 (goto-char (point-min))
4241 (search-forward-regexp "^$" nil t)
4242 (let ((case-fold-search nil))
4245 ;;;
4246 ;;; Article highlights
4247 ;;;
4249 ;; Written by Per Abrahamsen <abraham@iesd.auc.dk>.
4251 ;;; Internal Variables:
4253 (defcustom gnus-button-url-regexp "\\b\\(\\(www\\.\\|\\(s?https?\\|ftp\\|file\\|gopher\\|news\\|telnet\\|wais\\|mailto\\):\\)\\(//[-a-zA-Z0-9_.]+:[0-9]*\\)?\\([-a-zA-Z0-9_=!?#$@~`%&*+|\\/:;.,]\\|\\w\\)+\\([-a-zA-Z0-9_=#$@~`%&*+|\\/]\\|\\w\\)\\)"
4254 "Regular expression that matches URLs."
4255 :group 'gnus-article-buttons
4256 :type 'regexp)
4258 (defcustom gnus-button-alist
4260 0 t gnus-button-message-id 2)
4263 1 t
4264 gnus-button-fetch-group 4)
4267 t gnus-button-message-id 3)
4271 ;; This is how URLs _should_ be embedded in text...
4273 ;; Raw URLs.
4274 (,gnus-button-url-regexp 0 t browse-url 0))
4275 "*Alist of regexps matching buttons in article bodies.
4277 Each entry has the form (REGEXP BUTTON FORM CALLBACK PAR...), where
4278 REGEXP: is the string matching text around the button,
4279 BUTTON: is the number of the regexp grouping actually matching the button,
4280 FORM: is a lisp expression which must eval to true for the button to
4281 be added,
4282 CALLBACK: is the function to call when the user push this button, and each
4283 PAR: is a number of a regexp grouping whose text will be passed to CALLBACK.
4285 CALLBACK can also be a variable, in that case the value of that
4286 variable it the real callback function."
4287 :group 'gnus-article-buttons
4288 :type '(repeat (list regexp
4289 (integer :tag "Button")
4290 (sexp :tag "Form")
4291 (function :tag "Callback")
4292 (repeat :tag "Par"
4293 :inline t
4294 (integer :tag "Regexp group")))))
4296 (defcustom gnus-header-button-alist
4298 0 t gnus-button-message-id 0)
4301 0 t gnus-button-mailto 0)
4302 ("^X-[Uu][Rr][Ll]:" ,gnus-button-url-regexp 0 t browse-url 0)
4303 ("^Subject:" ,gnus-button-url-regexp 0 t browse-url 0)
4304 ("^[^:]+:" ,gnus-button-url-regexp 0 t browse-url 0)
4306 gnus-button-message-id 3))
4307 "*Alist of headers and regexps to match buttons in article heads.
4309 This alist is very similar to `gnus-button-alist', except that each
4310 alist has an additional HEADER element first in each entry:
4312 \(HEADER REGEXP BUTTON FORM CALLBACK PAR)
4314 HEADER is a regexp to match a header. For a fuller explanation, see
4315 `gnus-button-alist'."
4316 :group 'gnus-article-buttons
4317 :group 'gnus-article-headers
4318 :type '(repeat (list (regexp :tag "Header")
4319 regexp
4320 (integer :tag "Button")
4321 (sexp :tag "Form")
4322 (function :tag "Callback")
4323 (repeat :tag "Par"
4324 :inline t
4325 (integer :tag "Regexp group")))))
4327 (defvar gnus-button-regexp nil)
4328 (defvar gnus-button-marker-list nil)
4329 ;; Regexp matching any of the regexps from `gnus-button-alist'.
4331 (defvar gnus-button-last nil)
4332 ;; The value of `gnus-button-alist' when `gnus-button-regexp' was build.
4334 ;;; Commands:
4336 (defun gnus-article-push-button (event)
4337 "Check text under the mouse pointer for a callback function.
4338 If the text under the mouse pointer has a `gnus-callback' property,
4339 call it with the value of the `gnus-data' text property."
4340 (interactive "e")
4341 (set-buffer (window-buffer (posn-window (event-start event))))
4342 (let* ((pos (posn-point (event-start event)))
4343 (data (get-text-property pos 'gnus-data))
4344 (fun (get-text-property pos 'gnus-callback)))
4345 (goto-char pos)
4346 (when fun
4347 (funcall fun data))))
4349 (defun gnus-article-press-button ()
4350 "Check text at point for a callback function.
4351 If the text at point has a `gnus-callback' property,
4352 call it with the value of the `gnus-data' text property."
4353 (interactive)
4354 (let* ((data (get-text-property (point) 'gnus-data))
4355 (fun (get-text-property (point) 'gnus-callback)))
4356 (when fun
4357 (funcall fun data))))
4359 (defun gnus-article-highlight (&optional force)
4360 "Highlight current article.
4361 This function calls `gnus-article-highlight-headers',
4362 `gnus-article-highlight-citation',
4363 `gnus-article-highlight-signature', and `gnus-article-add-buttons' to
4364 do the highlighting. See the documentation for those functions."
4365 (interactive (list 'force))
4366 (gnus-article-highlight-headers)
4367 (gnus-article-highlight-citation force)
4368 (gnus-article-highlight-signature)
4369 (gnus-article-add-buttons force)
4370 (gnus-article-add-buttons-to-head))
4372 (defun gnus-article-highlight-some (&optional force)
4373 "Highlight current article.
4374 This function calls `gnus-article-highlight-headers',
4375 `gnus-article-highlight-signature', and `gnus-article-add-buttons' to
4376 do the highlighting. See the documentation for those functions."
4377 (interactive (list 'force))
4378 (gnus-article-highlight-headers)
4379 (gnus-article-highlight-signature)
4380 (gnus-article-add-buttons))
4382 (defun gnus-article-highlight-headers ()
4383 "Highlight article headers as specified by `gnus-header-face-alist'."
4384 (interactive)
4385 (save-excursion
4386 (set-buffer gnus-article-buffer)
4387 (save-restriction
4388 (let ((alist gnus-header-face-alist)
4389 (buffer-read-only nil)
4390 (case-fold-search t)
4391 (inhibit-point-motion-hooks t)
4392 entry regexp header-face field-face from hpoints fpoints)
4393 (article-narrow-to-head)
4394 (while (setq entry (pop alist))
4395 (goto-char (point-min))
4397 (if (string-equal "" (nth 0 entry))
4399 (nth 0 entry))
4401 header-face (nth 1 entry)
4402 field-face (nth 2 entry))
4403 (while (and (re-search-forward regexp nil t)
4404 (not (eobp)))
4405 (beginning-of-line)
4406 (setq from (point))
4407 (unless (search-forward ":" nil t)
4408 (forward-char 1))
4409 (when (and header-face
4410 (not (memq (point) hpoints)))
4411 (push (point) hpoints)
4412 (gnus-put-text-property from (point) 'face header-face))
4413 (when (and field-face
4414 (not (memq (setq from (point)) fpoints)))
4415 (push from fpoints)
4417 (forward-char -2)
4418 (goto-char (point-max)))
4419 (gnus-put-text-property from (point) 'face field-face))))))))
4421 (defun gnus-article-highlight-signature ()
4422 "Highlight the signature in an article.
4423 It does this by highlighting everything after
4424 `gnus-signature-separator' using `gnus-signature-face'."
4425 (interactive)
4426 (save-excursion
4427 (set-buffer gnus-article-buffer)
4428 (let ((buffer-read-only nil)
4429 (inhibit-point-motion-hooks t))
4430 (save-restriction
4431 (when (and gnus-signature-face
4432 (gnus-article-narrow-to-signature))
4433 (gnus-overlay-put (gnus-make-overlay (point-min) (point-max))
4434 'face gnus-signature-face)
4435 (widen)
4436 (gnus-article-search-signature)
4437 (let ((start (match-beginning 0))
4438 (end (set-marker (make-marker) (1+ (match-end 0)))))
4439 (gnus-article-add-button start (1- end) 'gnus-signature-toggle
4440 end)))))))
4442 (defun gnus-button-in-region-p (b e prop)
4443 "Say whether PROP exists in the region."
4444 (text-property-not-all b e prop nil))
4446 (defun gnus-article-add-buttons (&optional force)
4447 "Find external references in the article and make buttons of them.
4449 specified by `gnus-button-alist'."
4450 (interactive (list 'force))
4451 (save-excursion
4452 (set-buffer gnus-article-buffer)
4453 (let ((buffer-read-only nil)
4454 (inhibit-point-motion-hooks t)
4455 (case-fold-search t)
4456 (alist gnus-button-alist)
4457 beg entry regexp)
4458 ;; Remove all old markers.
4459 (let (marker entry new-list)
4460 (while (setq marker (pop gnus-button-marker-list))
4461 (if (or (< marker (point-min)) (>= marker (point-max)))
4462 (push marker new-list)
4463 (goto-char marker)
4464 (when (setq entry (gnus-button-entry))
4465 (put-text-property (match-beginning (nth 1 entry))
4466 (match-end (nth 1 entry))
4467 'gnus-callback nil))
4468 (set-marker marker nil)))
4469 (setq gnus-button-marker-list new-list))
4470 ;; We skip the headers.
4471 (article-goto-body)
4472 (setq beg (point))
4473 (while (setq entry (pop alist))
4474 (setq regexp (car entry))
4475 (goto-char beg)
4476 (while (re-search-forward regexp nil t)
4477 (let* ((start (and entry (match-beginning (nth 1 entry))))
4478 (end (and entry (match-end (nth 1 entry))))
4479 (from (match-beginning 0)))
4480 (when (and (or (eq t (nth 2 entry))
4481 (eval (nth 2 entry)))
4482 (not (gnus-button-in-region-p
4483 start end 'gnus-callback)))
4484 ;; That optional form returned non-nil, so we add the
4485 ;; button.
4486 (gnus-article-add-button
4487 start end 'gnus-button-push
4488 (car (push (set-marker (make-marker) from)
4489 gnus-button-marker-list))))))))))
4491 ;; Add buttons to the head of an article.
4492 (defun gnus-article-add-buttons-to-head ()
4493 "Add buttons to the head of the article."
4494 (interactive)
4495 (save-excursion
4496 (set-buffer gnus-article-buffer)
4497 (save-restriction
4498 (let ((buffer-read-only nil)
4499 (inhibit-point-motion-hooks t)
4500 (case-fold-search t)
4501 (alist gnus-header-button-alist)
4502 entry beg end)
4503 (article-narrow-to-head)
4504 (while alist
4505 ;; Each alist entry.
4506 (setq entry (car alist)
4507 alist (cdr alist))
4508 (goto-char (point-min))
4509 (while (re-search-forward (car entry) nil t)
4510 ;; Each header matching the entry.
4511 (setq beg (match-beginning 0))
4513 (match-beginning 0))
4514 (point-max)))
4515 (goto-char beg)
4516 (while (re-search-forward (nth 1 entry) end t)
4517 ;; Each match within a header.
4518 (let* ((entry (cdr entry))
4519 (start (match-beginning (nth 1 entry)))
4520 (end (match-end (nth 1 entry)))
4521 (form (nth 2 entry)))
4522 (goto-char (match-end 0))
4523 (when (eval form)
4524 (gnus-article-add-button
4525 start end (nth 3 entry)
4526 (buffer-substring (match-beginning (nth 4 entry))
4527 (match-end (nth 4 entry)))))))
4528 (goto-char end)))))))
4530 ;;; External functions:
4532 (defun gnus-article-add-button (from to fun &optional data)
4533 "Create a button between FROM and TO with callback FUN and data DATA."
4534 (when gnus-article-button-face
4535 (gnus-overlay-put (gnus-make-overlay from to)
4536 'face gnus-article-button-face))
4537 (gnus-add-text-properties
4538 from to
4539 (nconc (and gnus-article-mouse-face
4540 (list gnus-mouse-face-prop gnus-article-mouse-face))
4541 (list 'gnus-callback fun)
4542 (and data (list 'gnus-data data))))
4543 (widget-convert-button 'link from to :action 'gnus-widget-press-button
4544 :button-keymap gnus-widget-button-keymap))
4546 ;;; Internal functions:
4548 (defun gnus-article-set-globals ()
4549 (save-excursion
4550 (set-buffer gnus-summary-buffer)
4551 (gnus-set-global-variables)))
4553 (defun gnus-signature-toggle (end)
4554 (save-excursion
4555 (set-buffer gnus-article-buffer)
4556 (let ((buffer-read-only nil)
4557 (inhibit-point-motion-hooks t))
4558 (if (text-property-any end (point-max) 'article-type 'signature)
4559 (gnus-remove-text-properties-when
4560 'article-type 'signature end (point-max)
4561 (cons 'article-type (cons 'signature
4562 gnus-hidden-properties)))
4563 (gnus-add-text-properties-when
4564 'article-type nil end (point-max)
4565 (cons 'article-type (cons 'signature
4566 gnus-hidden-properties)))))))
4568 (defun gnus-button-entry ()
4569 ;; Return the first entry in `gnus-button-alist' matching this place.
4570 (let ((alist gnus-button-alist)
4571 (entry nil))
4572 (while alist
4573 (setq entry (pop alist))
4574 (if (looking-at (car entry))
4575 (setq alist nil)
4576 (setq entry nil)))
4577 entry))
4579 (defun gnus-button-push (marker)
4580 ;; Push button starting at MARKER.
4581 (save-excursion
4582 (goto-char marker)
4583 (let* ((entry (gnus-button-entry))
4584 (inhibit-point-motion-hooks t)
4585 (fun (nth 3 entry))
4586 (args (mapcar (lambda (group)
4587 (let ((string (match-string group)))
4588 (gnus-set-text-properties
4589 0 (length string) nil string)
4590 string))
4591 (nthcdr 4 entry))))
4592 (cond
4593 ((fboundp fun)
4594 (apply fun args))
4595 ((and (boundp fun)
4596 (fboundp (symbol-value fun)))
4597 (apply (symbol-value fun) args))
4598 (t
4599 (gnus-message 1 "You must define `%S' to use this button"
4600 (cons fun args)))))))
4602 (defun gnus-button-message-id (message-id)
4603 "Fetch MESSAGE-ID."
4604 (save-excursion
4605 (set-buffer gnus-summary-buffer)
4606 (gnus-summary-refer-article message-id)))
4608 (defun gnus-button-fetch-group (address)
4609 "Fetch GROUP specified by ADDRESS."
4610 (if (not (string-match "[:/]" address))
4611 ;; This is just a simple group url.
4612 (gnus-group-read-ephemeral-group address gnus-select-method)
4614 address))
4615 (error "Can't parse %s" address)
4616 (gnus-group-read-ephemeral-group
4617 (match-string 4 address)
4618 `(nntp ,(match-string 1 address)
4619 (nntp-address ,(match-string 1 address))
4620 (nntp-port-number ,(if (match-end 3)
4621 (match-string 3 address)
4622 "nntp")))))))
4624 (defun gnus-url-parse-query-string (query &optional downcase)
4625 (let (retval pairs cur key val)
4626 (setq pairs (split-string query "&"))
4627 (while pairs
4628 (setq cur (car pairs)
4629 pairs (cdr pairs))
4630 (if (not (string-match "=" cur))
4631 nil ; Grace
4632 (setq key (gnus-url-unhex-string (substring cur 0 (match-beginning 0)))
4633 val (gnus-url-unhex-string (substring cur (match-end 0) nil)))
4634 (if downcase
4635 (setq key (downcase key)))
4636 (setq cur (assoc key retval))
4637 (if cur
4638 (setcdr cur (cons val (cdr cur)))
4639 (setq retval (cons (list key val) retval)))))
4640 retval))
4642 (defun gnus-url-unhex (x)
4643 (if (> x ?9)
4644 (if (>= x ?a)
4645 (+ 10 (- x ?a))
4646 (+ 10 (- x ?A)))
4647 (- x ?0)))
4649 (defun gnus-url-unhex-string (str &optional allow-newlines)
4650 "Remove %XXX embedded spaces, etc in a url.
4651 If optional second argument ALLOW-NEWLINES is non-nil, then allow the
4652 decoding of carriage returns and line feeds in the string, which is normally
4653 forbidden in URL encoding."
4654 (setq str (or str ""))
4655 (let ((tmp "")
4656 (case-fold-search t))
4657 (while (string-match "%[0-9a-f][0-9a-f]" str)
4658 (let* ((start (match-beginning 0))
4659 (ch1 (gnus-url-unhex (elt str (+ start 1))))
4660 (code (+ (* 16 ch1)
4661 (gnus-url-unhex (elt str (+ start 2))))))
4662 (setq tmp (concat
4663 tmp (substring str 0 start)
4664 (cond
4665 (allow-newlines
4666 (char-to-string code))
4668 " ")
4669 (t (char-to-string code))))
4670 str (substring str (match-end 0)))))
4671 (setq tmp (concat tmp str))
4672 tmp))
4674 (defun gnus-url-mailto (url)
4675 ;; Send mail to someone
4677 (setq url (substring url (match-beginning 1) nil)))
4678 (let (to args subject func)
4679 (if (string-match (regexp-quote "?") url)
4680 (setq to (gnus-url-unhex-string (substring url 0 (match-beginning 0)))
4681 args (gnus-url-parse-query-string
4682 (substring url (match-end 0) nil) t))
4683 (setq to (gnus-url-unhex-string url)))
4684 (setq args (cons (list "to" to) args)
4685 subject (cdr-safe (assoc "subject" args)))
4686 (message-mail)
4687 (while args
4688 (setq func (intern-soft (concat "message-goto-" (downcase (caar args)))))
4689 (if (fboundp func)
4690 (funcall func)
4691 (message-position-on-field (caar args)))
4692 (insert (mapconcat 'identity (cdar args) ", "))
4693 (setq args (cdr args)))
4694 (if subject
4695 (message-goto-body)
4696 (message-goto-subject))))
4698 (defun gnus-button-mailto (address)
4699 "Mail to ADDRESS."
4700 (set-buffer (gnus-copy-article-buffer))
4701 (message-reply address))
4703 (defalias 'gnus-button-reply 'message-reply)
4705 (defun gnus-button-embedded-url (address)
4706 "Activate ADDRESS with `browse-url'."
4707 (browse-url (gnus-strip-whitespace address)))
4709 ;;; Next/prev buttons in the article buffer.
4714 (defvar gnus-prev-page-map nil)
4715 (unless gnus-prev-page-map
4716 (setq gnus-prev-page-map (make-sparse-keymap))
4717 (define-key gnus-prev-page-map gnus-mouse-2 'gnus-button-prev-page)
4720 (defun gnus-insert-prev-page-button ()
4721 (let ((buffer-read-only nil))
4722 (gnus-eval-format
4723 gnus-prev-page-line-format nil
4724 `(gnus-prev t local-map ,gnus-prev-page-map
4725 gnus-callback gnus-article-button-prev-page
4726 article-type annotation))))
4728 (defvar gnus-next-page-map nil)
4729 (unless gnus-next-page-map
4730 (setq gnus-next-page-map (make-keymap))
4731 (suppress-keymap gnus-prev-page-map)
4732 (define-key gnus-next-page-map gnus-mouse-2 'gnus-button-next-page)
4735 (defun gnus-button-next-page ()
4736 "Go to the next page."
4737 (interactive)
4738 (let ((win (selected-window)))
4739 (select-window (get-buffer-window gnus-article-buffer t))
4740 (gnus-article-next-page)
4741 (select-window win)))
4743 (defun gnus-button-prev-page ()
4744 "Go to the prev page."
4745 (interactive)
4746 (let ((win (selected-window)))
4747 (select-window (get-buffer-window gnus-article-buffer t))
4748 (gnus-article-prev-page)
4749 (select-window win)))
4751 (defun gnus-insert-next-page-button ()
4752 (let ((buffer-read-only nil))
4753 (gnus-eval-format gnus-next-page-line-format nil
4754 `(gnus-next
4755 t local-map ,gnus-next-page-map
4756 gnus-callback gnus-article-button-next-page
4757 article-type annotation))))
4759 (defun gnus-article-button-next-page (arg)
4760 "Go to the next page."
4761 (interactive "P")
4762 (let ((win (selected-window)))
4763 (select-window (get-buffer-window gnus-article-buffer t))
4764 (gnus-article-next-page)
4765 (select-window win)))
4767 (defun gnus-article-button-prev-page (arg)
4768 "Go to the prev page."
4769 (interactive "P")
4770 (let ((win (selected-window)))
4771 (select-window (get-buffer-window gnus-article-buffer t))
4772 (gnus-article-prev-page)
4773 (select-window win)))
4775 (defvar gnus-decode-header-methods
4776 '(mail-decode-encoded-word-region)
4777 "List of methods used to decode headers.
4779 This variable is a list of FUNCTION or (REGEXP . FUNCTION). If item
4780 is FUNCTION, FUNCTION will be apply to all newsgroups. If item is a
4781 (REGEXP . FUNCTION), FUNCTION will be only apply to thes newsgroups
4782 whose names match REGEXP.
4784 For example:
4786 mail-decode-encoded-word-region
4788 ")
4790 (defvar gnus-decode-header-methods-cache nil)
4792 (defun gnus-multi-decode-header (start end)
4793 "Apply the functions from `gnus-encoded-word-methods' that match."
4794 (unless (and gnus-decode-header-methods-cache
4795 (eq gnus-newsgroup-name
4796 (car gnus-decode-header-methods-cache)))
4797 (setq gnus-decode-header-methods-cache (list gnus-newsgroup-name))
4798 (mapcar (lambda (x)
4799 (if (symbolp x)
4800 (nconc gnus-decode-header-methods-cache (list x))
4801 (if (and gnus-newsgroup-name
4802 (string-match (car x) gnus-newsgroup-name))
4803 (nconc gnus-decode-header-methods-cache
4804 (list (cdr x))))))
4805 gnus-decode-header-methods))
4806 (let ((xlist gnus-decode-header-methods-cache))
4807 (pop xlist)
4808 (save-restriction
4809 (narrow-to-region start end)
4810 (while xlist
4811 (funcall (pop xlist) (point-min) (point-max))))))
4813 ;;;
4814 ;;; Treatment top-level handling.
4815 ;;;
4817 (defun gnus-treat-article (condition &optional part-number total-parts type)
4818 (let ((length (- (point-max) (point-min)))
4819 (alist gnus-treatment-function-alist)
4820 (article-goto-body-goes-to-point-min-p t)
4821 (treated-type
4822 (or (not type)
4823 (catch 'found
4824 (let ((list gnus-article-treat-types))
4825 (while list
4826 (when (string-match (pop list) type)
4827 (throw 'found t)))))))
4828 (highlightp (gnus-visual-p 'article-highlight 'highlight))
4829 val elem)
4830 (gnus-run-hooks 'gnus-part-display-hook)
4831 (while (setq elem (pop alist))
4832 (setq val
4833 (save-excursion
4834 (if (gnus-buffer-live-p gnus-summary-buffer)
4835 (set-buffer gnus-summary-buffer))
4836 (symbol-value (car elem))))
4837 (when (and (or (consp val)
4838 treated-type)
4839 (gnus-treat-predicate val)
4840 (or (not (get (car elem) 'highlight))
4841 highlightp))
4842 (save-restriction
4843 (funcall (cadr elem)))))))
4845 ;; Dynamic variables.
4846 (eval-when-compile
4847 (defvar part-number)
4848 (defvar total-parts)
4849 (defvar type)
4850 (defvar condition)
4851 (defvar length))
4853 (defun gnus-treat-predicate (val)
4854 (cond
4855 ((null val)
4856 nil)
4857 ((and (listp val)
4858 (stringp (car val)))
4859 (apply 'gnus-or (mapcar `(lambda (s)
4860 (string-match s ,(or gnus-newsgroup-name "")))
4861 val)))
4862 ((listp val)
4863 (let ((pred (pop val)))
4864 (cond
4865 ((eq pred 'or)
4866 (apply 'gnus-or (mapcar 'gnus-treat-predicate val)))
4867 ((eq pred 'and)
4868 (apply 'gnus-and (mapcar 'gnus-treat-predicate val)))
4869 ((eq pred 'not)
4870 (not (gnus-treat-predicate (car val))))
4871 ((eq pred 'typep)
4872 (equal (car val) type))
4873 (t
4874 (error "%S is not a valid predicate" pred)))))
4875 (condition
4876 (eq condition val))
4877 ((eq val t)
4878 t)
4879 ((eq val 'head)
4880 nil)
4881 ((eq val 'last)
4882 (eq part-number total-parts))
4883 ((numberp val)
4884 (< length val))
4885 (t
4886 (error "%S is not a valid value" val))))
4888 (gnus-ems-redefine)
4890 (provide 'gnus-art)
4892 (run-hooks 'gnus-art-load-hook)
4894 ;;; gnus-art.el ends here