| blob | 5f0487968f68723d79ba57d335db4d1c426f04ff |
1 ;;; gnus-art.el --- article mode commands for Gnus
3 ;; Copyright (C) 1996, 97, 98, 1999, 2000, 01, 02, 2004
4 ;; Free Software Foundation, Inc.
6 ;; Author: Lars Magne Ingebrigtsen <larsi@gnus.org>
7 ;; Keywords: news
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software; you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation; either version 2, or (at your option)
14 ;; any later version.
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs; see the file COPYING. If not, write to the
23 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
24 ;; Boston, MA 02111-1307, USA.
26 ;;; Commentary:
28 ;;; Code:
44 "Article display."
49 "Treating article parts."
54 "Hiding article parts."
59 "Article highlighting."
65 "Article signatures."
70 "Article headers."
75 "Special commands on articles."
80 "Fontisizing articles."
85 "Saving articles."
90 "Worshiping the MIME wonder."
95 "Pushable buttons in the article buffer."
100 "Other article options."
132 "*All headers that start with this regexp will be hidden.
133 This variable can also be a list of regexps of headers to be ignored.
134 If `gnus-visible-headers' is non-nil, this variable will be ignored."
136 regexp
141 "^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:"
142 "*All headers that do not match this regexp will be hidden.
143 This variable can also be a list of regexp of headers to remain visible.
144 If this variable is non-nil, `gnus-ignored-headers' will be ignored."
150 regexp)
156 "*This variable is a list of regular expressions.
157 If it is non-nil, headers that match the regular expressions will
158 be placed first in the article buffer in the sequence specified by
159 this list."
164 "Headers that are only to be displayed if they have interesting data.
165 Possible values in this list are `empty', `newsgroups', `followup-to',
166 `reply-to', `date', `long-to', and `many-to'."
177 "Regexp matching signature separator.
178 This can also be a list of regexps. In that case, it will be checked
179 from head to tail looking for a separator. Searches will be done from
180 the end of the buffer."
185 "Provide a limit to what is considered a signature.
186 If it is a number, no signature may not be longer (in characters) than
187 that number. If it is a floating point number, no signature may be
188 longer (in lines) than that number. If it is a function, the function
189 will be called without any parameters, and if it returns nil, there is
190 no signature in the buffer. If it is a string, it will be used as a
191 regexp. If it matches, the text in question is not a signature."
199 "Property list to use for hiding text."
203 ;; Fixme: This isn't the right thing for mixed graphical and and
204 ;; non-graphical frames in a session.
205 ;; gnus-xmas.el overrides this for XEmacs.
209 'gnus-article-display-xface
211 gnus-article-compface-xbm)
214 "{ echo '/* Width=48, Height=48 */'; uncompface; } | display -"
215 "{ echo '/* Width=48, Height=48 */'; uncompface; } | icontopbm | \
217 "*String or function to be executed to display an X-Face header.
218 If it is a string, the command will be executed in a sub-shell
219 asynchronously. The compressed face will be piped to this command."
222 function)
227 "Regexp matching posters whose face shouldn't be shown automatically."
232 "Banner alist for stripping.
233 For example,
234 ((egroups . \"^[ \\t\\n]*-------------------+\\\\( eGroups Sponsor -+\\\\)?....\\n\\\\(.+\\n\\\\)+\"))"
241 "\\(\\s-\\|^\\|[-\"]\\|\\s(\\)\\(%s\\(\\w+\\(\\s-+\\w+\\)*[.,]?\\)%s\\)\\(\\s-\\|[-,;:\"]\\s-\\|[?!.]+\\s-\\|\\s)\\)")
257 types)))
258 "*Alist that says how to fontify certain phrases.
259 Each item looks like this:
263 The first element is a regular expression to be matched. The second
264 is a number that says what regular expression grouping used to find
265 the entire emphasized word. The third is a number that says what
266 regexp grouping should be displayed and highlighted. The fourth
267 is the face used for highlighting."
269 regexp
272 face))
276 "A regexp to describe whitespace which should not be emphasized.
278 The former avoids underlining of leading and trailing whitespace,
279 and the latter avoids underlining any whitespace at all."
285 "Face used for displaying strong emphasized text (*word*)."
289 "Face used for displaying italic emphasized text (/word/)."
293 "Face used for displaying underlined emphasized text (_word_)."
297 "Face used for displaying underlined bold emphasized text (_*word*_)."
301 "Face used for displaying underlined italic emphasized text (_/word/_)."
305 "Face used for displaying bold italic emphasized text (/*word*/)."
310 "Face used for displaying underlined bold italic emphasized text.
311 Example: (_/*word*/_)."
316 "Face used for displaying highlighted words."
320 "Format for display of Date headers in article bodies.
321 See `format-time-string' for the possible values.
323 The variable can also be function, which should return a complete Date
324 header. The function is called with one argument, the time, which can
325 be fed to `format-time-string'."
334 "*If non-nil, don't remove any headers before saving."
339 "*This variable says how much prompting is to be done when saving articles.
340 If it is nil, no prompting will be done, and the articles will be
341 saved to the default files. If this variable is `always', each and
342 every article that is saved will be preceded by a prompt, even when
343 saving large batches of articles. If this variable is neither nil not
344 `always', there the user will be prompted once for a file name for
345 each invocation of the saving commands."
352 "Headers to keep if `gnus-save-all-headers' is nil.
353 If `gnus-save-all-headers' is non-nil, this variable will be ignored.
354 If that variable is nil, however, all headers that match this regexp
355 will be kept while the rest will be deleted before saving."
360 "A function to save articles in your favourite format.
361 The function must be interactively callable (in other words, it must
362 be an Emacs command).
364 Gnus provides the following functions:
366 * gnus-summary-save-in-rmail (Rmail format)
367 * gnus-summary-save-in-mail (Unix mail format)
368 * gnus-summary-save-in-folder (MH folder)
369 * gnus-summary-save-in-file (article format)
370 * gnus-summary-save-in-vm (use VM's folder format)
371 * gnus-summary-write-to-file (article format -- overwrite)."
381 "A function generating a file name to save articles in Rmail format.
382 The function is called with NEWSGROUP, HEADERS, and optional LAST-FILE."
387 "A function generating a file name to save articles in Unix mail format.
388 The function is called with NEWSGROUP, HEADERS, and optional LAST-FILE."
393 "A function generating a file name to save articles in MH folder.
394 The function is called with NEWSGROUP, HEADERS, and optional LAST-FOLDER."
399 "A function generating a file name to save articles in article format.
400 The function is called with NEWSGROUP, HEADERS, and optional
401 LAST-FILE."
408 "*Variable used to suggest where articles are to be saved.
409 For instance, if you would like to save articles related to Gnus in
411 you could set this variable to something like:
416 This variable is an alist where the where the key is the match and the
417 value is a list of possible files to save in if the match is non-nil.
419 If the match is a string, it is used as a regexp match on the
420 article. If the match is a symbol, that symbol will be funcalled
421 from the buffer of the article to be saved with the newsgroup as the
422 parameter. If it is a list, it will be evaled in the same buffer.
424 If this form or function returns a string, this string will be used as
425 a possible file name; and if it returns a non-nil list, that list will
426 be used as possible file names."
433 "*Regexp describing what to use as article page delimiters.
435 beginning of a line."
440 "*The format specification for the article mode line.
441 See `gnus-summary-mode-line-format' for a closer description.
443 The following additional specs are available:
445 %w The article washing status.
446 %m The number of MIME parts in the article."
451 "*A hook for Gnus article mode."
456 "*Hook run after the creation of the article mode menu."
461 "*A hook called after an article has been prepared in the article buffer."
466 "*A hook called after successfully hiding a PGP signature."
471 "Face used for highlighting buttons in the article buffer.
473 An article button is a piece of text that you can activate by pressing
474 `RET' or `mouse-2' above it."
479 "Face used for mouse highlighting in the article buffer.
481 Article buttons will be displayed in this face when the cursor is
482 above them."
487 "Face used for highlighting a signature in the article buffer.
488 Obsolete; use the face `gnus-signature-face' for customizations instead."
496 "Face used for highlighting a signature in the article buffer."
509 "Face used for displaying from headers."
522 "Face used for displaying subject headers."
535 "Face used for displaying newsgroups headers."
548 "Face used for displaying header names."
569 "*Controls highlighting of article header.
571 An alist of the form (HEADER NAME CONTENT).
573 HEADER is a regular expression which should match the name of an
574 header header and NAME and CONTENT are either face names or nil.
576 The name of each header field will be displayed using the face
577 specified by the first element in the list where HEADER match the
578 header name and NAME is non-nil. Similarly, the content will be
579 displayed by the first non-nil matching CONTENT face."
592 "*Hook run to decode charsets in articles."
597 "Function to display MIME articles."
625 "List of MIME types that should be ignored by Gnus."
631 "List of MIME types that should not be given buttons when rendered inline."
637 "Function called with a MIME handle as the argument.
638 This is meant for people who want to do something automatic based
639 on parts -- for instance, adding Vcard info to a database."
644 "An alist of MIME types to functions to display them."
650 "Whether the X-Sent and Date headers can coexist.
653 be added below it (otherwise)."
659 "Function called with a MIME handle as the argument.
660 This is meant for people who want to view first matched part.
661 For `undisplayed-alternative' (default), the first undisplayed
662 part or alternative part is used. For `undisplayed', the first
663 undisplayed part is used. For a function, the first part which
664 the function return t is used. For nil, the first part is
665 used."
684 "An alist of actions that run on the MIME attachment."
690 ;;;
691 ;;; The treatment variables
692 ;;;
717 "Highlight the signature.
718 Valid values are nil, t, `head', `last', an integer or a predicate.
719 See the manual for details."
725 "Add buttons.
726 Valid values are nil, t, `head', `last', an integer or a predicate.
727 See the manual for details."
733 "Add buttons to the head.
734 Valid values are nil, t, `head', `last', an integer or a predicate.
735 See the manual for details."
745 "Emphasize text.
746 Valid values are nil, t, `head', `last', an integer or a predicate.
747 See the manual for details."
753 "Remove carriage returns.
754 Valid values are nil, t, `head', `last', an integer or a predicate.
755 See the manual for details."
760 "Hide headers.
761 Valid values are nil, t, `head', `last', an integer or a predicate.
762 See the manual for details."
767 "Hide boring headers.
768 Valid values are nil, t, `head', `last', an integer or a predicate.
769 See the manual for details."
774 "Hide the signature.
775 Valid values are nil, t, `head', `last', an integer or a predicate.
776 See the manual for details."
781 "Fill the article.
782 Valid values are nil, t, `head', `last', an integer or a predicate.
783 See the manual for details."
788 "Hide cited text.
789 Valid values are nil, t, `head', `last', an integer or a predicate.
790 See the manual for details."
795 "Hide cited text.
796 Valid values are nil, t, `head', `last', an integer or a predicate.
797 See the manual for details."
802 "Strip list identifiers from `gnus-list-identifiers`.
803 Valid values are nil, t, `head', `last', an integer or a predicate.
804 See the manual for details."
810 "Strip PGP signatures.
811 Valid values are nil, t, `head', `last', an integer or a predicate.
812 See the manual for details."
817 "Strip PEM signatures.
818 Valid values are nil, t, `head', `last', an integer or a predicate.
819 See the manual for details."
824 "Strip banners from articles.
825 The banner to be stripped is specified in the `banner' group parameter.
826 Valid values are nil, t, `head', `last', an integer or a predicate.
827 See the manual for details."
832 "Highlight the headers.
833 Valid values are nil, t, `head', `last', an integer or a predicate.
834 See the manual for details."
840 "Highlight cited text.
841 Valid values are nil, t, `head', `last', an integer or a predicate.
842 See the manual for details."
848 "Display the Date in UT (GMT).
849 Valid values are nil, t, `head', `last', an integer or a predicate.
850 See the manual for details."
855 "Display the Date in the local timezone.
856 Valid values are nil, t, `head', `last', an integer or a predicate.
857 See the manual for details."
862 "Display the Date header in a way that says how much time has elapsed.
863 Valid values are nil, t, `head', `last', an integer or a predicate.
864 See the manual for details."
869 "Display the date in the original timezone.
870 Valid values are nil, t, `head', `last', an integer or a predicate.
871 See the manual for details."
876 "Display the date in the ISO8601 format.
877 Valid values are nil, t, `head', `last', an integer or a predicate.
878 See the manual for details."
884 "Display the date in a user-defined format.
885 The format is defined by the `gnus-article-time-format' variable.
886 Valid values are nil, t, `head', `last', an integer or a predicate.
887 See the manual for details."
892 "Strip the X-No-Archive header line from the beginning of the body.
893 Valid values are nil, t, `head', `last', an integer or a predicate.
894 See the manual for details."
900 "Strip trailing blank lines.
901 Valid values are nil, t, `head', `last', an integer or a predicate.
902 See the manual for details."
907 "Strip leading blank lines.
908 Valid values are nil, t, `head', `last', an integer or a predicate.
909 See the manual for details."
914 "Strip multiple blank lines.
915 Valid values are nil, t, `head', `last', an integer or a predicate.
916 See the manual for details."
921 "Treat overstrike highlighting.
922 Valid values are nil, t, `head', `last', an integer or a predicate.
923 See the manual for details."
934 "Display X-Face headers.
935 Valid values are nil, t, `head', `last', an integer or a predicate.
936 See the manual for details."
947 t nil)
948 "Display smileys.
949 Valid values are nil, t, `head', `last', an integer or a predicate.
950 See the manual for details."
957 "Display picons.
958 Valid values are nil, t, `head', `last', an integer or a predicate.
959 See the manual for details."
965 "Capitalize sentence-starting words.
966 Valid values are nil, t, `head', `last', an integer or a predicate.
967 See the manual for details."
973 "Fill long lines.
974 Valid values are nil, t, `head', `last', an integer or a predicate.
975 See the manual for details."
980 "Play sounds.
981 Valid values are nil, t, `head', `last', an integer or a predicate.
982 See the manual for details."
988 "Translate articles from one language to another.
989 Valid values are nil, t, `head', `last', an integer or a predicate.
990 See the manual for details."
995 ;;; Internal variables
1030 gnus-article-remove-trailing-blank-lines)
1032 gnus-article-strip-leading-blank-lines)
1034 gnus-article-strip-multiple-blank-lines)
1051 table)
1052 "Syntax table used in article mode buffers.
1060 gnus-summary-mode-line-format-alist))
1067 "Set text PROPS on the B to E region, extending `intangible' 1 past B."
1075 "Remove hidden text properties from region between B and E."
1082 "Hide text of TYPE between B and E."
1088 "Unhide text of TYPE between B and E."
1098 "Hide text of TYPE in the current buffer."
1106 "Delete text of TYPE in the current buffer."
1115 "Delete all invisible text in the current buffer."
1124 "Say whether any text of type TYPE exists in the buffer."
1128 "Give the rank of the string HEADER as given by `gnus-sorted-header-list'."
1136 i))
1139 "Hide unwanted headers and possibly sort them as well."
1141 ;; This function might be inhibited.
1150 gnus-ignored-headers)
1156 gnus-visible-headers)
1161 beg)
1162 ;; First we narrow to just the headers.
1164 ;; Hide any "From " lines at the beginning of (mail) articles.
1169 ;; Then treat the rest of the header lines.
1170 ;; Then we use the two regular expressions
1171 ;; `gnus-ignored-headers' and `gnus-visible-headers' to
1172 ;; select which header lines is to remain visible in the
1173 ;; article buffer.
1176 ;; Mark the rank of the header.
1188 ;; We delete the unwanted headers.
1195 "Toggle hiding of headers that aren't very interesting.
1196 If given a negative prefix, always show; if given a positive prefix,
1197 always hide."
1206 elem)
1212 ;; Hide empty headers.
1224 ;; Hide boring Newsgroups header.
1229 gnus-newsgroup-name
1240 from reply-to
1304 "Make all header lines 40 characters long."
1307 column)
1314 gnus-article-normalized-header-length)
1318 ? )))
1327 ;; Do nothing.
1328 ))
1332 "Translate M****s*** sm*rtq**t*s into proper text.
1333 Note that this function guesses whether a character is a sm*rtq**t* or
1334 not, so it should only be used interactively.
1336 Sm*rtq**t*s are M****s***'s unilateral extension to the character map
1337 in an attempt to provide more quoting characters. If you see
1339 apostrophe or quotation mark, then try this wash."
1344 "Translate all characters in the body of the article according to FROM and TO.
1345 FROM is a string of characters to translate from; to is a string of
1346 characters to translate to."
1361 "Translate all string in the body of the article according to MAP.
1366 elem)
1373 "Translate overstrikes into bold text."
1381 ;; We do the boldification/underlining by hiding the
1382 ;; overstrikes and putting the proper text property
1383 ;; on the letters.
1399 "Fill lines that are wider than the window width."
1417 "Capitalize the first word in each sentence."
1428 "Remove trailing CRs and then translate remaining CRs into LFs."
1440 "Remove all trailing blank lines from the article."
1457 "Look for an X-Face header and display it if present."
1460 ;; Delete the old process, if any.
1465 from last)
1474 ;; Check whether this face is censored.
1478 from))))
1479 ;; Has to be present.
1481 ;; This used to try to do multiple faces (`while' instead of
1482 ;; `when' above), but (a) sending multiple EOFs to xv doesn't
1483 ;; work (b) it can crash some versions of Emacs (c) are
1484 ;; multiple faces really something to encourage?
1487 ;; We now have the area of the buffer where the X-Face is stored.
1491 ;; We display the face.
1493 ;; The command is a lisp function, so we call it.
1497 ;; The command is a string, so we interpret the command
1498 ;; as a, well, command, and fork it off.
1502 "article-x-face" nil shell-file-name shell-command-switch
1503 gnus-article-x-face-command))
1508 "Decode all MIME-encoded words in the article."
1513 buffer-read-only
1517 gnus-newsgroup-ignored-charsets)))
1521 "Decode charset-encoded text in the article.
1522 If PROMPT (the prefix), prompt for a coding system to use."
1525 buffer-read-only
1531 gnus-newsgroup-ignored-charsets))
1532 ct cte ctl charset format)
1556 ;; The text code could have been decoded.
1567 "Remove encoded-word encoding from headers."
1574 gnus-newsgroup-ignored-charsets))
1575 buffer-read-only)
1581 "Translate a quoted-printable-encoded article.
1582 If FORCE, decode the article whether it is marked as quoted-printable
1583 or not."
1609 "Translate a base64 article.
1610 If FORCE, decode the article whether it is marked as base64 not."
1642 "Translate a HZ-encoded article."
1650 "Format an html article."
1654 charset)
1680 "Remove list identifies from the Subject header.
1681 The `gnus-list-identifiers' variable specifies what to do."
1686 buffer-read-only)
1695 nil t)
1703 "Remove any PGP headers and signatures in the current article."
1708 buffer-read-only beg end)
1710 ;; Hide the "header".
1714 ;; Remove armor headers (rfc2440 6.2)
1718 ;; Hide the actual signature.
1722 end
1725 ;; Perhaps we shouldn't hide to the end of the buffer
1726 ;; if there is no end to the signature?
1728 ;; Hide "- " PGP quotation markers.
1739 "Toggle hiding of any PEM headers and signatures in the current article.
1740 If given a negative prefix, always show; if given a positive prefix,
1741 always hide."
1747 ;; Hide the horrendously ugly "header".
1750 nil t)
1754 end
1759 ;; Hide the trailer as well
1761 nil t)
1766 "Strip the banner specified by the `banner' group parameter."
1773 buffer-read-only beg end)
1791 "Translate article using an online translation service."
1808 "Hide the signature in the current article.
1809 If given a negative prefix, always show; if given a positive prefix,
1810 always hide."
1821 "Strip offensive headers from bodies."
1830 "Remove all blank lines from the beginning of the article."
1834 buffer-read-only)
1841 "Narrow the buffer to the head of the message.
1842 Point is left at the beginning of the narrowed-to region."
1851 "Place point at the start of the body."
1854 ;; This variable is only bound when dealing with separate
1855 ;; MIME body parts.
1857 t)
1859 t)
1862 nil)))
1865 "Replace consecutive blank lines with one empty line."
1869 buffer-read-only)
1870 ;; First make all blank lines empty.
1876 ;; Then replace multiple empty lines with a single empty line.
1884 "Remove all white space from the beginning of the lines in the article."
1888 buffer-read-only)
1894 "Remove all white space from the end of the lines in the article."
1898 buffer-read-only)
1904 "Strip leading, trailing and multiple blank lines."
1911 "Strip all blank lines."
1915 buffer-read-only)
1921 "Narrow to the signature; return t if a signature is found, else nil."
1925 ;; Check whether we have some limits to what we consider
1926 ;; to be a signature.
1929 limit limited)
1941 limits nil)))
1944 t)))))
1947 "Search the current buffer for the signature separator.
1948 Put point at the beginning of the signature separator."
1957 seps))
1958 t
1960 nil)))
1963 "Return the current prefix arg as a number, or 0 if no prefix."
1969 "Return nil if hiding is necessary.
1970 Arg can be nil or a number. nil and positive means hide, negative
1971 means show, 0 means toggle."
1978 nil)
1981 t)
1986 t)
1987 nil)))))))
1990 "Say whether the current buffer contains hidden text of type TYPE."
1998 'hidden
1999 nil)))
2002 "Show all hidden text of type TYPE.
2003 Originally it is hide instead of DUMMY."
2007 'article-type type
2010 gnus-hidden-properties)))))
2022 "Convert DATE date to universal time in the current article.
2023 If TYPE is `local', convert to local time; if it is `lapsed', output
2024 how much time has lapsed since DATE. For `lapsed', the value of
2035 tdate-regexp)
2041 header))
2043 pos
2044 bface eface)
2052 date)
2058 ;; Delete any old Date headers.
2073 ;; Do highlighting.
2084 "Return a DATE line of TYPE."
2089 ;; Convert to the local timezone. We have to slap a
2090 ;; `condition-case' round the calls to the timezone
2091 ;; functions since they aren't particularly resistant to
2092 ;; buggy dates.
2098 ;; Convert to Universal Time.
2110 ;; Get the original date from the article.
2114 date)))
2115 ;; Let the user define the format.
2120 "Date: "
2122 ;; ISO 8601.
2126 "Date: "
2131 ;; Do an X-Sent lapsed format.
2133 ;; If the date is seriously mangled, the timezone functions are
2134 ;; liable to bug out, so we ignore all errors.
2141 num prev)
2149 "X-Sent: "
2150 ;; This is a bit convoluted, but basically we go
2151 ;; through the time units for years, weeks, etc,
2152 ;; and divide things to see whether that results
2153 ;; in positive answers.
2157 ;; The (remaining) seconds are too few to
2158 ;; be divided into this time unit.
2159 ""
2160 ;; It's big enough, so we output it.
2169 ;; If dates are odd, then it might appear like the
2170 ;; article was sent in the future.
2172 " ago"
2178 "Convert the current article date to the local timezone."
2183 "Convert the current article date to what it was originally.
2184 This is only useful if you have used some other date conversion
2185 function and want to see what the date was before converting."
2190 "Convert the current article date to time lapsed since it was sent."
2195 "Function to be run from a timer to update the lapsed time line."
2209 "Start a timer to update the X-Sent header in the article buffers.
2210 The numerical prefix says how frequently (in seconds) the function
2211 is to run."
2220 "Stop the X-Sent timer."
2227 "Convert the current article date to the user-defined format.
2228 This format is defined by the `gnus-article-time-format' variable."
2233 "Convert the current article date to ISO8601."
2238 "Show all hidden text in the article buffer."
2245 "Emphasize text according to `gnus-emphasis-alist'."
2252 gnus-article-emphasis-alist)
2254 gnus-emphasis-alist))
2257 gnus-hidden-properties))
2258 regexp elem beg invisible visible face)
2279 "Setup newsgroup emphasis alist."
2291 highlight)
2296 gnus-emphasis-alist)))))
2302 ;;; Saving functions.
2305 "Save the currently selected article."
2307 ;; Remove headers according to `gnus-saved-headers'.
2317 ;; !!! Magic! The saving functions all save
2318 ;; `gnus-save-article-buffer' (or so they think), but we
2319 ;; bind that variable to our save-buffer.
2334 function group headers variable)
2337 result)
2342 default-name)
2344 default-name)
2353 gnus-number-of-articles-to-be-saved)
2356 ;; Let the split methods have their say.
2358 ;; No split name was found.
2364 default-name))
2365 ;; A single group name is returned.
2374 default-name))
2375 ;; A single split name was found
2385 dir name)))
2386 ;; A list of splits was found.
2396 gnus-article-save-directory
2398 gnus-article-save-directory)))
2400 ;; Create the directory.
2402 ;; If we have read a directory, we append the default file name.
2406 ;; Possibly translate some characters.
2419 "If GROUP is an nndoc group, return the name of the parent group."
2424 "Append this article to Rmail file.
2425 Optional argument FILENAME specifies file name.
2426 Directory to save to is default to `gnus-article-save-directory'."
2428 "Save %s in rmail file:" filename
2429 gnus-rmail-save-name gnus-newsgroup-name
2436 filename)
2439 "Append this article to Unix mail file.
2440 Optional argument FILENAME specifies file name.
2441 Directory to save to is default to `gnus-article-save-directory'."
2443 "Save %s in Unix mail file:" filename
2444 gnus-mail-save-name gnus-newsgroup-name
2454 filename)
2457 "Append this article to file.
2458 Optional argument FILENAME specifies file name.
2459 Directory to save to is default to `gnus-article-save-directory'."
2461 "Save %s in file:" filename
2462 gnus-file-save-name gnus-newsgroup-name
2472 filename)
2475 "Write this article to a file.
2476 Optional argument FILENAME specifies file name.
2477 The directory to save in defaults to `gnus-article-save-directory'."
2481 "Append this article body to a file.
2482 Optional argument FILENAME specifies file name.
2483 The directory to save in defaults to `gnus-article-save-directory'."
2485 "Save %s body in file:" filename
2486 gnus-file-save-name gnus-newsgroup-name
2495 filename)
2498 "Pipe this article to subprocess."
2501 gnus-last-shell-command)
2502 gnus-last-shell-command)
2504 command)
2507 "Shell command on %s: "
2511 gnus-number-of-articles-to-be-saved)
2513 gnus-last-shell-command))))
2524 ;;; Article file names when saving.
2527 "Capitalize NEWSGROUP name."
2533 "Generate file name from NEWSGROUP, HEADERS, and optional LAST-FILE.
2534 If variable `gnus-use-long-file-name' is non-nil, it is ~/News/News.group/num.
2535 Otherwise, it is like ~/News/news/group/num."
2542 gnus-article-save-directory)))
2547 default
2551 "Generate file name from NEWSGROUP, HEADERS, and optional LAST-FILE.
2552 If variable `gnus-use-long-file-name' is non-nil, it is
2553 ~/News/news.group/num. Otherwise, it is like ~/News/news/group/num."
2557 newsgroup
2560 gnus-article-save-directory)))
2565 default
2569 "Generate file name from NEWSGROUP, HEADERS, and optional LAST-FILE.
2570 If variable `gnus-use-long-file-name' is non-nil, it is
2571 ~/News/news.group. Otherwise, it is like ~/News/news/group/news."
2575 newsgroup
2577 gnus-article-save-directory)))
2599 article-hide-boring-headers
2600 article-treat-overstrike
2601 article-fill-long-lines
2602 article-capitalize-sentences
2603 article-remove-cr
2604 article-display-x-face
2605 article-de-quoted-unreadable
2606 article-de-base64-unreadable
2607 article-decode-HZ
2608 article-wash-html
2609 article-hide-list-identifiers
2610 article-hide-pgp
2611 article-strip-banner
2612 article-babel
2613 article-hide-pem
2614 article-hide-signature
2615 article-strip-headers-in-body
2616 article-remove-trailing-blank-lines
2617 article-strip-leading-blank-lines
2618 article-strip-multiple-blank-lines
2619 article-strip-leading-space
2620 article-strip-trailing-space
2621 article-strip-blank-lines
2622 article-strip-all-blank-lines
2623 article-date-local
2624 article-date-iso8601
2625 article-date-original
2626 article-date-ut
2627 article-decode-mime-words
2628 article-decode-charset
2629 article-decode-encoded-words
2630 article-date-user
2631 article-date-lapsed
2632 article-emphasize
2633 article-treat-dumbquotes
2634 article-normalize-headers
2636 \f
2637 ;;;
2638 ;;; Gnus article mode
2639 ;;;
2646 " " gnus-article-goto-next-page
2648 [delete] gnus-article-goto-prev-page
2649 [backspace] gnus-article-goto-prev-page
2650 "\C-c^" gnus-article-refer-article
2651 "h" gnus-article-show-summary
2652 "s" gnus-article-show-summary
2653 "\C-c\C-m" gnus-article-mail
2654 "?" gnus-article-describe-briefly
2655 "e" gnus-summary-edit-article
2656 "<" beginning-of-buffer
2657 ">" end-of-buffer
2658 "\C-c\C-i" gnus-info-find-node
2659 "\C-c\C-b" gnus-bug
2660 "\C-hk" gnus-article-describe-key
2661 "\C-hc" gnus-article-describe-key-briefly
2663 "\C-d" gnus-article-read-summary-keys
2664 "\M-*" gnus-article-read-summary-keys
2665 "\M-#" gnus-article-read-summary-keys
2666 "\M-^" gnus-article-read-summary-keys
2667 "\M-g" gnus-article-read-summary-keys)
2669 (substitute-key-definition
2670 'undefined 'gnus-article-read-summary-keys gnus-article-mode-map)
2672 (defvar gnus-article-post-menu nil)
2674 (defun gnus-article-make-menu-bar ()
2675 (gnus-turn-off-edit-menu 'article)
2676 (unless (boundp 'gnus-article-article-menu)
2677 (easy-menu-define
2678 gnus-article-article-menu gnus-article-mode-map ""
2679 '("Article"
2680 ["Scroll forwards" gnus-article-goto-next-page t]
2681 ["Scroll backwards" gnus-article-goto-prev-page t]
2682 ["Show summary" gnus-article-show-summary t]
2683 ["Fetch Message-ID at point" gnus-article-refer-article t]
2684 ["Mail to address at point" gnus-article-mail t]
2685 ["Send a bug report" gnus-bug t]))
2687 (easy-menu-define
2688 gnus-article-treatment-menu gnus-article-mode-map ""
2689 ;; Fixme: this should use :active (and maybe :visible).
2690 '("Treatment"
2691 ["Hide headers" gnus-article-hide-headers t]
2692 ["Hide signature" gnus-article-hide-signature t]
2693 ["Hide citation" gnus-article-hide-citation t]
2694 ["Treat overstrike" gnus-article-treat-overstrike t]
2695 ["Remove carriage return" gnus-article-remove-cr t]
2696 ["Remove quoted-unreadable" gnus-article-de-quoted-unreadable t]
2697 ["Remove base64" gnus-article-de-base64-unreadable t]
2698 ["Treat html" gnus-article-wash-html t]
2699 ["Decode HZ" gnus-article-decode-HZ t]))
2701 ;; Note "Commands" menu is defined in gnus-sum.el for consistency
2703 (when (boundp 'gnus-summary-post-menu)
2704 (cond
2705 ((not (keymapp gnus-summary-post-menu))
2706 (setq gnus-article-post-menu gnus-summary-post-menu))
2707 ((not gnus-article-post-menu)
2708 ;; Don't share post menu.
2709 (setq gnus-article-post-menu
2710 (copy-keymap gnus-summary-post-menu))))
2711 (define-key gnus-article-mode-map [menu-bar post]
2712 (cons "Post" gnus-article-post-menu)))
2714 (gnus-run-hooks 'gnus-article-menu-hook)))
2716 ;; Fixme: do something for the Emacs tool bar in Article mode a la
2717 ;; Summary.
2719 (defun gnus-article-mode ()
2720 "Major mode for displaying an article.
2722 All normal editing commands are switched off.
2724 The following commands are available in addition to all summary mode
2725 commands:
2734 (interactive)
2735 (gnus-simplify-mode-line)
2736 (setq mode-name "Article")
2737 (setq major-mode 'gnus-article-mode)
2738 (make-local-variable 'minor-mode-alist)
2739 (use-local-map gnus-article-mode-map)
2740 (when (gnus-visual-p 'article-menu 'menu)
2741 (gnus-article-make-menu-bar))
2742 (gnus-update-format-specifications nil 'article-mode)
2743 (set (make-local-variable 'page-delimiter) gnus-page-delimiter)
2744 (make-local-variable 'gnus-page-broken)
2745 (make-local-variable 'gnus-button-marker-list)
2746 (make-local-variable 'gnus-article-current-summary)
2747 (make-local-variable 'gnus-article-mime-handles)
2748 (make-local-variable 'gnus-article-decoded-p)
2749 (make-local-variable 'gnus-article-mime-handle-alist)
2750 (make-local-variable 'gnus-article-wash-types)
2751 (gnus-set-default-directory)
2752 (buffer-disable-undo)
2753 (setq buffer-read-only t)
2754 (set-syntax-table gnus-article-mode-syntax-table)
2755 (mm-enable-multibyte)
2756 (gnus-run-hooks 'gnus-article-mode-hook))
2758 (defun gnus-article-setup-buffer ()
2759 "Initialize the article buffer."
2760 (let* ((name (if gnus-single-article-buffer "*Article*"
2761 (concat "*Article " gnus-newsgroup-name "*")))
2762 (original
2764 (concat " *Original Article"
2765 (substring name (match-end 0))))))
2766 (setq gnus-article-buffer name)
2767 (setq gnus-original-article-buffer original)
2768 (setq gnus-article-mime-handle-alist nil)
2769 ;; This might be a variable local to the summary buffer.
2770 (unless gnus-single-article-buffer
2771 (save-excursion
2772 (set-buffer gnus-summary-buffer)
2773 (setq gnus-article-buffer name)
2774 (setq gnus-original-article-buffer original)
2775 (gnus-set-global-variables)))
2776 (gnus-article-setup-highlight-words)
2777 ;; Init original article buffer.
2778 (save-excursion
2779 (set-buffer (gnus-get-buffer-create gnus-original-article-buffer))
2780 (mm-enable-multibyte)
2781 (setq major-mode 'gnus-original-article-mode)
2782 (make-local-variable 'gnus-original-article))
2783 (if (get-buffer name)
2784 (save-excursion
2785 (set-buffer name)
2786 (when gnus-article-mime-handles
2787 (mm-destroy-parts gnus-article-mime-handles)
2788 (setq gnus-article-mime-handles nil))
2789 ;; Set it to nil in article-buffer!
2790 (setq gnus-article-mime-handle-alist nil)
2791 (buffer-disable-undo)
2792 (setq buffer-read-only t)
2793 (unless (eq major-mode 'gnus-article-mode)
2794 (gnus-article-mode))
2795 (current-buffer))
2796 (save-excursion
2797 (set-buffer (gnus-get-buffer-create name))
2798 (gnus-article-mode)
2799 (make-local-variable 'gnus-summary-buffer)
2800 (gnus-summary-set-local-parameters gnus-newsgroup-name)
2801 (current-buffer)))))
2803 ;; Set article window start at LINE, where LINE is the number of lines
2804 ;; from the head of the article.
2805 (defun gnus-article-set-window-start (&optional line)
2806 (set-window-start
2807 (get-buffer-window gnus-article-buffer t)
2808 (save-excursion
2809 (set-buffer gnus-article-buffer)
2810 (goto-char (point-min))
2811 (if (not line)
2812 (point-min)
2813 (gnus-message 6 "Moved to bookmark")
2815 (forward-line line)
2816 (point)))))
2818 (defun gnus-article-prepare (article &optional all-headers header)
2819 "Prepare ARTICLE in article mode buffer.
2820 ARTICLE should either be an article number or a Message-ID.
2821 If ARTICLE is an id, HEADER should be the article headers.
2822 If ALL-HEADERS is non-nil, no headers are hidden."
2823 (save-excursion
2824 ;; Make sure we start in a summary buffer.
2825 (unless (eq major-mode 'gnus-summary-mode)
2826 (set-buffer gnus-summary-buffer))
2827 (setq gnus-summary-buffer (current-buffer))
2828 (let* ((gnus-article (if header (mail-header-number header) article))
2829 (summary-buffer (current-buffer))
2830 (gnus-tmp-internal-hook gnus-article-internal-prepare-hook)
2831 (group gnus-newsgroup-name)
2832 result)
2833 (save-excursion
2834 (gnus-article-setup-buffer)
2835 (set-buffer gnus-article-buffer)
2836 ;; Deactivate active regions.
2837 (when (and (boundp 'transient-mark-mode)
2838 transient-mark-mode)
2839 (setq mark-active nil))
2840 (if (not (setq result (let ((inhibit-read-only t))
2841 (gnus-request-article-this-buffer
2842 article group))))
2843 ;; There is no such article.
2844 (save-excursion
2845 (when (and (numberp article)
2846 (not (memq article gnus-newsgroup-sparse)))
2847 (setq gnus-article-current
2848 (cons gnus-newsgroup-name article))
2849 (set-buffer gnus-summary-buffer)
2850 (setq gnus-current-article article)
2851 (if (eq (gnus-article-mark article) gnus-undownloaded-mark)
2852 (progn
2853 (gnus-summary-set-agent-mark article)
2854 (message "Message marked for downloading"))
2855 (gnus-summary-mark-article article gnus-canceled-mark)
2856 (unless (memq article gnus-newsgroup-sparse)
2857 (gnus-error 1 "No such article (may have expired or been canceled)")))))
2858 (if (or (eq result 'pseudo)
2859 (eq result 'nneething))
2860 (progn
2861 (save-excursion
2862 (set-buffer summary-buffer)
2863 (push article gnus-newsgroup-history)
2864 (setq gnus-last-article gnus-current-article
2865 gnus-current-article 0
2866 gnus-current-headers nil
2867 gnus-article-current nil)
2868 (if (eq result 'nneething)
2869 (gnus-configure-windows 'summary)
2870 (gnus-configure-windows 'article))
2871 (gnus-set-global-variables))
2872 (let ((gnus-article-mime-handle-alist-1
2873 gnus-article-mime-handle-alist))
2874 (gnus-set-mode-line 'article)))
2875 ;; The result from the `request' was an actual article -
2876 ;; or at least some text that is now displayed in the
2877 ;; article buffer.
2878 (when (and (numberp article)
2879 (not (eq article gnus-current-article)))
2880 ;; Seems like a new article has been selected.
2881 ;; `gnus-current-article' must be an article number.
2882 (save-excursion
2883 (set-buffer summary-buffer)
2884 (push article gnus-newsgroup-history)
2885 (setq gnus-last-article gnus-current-article
2886 gnus-current-article article
2887 gnus-current-headers
2888 (gnus-summary-article-header gnus-current-article)
2889 gnus-article-current
2890 (cons gnus-newsgroup-name gnus-current-article))
2891 (unless (vectorp gnus-current-headers)
2892 (setq gnus-current-headers nil))
2893 (gnus-summary-goto-subject gnus-current-article)
2894 (when (gnus-summary-show-thread)
2895 ;; If the summary buffer really was folded, the
2896 ;; previous goto may not actually have gone to
2897 ;; the right article, but the thread root instead.
2898 ;; So we go again.
2899 (gnus-summary-goto-subject gnus-current-article))
2900 (gnus-run-hooks 'gnus-mark-article-hook)
2901 (gnus-set-mode-line 'summary)
2902 (when (gnus-visual-p 'article-highlight 'highlight)
2903 (gnus-run-hooks 'gnus-visual-mark-article-hook))
2904 ;; Set the global newsgroup variables here.
2905 (gnus-set-global-variables)
2906 (setq gnus-have-all-headers
2907 (or all-headers gnus-show-all-headers))))
2908 (save-excursion
2909 (gnus-configure-windows 'article))
2910 (when (or (numberp article)
2911 (stringp article))
2912 (gnus-article-prepare-display)
2913 ;; Do page break.
2914 (goto-char (point-min))
2915 (setq gnus-page-broken
2916 (when gnus-break-pages
2917 (gnus-narrow-to-page)
2918 t)))
2919 (let ((gnus-article-mime-handle-alist-1
2920 gnus-article-mime-handle-alist))
2921 (gnus-set-mode-line 'article))
2922 (article-goto-body)
2923 (set-window-point (get-buffer-window (current-buffer)) (point))
2924 (gnus-configure-windows 'article)
2925 t))))))
2927 ;;;###autoload
2928 (defun gnus-article-prepare-display ()
2929 "Make the current buffer look like a nice article."
2930 ;; Hooks for getting information from the article.
2931 ;; This hook must be called before being narrowed.
2932 (let ((gnus-article-buffer (current-buffer))
2933 buffer-read-only)
2934 (unless (eq major-mode 'gnus-article-mode)
2935 (gnus-article-mode))
2936 (setq buffer-read-only nil
2937 gnus-article-wash-types nil)
2938 (gnus-run-hooks 'gnus-tmp-internal-hook)
2939 (when gnus-display-mime-function
2940 (funcall gnus-display-mime-function))
2941 (gnus-run-hooks 'gnus-article-prepare-hook)))
2943 ;;;
2944 ;;; Gnus MIME viewing functions
2945 ;;;
2948 "The following specs can be used:
2949 %t The MIME type
2950 %T MIME type, along with additional info
2951 %n The `name' parameter
2952 %d The description, if any
2953 %l The length of the encoded part
2954 %p The part identifier number
2955 %e Dots if the part isn't displayed")
2957 (defvar gnus-mime-button-line-format-alist
2958 '((?t gnus-tmp-type ?s)
2959 (?T gnus-tmp-type-long ?s)
2960 (?n gnus-tmp-name ?s)
2961 (?d gnus-tmp-description ?s)
2962 (?p gnus-tmp-id ?s)
2963 (?l gnus-tmp-length ?d)
2964 (?e gnus-tmp-dots ?s)))
2966 (defvar gnus-mime-button-commands
2968 (gnus-mime-view-part "v" "View Interactively...")
2969 (gnus-mime-view-part-as-type "t" "View As Type...")
2970 (gnus-mime-save-part "o" "Save...")
2971 (gnus-mime-copy-part "c" "View As Text, In Other Buffer")
2972 (gnus-mime-inline-part "i" "View As Text, In This Buffer")
2973 (gnus-mime-internalize-part "E" "View Internally")
2974 (gnus-mime-externalize-part "e" "View Externally")
2975 (gnus-mime-pipe-part "|" "Pipe To Command...")
2976 (gnus-mime-action-on-part "." "Take action on the part")))
2978 (defun gnus-article-mime-part-status ()
2979 (if gnus-article-mime-handle-alist-1
2980 (format " (%d parts)" (length gnus-article-mime-handle-alist-1))
2981 ""))
2983 (defvar gnus-mime-button-map
2984 (let ((map (make-sparse-keymap)))
2985 ;; Not for Emacs 21: fixme better.
2986 ;; (set-keymap-parent map gnus-article-mode-map)
2987 (define-key map gnus-mouse-2 'gnus-article-push-button)
2988 (define-key map gnus-down-mouse-3 'gnus-mime-button-menu)
2989 (dolist (c gnus-mime-button-commands)
2990 (define-key map (cadr c) (car c)))
2991 map))
2993 (defun gnus-mime-button-menu (event)
2994 "Construct a context-sensitive menu of MIME commands."
2995 (interactive "e")
2996 (save-excursion
2997 (mouse-set-point event)
2998 (gnus-article-check-buffer)
2999 (let ((response (x-popup-menu
3000 t `("MIME Part"
3001 ("" ,@(mapcar (lambda (c)
3002 (cons (caddr c) (car c)))
3003 gnus-mime-button-commands))))))
3004 (if response
3005 (call-interactively response)))))
3007 (defun gnus-mime-view-all-parts (&optional handles)
3008 "View all the MIME parts."
3009 (interactive)
3010 (save-current-buffer
3011 (set-buffer gnus-article-buffer)
3012 (let ((handles (or handles gnus-article-mime-handles))
3013 (mail-parse-charset gnus-newsgroup-charset)
3014 (mail-parse-ignored-charsets
3015 (save-excursion (set-buffer gnus-summary-buffer)
3016 gnus-newsgroup-ignored-charsets)))
3017 (if (stringp (car handles))
3018 (gnus-mime-view-all-parts (cdr handles))
3019 (mapcar 'mm-display-part handles)))))
3021 (defun gnus-mime-save-part ()
3022 "Save the MIME part under point."
3023 (interactive)
3024 (gnus-article-check-buffer)
3025 (let ((data (get-text-property (point) 'gnus-data)))
3026 (mm-save-part data)))
3028 (defun gnus-mime-pipe-part ()
3029 "Pipe the MIME part under point to a process."
3030 (interactive)
3031 (gnus-article-check-buffer)
3032 (let ((data (get-text-property (point) 'gnus-data)))
3033 (mm-pipe-part data)))
3035 (defun gnus-mime-view-part ()
3036 "Interactively choose a viewing method for the MIME part under point."
3037 (interactive)
3038 (gnus-article-check-buffer)
3039 (let ((data (get-text-property (point) 'gnus-data)))
3040 (push (setq data (copy-sequence data)) gnus-article-mime-handles)
3041 (mm-interactively-view-part data)))
3043 (defun gnus-mime-view-part-as-type-internal ()
3044 (gnus-article-check-buffer)
3045 (let* ((name (mail-content-type-get
3046 (mm-handle-type (get-text-property (point) 'gnus-data))
3047 'name))
3048 (def-type (and name (mm-default-file-encoding name))))
3049 (and def-type (cons def-type 0))))
3051 (defun gnus-mime-view-part-as-type (mime-type)
3052 "Choose a MIME media type, and view the part as such."
3053 (interactive
3054 (list (completing-read
3055 "View as MIME type: "
3056 (mapcar #'list (mailcap-mime-types))
3057 nil nil
3058 (gnus-mime-view-part-as-type-internal))))
3059 (gnus-article-check-buffer)
3060 (let ((handle (get-text-property (point) 'gnus-data)))
3061 (gnus-mm-display-part
3062 (mm-make-handle (mm-handle-buffer handle)
3063 (cons mime-type (cdr (mm-handle-type handle)))
3064 (mm-handle-encoding handle)
3065 (mm-handle-undisplayer handle)
3066 (mm-handle-disposition handle)
3067 (mm-handle-description handle)
3068 (mm-handle-cache handle)
3069 (mm-handle-id handle)))))
3071 (defun gnus-mime-copy-part (&optional handle)
3072 "Put the MIME part under point into a new buffer."
3073 (interactive)
3074 (gnus-article-check-buffer)
3075 (let* ((handle (or handle (get-text-property (point) 'gnus-data)))
3076 (contents (mm-get-part handle))
3077 (base (file-name-nondirectory
3078 (or
3079 (mail-content-type-get (mm-handle-type handle) 'name)
3080 (mail-content-type-get (mm-handle-type handle)
3081 'filename)
3082 "*decoded*")))
3083 (buffer (generate-new-buffer base)))
3084 (switch-to-buffer buffer)
3085 (insert contents)
3086 ;; We do it this way to make `normal-mode' set the appropriate mode.
3087 (unwind-protect
3088 (progn
3089 (setq buffer-file-name (expand-file-name base))
3090 (normal-mode))
3091 (setq buffer-file-name nil))
3092 (goto-char (point-min))))
3094 (defun gnus-mime-inline-part (&optional handle arg)
3095 "Insert the MIME part under point into the current buffer."
3096 (interactive (list nil current-prefix-arg))
3097 (gnus-article-check-buffer)
3098 (let* ((handle (or handle (get-text-property (point) 'gnus-data)))
3099 contents charset
3100 (b (point))
3101 buffer-read-only)
3102 (if (mm-handle-undisplayer handle)
3103 (mm-remove-part handle)
3104 (setq contents (mm-get-part handle))
3105 (cond
3106 ((not arg)
3107 (setq charset (or (mail-content-type-get
3108 (mm-handle-type handle) 'charset)
3109 gnus-newsgroup-charset)))
3110 ((numberp arg)
3111 (setq charset
3112 (or (cdr (assq arg
3113 gnus-summary-show-article-charset-alist))
3114 (read-coding-system "Charset: ")))))
3115 (forward-line 2)
3116 (mm-insert-inline handle
3117 (if (and charset
3118 (setq charset (mm-charset-to-coding-system
3119 charset))
3120 (not (eq charset 'ascii)))
3121 (mm-decode-coding-string contents charset)
3122 contents))
3123 (goto-char b))))
3125 (defun gnus-mime-externalize-part (&optional handle)
3126 "View the MIME part under point with an external viewer."
3127 (interactive)
3128 (gnus-article-check-buffer)
3129 (let* ((handle (or handle (get-text-property (point) 'gnus-data)))
3130 (mm-user-display-methods nil)
3131 (mm-inlined-types nil)
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-internalize-part (&optional handle)
3141 "View the MIME part under point with an internal viewer.
3142 In no internal viewer is available, use an external viewer."
3143 (interactive)
3144 (gnus-article-check-buffer)
3145 (let* ((handle (or handle (get-text-property (point) 'gnus-data)))
3146 (mm-inlined-types '(".*"))
3147 (mm-inline-large-images t)
3148 (mail-parse-charset gnus-newsgroup-charset)
3149 (mail-parse-ignored-charsets
3150 (save-excursion (set-buffer gnus-summary-buffer)
3151 gnus-newsgroup-ignored-charsets)))
3152 (if (mm-handle-undisplayer handle)
3153 (mm-remove-part handle)
3154 (mm-display-part handle))))
3156 (defun gnus-mime-action-on-part (&optional action)
3157 "Do something with the MIME attachment at \(point\)."
3158 (interactive
3159 (list (completing-read "Action: " gnus-mime-action-alist)))
3160 (gnus-article-check-buffer)
3161 (let ((action-pair (assoc action gnus-mime-action-alist)))
3162 (if action-pair
3163 (funcall (cdr action-pair)))))
3166 (defun gnus-article-part-wrapper (n function)
3167 (save-current-buffer
3168 (set-buffer gnus-article-buffer)
3169 (when (> n (length gnus-article-mime-handle-alist))
3170 (error "No such part"))
3171 (gnus-article-goto-part n)
3172 (let ((handle (cdr (assq n gnus-article-mime-handle-alist))))
3173 (funcall function handle))))
3175 (defun gnus-article-pipe-part (n)
3176 "Pipe MIME part N, which is the numerical prefix."
3177 (interactive "p")
3178 (gnus-article-part-wrapper n 'mm-pipe-part))
3180 (defun gnus-article-save-part (n)
3181 "Save MIME part N, which is the numerical prefix."
3182 (interactive "p")
3183 (gnus-article-part-wrapper n 'mm-save-part))
3185 (defun gnus-article-interactively-view-part (n)
3186 "View MIME part N interactively, which is the numerical prefix."
3187 (interactive "p")
3188 (gnus-article-part-wrapper n 'mm-interactively-view-part))
3190 (defun gnus-article-copy-part (n)
3191 "Copy MIME part N, which is the numerical prefix."
3192 (interactive "p")
3193 (gnus-article-part-wrapper n 'gnus-mime-copy-part))
3195 (defun gnus-article-externalize-part (n)
3196 "View MIME part N externally, which is the numerical prefix."
3197 (interactive "p")
3198 (gnus-article-part-wrapper n 'gnus-mime-externalize-part))
3200 (defun gnus-article-inline-part (n)
3201 "Inline MIME part N, which is the numerical prefix."
3202 (interactive "p")
3203 (gnus-article-part-wrapper n 'gnus-mime-inline-part))
3205 (defun gnus-article-mime-match-handle-first (condition)
3206 (if condition
3207 (let ((alist gnus-article-mime-handle-alist) ihandle n)
3208 (while (setq ihandle (pop alist))
3209 (if (and (cond
3210 ((functionp condition)
3211 (funcall condition (cdr ihandle)))
3212 ((eq condition 'undisplayed)
3213 (not (or (mm-handle-undisplayer (cdr ihandle))
3214 (equal (mm-handle-media-type (cdr ihandle))
3215 "multipart/alternative"))))
3216 ((eq condition 'undisplayed-alternative)
3217 (not (mm-handle-undisplayer (cdr ihandle))))
3218 (t t))
3219 (gnus-article-goto-part (car ihandle))
3220 (or (not n) (< (car ihandle) n)))
3221 (setq n (car ihandle))))
3222 (or n 1))
3223 1))
3225 (defun gnus-article-view-part (&optional n)
3226 "View MIME part N, which is the numerical prefix."
3227 (interactive "P")
3228 (save-current-buffer
3229 (set-buffer gnus-article-buffer)
3230 (or (numberp n) (setq n (gnus-article-mime-match-handle-first
3231 gnus-article-mime-match-handle-function)))
3232 (when (> n (length gnus-article-mime-handle-alist))
3233 (error "No such part"))
3234 (let ((handle (cdr (assq n gnus-article-mime-handle-alist))))
3235 (when (gnus-article-goto-part n)
3236 (if (equal (car handle) "multipart/alternative")
3237 (gnus-article-press-button)
3238 (when (eq (gnus-mm-display-part handle) 'internal)
3239 (gnus-set-window-start)))))))
3241 (defsubst gnus-article-mime-total-parts ()
3242 (if (bufferp (car gnus-article-mime-handles))
3243 1 ;; single part
3244 (1- (length gnus-article-mime-handles))))
3246 (defun gnus-mm-display-part (handle)
3247 "Display HANDLE and fix MIME button."
3248 (let ((id (get-text-property (point) 'gnus-part))
3249 (point (point))
3250 buffer-read-only)
3251 (forward-line 1)
3252 (prog1
3253 (let ((window (selected-window))
3254 (mail-parse-charset gnus-newsgroup-charset)
3255 (mail-parse-ignored-charsets
3256 (save-excursion (set-buffer gnus-summary-buffer)
3257 gnus-newsgroup-ignored-charsets)))
3258 (save-excursion
3259 (unwind-protect
3260 (let ((win (get-buffer-window (current-buffer) t))
3261 (beg (point)))
3262 (when win
3263 (select-window win))
3264 (goto-char point)
3265 (forward-line)
3266 (if (mm-handle-displayed-p handle)
3267 ;; This will remove the part.
3268 (mm-display-part handle)
3269 (save-restriction
3270 (narrow-to-region (point) (1+ (point)))
3271 (mm-display-part handle)
3272 ;; We narrow to the part itself and
3273 ;; then call the treatment functions.
3274 (goto-char (point-min))
3275 (forward-line 1)
3276 (narrow-to-region (point) (point-max))
3277 (gnus-treat-article
3278 nil id
3279 (gnus-article-mime-total-parts)
3280 (mm-handle-media-type handle)))))
3281 (select-window window))))
3282 (goto-char point)
3283 (delete-region (gnus-point-at-bol) (progn (forward-line 1) (point)))
3284 (gnus-insert-mime-button
3285 handle id (list (mm-handle-displayed-p handle)))
3286 (goto-char point))))
3288 (defun gnus-article-goto-part (n)
3289 "Go to MIME part N."
3290 (let ((point (text-property-any (point-min) (point-max) 'gnus-part n)))
3291 (when point
3292 (goto-char point))))
3294 (defun gnus-insert-mime-button (handle gnus-tmp-id &optional displayed)
3295 (let ((gnus-tmp-name
3296 (or (mail-content-type-get (mm-handle-type handle)
3297 'name)
3298 (mail-content-type-get (mm-handle-disposition handle)
3299 'filename)
3300 ""))
3301 (gnus-tmp-type (mm-handle-media-type handle))
3302 (gnus-tmp-description
3303 (mail-decode-encoded-word-string (or (mm-handle-description handle)
3304 "")))
3305 (gnus-tmp-dots
3306 (if (if displayed (car displayed)
3307 (mm-handle-displayed-p handle))
3308 "" "..."))
3309 (gnus-tmp-length (with-current-buffer (mm-handle-buffer handle)
3310 (buffer-size)))
3311 gnus-tmp-type-long b e)
3312 (when (string-match ".*/" gnus-tmp-name)
3313 (setq gnus-tmp-name (replace-match "" t t gnus-tmp-name)))
3314 (setq gnus-tmp-type-long (concat gnus-tmp-type
3315 (and (not (equal gnus-tmp-name ""))
3316 (concat "; " gnus-tmp-name))))
3317 (or (equal gnus-tmp-description "")
3318 (setq gnus-tmp-type-long (concat " --- " gnus-tmp-type-long)))
3319 (unless (bolp)
3321 (setq b (point))
3322 (gnus-eval-format
3323 gnus-mime-button-line-format gnus-mime-button-line-format-alist
3324 `(keymap ,gnus-mime-button-map
3325 ;; Not for Emacs 21: fixme better.
3326 ;; local-map ,gnus-mime-button-map
3327 gnus-callback gnus-mm-display-part
3328 gnus-part ,gnus-tmp-id
3329 article-type annotation
3330 gnus-data ,handle))
3331 (setq e (point))
3332 (widget-convert-button
3333 'link b e
3334 :mime-handle handle
3335 :action 'gnus-widget-press-button
3336 :button-keymap gnus-mime-button-map
3337 :help-echo
3338 (lambda (widget/window &optional overlay pos)
3339 ;; Needed to properly clear the message due to a bug in
3340 ;; wid-edit (XEmacs only).
3341 (if (boundp 'help-echo-owns-message)
3342 (setq help-echo-owns-message t))
3343 (format
3344 "%S: %s the MIME part; %S: more options"
3345 (aref gnus-mouse-2 0)
3346 ;; XEmacs will get a single widget arg; Emacs 21 will get
3347 ;; window, overlay, position.
3348 (if (mm-handle-displayed-p
3349 (if overlay
3350 (with-current-buffer (gnus-overlay-buffer overlay)
3351 (widget-get (widget-at (gnus-overlay-start overlay))
3352 :mime-handle))
3353 (widget-get widget/window :mime-handle)))
3354 "hide" "show")
3355 (aref gnus-down-mouse-3 0))))))
3357 (defun gnus-widget-press-button (elems el)
3358 (goto-char (widget-get elems :from))
3359 (gnus-article-press-button))
3361 (defvar gnus-displaying-mime nil)
3363 (defun gnus-display-mime (&optional ihandles)
3364 "Display the MIME parts."
3365 (save-excursion
3366 (save-selected-window
3367 (let ((window (get-buffer-window gnus-article-buffer))
3368 (point (point)))
3369 (when window
3370 (select-window window)
3371 ;; We have to do this since selecting the window
3372 ;; may change the point. So we set the window point.
3373 (set-window-point window point)))
3374 (let* ((handles (or ihandles (mm-dissect-buffer) (mm-uu-dissect)))
3375 buffer-read-only handle name type b e display)
3376 (when (and (not ihandles)
3377 (not gnus-displaying-mime))
3378 ;; Top-level call; we clean up.
3379 (when gnus-article-mime-handles
3380 (mm-destroy-parts gnus-article-mime-handles)
3381 (setq gnus-article-mime-handle-alist nil));; A trick.
3382 (setq gnus-article-mime-handles handles)
3383 ;; We allow users to glean info from the handles.
3384 (when gnus-article-mime-part-function
3385 (gnus-mime-part-function handles)))
3386 (if (and handles
3387 (or (not (stringp (car handles)))
3388 (cdr handles)))
3389 (progn
3390 (when (and (not ihandles)
3391 (not gnus-displaying-mime))
3392 ;; Clean up for mime parts.
3393 (article-goto-body)
3394 (delete-region (point) (point-max)))
3395 (let ((gnus-displaying-mime t))
3396 (gnus-mime-display-part handles)))
3397 (save-restriction
3398 (article-goto-body)
3399 (narrow-to-region (point) (point-max))
3400 (gnus-treat-article nil 1 1)
3401 (widen)))
3402 (unless ihandles
3403 ;; Highlight the headers.
3404 (save-excursion
3405 (save-restriction
3406 (article-goto-body)
3407 (narrow-to-region (point-min) (point))
3408 (gnus-treat-article 'head))))))))
3410 (defvar gnus-mime-display-multipart-as-mixed nil)
3412 (defun gnus-mime-display-part (handle)
3413 (cond
3414 ;; Single part.
3415 ((not (stringp (car handle)))
3416 (gnus-mime-display-single handle))
3417 ;; User-defined multipart
3418 ((cdr (assoc (car handle) gnus-mime-multipart-functions))
3419 (funcall (cdr (assoc (car handle) gnus-mime-multipart-functions))
3420 handle))
3421 ;; multipart/alternative
3422 ((and (equal (car handle) "multipart/alternative")
3423 (not gnus-mime-display-multipart-as-mixed))
3424 (let ((id (1+ (length gnus-article-mime-handle-alist))))
3425 (push (cons id handle) gnus-article-mime-handle-alist)
3426 (gnus-mime-display-alternative (cdr handle) nil nil id)))
3427 ;; multipart/related
3428 ((and (equal (car handle) "multipart/related")
3429 (not gnus-mime-display-multipart-as-mixed))
3430 ;;;!!!We should find the start part, but we just default
3431 ;;;!!!to the first part.
3432 (gnus-mime-display-part (cadr handle)))
3433 ;; Other multiparts are handled like multipart/mixed.
3434 (t
3435 (gnus-mime-display-mixed (cdr handle)))))
3437 (defun gnus-mime-part-function (handles)
3438 (if (stringp (car handles))
3439 (mapcar 'gnus-mime-part-function (cdr handles))
3440 (funcall gnus-article-mime-part-function handles)))
3442 (defun gnus-mime-display-mixed (handles)
3443 (mapcar 'gnus-mime-display-part handles))
3445 (defun gnus-mime-display-single (handle)
3446 (let ((type (mm-handle-media-type handle))
3447 (ignored gnus-ignored-mime-types)
3448 (not-attachment t)
3449 (move nil)
3450 display text)
3451 (catch 'ignored
3452 (progn
3453 (while ignored
3454 (when (string-match (pop ignored) type)
3455 (throw 'ignored nil)))
3456 (if (and (setq not-attachment
3457 (and (not (mm-inline-override-p handle))
3458 (or (not (mm-handle-disposition handle))
3459 (equal (car (mm-handle-disposition handle))
3460 "inline")
3461 (mm-attachment-override-p handle))))
3462 (mm-automatic-display-p handle)
3463 (or (mm-inlined-p handle)
3464 (mm-automatic-external-display-p type)))
3465 (setq display t)
3466 (when (equal (mm-handle-media-supertype handle) "text")
3467 (setq text t)))
3468 (let ((id (1+ (length gnus-article-mime-handle-alist)))
3469 beg)
3470 (push (cons id handle) gnus-article-mime-handle-alist)
3471 (when (or (not display)
3472 (not (gnus-unbuttonized-mime-type-p type)))
3473 ;(gnus-article-insert-newline)
3474 (gnus-insert-mime-button
3475 handle id (list (or display (and not-attachment text))))
3476 (gnus-article-insert-newline)
3477 ;(gnus-article-insert-newline)
3478 (setq move t))
3479 (setq beg (point))
3480 (cond
3481 (display
3482 (when move
3483 (forward-line -2)
3484 (setq beg (point)))
3485 (let ((mail-parse-charset gnus-newsgroup-charset)
3486 (mail-parse-ignored-charsets
3487 (save-excursion (condition-case ()
3488 (set-buffer gnus-summary-buffer)
3489 (error))
3490 gnus-newsgroup-ignored-charsets)))
3491 (mm-display-part handle t))
3492 (goto-char (point-max)))
3493 ((and text not-attachment)
3494 (when move
3495 (forward-line -2)
3496 (setq beg (point)))
3497 (gnus-article-insert-newline)
3498 (mm-insert-inline handle (mm-get-part handle))
3499 (goto-char (point-max))))
3500 ;; Do highlighting.
3501 (save-excursion
3502 (save-restriction
3503 (narrow-to-region beg (point))
3504 (gnus-treat-article
3505 nil id
3506 (gnus-article-mime-total-parts)
3507 (mm-handle-media-type handle)))))))))
3509 (defun gnus-unbuttonized-mime-type-p (type)
3510 "Say whether TYPE is to be unbuttonized."
3511 (unless gnus-inhibit-mime-unbuttonizing
3512 (catch 'found
3513 (let ((types gnus-unbuttonized-mime-types))
3514 (while types
3515 (when (string-match (pop types) type)
3516 (throw 'found t)))))))
3518 (defun gnus-article-insert-newline ()
3519 "Insert a newline, but mark it as undeletable."
3520 (gnus-put-text-property
3523 (defun gnus-mime-display-alternative (handles &optional preferred ibegend id)
3524 (let* ((preferred (or preferred (mm-preferred-alternative handles)))
3525 (ihandles handles)
3526 (point (point))
3527 handle buffer-read-only from props begend not-pref)
3528 (save-window-excursion
3529 (save-restriction
3530 (when ibegend
3531 (narrow-to-region (car ibegend)
3532 (or (cdr ibegend)
3533 (progn
3534 (goto-char (car ibegend))
3535 (forward-line 2)
3536 (point))))
3537 (delete-region (point-min) (point-max))
3538 (mm-remove-parts handles))
3539 (setq begend (list (point-marker)))
3540 ;; Do the toggle.
3541 (unless (setq not-pref (cadr (member preferred ihandles)))
3542 (setq not-pref (car ihandles)))
3543 (when (or ibegend
3544 (not (gnus-unbuttonized-mime-type-p
3545 "multipart/alternative")))
3546 (gnus-add-text-properties
3547 (setq from (point))
3548 (progn
3549 (insert (format "%d. " id))
3550 (point))
3551 `(gnus-callback
3552 (lambda (handles)
3553 (unless ,(not ibegend)
3554 (setq gnus-article-mime-handle-alist
3555 ',gnus-article-mime-handle-alist))
3556 (gnus-mime-display-alternative
3557 ',ihandles ',not-pref ',begend ,id))
3558 ;; Not for Emacs 21: fixme better.
3559 ;; local-map ,gnus-mime-button-map
3560 ,gnus-mouse-face-prop ,gnus-article-mouse-face
3561 face ,gnus-article-button-face
3562 keymap ,gnus-mime-button-map
3563 gnus-part ,id
3564 gnus-data ,handle))
3565 (widget-convert-button 'link from (point)
3566 :action 'gnus-widget-press-button
3567 :button-keymap gnus-widget-button-keymap)
3568 ;; Do the handles
3569 (while (setq handle (pop handles))
3570 (gnus-add-text-properties
3571 (setq from (point))
3572 (progn
3573 (insert (format "(%c) %-18s"
3574 (if (equal handle preferred) ?* ? )
3575 (mm-handle-media-type handle)))
3576 (point))
3577 `(gnus-callback
3578 (lambda (handles)
3579 (unless ,(not ibegend)
3580 (setq gnus-article-mime-handle-alist
3581 ',gnus-article-mime-handle-alist))
3582 (gnus-mime-display-alternative
3583 ',ihandles ',handle ',begend ,id))
3584 ;; Not for Emacs 21: fixme better.
3585 ;; local-map ,gnus-mime-button-map
3586 ,gnus-mouse-face-prop ,gnus-article-mouse-face
3587 face ,gnus-article-button-face
3588 keymap ,gnus-mime-button-map
3589 gnus-part ,id
3590 gnus-data ,handle))
3591 (widget-convert-button 'link from (point)
3592 :action 'gnus-widget-press-button
3593 :button-keymap gnus-widget-button-keymap)
3594 (insert " "))
3596 (when preferred
3597 (if (stringp (car preferred))
3598 (gnus-display-mime preferred)
3599 (let ((mail-parse-charset gnus-newsgroup-charset)
3600 (mail-parse-ignored-charsets
3601 (save-excursion (set-buffer gnus-summary-buffer)
3602 gnus-newsgroup-ignored-charsets)))
3603 (mm-display-part preferred)
3604 ;; Do highlighting.
3605 (save-excursion
3606 (save-restriction
3607 (narrow-to-region (car begend) (point-max))
3608 (gnus-treat-article
3609 nil (length gnus-article-mime-handle-alist)
3610 (gnus-article-mime-total-parts)
3611 (mm-handle-media-type handle))))))
3612 (goto-char (point-max))
3613 (setcdr begend (point-marker)))))
3614 (when ibegend
3615 (goto-char point))))
3617 (defun gnus-article-wash-status ()
3618 "Return a string which display status of article washing."
3619 (save-excursion
3620 (set-buffer gnus-article-buffer)
3621 (let ((cite (memq 'cite gnus-article-wash-types))
3622 (headers (memq 'headers gnus-article-wash-types))
3623 (boring (memq 'boring-headers gnus-article-wash-types))
3624 (pgp (memq 'pgp gnus-article-wash-types))
3625 (pem (memq 'pem gnus-article-wash-types))
3626 (signature (memq 'signature gnus-article-wash-types))
3627 (overstrike (memq 'overstrike gnus-article-wash-types))
3628 (emphasis (memq 'emphasis gnus-article-wash-types)))
3629 (format "%c%c%c%c%c%c"
3630 (if cite ?c ? )
3631 (if (or headers boring) ?h ? )
3632 (if (or pgp pem) ?p ? )
3633 (if signature ?s ? )
3634 (if overstrike ?o ? )
3635 (if emphasis ?e ? )))))
3637 (defalias 'gnus-article-hide-headers-if-wanted 'gnus-article-maybe-hide-headers)
3639 (defun gnus-article-maybe-hide-headers ()
3640 "Hide unwanted headers if `gnus-have-all-headers' is nil.
3641 Provided for backwards compatibility."
3642 (when (and (or (not (gnus-buffer-live-p gnus-summary-buffer))
3643 (not (save-excursion (set-buffer gnus-summary-buffer)
3644 gnus-have-all-headers)))
3645 (not gnus-inhibit-hiding))
3646 (gnus-article-hide-headers)))
3648 ;;; Article savers.
3650 (defun gnus-output-to-file (file-name)
3651 "Append the current article to a file named FILE-NAME."
3652 (let ((artbuf (current-buffer)))
3653 (with-temp-buffer
3654 (insert-buffer-substring artbuf)
3655 ;; Append newline at end of the buffer as separator, and then
3656 ;; save it to file.
3657 (goto-char (point-max))
3659 (let ((file-name-coding-system nnmail-pathname-coding-system))
3660 (mm-append-to-file (point-min) (point-max) file-name))
3661 t)))
3663 (defun gnus-narrow-to-page (&optional arg)
3664 "Narrow the article buffer to a page.
3665 If given a numerical ARG, move forward ARG pages."
3666 (interactive "P")
3667 (setq arg (if arg (prefix-numeric-value arg) 0))
3668 (save-excursion
3669 (set-buffer gnus-article-buffer)
3670 (goto-char (point-min))
3671 (widen)
3672 ;; Remove any old next/prev buttons.
3673 (when (gnus-visual-p 'page-marker)
3674 (let ((inhibit-read-only t))
3675 (gnus-remove-text-with-property 'gnus-prev)
3676 (gnus-remove-text-with-property 'gnus-next)))
3677 (when
3678 (cond ((< arg 0)
3679 (re-search-backward page-delimiter nil 'move (1+ (abs arg))))
3680 ((> arg 0)
3681 (re-search-forward page-delimiter nil 'move arg)))
3682 (goto-char (match-end 0)))
3683 (narrow-to-region
3684 (point)
3685 (if (re-search-forward page-delimiter nil 'move)
3686 (match-beginning 0)
3687 (point)))
3688 (when (and (gnus-visual-p 'page-marker)
3689 (> (point-min) (save-restriction (widen) (point-min))))
3690 (save-excursion
3691 (goto-char (point-min))
3692 (gnus-insert-prev-page-button)))
3693 (when (and (gnus-visual-p 'page-marker)
3694 (< (point-max) (save-restriction (widen) (point-max))))
3695 (save-excursion
3696 (goto-char (point-max))
3697 (gnus-insert-next-page-button)))))
3699 ;; Article mode commands
3701 (defun gnus-article-goto-next-page ()
3702 "Show the next page of the article."
3703 (interactive)
3704 (when (gnus-article-next-page)
3705 (goto-char (point-min))
3706 (gnus-article-read-summary-keys nil (gnus-character-to-event ?n))))
3708 (defun gnus-article-goto-prev-page ()
3709 "Show the next page of the article."
3710 (interactive)
3711 (if (bobp) (gnus-article-read-summary-keys nil (gnus-character-to-event ?p))
3712 (gnus-article-prev-page nil)))
3714 (defun gnus-article-next-page (&optional lines)
3715 "Show the next page of the current article.
3716 If end of article, return non-nil. Otherwise return nil.
3717 Argument LINES specifies lines to be scrolled up."
3718 (interactive "p")
3719 (move-to-window-line -1)
3720 (if (save-excursion
3721 (end-of-line)
3722 (and (pos-visible-in-window-p) ;Not continuation line.
3723 (eobp)))
3724 ;; Nothing in this page.
3725 (if (or (not gnus-page-broken)
3726 (save-excursion
3727 (save-restriction
3728 (widen) (forward-line 1) (eobp)))) ;Real end-of-buffer?
3729 t ;Nothing more.
3730 (gnus-narrow-to-page 1) ;Go to next page.
3731 nil)
3732 ;; More in this page.
3733 (let ((scroll-in-place nil))
3734 (condition-case ()
3735 (scroll-up lines)
3736 (end-of-buffer
3737 ;; Long lines may cause an end-of-buffer error.
3738 (goto-char (point-max)))))
3739 (move-to-window-line 0)
3740 nil))
3742 (defun gnus-article-prev-page (&optional lines)
3743 "Show previous page of current article.
3744 Argument LINES specifies lines to be scrolled down."
3745 (interactive "p")
3746 (move-to-window-line 0)
3747 (if (and gnus-page-broken
3748 (bobp)
3749 (not (save-restriction (widen) (bobp)))) ;Real beginning-of-buffer?
3750 (progn
3751 (gnus-narrow-to-page -1) ;Go to previous page.
3752 (goto-char (point-max))
3753 (recenter -1))
3754 (let ((scroll-in-place nil))
3755 (prog1
3756 (condition-case ()
3757 (scroll-down lines)
3758 (beginning-of-buffer
3759 (goto-char (point-min))))
3760 (move-to-window-line 0)))))
3762 (defun gnus-article-refer-article ()
3763 "Read article specified by message-id around point."
3764 (interactive)
3765 (let ((point (point)))
3766 (search-forward ">" nil t) ;Move point to end of "<....>".
3768 (let ((message-id (match-string 1)))
3769 (goto-char point)
3770 (set-buffer gnus-summary-buffer)
3771 (gnus-summary-refer-article message-id))
3772 (goto-char (point))
3773 (error "No references around point"))))
3775 (defun gnus-article-show-summary ()
3776 "Reconfigure windows to show summary buffer."
3777 (interactive)
3778 (if (not (gnus-buffer-live-p gnus-summary-buffer))
3779 (error "There is no summary buffer for this article buffer")
3780 (gnus-article-set-globals)
3781 (gnus-configure-windows 'article)
3782 (gnus-summary-goto-subject gnus-current-article)
3783 (gnus-summary-position-point)))
3785 (defun gnus-article-describe-briefly ()
3786 "Describe article mode commands briefly."
3787 (interactive)
3788 (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")))
3790 (defun gnus-article-summary-command ()
3791 "Execute the last keystroke in the summary buffer."
3792 (interactive)
3793 (let ((obuf (current-buffer))
3794 (owin (current-window-configuration))
3795 func)
3796 (switch-to-buffer gnus-article-current-summary 'norecord)
3797 (setq func (lookup-key (current-local-map) (this-command-keys)))
3798 (call-interactively func)
3799 (set-buffer obuf)
3800 (set-window-configuration owin)
3801 (set-window-point (get-buffer-window (current-buffer)) (point))))
3803 (defun gnus-article-summary-command-nosave ()
3804 "Execute the last keystroke in the summary buffer."
3805 (interactive)
3806 (let (func)
3807 (pop-to-buffer gnus-article-current-summary 'norecord)
3808 (setq func (lookup-key (current-local-map) (this-command-keys)))
3809 (call-interactively func)))
3811 (defun gnus-article-check-buffer ()
3812 "Beep if not in an article buffer."
3813 (unless (equal major-mode 'gnus-article-mode)
3814 (error "Command invoked outside of a Gnus article buffer")))
3816 (defun gnus-article-read-summary-keys (&optional arg key not-restore-window)
3817 "Read a summary buffer key sequence and execute it from the article buffer."
3818 (interactive "P")
3819 (gnus-article-check-buffer)
3820 (let ((nosaves
3821 '("q" "Q" "c" "r" "R" "\C-c\C-f" "m" "a" "f" "F"
3822 "Zc" "ZC" "ZE" "ZQ" "ZZ" "Zn" "ZR" "ZG" "ZN" "ZP"
3823 "=" "^" "\M-^" "|"))
3824 (nosave-but-article
3826 (nosave-in-article
3827 '("\C-d"))
3828 (up-to-top
3829 '("n" "Gn" "p" "Gp"))
3830 keys new-sum-point)
3831 (save-excursion
3832 (set-buffer gnus-article-current-summary)
3833 (let (gnus-pick-mode)
3834 (push (or key last-command-event) unread-command-events)
3835 (setq keys (if (featurep 'xemacs)
3836 (events-to-keys (read-key-sequence nil))
3837 (read-key-sequence nil)))))
3839 (message "")
3841 (if (or (member keys nosaves)
3842 (member keys nosave-but-article)
3843 (member keys nosave-in-article))
3844 (let (func)
3845 (save-window-excursion
3846 (pop-to-buffer gnus-article-current-summary 'norecord)
3847 ;; We disable the pick minor mode commands.
3848 (let (gnus-pick-mode)
3849 (setq func (lookup-key (current-local-map) keys))))
3850 (if (or (not func)
3851 (numberp func))
3852 (ding)
3853 (unless (member keys nosave-in-article)
3854 (set-buffer gnus-article-current-summary))
3855 (call-interactively func)
3856 (setq new-sum-point (point)))
3857 (when (member keys nosave-but-article)
3858 (pop-to-buffer gnus-article-buffer 'norecord)))
3859 ;; These commands should restore window configuration.
3860 (let ((obuf (current-buffer))
3861 (owin (current-window-configuration))
3862 (opoint (point))
3863 (summary gnus-article-current-summary)
3864 func in-buffer selected)
3865 (if not-restore-window
3866 (pop-to-buffer summary 'norecord)
3867 (switch-to-buffer summary 'norecord))
3868 (setq in-buffer (current-buffer))
3869 ;; We disable the pick minor mode commands.
3870 (if (and (setq func (let (gnus-pick-mode)
3871 (lookup-key (current-local-map) keys)))
3872 (functionp func))
3873 (progn
3874 (call-interactively func)
3875 (setq new-sum-point (point))
3876 (when (eq in-buffer (current-buffer))
3877 (setq selected (gnus-summary-select-article))
3878 (set-buffer obuf)
3879 (unless not-restore-window
3880 (set-window-configuration owin))
3881 (when (eq selected 'old)
3882 (article-goto-body)
3883 (set-window-start (get-buffer-window (current-buffer))
3884 1)
3885 (set-window-point (get-buffer-window (current-buffer))
3886 (point)))
3887 (let ((win (get-buffer-window gnus-article-current-summary)))
3888 (when win
3889 (set-window-point win new-sum-point)))) )
3890 (switch-to-buffer gnus-article-buffer)
3891 (ding))))))
3893 (defun gnus-article-describe-key (key)
3894 "Display documentation of the function invoked by KEY. KEY is a string."
3895 (interactive "kDescribe key: ")
3896 (gnus-article-check-buffer)
3897 (if (eq (key-binding key) 'gnus-article-read-summary-keys)
3898 (save-excursion
3899 (set-buffer gnus-article-current-summary)
3900 (let (gnus-pick-mode)
3901 (push (elt key 0) unread-command-events)
3902 (setq key (if (featurep 'xemacs)
3903 (events-to-keys (read-key-sequence "Describe key: "))
3904 (read-key-sequence "Describe key: "))))
3905 (describe-key key))
3906 (describe-key key)))
3908 (defun gnus-article-describe-key-briefly (key &optional insert)
3909 "Display documentation of the function invoked by KEY. KEY is a string."
3911 (gnus-article-check-buffer)
3912 (if (eq (key-binding key) 'gnus-article-read-summary-keys)
3913 (save-excursion
3914 (set-buffer gnus-article-current-summary)
3915 (let (gnus-pick-mode)
3916 (push (elt key 0) unread-command-events)
3917 (setq key (if (featurep 'xemacs)
3918 (events-to-keys (read-key-sequence "Describe key: "))
3919 (read-key-sequence "Describe key: "))))
3920 (describe-key-briefly key insert))
3921 (describe-key-briefly key insert)))
3923 (defun gnus-article-hide (&optional arg force)
3924 "Hide all the gruft in the current article.
3925 This means that PGP stuff, signatures, cited text and (some)
3926 headers will be hidden.
3927 If given a prefix, show the hidden text instead."
3928 (interactive (append (gnus-article-hidden-arg) (list 'force)))
3929 (gnus-article-hide-headers arg)
3930 (gnus-article-hide-list-identifiers arg)
3931 (gnus-article-hide-pgp arg)
3932 (gnus-article-hide-citation-maybe arg force)
3933 (gnus-article-hide-signature arg))
3935 (defun gnus-article-maybe-highlight ()
3936 "Do some article highlighting if article highlighting is requested."
3937 (when (gnus-visual-p 'article-highlight 'highlight)
3938 (gnus-article-highlight-some)))
3940 (defun gnus-check-group-server ()
3941 ;; Make sure the connection to the server is alive.
3942 (unless (gnus-server-opened
3943 (gnus-find-method-for-group gnus-newsgroup-name))
3944 (gnus-check-server (gnus-find-method-for-group gnus-newsgroup-name))
3945 (gnus-request-group gnus-newsgroup-name t)))
3947 (defun gnus-request-article-this-buffer (article group)
3948 "Get an article and insert it into this buffer."
3949 (let (do-update-line sparse-header)
3950 (prog1
3951 (save-excursion
3952 (erase-buffer)
3953 (gnus-kill-all-overlays)
3954 (setq group (or group gnus-newsgroup-name))
3956 ;; Using `gnus-request-article' directly will insert the article into
3957 ;; `nntp-server-buffer' - so we'll save some time by not having to
3958 ;; copy it from the server buffer into the article buffer.
3960 ;; We only request an article by message-id when we do not have the
3961 ;; headers for it, so we'll have to get those.
3962 (when (stringp article)
3963 (gnus-read-header article))
3965 ;; If the article number is negative, that means that this article
3966 ;; doesn't belong in this newsgroup (possibly), so we find its
3967 ;; message-id and request it by id instead of number.
3968 (when (and (numberp article)
3969 gnus-summary-buffer
3970 (get-buffer gnus-summary-buffer)
3971 (gnus-buffer-exists-p gnus-summary-buffer))
3972 (save-excursion
3973 (set-buffer gnus-summary-buffer)
3974 (let ((header (gnus-summary-article-header article)))
3975 (when (< article 0)
3976 (cond
3977 ((memq article gnus-newsgroup-sparse)
3978 ;; This is a sparse gap article.
3979 (setq do-update-line article)
3980 (setq article (mail-header-id header))
3981 (setq sparse-header (gnus-read-header article))
3982 (setq gnus-newsgroup-sparse
3983 (delq article gnus-newsgroup-sparse)))
3984 ((vectorp header)
3985 ;; It's a real article.
3986 (setq article (mail-header-id header)))
3987 (t
3988 ;; It is an extracted pseudo-article.
3989 (setq article 'pseudo)
3990 (gnus-request-pseudo-article header))))
3992 (let ((method (gnus-find-method-for-group
3993 gnus-newsgroup-name)))
3994 (when (and (eq (car method) 'nneething)
3995 (vectorp header))
3996 (let ((dir (expand-file-name
3997 (mail-header-subject header)
3998 (file-name-as-directory
3999 (or (cadr (assq 'nneething-address method))
4000 (nth 1 method))))))
4001 (when (file-directory-p dir)
4002 (setq article 'nneething)
4003 (gnus-group-enter-directory dir))))))))
4005 (cond
4006 ;; Refuse to select canceled articles.
4007 ((and (numberp article)
4008 gnus-summary-buffer
4009 (get-buffer gnus-summary-buffer)
4010 (gnus-buffer-exists-p gnus-summary-buffer)
4011 (eq (cdr (save-excursion
4012 (set-buffer gnus-summary-buffer)
4013 (assq article gnus-newsgroup-reads)))
4014 gnus-canceled-mark))
4015 nil)
4016 ;; We first check `gnus-original-article-buffer'.
4017 ((and (get-buffer gnus-original-article-buffer)
4018 (numberp article)
4019 (save-excursion
4020 (set-buffer gnus-original-article-buffer)
4021 (and (equal (car gnus-original-article) group)
4022 (eq (cdr gnus-original-article) article))))
4023 (insert-buffer-substring gnus-original-article-buffer)
4024 'article)
4025 ;; Check the backlog.
4026 ((and gnus-keep-backlog
4027 (gnus-backlog-request-article group article (current-buffer)))
4028 'article)
4029 ;; Check asynchronous pre-fetch.
4030 ((gnus-async-request-fetched-article group article (current-buffer))
4031 (gnus-async-prefetch-next group article gnus-summary-buffer)
4032 (when (and (numberp article) gnus-keep-backlog)
4033 (gnus-backlog-enter-article group article (current-buffer)))
4034 'article)
4035 ;; Check the cache.
4036 ((and gnus-use-cache
4037 (numberp article)
4038 (gnus-cache-request-article article group))
4039 'article)
4040 ;; Get the article and put into the article buffer.
4041 ((or (stringp article)
4042 (numberp article))
4043 (let ((gnus-override-method gnus-override-method)
4044 (methods (and (stringp article)
4045 gnus-refer-article-method))
4046 result
4047 (inhibit-read-only t))
4048 (if (or (not (listp methods))
4049 (and (symbolp (car methods))
4050 (assq (car methods) nnoo-definition-alist)))
4051 (setq methods (list methods)))
4052 (when (and (null gnus-override-method)
4053 methods)
4054 (setq gnus-override-method (pop methods)))
4055 (while (not result)
4056 (when (eq gnus-override-method 'current)
4057 (setq gnus-override-method
4058 (with-current-buffer gnus-summary-buffer
4059 gnus-current-select-method)))
4060 (erase-buffer)
4061 (gnus-kill-all-overlays)
4062 (let ((gnus-newsgroup-name group))
4063 (gnus-check-group-server))
4064 (when (gnus-request-article article group (current-buffer))
4065 (when (numberp article)
4066 (gnus-async-prefetch-next group article
4067 gnus-summary-buffer)
4068 (when gnus-keep-backlog
4069 (gnus-backlog-enter-article
4070 group article (current-buffer))))
4071 (setq result 'article))
4072 (if (not result)
4073 (if methods
4074 (setq gnus-override-method (pop methods))
4075 (setq result 'done))))
4076 (and (eq result 'article) 'article)))
4077 ;; It was a pseudo.
4078 (t article)))
4080 ;; Associate this article with the current summary buffer.
4081 (setq gnus-article-current-summary gnus-summary-buffer)
4083 ;; Take the article from the original article buffer
4084 ;; and place it in the buffer it's supposed to be in.
4085 (when (and (get-buffer gnus-article-buffer)
4086 (equal (buffer-name (current-buffer))
4087 (buffer-name (get-buffer gnus-article-buffer))))
4088 (save-excursion
4089 (if (get-buffer gnus-original-article-buffer)
4090 (set-buffer gnus-original-article-buffer)
4091 (set-buffer (gnus-get-buffer-create gnus-original-article-buffer))
4092 (buffer-disable-undo)
4093 (setq major-mode 'gnus-original-article-mode)
4094 (setq buffer-read-only t))
4095 (let (buffer-read-only)
4096 (erase-buffer)
4097 (insert-buffer-substring gnus-article-buffer))
4098 (setq gnus-original-article (cons group article)))
4100 ;; Decode charsets.
4101 (run-hooks 'gnus-article-decode-hook)
4102 ;; Mark article as decoded or not.
4103 (setq gnus-article-decoded-p gnus-article-decode-hook))
4105 ;; Update sparse articles.
4106 (when (and do-update-line
4107 (or (numberp article)
4108 (stringp article)))
4109 (let ((buf (current-buffer)))
4110 (set-buffer gnus-summary-buffer)
4111 (gnus-summary-update-article do-update-line sparse-header)
4112 (gnus-summary-goto-subject do-update-line nil t)
4113 (set-window-point (get-buffer-window (current-buffer) t)
4114 (point))
4115 (set-buffer buf))))))
4117 ;;;
4118 ;;; Article editing
4119 ;;;
4121 (defcustom gnus-article-edit-mode-hook nil
4122 "Hook run in article edit mode buffers."
4123 :group 'gnus-article-various
4124 :type 'hook)
4126 (defvar gnus-article-edit-done-function nil)
4128 (defvar gnus-article-edit-mode-map nil)
4130 ;; Should we be using derived.el for this?
4131 (unless gnus-article-edit-mode-map
4132 (setq gnus-article-edit-mode-map (make-sparse-keymap))
4133 (set-keymap-parent gnus-article-edit-mode-map text-mode-map)
4135 (gnus-define-keys gnus-article-edit-mode-map
4136 "\C-c\C-c" gnus-article-edit-done
4137 "\C-c\C-k" gnus-article-edit-exit)
4139 (gnus-define-keys (gnus-article-edit-wash-map
4140 "\C-c\C-w" gnus-article-edit-mode-map)
4141 "f" gnus-article-edit-full-stops))
4143 (define-derived-mode gnus-article-edit-mode message-mode "Article Edit"
4144 "Major mode for editing articles.
4145 This is an extended text-mode.
4148 (make-local-variable 'gnus-article-edit-done-function)
4149 (make-local-variable 'gnus-prev-winconf)
4150 (set (make-local-variable 'font-lock-defaults)
4151 '(message-font-lock-keywords t))
4152 (setq buffer-read-only nil)
4153 (buffer-enable-undo)
4154 (widen))
4156 (defun gnus-article-edit (&optional force)
4157 "Edit the current article.
4158 This will have permanent effect only in mail groups.
4159 If FORCE is non-nil, allow editing of articles even in read-only
4160 groups."
4161 (interactive "P")
4162 (when (and (not force)
4163 (gnus-group-read-only-p))
4164 (error "The current newsgroup does not support article editing"))
4165 (gnus-article-date-original)
4166 (gnus-article-edit-article
4167 'ignore
4168 `(lambda (no-highlight)
4169 'ignore
4170 (gnus-summary-edit-article-done
4171 ,(or (mail-header-references gnus-current-headers) "")
4172 ,(gnus-group-read-only-p) ,gnus-summary-buffer no-highlight))))
4174 (defun gnus-article-edit-article (start-func exit-func)
4175 "Start editing the contents of the current article buffer."
4176 (let ((winconf (current-window-configuration)))
4177 (set-buffer gnus-article-buffer)
4178 (gnus-article-edit-mode)
4179 (funcall start-func)
4180 (gnus-configure-windows 'edit-article)
4181 (setq gnus-article-edit-done-function exit-func)
4182 (setq gnus-prev-winconf winconf)
4183 (gnus-message 6 "C-c C-c to end edits")))
4185 (defun gnus-article-edit-done (&optional arg)
4186 "Update the article edits and exit."
4187 (interactive "P")
4188 (widen)
4189 (save-excursion
4190 (save-restriction
4191 (when (article-goto-body)
4192 (let ((lines (count-lines (point) (point-max)))
4193 (length (- (point-max) (point)))
4194 (case-fold-search t)
4195 (body (copy-marker (point))))
4196 (goto-char (point-min))
4198 (delete-region (match-beginning 1) (match-end 1))
4199 (insert (number-to-string length)))
4200 (goto-char (point-min))
4201 (when (re-search-forward
4203 (delete-region (match-beginning 1) (match-end 1))
4204 (insert (number-to-string length)))
4205 (goto-char (point-min))
4207 (delete-region (match-beginning 1) (match-end 1))
4208 (insert (number-to-string lines)))))))
4209 (let ((func gnus-article-edit-done-function)
4210 (buf (current-buffer))
4211 (start (window-start)))
4212 (gnus-article-edit-exit)
4213 (save-excursion
4214 (set-buffer buf)
4215 (let ((inhibit-read-only t))
4216 (funcall func arg))
4217 ;; The cache and backlog have to be flushed somewhat.
4218 (when gnus-keep-backlog
4219 (gnus-backlog-remove-article
4220 (car gnus-article-current) (cdr gnus-article-current)))
4221 ;; Flush original article as well.
4222 (save-excursion
4223 (when (get-buffer gnus-original-article-buffer)
4224 (set-buffer gnus-original-article-buffer)
4225 (setq gnus-original-article nil)))
4226 (when gnus-use-cache
4227 (gnus-cache-update-article
4228 (car gnus-article-current) (cdr gnus-article-current))))
4229 (set-buffer buf)
4230 (set-window-start (get-buffer-window buf) start)
4231 (set-window-point (get-buffer-window buf) (point))))
4233 (defun gnus-article-edit-exit ()
4234 "Exit the article editing without updating."
4235 (interactive)
4236 ;; We remove all text props from the article buffer.
4237 (let ((buf (buffer-substring-no-properties (point-min) (point-max)))
4238 (curbuf (current-buffer))
4239 (p (point))
4240 (window-start (window-start)))
4241 (erase-buffer)
4242 (insert buf)
4243 (let ((winconf gnus-prev-winconf))
4244 (gnus-article-mode)
4245 (set-window-configuration winconf)
4246 ;; Tippy-toe some to make sure that point remains where it was.
4247 (save-current-buffer
4248 (set-buffer curbuf)
4249 (set-window-start (get-buffer-window (current-buffer)) window-start)
4250 (goto-char p)))))
4252 (defun gnus-article-edit-full-stops ()
4253 "Interactively repair spacing at end of sentences."
4254 (interactive)
4255 (save-excursion
4256 (goto-char (point-min))
4257 (search-forward-regexp "^$" nil t)
4258 (let ((case-fold-search nil))
4261 ;;;
4262 ;;; Article highlights
4263 ;;;
4265 ;; Written by Per Abrahamsen <abraham@iesd.auc.dk>.
4267 ;;; Internal Variables:
4269 (defcustom gnus-button-url-regexp
4270 (if (string-match "[[:digit:]]" "1") ;; support POSIX?
4271 "\\b\\(\\(www\\.\\|\\(s?https?\\|ftp\\|file\\|gopher\\|news\\|telnet\\|wais\\|mailto\\|info\\):\\)\\(//[-a-zA-Z0-9_.]+:[0-9]*\\)?[-a-zA-Z0-9_=!?#$@~`%&*+|\\/:;.,[:word:]]+[-a-zA-Z0-9_=#$@~`%&*+|\\/[:word:]]\\)"
4272 "\\b\\(\\(www\\.\\|\\(s?https?\\|ftp\\|file\\|gopher\\|news\\|telnet\\|wais\\|mailto\\|info\\):\\)\\(//[-a-zA-Z0-9_.]+:[0-9]*\\)?\\([-a-zA-Z0-9_=!?#$@~`%&*+|\\/:;.,]\\|\\w\\)+\\([-a-zA-Z0-9_=#$@~`%&*+|\\/]\\|\\w\\)\\)")
4273 "Regular expression that matches URLs."
4274 :group 'gnus-article-buttons
4275 :type 'regexp)
4277 (defcustom gnus-button-alist
4279 0 t gnus-button-message-id 2)
4282 1 t
4283 gnus-button-fetch-group 4)
4286 t gnus-button-message-id 3)
4290 ;; This is how URLs _should_ be embedded in text...
4292 ;; Info manual references.
4294 0 t Info-goto-node 2)
4295 ;; Raw URLs.
4296 (,gnus-button-url-regexp 0 t browse-url 0))
4297 "*Alist of regexps matching buttons in article bodies.
4299 Each entry has the form (REGEXP BUTTON FORM CALLBACK PAR...), where
4300 REGEXP: is the string matching text around the button,
4301 BUTTON: is the number of the regexp grouping actually matching the button,
4302 FORM: is a Lisp expression which must eval to true for the button to
4303 be added,
4304 CALLBACK: is the function to call when the user push this button, and each
4305 PAR: is a number of a regexp grouping whose text will be passed to CALLBACK.
4307 CALLBACK can also be a variable, in that case the value of that
4308 variable it the real callback function."
4309 :group 'gnus-article-buttons
4310 :type '(repeat (list regexp
4311 (integer :tag "Button")
4312 (sexp :tag "Form")
4313 (function :tag "Callback")
4314 (repeat :tag "Par"
4315 :inline t
4316 (integer :tag "Regexp group")))))
4318 (defcustom gnus-header-button-alist
4320 0 t gnus-button-message-id 0)
4323 0 t gnus-button-mailto 0)
4324 ("^X-[Uu][Rr][Ll]:" ,gnus-button-url-regexp 0 t browse-url 0)
4325 ("^Subject:" ,gnus-button-url-regexp 0 t browse-url 0)
4326 ("^[^:]+:" ,gnus-button-url-regexp 0 t browse-url 0)
4328 gnus-button-message-id 3))
4329 "*Alist of headers and regexps to match buttons in article heads.
4331 This alist is very similar to `gnus-button-alist', except that each
4332 alist has an additional HEADER element first in each entry:
4334 \(HEADER REGEXP BUTTON FORM CALLBACK PAR)
4336 HEADER is a regexp to match a header. For a fuller explanation, see
4337 `gnus-button-alist'."
4338 :group 'gnus-article-buttons
4339 :group 'gnus-article-headers
4340 :type '(repeat (list (regexp :tag "Header")
4341 regexp
4342 (integer :tag "Button")
4343 (sexp :tag "Form")
4344 (function :tag "Callback")
4345 (repeat :tag "Par"
4346 :inline t
4347 (integer :tag "Regexp group")))))
4349 (defvar gnus-button-regexp nil)
4350 (defvar gnus-button-marker-list nil)
4351 ;; Regexp matching any of the regexps from `gnus-button-alist'.
4353 (defvar gnus-button-last nil)
4354 ;; The value of `gnus-button-alist' when `gnus-button-regexp' was build.
4356 ;;; Commands:
4358 (defun gnus-article-push-button (event)
4359 "Check text under the mouse pointer for a callback function.
4360 If the text under the mouse pointer has a `gnus-callback' property,
4361 call it with the value of the `gnus-data' text property."
4362 (interactive "e")
4363 (set-buffer (window-buffer (posn-window (event-start event))))
4364 (let* ((pos (posn-point (event-start event)))
4365 (data (get-text-property pos 'gnus-data))
4366 (fun (get-text-property pos 'gnus-callback)))
4367 (goto-char pos)
4368 (when fun
4369 (funcall fun data))))
4371 (defun gnus-article-press-button ()
4372 "Check text at point for a callback function.
4373 If the text at point has a `gnus-callback' property,
4374 call it with the value of the `gnus-data' text property."
4375 (interactive)
4376 (let* ((data (get-text-property (point) 'gnus-data))
4377 (fun (get-text-property (point) 'gnus-callback)))
4378 (when fun
4379 (funcall fun data))))
4381 (defun gnus-article-highlight (&optional force)
4382 "Highlight current article.
4383 This function calls `gnus-article-highlight-headers',
4384 `gnus-article-highlight-citation',
4385 `gnus-article-highlight-signature', and `gnus-article-add-buttons' to
4386 do the highlighting. See the documentation for those functions."
4387 (interactive (list 'force))
4388 (gnus-article-highlight-headers)
4389 (gnus-article-highlight-citation force)
4390 (gnus-article-highlight-signature)
4391 (gnus-article-add-buttons force)
4392 (gnus-article-add-buttons-to-head))
4394 (defun gnus-article-highlight-some (&optional force)
4395 "Highlight current article.
4396 This function calls `gnus-article-highlight-headers',
4397 `gnus-article-highlight-signature', and `gnus-article-add-buttons' to
4398 do the highlighting. See the documentation for those functions."
4399 (interactive (list 'force))
4400 (gnus-article-highlight-headers)
4401 (gnus-article-highlight-signature)
4402 (gnus-article-add-buttons))
4404 (defun gnus-article-highlight-headers ()
4405 "Highlight article headers as specified by `gnus-header-face-alist'."
4406 (interactive)
4407 (save-excursion
4408 (set-buffer gnus-article-buffer)
4409 (save-restriction
4410 (let ((alist gnus-header-face-alist)
4411 (inhibit-read-only t)
4412 (case-fold-search t)
4413 (inhibit-point-motion-hooks t)
4414 entry regexp header-face field-face from hpoints fpoints)
4415 (article-narrow-to-head)
4416 (while (setq entry (pop alist))
4417 (goto-char (point-min))
4419 (if (string-equal "" (nth 0 entry))
4421 (nth 0 entry))
4423 header-face (nth 1 entry)
4424 field-face (nth 2 entry))
4425 (while (and (re-search-forward regexp nil t)
4426 (not (eobp)))
4427 (beginning-of-line)
4428 (setq from (point))
4429 (unless (search-forward ":" nil t)
4430 (forward-char 1))
4431 (when (and header-face
4432 (not (memq (point) hpoints)))
4433 (push (point) hpoints)
4434 (gnus-put-text-property from (point) 'face header-face))
4435 (when (and field-face
4436 (not (memq (setq from (point)) fpoints)))
4437 (push from fpoints)
4439 (forward-char -2)
4440 (goto-char (point-max)))
4441 (gnus-put-text-property from (point) 'face field-face))))))))
4443 (defun gnus-article-highlight-signature ()
4444 "Highlight the signature in an article.
4445 It does this by highlighting everything after
4446 `gnus-signature-separator' using `gnus-signature-face'."
4447 (interactive)
4448 (save-excursion
4449 (set-buffer gnus-article-buffer)
4450 (let ((inhibit-read-only t)
4451 (inhibit-point-motion-hooks t))
4452 (save-restriction
4453 (when (and gnus-signature-face
4454 (gnus-article-narrow-to-signature))
4455 (gnus-overlay-put (gnus-make-overlay (point-min) (point-max))
4456 'face gnus-signature-face)
4457 (widen)
4458 (gnus-article-search-signature)
4459 (let ((start (match-beginning 0))
4460 (end (set-marker (make-marker) (1+ (match-end 0)))))
4461 (gnus-article-add-button start (1- end) 'gnus-signature-toggle
4462 end)))))))
4464 (defun gnus-button-in-region-p (b e prop)
4465 "Say whether PROP exists in the region."
4466 (text-property-not-all b e prop nil))
4468 (defun gnus-article-add-buttons (&optional force)
4469 "Find external references in the article and make buttons of them.
4471 specified by `gnus-button-alist'."
4472 (interactive (list 'force))
4473 (save-excursion
4474 (set-buffer gnus-article-buffer)
4475 (let ((inhibit-read-only t)
4476 (inhibit-point-motion-hooks t)
4477 (case-fold-search t)
4478 (alist gnus-button-alist)
4479 beg entry regexp)
4480 ;; Remove all old markers.
4481 (let (marker entry new-list)
4482 (while (setq marker (pop gnus-button-marker-list))
4483 (if (or (< marker (point-min)) (>= marker (point-max)))
4484 (push marker new-list)
4485 (goto-char marker)
4486 (when (setq entry (gnus-button-entry))
4487 (put-text-property (match-beginning (nth 1 entry))
4488 (match-end (nth 1 entry))
4489 'gnus-callback nil))
4490 (set-marker marker nil)))
4491 (setq gnus-button-marker-list new-list))
4492 ;; We skip the headers.
4493 (article-goto-body)
4494 (setq beg (point))
4495 (while (setq entry (pop alist))
4496 (setq regexp (car entry))
4497 (goto-char beg)
4498 (while (re-search-forward regexp nil t)
4499 (let* ((start (and entry (match-beginning (nth 1 entry))))
4500 (end (and entry (match-end (nth 1 entry))))
4501 (from (match-beginning 0)))
4502 (when (and (or (eq t (nth 2 entry))
4503 (eval (nth 2 entry)))
4504 (not (gnus-button-in-region-p
4505 start end 'gnus-callback)))
4506 ;; That optional form returned non-nil, so we add the
4507 ;; button.
4508 (gnus-article-add-button
4509 start end 'gnus-button-push
4510 (car (push (set-marker (make-marker) from)
4511 gnus-button-marker-list))))))))))
4513 ;; Add buttons to the head of an article.
4514 (defun gnus-article-add-buttons-to-head ()
4515 "Add buttons to the head of the article."
4516 (interactive)
4517 (save-excursion
4518 (set-buffer gnus-article-buffer)
4519 (save-restriction
4520 (let ((inhibit-read-only t)
4521 (inhibit-point-motion-hooks t)
4522 (case-fold-search t)
4523 (alist gnus-header-button-alist)
4524 entry beg end)
4525 (article-narrow-to-head)
4526 (while alist
4527 ;; Each alist entry.
4528 (setq entry (car alist)
4529 alist (cdr alist))
4530 (goto-char (point-min))
4531 (while (re-search-forward (car entry) nil t)
4532 ;; Each header matching the entry.
4533 (setq beg (match-beginning 0))
4535 (match-beginning 0))
4536 (point-max)))
4537 (goto-char beg)
4538 (while (re-search-forward (nth 1 entry) end t)
4539 ;; Each match within a header.
4540 (let* ((entry (cdr entry))
4541 (start (match-beginning (nth 1 entry)))
4542 (end (match-end (nth 1 entry)))
4543 (form (nth 2 entry)))
4544 (goto-char (match-end 0))
4545 (when (eval form)
4546 (gnus-article-add-button
4547 start end (nth 3 entry)
4548 (buffer-substring (match-beginning (nth 4 entry))
4549 (match-end (nth 4 entry)))))))
4550 (goto-char end)))))))
4552 ;;; External functions:
4554 (defun gnus-article-add-button (from to fun &optional data)
4555 "Create a button between FROM and TO with callback FUN and data DATA."
4556 (when gnus-article-button-face
4557 (gnus-overlay-put (gnus-make-overlay from to)
4558 'face gnus-article-button-face))
4559 (gnus-add-text-properties
4560 from to
4561 (nconc (and gnus-article-mouse-face
4562 (list gnus-mouse-face-prop gnus-article-mouse-face))
4563 (list 'gnus-callback fun)
4564 (and data (list 'gnus-data data))))
4565 (widget-convert-button 'link from to :action 'gnus-widget-press-button
4566 :button-keymap gnus-widget-button-keymap))
4568 ;;; Internal functions:
4570 (defun gnus-article-set-globals ()
4571 (save-excursion
4572 (set-buffer gnus-summary-buffer)
4573 (gnus-set-global-variables)))
4575 (defun gnus-signature-toggle (end)
4576 (save-excursion
4577 (set-buffer gnus-article-buffer)
4578 (let ((inhibit-read-only t)
4579 (inhibit-point-motion-hooks t))
4580 (if (text-property-any end (point-max) 'article-type 'signature)
4581 (gnus-remove-text-properties-when
4582 'article-type 'signature end (point-max)
4583 (cons 'article-type (cons 'signature
4584 gnus-hidden-properties)))
4585 (gnus-add-text-properties-when
4586 'article-type nil end (point-max)
4587 (cons 'article-type (cons 'signature
4588 gnus-hidden-properties)))))))
4590 (defun gnus-button-entry ()
4591 ;; Return the first entry in `gnus-button-alist' matching this place.
4592 (let ((alist gnus-button-alist)
4593 (entry nil))
4594 (while alist
4595 (setq entry (pop alist))
4596 (if (looking-at (car entry))
4597 (setq alist nil)
4598 (setq entry nil)))
4599 entry))
4601 (defun gnus-button-push (marker)
4602 ;; Push button starting at MARKER.
4603 (save-excursion
4604 (goto-char marker)
4605 (let* ((entry (gnus-button-entry))
4606 (inhibit-point-motion-hooks t)
4607 (fun (nth 3 entry))
4608 (args (mapcar (lambda (group)
4609 (let ((string (match-string group)))
4610 (gnus-set-text-properties
4611 0 (length string) nil string)
4612 string))
4613 (nthcdr 4 entry))))
4614 (cond
4615 ((fboundp fun)
4616 (apply fun args))
4617 ((and (boundp fun)
4618 (fboundp (symbol-value fun)))
4619 (apply (symbol-value fun) args))
4620 (t
4621 (gnus-message 1 "You must define `%S' to use this button"
4622 (cons fun args)))))))
4624 (defun gnus-button-message-id (message-id)
4625 "Fetch MESSAGE-ID."
4626 (save-excursion
4627 (set-buffer gnus-summary-buffer)
4628 (gnus-summary-refer-article message-id)))
4630 (defun gnus-button-fetch-group (address)
4631 "Fetch GROUP specified by ADDRESS."
4632 (if (not (string-match "[:/]" address))
4633 ;; This is just a simple group url.
4634 (gnus-group-read-ephemeral-group address gnus-select-method)
4636 address))
4637 (error "Can't parse %s" address)
4638 (gnus-group-read-ephemeral-group
4639 (match-string 4 address)
4640 `(nntp ,(match-string 1 address)
4641 (nntp-address ,(match-string 1 address))
4642 (nntp-port-number ,(if (match-end 3)
4643 (match-string 3 address)
4644 "nntp")))))))
4646 (defun gnus-url-parse-query-string (query &optional downcase)
4647 (let (retval pairs cur key val)
4648 (setq pairs (split-string query "&"))
4649 (while pairs
4650 (setq cur (car pairs)
4651 pairs (cdr pairs))
4652 (if (not (string-match "=" cur))
4653 nil ; Grace
4654 (setq key (gnus-url-unhex-string (substring cur 0 (match-beginning 0)))
4655 val (gnus-url-unhex-string (substring cur (match-end 0) nil)))
4656 (if downcase
4657 (setq key (downcase key)))
4658 (setq cur (assoc key retval))
4659 (if cur
4660 (setcdr cur (cons val (cdr cur)))
4661 (setq retval (cons (list key val) retval)))))
4662 retval))
4664 (defun gnus-url-unhex (x)
4665 (if (> x ?9)
4666 (if (>= x ?a)
4667 (+ 10 (- x ?a))
4668 (+ 10 (- x ?A)))
4669 (- x ?0)))
4671 (defun gnus-url-unhex-string (str &optional allow-newlines)
4672 "Remove %XXX embedded spaces, etc in a url.
4673 If optional second argument ALLOW-NEWLINES is non-nil, then allow the
4674 decoding of carriage returns and line feeds in the string, which is normally
4675 forbidden in URL encoding."
4676 (setq str (or str ""))
4677 (let ((tmp "")
4678 (case-fold-search t))
4679 (while (string-match "%[0-9a-f][0-9a-f]" str)
4680 (let* ((start (match-beginning 0))
4681 (ch1 (gnus-url-unhex (elt str (+ start 1))))
4682 (code (+ (* 16 ch1)
4683 (gnus-url-unhex (elt str (+ start 2))))))
4684 (setq tmp (concat
4685 tmp (substring str 0 start)
4686 (cond
4687 (allow-newlines
4688 (char-to-string code))
4690 " ")
4691 (t (char-to-string code))))
4692 str (substring str (match-end 0)))))
4693 (setq tmp (concat tmp str))
4694 tmp))
4696 (defun gnus-url-mailto (url)
4697 ;; Send mail to someone
4699 (setq url (substring url (match-beginning 1) nil)))
4700 (let (to args subject func)
4701 (if (string-match (regexp-quote "?") url)
4702 (setq to (gnus-url-unhex-string (substring url 0 (match-beginning 0)))
4703 args (gnus-url-parse-query-string
4704 (substring url (match-end 0) nil) t))
4705 (setq to (gnus-url-unhex-string url)))
4706 (setq args (cons (list "to" to) args)
4707 subject (cdr-safe (assoc "subject" args)))
4708 (message-mail)
4709 (while args
4710 (setq func (intern-soft (concat "message-goto-" (downcase (caar args)))))
4711 (if (fboundp func)
4712 (funcall func)
4713 (message-position-on-field (caar args)))
4714 (insert (mapconcat 'identity (cdar args) ", "))
4715 (setq args (cdr args)))
4716 (if subject
4717 (message-goto-body)
4718 (message-goto-subject))))
4720 (defun gnus-button-mailto (address)
4721 "Mail to ADDRESS."
4722 (set-buffer (gnus-copy-article-buffer))
4723 (message-reply address))
4725 (defalias 'gnus-button-reply 'message-reply)
4727 (defun gnus-button-embedded-url (address)
4728 "Activate ADDRESS with `browse-url'."
4729 (browse-url (gnus-strip-whitespace address)))
4731 ;;; Next/prev buttons in the article buffer.
4736 (defvar gnus-prev-page-map nil)
4737 (unless gnus-prev-page-map
4738 (setq gnus-prev-page-map (make-sparse-keymap))
4739 (define-key gnus-prev-page-map gnus-mouse-2 'gnus-button-prev-page)
4742 (defun gnus-insert-prev-page-button ()
4743 (let ((inhibit-read-only t))
4744 (gnus-eval-format
4745 gnus-prev-page-line-format nil
4746 `(gnus-prev t local-map ,gnus-prev-page-map
4747 gnus-callback gnus-article-button-prev-page
4748 article-type annotation))))
4750 (defvar gnus-next-page-map nil)
4751 (unless gnus-next-page-map
4752 (setq gnus-next-page-map (make-keymap))
4753 (suppress-keymap gnus-prev-page-map)
4754 (define-key gnus-next-page-map gnus-mouse-2 'gnus-button-next-page)
4757 (defun gnus-button-next-page ()
4758 "Go to the next page."
4759 (interactive)
4760 (let ((win (selected-window)))
4761 (select-window (get-buffer-window gnus-article-buffer t))
4762 (gnus-article-next-page)
4763 (select-window win)))
4765 (defun gnus-button-prev-page ()
4766 "Go to the prev page."
4767 (interactive)
4768 (let ((win (selected-window)))
4769 (select-window (get-buffer-window gnus-article-buffer t))
4770 (gnus-article-prev-page)
4771 (select-window win)))
4773 (defun gnus-insert-next-page-button ()
4774 (let ((inhibit-read-only t))
4775 (gnus-eval-format gnus-next-page-line-format nil
4776 `(gnus-next
4777 t local-map ,gnus-next-page-map
4778 gnus-callback gnus-article-button-next-page
4779 article-type annotation))))
4781 (defun gnus-article-button-next-page (arg)
4782 "Go to the next page."
4783 (interactive "P")
4784 (let ((win (selected-window)))
4785 (select-window (get-buffer-window gnus-article-buffer t))
4786 (gnus-article-next-page)
4787 (select-window win)))
4789 (defun gnus-article-button-prev-page (arg)
4790 "Go to the prev page."
4791 (interactive "P")
4792 (let ((win (selected-window)))
4793 (select-window (get-buffer-window gnus-article-buffer t))
4794 (gnus-article-prev-page)
4795 (select-window win)))
4797 (defvar gnus-decode-header-methods
4798 '(mail-decode-encoded-word-region)
4799 "List of methods used to decode headers.
4801 This variable is a list of FUNCTION or (REGEXP . FUNCTION). If item
4802 is FUNCTION, FUNCTION will be applied to all newsgroups. If item is a
4803 \(REGEXP . FUNCTION), FUNCTION will be only applied to these newsgroups
4804 whose names match REGEXP.
4806 For example:
4808 mail-decode-encoded-word-region
4810 ")
4812 (defvar gnus-decode-header-methods-cache nil)
4814 (defun gnus-multi-decode-header (start end)
4815 "Apply the functions from `gnus-encoded-word-methods' that match."
4816 (unless (and gnus-decode-header-methods-cache
4817 (eq gnus-newsgroup-name
4818 (car gnus-decode-header-methods-cache)))
4819 (setq gnus-decode-header-methods-cache (list gnus-newsgroup-name))
4820 (mapcar (lambda (x)
4821 (if (symbolp x)
4822 (nconc gnus-decode-header-methods-cache (list x))
4823 (if (and gnus-newsgroup-name
4824 (string-match (car x) gnus-newsgroup-name))
4825 (nconc gnus-decode-header-methods-cache
4826 (list (cdr x))))))
4827 gnus-decode-header-methods))
4828 (let ((xlist gnus-decode-header-methods-cache))
4829 (pop xlist)
4830 (save-restriction
4831 (narrow-to-region start end)
4832 (while xlist
4833 (funcall (pop xlist) (point-min) (point-max))))))
4835 ;;;
4836 ;;; Treatment top-level handling.
4837 ;;;
4839 (defun gnus-treat-article (condition &optional part-number total-parts type)
4840 (let ((length (- (point-max) (point-min)))
4841 (alist gnus-treatment-function-alist)
4842 (article-goto-body-goes-to-point-min-p t)
4843 (treated-type
4844 (or (not type)
4845 (catch 'found
4846 (let ((list gnus-article-treat-types))
4847 (while list
4848 (when (string-match (pop list) type)
4849 (throw 'found t)))))))
4850 (highlightp (gnus-visual-p 'article-highlight 'highlight))
4851 val elem)
4852 (gnus-run-hooks 'gnus-part-display-hook)
4853 (while (setq elem (pop alist))
4854 (setq val
4855 (save-excursion
4856 (if (gnus-buffer-live-p gnus-summary-buffer)
4857 (set-buffer gnus-summary-buffer))
4858 (symbol-value (car elem))))
4859 (when (and (or (consp val)
4860 treated-type)
4861 (gnus-treat-predicate val)
4862 (or (not (get (car elem) 'highlight))
4863 highlightp))
4864 (save-restriction
4865 (funcall (cadr elem)))))))
4867 ;; Dynamic variables.
4868 (eval-when-compile
4869 (defvar part-number)
4870 (defvar total-parts)
4871 (defvar type)
4872 (defvar condition)
4873 (defvar length))
4875 (defun gnus-treat-predicate (val)
4876 (cond
4877 ((null val)
4878 nil)
4879 ((and (listp val)
4880 (stringp (car val)))
4881 (apply 'gnus-or (mapcar `(lambda (s)
4882 (string-match s ,(or gnus-newsgroup-name "")))
4883 val)))
4884 ((listp val)
4885 (let ((pred (pop val)))
4886 (cond
4887 ((eq pred 'or)
4888 (apply 'gnus-or (mapcar 'gnus-treat-predicate val)))
4889 ((eq pred 'and)
4890 (apply 'gnus-and (mapcar 'gnus-treat-predicate val)))
4891 ((eq pred 'not)
4892 (not (gnus-treat-predicate (car val))))
4893 ((eq pred 'typep)
4894 (equal (car val) type))
4895 (t
4896 (error "%S is not a valid predicate" pred)))))
4897 (condition
4898 (eq condition val))
4899 ((eq val t)
4900 t)
4901 ((eq val 'head)
4902 nil)
4903 ((eq val 'last)
4904 (eq part-number total-parts))
4905 ((numberp val)
4906 (< length val))
4907 (t
4908 (error "%S is not a valid value" val))))
4910 (gnus-ems-redefine)
4912 (provide 'gnus-art)
4914 (run-hooks 'gnus-art-load-hook)
4916 ;;; arch-tag: 2654516f-6279-48f9-a83b-05c1fa450c33
4917 ;;; gnus-art.el ends here