*** empty log message ***
[gnus] / lisp / gnus-uu.el
1 ;;; gnus-uu.el --- extract (uu)encoded files in Gnus
2 ;; Copyright (C) 1985,86,87,93,94,95,96,97 Free Software Foundation, Inc.
3
4 ;; Author: Lars Magne Ingebrigtsen <larsi@ifi.uio.no>
5 ;; Created: 2 Oct 1993
6 ;; Keyword: news
7
8 ;; This file is part of GNU Emacs.
9
10 ;; GNU Emacs is free software; you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation; either version 2, or (at your option)
13 ;; any later version.
14
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 ;; GNU General Public License for more details.
19
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs; see the file COPYING.  If not, write to the
22 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
23 ;; Boston, MA 02111-1307, USA.
24
25 ;;; Commentary:
26
27 ;;; Code:
28
29 (eval-when-compile (require 'cl))
30
31 (require 'gnus)
32 (require 'gnus-art)
33 (require 'message)
34 (require 'gnus-msg)
35
36 (defgroup gnus-extract nil
37   "Extracting encoded files."
38   :prefix "gnus-uu-"
39   :group 'gnus)
40
41 (defgroup gnus-extract-view nil
42   "Viewwing extracted files."
43   :group 'gnus-extract)
44
45 (defgroup gnus-extract-archive nil
46   "Extracting encoded archives."
47   :group 'gnus-extract)
48
49 (defgroup gnus-extract-post nil
50   "Extracting encoded archives."
51   :prefix "gnus-uu-post"
52   :group 'gnus-extract)
53
54 ;; Default viewing action rules
55
56 (defcustom gnus-uu-default-view-rules
57   '(("\\.te?xt$\\|\\.doc$\\|read.*me\\|\\.c?$\\|\\.h$\\|\\.bat$\\|\\.asm$\\|makefile" "cat %s | sed s/\r//g")
58     ("\\.pas$" "cat %s | sed s/\r//g")
59     ("\\.[1-9]$" "groff -mandoc -Tascii %s | sed s/\b.//g")
60     ("\\.\\(jpe?g\\|gif\\|tiff?\\|p[pgb]m\\|xwd\\|xbm\\|pcx\\)$" "xv")
61     ("\\.tga$" "tgatoppm %s | xv -")
62     ("\\.\\(wav\\|aiff\\|hcom\\|u[blw]\\|s[bfw]\\|voc\\|smp\\)$"
63      "sox -v .5 %s -t .au -u - > /dev/audio")
64     ("\\.au$" "cat %s > /dev/audio")
65     ("\\.midi?$" "playmidi -f")
66     ("\\.mod$" "str32")
67     ("\\.ps$" "ghostview")
68     ("\\.dvi$" "xdvi")
69     ("\\.html$" "xmosaic")
70     ("\\.mpe?g$" "mpeg_play")
71     ("\\.\\(flc\\|fli\\|rle\\|iff\\|pfx\\|avi\\|sme\\|rpza\\|dl\\|qt\\|rsrc\\|mov\\)$" "xanim")
72     ("\\.\\(tar\\|arj\\|zip\\|zoo\\|arc\\|gz\\|Z\\|lzh\\|ar\\|lha\\)$"
73      "gnus-uu-archive"))
74   "Default actions to be taken when the user asks to view a file.
75 To change the behaviour, you can either edit this variable or set
76 `gnus-uu-user-view-rules' to something useful.
77
78 For example:
79
80 To make gnus-uu use 'xli' to display JPEG and GIF files, put the
81 following in your .emacs file:
82
83   (setq gnus-uu-user-view-rules '((\"jpg$\\\\|gif$\" \"xli\")))
84
85 Both these variables are lists of lists with two string elements.  The
86 first string is a regular expression.  If the file name matches this
87 regular expression, the command in the second string is executed with
88 the file as an argument.
89
90 If the command string contains \"%s\", the file name will be inserted
91 at that point in the command string.  If there's no \"%s\" in the
92 command string, the file name will be appended to the command string
93 before executing.
94
95 There are several user variables to tailor the behaviour of gnus-uu to
96 your needs.  First we have `gnus-uu-user-view-rules', which is the
97 variable gnus-uu first consults when trying to decide how to view a
98 file.  If this variable contains no matches, gnus-uu examines the
99 default rule variable provided in this package.  If gnus-uu finds no
100 match here, it uses `gnus-uu-user-view-rules-end' to try to make a
101 match."
102   :group 'gnus-extract-view
103   :type '(repeat (group regexp (string :tag "Command"))))
104
105 (defcustom gnus-uu-user-view-rules nil
106   "What actions are to be taken to view a file.
107 See the documentation on the `gnus-uu-default-view-rules' variable for
108 details."
109   :group 'gnus-extract-view
110   :type '(repeat (group regexp (string :tag "Command"))))
111
112 (defcustom gnus-uu-user-view-rules-end
113   '(("" "file"))
114   "What actions are to be taken if no rule matched the file name.
115 See the documentation on the `gnus-uu-default-view-rules' variable for
116 details."
117   :group 'gnus-extract-view
118   :type '(repeat (group regexp (string :tag "Command"))))
119
120 ;; Default unpacking commands
121
122 (defcustom gnus-uu-default-archive-rules
123   '(("\\.tar$" "tar xf")
124     ("\\.zip$" "unzip -o")
125     ("\\.ar$" "ar x")
126     ("\\.arj$" "unarj x")
127     ("\\.zoo$" "zoo -e")
128     ("\\.\\(lzh\\|lha\\)$" "lha x")
129     ("\\.Z$" "uncompress")
130     ("\\.gz$" "gunzip")
131     ("\\.arc$" "arc -x"))
132   "See `gnus-uu-user-archive-rules'."
133   :group 'gnus-extract-archive
134   :type '(repeat (group regexp (string :tag "Command"))))
135
136 (defvar gnus-uu-destructive-archivers
137   (list "uncompress" "gunzip"))
138
139 (defcustom gnus-uu-user-archive-rules nil
140   "A list that can be set to override the default archive unpacking commands.
141 To use, for instance, 'untar' to unpack tar files and 'zip -x' to
142 unpack zip files, say the following:
143   (setq gnus-uu-user-archive-rules
144     '((\"\\\\.tar$\" \"untar\")
145       (\"\\\\.zip$\" \"zip -x\")))"
146   :group 'gnus-extract-archive
147   :type '(repeat (group regexp (string :tag "Command"))))
148
149 (defcustom gnus-uu-ignore-files-by-name nil
150   "*A regular expression saying what files should not be viewed based on name.
151 If, for instance, you want gnus-uu to ignore all .au and .wav files,
152 you could say something like
153
154   (setq gnus-uu-ignore-files-by-name \"\\\\.au$\\\\|\\\\.wav$\")
155
156 Note that this variable can be used in conjunction with the
157 `gnus-uu-ignore-files-by-type' variable."
158   :group 'gnus-extract
159   :type '(choice (const :tag "off" nil)
160                  (regexp :format "%v")))
161
162 (defcustom gnus-uu-ignore-files-by-type nil
163   "*A regular expression saying what files that shouldn't be viewed, based on MIME file type.
164 If, for instance, you want gnus-uu to ignore all audio files and all mpegs,
165 you could say something like
166
167   (setq gnus-uu-ignore-files-by-type \"audio/\\\\|video/mpeg\")
168
169 Note that this variable can be used in conjunction with the
170 `gnus-uu-ignore-files-by-name' variable."
171   :group 'gnus-extract
172   :type '(choice (const :tag "off" nil)
173                  (regexp :format "%v")))
174
175 ;; Pseudo-MIME support
176
177 (defconst gnus-uu-ext-to-mime-list
178   '(("\\.gif$" "image/gif")
179     ("\\.jpe?g$" "image/jpeg")
180     ("\\.tiff?$" "image/tiff")
181     ("\\.xwd$" "image/xwd")
182     ("\\.pbm$" "image/pbm")
183     ("\\.pgm$" "image/pgm")
184     ("\\.ppm$" "image/ppm")
185     ("\\.xbm$" "image/xbm")
186     ("\\.pcx$" "image/pcx")
187     ("\\.tga$" "image/tga")
188     ("\\.ps$" "image/postscript")
189     ("\\.fli$" "video/fli")
190     ("\\.wav$" "audio/wav")
191     ("\\.aiff$" "audio/aiff")
192     ("\\.hcom$" "audio/hcom")
193     ("\\.voc$" "audio/voc")
194     ("\\.smp$" "audio/smp")
195     ("\\.mod$" "audio/mod")
196     ("\\.dvi$" "image/dvi")
197     ("\\.mpe?g$" "video/mpeg")
198     ("\\.au$" "audio/basic")
199     ("\\.\\(te?xt\\|doc\\|c\\|h\\)$" "text/plain")
200     ("\\.\\(c\\|h\\)$" "text/source")
201     ("read.*me" "text/plain")
202     ("\\.html$" "text/html")
203     ("\\.bat$" "text/bat")
204     ("\\.[1-6]$" "text/man")
205     ("\\.flc$" "video/flc")
206     ("\\.rle$" "video/rle")
207     ("\\.pfx$" "video/pfx")
208     ("\\.avi$" "video/avi")
209     ("\\.sme$" "video/sme")
210     ("\\.rpza$" "video/prza")
211     ("\\.dl$" "video/dl")
212     ("\\.qt$" "video/qt")
213     ("\\.rsrc$" "video/rsrc")
214     ("\\..*$" "unknown/unknown")))
215
216 ;; Various variables users may set
217
218 (defcustom gnus-uu-tmp-dir "/tmp/"
219   "*Variable saying where gnus-uu is to do its work.
220 Default is \"/tmp/\"."
221   :group 'gnus-extract
222   :type 'directory)
223
224 (defcustom gnus-uu-do-not-unpack-archives nil
225   "*Non-nil means that gnus-uu won't peek inside archives looking for files to display.
226 Default is nil."
227   :group 'gnus-extract-archive
228   :type 'boolean)
229
230 (defcustom gnus-uu-ignore-default-view-rules nil
231   "*Non-nil means that gnus-uu will ignore the default viewing rules.
232 Only the user viewing rules will be consulted.  Default is nil."
233   :group 'gnus-extract-view
234   :type 'boolean)
235
236 (defcustom gnus-uu-grabbed-file-functions nil
237   "Functions run on each file after successful decoding.
238 They will be called with the name of the file as the argument.
239 Likely functions you can use in this list are `gnus-uu-grab-view'
240 and `gnus-uu-grab-move'."
241   :group 'gnus-extract
242   :options '(gnus-uu-grab-view gnus-uu-grab-move)
243   :type 'hook)
244
245 (defcustom gnus-uu-ignore-default-archive-rules nil
246   "*Non-nil means that gnus-uu will ignore the default archive unpacking commands.
247 Only the user unpacking commands will be consulted.  Default is nil."
248   :group 'gnus-extract-archive
249   :type 'boolean)
250
251 (defcustom gnus-uu-kill-carriage-return t
252   "*Non-nil means that gnus-uu will strip all carriage returns from articles.
253 Default is t."
254   :group 'gnus-extract
255   :type 'boolean)
256
257 (defcustom gnus-uu-view-with-metamail nil
258   "*Non-nil means that files will be viewed with metamail.
259 The gnus-uu viewing functions will be ignored and gnus-uu will try
260 to guess at a content-type based on file name suffixes.  Default
261 it nil."
262   :group 'gnus-extract
263   :type 'boolean)
264
265 (defcustom gnus-uu-unmark-articles-not-decoded nil
266   "*Non-nil means that gnus-uu will mark articles that were unsuccessfully decoded as unread.
267 Default is nil."
268   :group 'gnus-extract
269   :type 'boolean)
270
271 (defcustom gnus-uu-correct-stripped-uucode nil
272   "*Non-nil means that gnus-uu will *try* to fix uuencoded files that have had trailing spaces deleted.
273 Default is nil."
274   :group 'gnus-extract
275   :type 'boolean)
276
277 (defcustom gnus-uu-save-in-digest nil
278   "*Non-nil means that gnus-uu, when asked to save without decoding, will save in digests.
279 If this variable is nil, gnus-uu will just save everything in a
280 file without any embellishments.  The digesting almost conforms to RFC1153 -
281 no easy way to specify any meaningful volume and issue numbers were found,
282 so I simply dropped them."
283   :group 'gnus-extract
284   :type 'boolean)
285
286 (defcustom gnus-uu-digest-headers
287   '("^Date:" "^From:" "^To:" "^Cc:" "^Subject:" "^Message-ID:" "^Keywords:"
288     "^Summary:" "^References:")
289   "List of regexps to match headers included in digested messages.
290 The headers will be included in the sequence they are matched."
291   :group 'gnus-extract
292   :type '(repeat regexp))
293
294 (defcustom gnus-uu-save-separate-articles nil
295   "*Non-nil means that gnus-uu will save articles in separate files."
296   :group 'gnus-extract
297   :type 'boolean)
298
299 (defcustom gnus-uu-be-dangerous 'ask
300   "*Specifies what to do if unusual situations arise during decoding.
301 If nil, be as conservative as possible.  If t, ignore things that
302 didn't work, and overwrite existing files.  Otherwise, ask each time."
303   :group 'gnus-extract
304   :type '(choice (const :tag "conservative" nil)
305                  (const :tag "ask" ask)
306                  (const :tag "liberal" t)))
307
308 ;; Internal variables
309
310 (defvar gnus-uu-saved-article-name nil)
311
312 (defconst gnus-uu-begin-string "^begin[ \t]+[0-7][0-7][0-7][ \t]+\\(.*\\)$")
313 (defconst gnus-uu-end-string "^end[ \t]*$")
314
315 (defconst gnus-uu-body-line "^M")
316 (let ((i 61))
317   (while (> (setq i (1- i)) 0)
318     (setq gnus-uu-body-line (concat gnus-uu-body-line "[^a-z]")))
319   (setq gnus-uu-body-line (concat gnus-uu-body-line ".?$")))
320
321 ;"^M.............................................................?$"
322
323 (defconst gnus-uu-shar-begin-string "^#! */bin/sh")
324
325 (defvar gnus-uu-shar-file-name nil)
326 (defconst gnus-uu-shar-name-marker "begin [0-7][0-7][0-7][ \t]+\\(\\(\\w\\|\\.\\)*\\b\\)")
327
328 (defconst gnus-uu-postscript-begin-string "^%!PS-")
329 (defconst gnus-uu-postscript-end-string "^%%EOF$")
330
331 (defvar gnus-uu-file-name nil)
332 (defconst gnus-uu-uudecode-process nil)
333 (defvar gnus-uu-binhex-article-name nil)
334
335 (defvar gnus-uu-work-dir nil)
336
337 (defconst gnus-uu-output-buffer-name " *Gnus UU Output*")
338
339 (defvar gnus-uu-default-dir gnus-article-save-directory)
340 (defvar gnus-uu-digest-from-subject nil)
341
342 ;; Keymaps
343
344 (gnus-define-keys (gnus-uu-mark-map "P" gnus-summary-mark-map)
345   "p" gnus-summary-mark-as-processable
346   "u" gnus-summary-unmark-as-processable
347   "U" gnus-summary-unmark-all-processable
348   "v" gnus-uu-mark-over
349   "s" gnus-uu-mark-series
350   "r" gnus-uu-mark-region
351   "R" gnus-uu-mark-by-regexp
352   "t" gnus-uu-mark-thread
353   "T" gnus-uu-unmark-thread
354   "a" gnus-uu-mark-all
355   "b" gnus-uu-mark-buffer
356   "S" gnus-uu-mark-sparse
357   "k" gnus-summary-kill-process-mark
358   "y" gnus-summary-yank-process-mark
359   "w" gnus-summary-save-process-mark
360   "i" gnus-uu-invert-processable)
361
362 (gnus-define-keys (gnus-uu-extract-map "X" gnus-summary-mode-map)
363   ;;"x" gnus-uu-extract-any
364   ;;"m" gnus-uu-extract-mime
365   "u" gnus-uu-decode-uu
366   "U" gnus-uu-decode-uu-and-save
367   "s" gnus-uu-decode-unshar
368   "S" gnus-uu-decode-unshar-and-save
369   "o" gnus-uu-decode-save
370   "O" gnus-uu-decode-save
371   "b" gnus-uu-decode-binhex
372   "B" gnus-uu-decode-binhex
373   "p" gnus-uu-decode-postscript
374   "P" gnus-uu-decode-postscript-and-save)
375
376 (gnus-define-keys
377  (gnus-uu-extract-view-map "v" gnus-uu-extract-map)
378  "u" gnus-uu-decode-uu-view
379  "U" gnus-uu-decode-uu-and-save-view
380  "s" gnus-uu-decode-unshar-view
381  "S" gnus-uu-decode-unshar-and-save-view
382  "o" gnus-uu-decode-save-view
383  "O" gnus-uu-decode-save-view
384  "b" gnus-uu-decode-binhex-view
385  "B" gnus-uu-decode-binhex-view
386  "p" gnus-uu-decode-postscript-view
387  "P" gnus-uu-decode-postscript-and-save-view)
388
389
390 ;; Commands.
391
392 (defun gnus-uu-decode-uu (&optional n)
393   "Uudecodes the current article."
394   (interactive "P")
395   (gnus-uu-decode-with-method 'gnus-uu-uustrip-article n))
396
397 (defun gnus-uu-decode-uu-and-save (n dir)
398   "Decodes and saves the resulting file."
399   (interactive
400    (list current-prefix-arg
401          (file-name-as-directory
402           (read-file-name "Uudecode and save in dir: "
403                           gnus-uu-default-dir
404                           gnus-uu-default-dir t))))
405   (gnus-uu-decode-with-method 'gnus-uu-uustrip-article n dir nil nil t))
406
407 (defun gnus-uu-decode-unshar (&optional n)
408   "Unshars the current article."
409   (interactive "P")
410   (gnus-uu-decode-with-method 'gnus-uu-unshar-article n nil nil 'scan t))
411
412 (defun gnus-uu-decode-unshar-and-save (n dir)
413   "Unshars and saves the current article."
414   (interactive
415    (list current-prefix-arg
416          (file-name-as-directory
417           (read-file-name "Unshar and save in dir: "
418                           gnus-uu-default-dir
419                           gnus-uu-default-dir t))))
420   (gnus-uu-decode-with-method 'gnus-uu-unshar-article n dir nil 'scan t))
421
422 (defun gnus-uu-decode-save (n file)
423   "Saves the current article."
424   (interactive
425    (list current-prefix-arg
426          (read-file-name
427           (if gnus-uu-save-separate-articles
428               "Save articles is dir: "
429             "Save articles in file: ")
430           gnus-uu-default-dir
431           gnus-uu-default-dir)))
432   (setq gnus-uu-saved-article-name file)
433   (gnus-uu-decode-with-method 'gnus-uu-save-article n nil t))
434
435 (defun gnus-uu-decode-binhex (n dir)
436   "Unbinhexes the current article."
437   (interactive
438    (list current-prefix-arg
439          (file-name-as-directory
440           (read-file-name "Unbinhex and save in dir: "
441                           gnus-uu-default-dir
442                           gnus-uu-default-dir))))
443   (setq gnus-uu-binhex-article-name
444         (make-temp-name (concat gnus-uu-work-dir "binhex")))
445   (gnus-uu-decode-with-method 'gnus-uu-binhex-article n dir))
446
447 (defun gnus-uu-decode-uu-view (&optional n)
448   "Uudecodes and views the current article."
449   (interactive "P")
450   (let ((gnus-view-pseudos (or gnus-view-pseudos 'automatic)))
451     (gnus-uu-decode-uu n)))
452
453 (defun gnus-uu-decode-uu-and-save-view (n dir)
454   "Decodes, views and saves the resulting file."
455   (interactive
456    (list current-prefix-arg
457          (read-file-name "Uudecode, view and save in dir: "
458                          gnus-uu-default-dir
459                          gnus-uu-default-dir t)))
460   (let ((gnus-view-pseudos (or gnus-view-pseudos 'automatic)))
461     (gnus-uu-decode-uu-and-save n dir)))
462
463 (defun gnus-uu-decode-unshar-view (&optional n)
464   "Unshars and views the current article."
465   (interactive "P")
466   (let ((gnus-view-pseudos (or gnus-view-pseudos 'automatic)))
467     (gnus-uu-decode-unshar n)))
468
469 (defun gnus-uu-decode-unshar-and-save-view (n dir)
470   "Unshars and saves the current article."
471   (interactive
472    (list current-prefix-arg
473          (read-file-name "Unshar, view and save in dir: "
474                          gnus-uu-default-dir
475                          gnus-uu-default-dir t)))
476   (let ((gnus-view-pseudos (or gnus-view-pseudos 'automatic)))
477     (gnus-uu-decode-unshar-and-save n dir)))
478
479 (defun gnus-uu-decode-save-view (n file)
480   "Saves and views the current article."
481   (interactive
482    (list current-prefix-arg
483          (read-file-name  (if gnus-uu-save-separate-articles
484                               "Save articles is dir: "
485                             "Save articles in file: ")
486                           gnus-uu-default-dir gnus-uu-default-dir)))
487   (let ((gnus-view-pseudos (or gnus-view-pseudos 'automatic)))
488     (gnus-uu-decode-save n file)))
489
490 (defun gnus-uu-decode-binhex-view (n file)
491   "Unbinhexes and views the current article."
492   (interactive
493    (list current-prefix-arg
494          (read-file-name "Unbinhex, view and save in dir: "
495                          gnus-uu-default-dir gnus-uu-default-dir)))
496   (setq gnus-uu-binhex-article-name
497         (make-temp-name (concat gnus-uu-work-dir "binhex")))
498   (let ((gnus-view-pseudos (or gnus-view-pseudos 'automatic)))
499     (gnus-uu-decode-binhex n file)))
500
501
502 ;; Digest and forward articles
503
504 (defun gnus-uu-digest-mail-forward (&optional n post)
505   "Digests and forwards all articles in this series."
506   (interactive "P")
507   (let ((gnus-uu-save-in-digest t)
508         (file (make-temp-name (nnheader-concat gnus-uu-tmp-dir "forward")))
509         buf subject from newsgroups)
510     (gnus-setup-message 'forward
511       (setq gnus-uu-digest-from-subject nil)
512       (gnus-uu-decode-save n file)
513       (setq buf (switch-to-buffer (get-buffer-create " *gnus-uu-forward*")))
514       (gnus-add-current-to-buffer-list)
515       (erase-buffer)
516       (insert-file file)
517       (let ((fs gnus-uu-digest-from-subject))
518         (when fs
519           (setq from (caar fs)
520                 subject (gnus-simplify-subject-fuzzy (cdar fs))
521                 fs (cdr fs))
522           (while (and fs (or from subject))
523             (when from
524               (unless (string= from (caar fs))
525                 (setq from nil)))
526             (when subject
527               (unless (string= (gnus-simplify-subject-fuzzy (cdar fs))
528                                subject)
529                 (setq subject nil)))
530             (setq fs (cdr fs))))
531         (unless subject
532           (setq subject "Digested Articles"))
533         (unless from
534           (setq from
535                 (if (gnus-news-group-p gnus-newsgroup-name)
536                     gnus-newsgroup-name
537                   "Various"))))
538       (goto-char (point-min))
539       (when (re-search-forward "^Subject: ")
540         (delete-region (point) (gnus-point-at-eol))
541         (insert subject))
542       (goto-char (point-min))
543       (when (re-search-forward "^From: ")
544         (delete-region (point) (gnus-point-at-eol))
545         (insert from))
546       (message-forward post))
547     (delete-file file)
548     (kill-buffer buf)
549     (setq gnus-uu-digest-from-subject nil)))
550
551 (defun gnus-uu-digest-post-forward (&optional n)
552   "Digest and forward to a newsgroup."
553   (interactive "P")
554   (gnus-uu-digest-mail-forward n t))
555
556 ;; Process marking.
557
558 (defun gnus-uu-mark-by-regexp (regexp &optional unmark)
559   "Ask for a regular expression and set the process mark on all articles that match."
560   (interactive (list (read-from-minibuffer "Mark (regexp): ")))
561   (gnus-set-global-variables)
562   (let ((articles (gnus-uu-find-articles-matching regexp)))
563     (while articles
564       (if unmark
565           (gnus-summary-remove-process-mark (pop articles))
566         (gnus-summary-set-process-mark (pop articles))))
567     (message ""))
568   (gnus-summary-position-point))
569
570 (defun gnus-uu-unmark-by-regexp (regexp &optional unmark)
571   "Ask for a regular expression and remove the process mark on all articles that match."
572   (interactive (list (read-from-minibuffer "Mark (regexp): ")))
573   (gnus-uu-mark-by-regexp regexp t))
574
575 (defun gnus-uu-mark-series ()
576   "Mark the current series with the process mark."
577   (interactive)
578   (gnus-set-global-variables)
579   (let ((articles (gnus-uu-find-articles-matching)))
580     (while articles
581       (gnus-summary-set-process-mark (car articles))
582       (setq articles (cdr articles)))
583     (message ""))
584   (gnus-summary-position-point))
585
586 (defun gnus-uu-mark-region (beg end &optional unmark)
587   "Set the process mark on all articles between point and mark."
588   (interactive "r")
589   (gnus-set-global-variables)
590   (save-excursion
591     (goto-char beg)
592     (while (< (point) end)
593       (if unmark
594           (gnus-summary-remove-process-mark (gnus-summary-article-number))
595         (gnus-summary-set-process-mark (gnus-summary-article-number)))
596       (forward-line 1)))
597   (gnus-summary-position-point))
598
599 (defun gnus-uu-unmark-region (beg end)
600   "Remove the process mark from all articles between point and mark."
601   (interactive "r")
602   (gnus-uu-mark-region beg end t))
603
604 (defun gnus-uu-mark-buffer ()
605   "Set the process mark on all articles in the buffer."
606   (interactive)
607   (gnus-uu-mark-region (point-min) (point-max)))
608
609 (defun gnus-uu-unmark-buffer ()
610   "Remove the process mark on all articles in the buffer."
611   (interactive)
612   (gnus-uu-mark-region (point-min) (point-max) t))
613
614 (defun gnus-uu-mark-thread ()
615   "Marks all articles downwards in this thread."
616   (interactive)
617   (gnus-set-global-variables)
618   (let ((level (gnus-summary-thread-level)))
619     (while (and (gnus-summary-set-process-mark (gnus-summary-article-number))
620                 (zerop (gnus-summary-next-subject 1))
621                 (> (gnus-summary-thread-level) level))))
622   (gnus-summary-position-point))
623
624 (defun gnus-uu-unmark-thread ()
625   "Unmarks all articles downwards in this thread."
626   (interactive)
627   (gnus-set-global-variables)
628   (let ((level (gnus-summary-thread-level)))
629     (while (and (gnus-summary-remove-process-mark
630                  (gnus-summary-article-number))
631                 (zerop (gnus-summary-next-subject 1))
632                 (> (gnus-summary-thread-level) level))))
633   (gnus-summary-position-point))
634
635 (defun gnus-uu-invert-processable ()
636   "Invert the list of process-marked articles."
637   (interactive)
638   (let ((data gnus-newsgroup-data)
639         d number)
640     (save-excursion
641       (while data
642         (if (memq (setq number (gnus-data-number (pop data)))
643                   gnus-newsgroup-processable)
644             (gnus-summary-remove-process-mark number)
645           (gnus-summary-set-process-mark number)))))
646   (gnus-summary-position-point))
647
648 (defun gnus-uu-mark-over (&optional score)
649   "Mark all articles with a score over SCORE (the prefix.)"
650   (interactive "P")
651   (let ((score (gnus-score-default score))
652         (data gnus-newsgroup-data))
653     (save-excursion
654       (while data
655         (when (> (or (cdr (assq (gnus-data-number (car data))
656                                 gnus-newsgroup-scored))
657                      gnus-summary-default-score 0)
658                  score)
659           (gnus-summary-set-process-mark (caar data)))
660         (setq data (cdr data))))
661     (gnus-summary-position-point)))
662
663 (defun gnus-uu-mark-sparse ()
664   "Mark all series that have some articles marked."
665   (interactive)
666   (gnus-set-global-variables)
667   (let ((marked (nreverse gnus-newsgroup-processable))
668         subject articles total headers)
669     (unless marked
670       (error "No articles marked with the process mark"))
671     (setq gnus-newsgroup-processable nil)
672     (save-excursion
673       (while marked
674         (and (vectorp (setq headers
675                             (gnus-summary-article-header (car marked))))
676              (setq subject (mail-header-subject headers)
677                    articles (gnus-uu-find-articles-matching
678                              (gnus-uu-reginize-string subject))
679                    total (nconc total articles)))
680         (while articles
681           (gnus-summary-set-process-mark (car articles))
682           (setcdr marked (delq (car articles) (cdr marked)))
683           (setq articles (cdr articles)))
684         (setq marked (cdr marked)))
685       (setq gnus-newsgroup-processable (nreverse total)))
686     (gnus-summary-position-point)))
687
688 (defun gnus-uu-mark-all ()
689   "Mark all articles in \"series\" order."
690   (interactive)
691   (gnus-set-global-variables)
692   (setq gnus-newsgroup-processable nil)
693   (save-excursion
694     (let ((data gnus-newsgroup-data)
695           number)
696       (while data
697         (when (and (not (memq (setq number (gnus-data-number (car data)))
698                               gnus-newsgroup-processable))
699                    (vectorp (gnus-data-header (car data))))
700           (gnus-summary-goto-subject number)
701           (gnus-uu-mark-series))
702         (setq data (cdr data)))))
703   (gnus-summary-position-point))
704
705 ;; All PostScript functions written by Erik Selberg <speed@cs.washington.edu>.
706
707 (defun gnus-uu-decode-postscript (&optional n)
708   "Gets postscript of the current article."
709   (interactive "P")
710   (gnus-uu-decode-with-method 'gnus-uu-decode-postscript-article n))
711
712 (defun gnus-uu-decode-postscript-view (&optional n)
713   "Gets and views the current article."
714   (interactive "P")
715   (let ((gnus-view-pseudos (or gnus-view-pseudos 'automatic)))
716     (gnus-uu-decode-postscript n)))
717
718 (defun gnus-uu-decode-postscript-and-save (n dir)
719   "Extracts postscript and saves the current article."
720   (interactive
721    (list current-prefix-arg
722          (file-name-as-directory
723           (read-file-name "Save in dir: "
724                           gnus-uu-default-dir
725                           gnus-uu-default-dir t))))
726   (gnus-uu-decode-with-method 'gnus-uu-decode-postscript-article
727                               n dir nil nil t))
728
729 (defun gnus-uu-decode-postscript-and-save-view (n dir)
730   "Decodes, views and saves the resulting file."
731   (interactive
732    (list current-prefix-arg
733          (read-file-name "Where do you want to save the file(s)? "
734                          gnus-uu-default-dir
735                          gnus-uu-default-dir t)))
736   (let ((gnus-view-pseudos (or gnus-view-pseudos 'automatic)))
737     (gnus-uu-decode-postscript-and-save n dir)))
738
739
740 ;; Internal functions.
741
742 (defun gnus-uu-decode-with-method (method n &optional save not-insert
743                                           scan cdir)
744   (gnus-uu-initialize scan)
745   (when save
746     (setq gnus-uu-default-dir save))
747   ;; Create the directory we save to.
748   (when (and scan cdir save
749              (not (file-exists-p save)))
750     (make-directory save t))
751   (let ((articles (gnus-uu-get-list-of-articles n))
752         files)
753     (setq files (gnus-uu-grab-articles articles method t))
754     (let ((gnus-current-article (car articles)))
755       (when scan
756         (setq files (gnus-uu-scan-directory gnus-uu-work-dir))))
757     (when save
758       (gnus-uu-save-files files save))
759     (when (eq gnus-uu-do-not-unpack-archives nil)
760       (setq files (gnus-uu-unpack-files files)))
761     (setq files (nreverse (gnus-uu-get-actions files)))
762     (or not-insert (not gnus-insert-pseudo-articles)
763         (gnus-summary-insert-pseudos files save))))
764
765 (defun gnus-uu-scan-directory (dir &optional rec)
766   "Return a list of all files under DIR."
767   (let ((files (directory-files dir t))
768         out file)
769     (while (setq file (pop files))
770       (unless (member (file-name-nondirectory file) '("." ".."))
771         (push (list (cons 'name file)
772                     (cons 'article gnus-current-article))
773               out)
774         (when (file-directory-p file)
775           (setq out (nconc (gnus-uu-scan-directory file t) out)))))
776     (if rec
777         out
778       (nreverse out))))
779
780 (defun gnus-uu-save-files (files dir)
781   "Save FILES in DIR."
782   (let ((len (length files))
783         (reg (concat "^" (regexp-quote gnus-uu-work-dir)))
784         to-file file fromdir)
785     (while (setq file (cdr (assq 'name (pop files))))
786       (when (file-exists-p file)
787         (string-match reg file)
788         (setq fromdir (substring file (match-end 0)))
789         (if (file-directory-p file)
790             (gnus-make-directory (concat dir fromdir))
791           (setq to-file (concat dir fromdir))
792           (when (or (not (file-exists-p to-file))
793                     (eq gnus-uu-be-dangerous t)
794                     (and gnus-uu-be-dangerous
795                          (gnus-y-or-n-p (format "%s exists; overwrite? "
796                                                 to-file))))
797             (copy-file file to-file t t)))))
798     (gnus-message 5 "Saved %d file%s" len (if (= len 1) "" "s"))))
799
800 ;; Functions for saving and possibly digesting articles without
801 ;; any decoding.
802
803 ;; Function called by gnus-uu-grab-articles to treat each article.
804 (defun gnus-uu-save-article (buffer in-state)
805   (cond
806    (gnus-uu-save-separate-articles
807     (save-excursion
808       (set-buffer buffer)
809       (gnus-write-buffer
810        (concat gnus-uu-saved-article-name gnus-current-article))
811       (cond ((eq in-state 'first) (list gnus-uu-saved-article-name 'begin))
812             ((eq in-state 'first-and-last) (list gnus-uu-saved-article-name
813                                                  'begin 'end))
814             ((eq in-state 'last) (list 'end))
815             (t (list 'middle)))))
816    ((not gnus-uu-save-in-digest)
817     (save-excursion
818       (set-buffer buffer)
819       (write-region (point-min) (point-max) gnus-uu-saved-article-name t)
820       (cond ((eq in-state 'first) (list gnus-uu-saved-article-name 'begin))
821             ((eq in-state 'first-and-last) (list gnus-uu-saved-article-name
822                                                  'begin 'end))
823             ((eq in-state 'last) (list 'end))
824             (t (list 'middle)))))
825    (t
826     (let ((header (gnus-summary-article-header)))
827       (push (cons (mail-header-from header)
828                   (mail-header-subject header))
829             gnus-uu-digest-from-subject))
830     (let ((name (file-name-nondirectory gnus-uu-saved-article-name))
831           (delim (concat "^" (make-string 30 ?-) "$"))
832           beg subj headers headline sorthead body end-string state)
833       (if (or (eq in-state 'first)
834               (eq in-state 'first-and-last))
835           (progn
836             (setq state (list 'begin))
837             (save-excursion (set-buffer (get-buffer-create "*gnus-uu-body*"))
838                             (erase-buffer))
839             (save-excursion
840               (set-buffer (get-buffer-create "*gnus-uu-pre*"))
841               (erase-buffer)
842               (insert (format
843                        "Date: %s\nFrom: %s\nSubject: %s Digest\n\nTopics:\n"
844                        (current-time-string) name name))))
845         (when (not (eq in-state 'end))
846           (setq state (list 'middle))))
847       (save-excursion
848         (set-buffer (get-buffer "*gnus-uu-body*"))
849         (goto-char (setq beg (point-max)))
850         (save-excursion
851           (save-restriction
852             (set-buffer buffer)
853             (let (buffer-read-only)
854               (gnus-set-text-properties (point-min) (point-max) nil)
855               ;; These two are necessary for XEmacs 19.12 fascism.
856               (put-text-property (point-min) (point-max) 'invisible nil)
857               (put-text-property (point-min) (point-max) 'intangible nil))
858             (goto-char (point-min))
859             (re-search-forward "\n\n")
860             ;; Quote all 30-dash lines.
861             (save-excursion
862               (while (re-search-forward delim nil t)
863                 (beginning-of-line)
864                 (delete-char 1)
865                 (insert " ")))
866             (setq body (buffer-substring (1- (point)) (point-max)))
867             (narrow-to-region (point-min) (point))
868             (if (not (setq headers gnus-uu-digest-headers))
869                 (setq sorthead (buffer-substring (point-min) (point-max)))
870               (while headers
871                 (setq headline (car headers))
872                 (setq headers (cdr headers))
873                 (goto-char (point-min))
874                 (while (re-search-forward headline nil t)
875                   (setq sorthead
876                         (concat sorthead
877                                 (buffer-substring
878                                  (match-beginning 0)
879                                  (or (and (re-search-forward "^[^ \t]" nil t)
880                                           (1- (point)))
881                                      (progn (forward-line 1) (point)))))))))
882             (widen)))
883         (insert sorthead) (goto-char (point-max))
884         (insert body) (goto-char (point-max))
885         (insert (concat "\n" (make-string 30 ?-) "\n\n"))
886         (goto-char beg)
887         (when (re-search-forward "^Subject: \\(.*\\)$" nil t)
888           (setq subj (buffer-substring (match-beginning 1) (match-end 1)))
889           (save-excursion
890             (set-buffer (get-buffer "*gnus-uu-pre*"))
891             (insert (format "   %s\n" subj)))))
892       (when (or (eq in-state 'last)
893                 (eq in-state 'first-and-last))
894         (save-excursion
895           (set-buffer (get-buffer "*gnus-uu-pre*"))
896           (insert (format "\n\n%s\n\n" (make-string 70 ?-)))
897           (gnus-write-buffer gnus-uu-saved-article-name))
898         (save-excursion
899           (set-buffer (get-buffer "*gnus-uu-body*"))
900           (goto-char (point-max))
901           (insert
902            (concat (setq end-string (format "End of %s Digest" name))
903                    "\n"))
904           (insert (concat (make-string (length end-string) ?*) "\n"))
905           (write-region
906            (point-min) (point-max) gnus-uu-saved-article-name t))
907         (kill-buffer (get-buffer "*gnus-uu-pre*"))
908         (kill-buffer (get-buffer "*gnus-uu-body*"))
909         (push 'end state))
910       (if (memq 'begin state)
911           (cons gnus-uu-saved-article-name state)
912         state)))))
913
914 ;; Binhex treatment - not very advanced.
915
916 (defconst gnus-uu-binhex-body-line
917   "^[^:]...............................................................$")
918 (defconst gnus-uu-binhex-begin-line
919   "^:...............................................................$")
920 (defconst gnus-uu-binhex-end-line
921   ":$")
922
923 (defun gnus-uu-binhex-article (buffer in-state)
924   (let (state start-char)
925     (save-excursion
926       (set-buffer buffer)
927       (widen)
928       (goto-char (point-min))
929       (when (not (re-search-forward gnus-uu-binhex-begin-line nil t))
930         (when (not (re-search-forward gnus-uu-binhex-body-line nil t))
931           (setq state (list 'wrong-type))))
932
933       (if (memq 'wrong-type state)
934           ()
935         (beginning-of-line)
936         (setq start-char (point))
937         (if (looking-at gnus-uu-binhex-begin-line)
938             (progn
939               (setq state (list 'begin))
940               (write-region 1 1 gnus-uu-binhex-article-name))
941           (setq state (list 'middle)))
942         (goto-char (point-max))
943         (re-search-backward (concat gnus-uu-binhex-body-line "\\|"
944                                     gnus-uu-binhex-end-line)
945                             nil t)
946         (when (looking-at gnus-uu-binhex-end-line)
947           (setq state (if (memq 'begin state)
948                           (cons 'end state)
949                         (list 'end))))
950         (beginning-of-line)
951         (forward-line 1)
952         (when (file-exists-p gnus-uu-binhex-article-name)
953           (append-to-file start-char (point) gnus-uu-binhex-article-name))))
954     (if (memq 'begin state)
955         (cons gnus-uu-binhex-article-name state)
956       state)))
957
958 ;; PostScript
959
960 (defun gnus-uu-decode-postscript-article (process-buffer in-state)
961   (let ((state (list 'ok))
962         start-char end-char file-name)
963     (save-excursion
964       (set-buffer process-buffer)
965       (goto-char (point-min))
966       (if (not (re-search-forward gnus-uu-postscript-begin-string nil t))
967           (setq state (list 'wrong-type))
968         (beginning-of-line)
969         (setq start-char (point))
970         (if (not (re-search-forward gnus-uu-postscript-end-string nil t))
971             (setq state (list 'wrong-type))
972           (setq end-char (point))
973           (set-buffer (get-buffer-create gnus-uu-output-buffer-name))
974           (insert-buffer-substring process-buffer start-char end-char)
975           (setq file-name (concat gnus-uu-work-dir
976                                   (cdr gnus-article-current) ".ps"))
977           (write-region (point-min) (point-max) file-name)
978           (setq state (list file-name 'begin 'end)))))
979     state))
980
981
982 ;; Find actions.
983
984 (defun gnus-uu-get-actions (files)
985   (let ((ofiles files)
986         action name)
987     (while files
988       (setq name (cdr (assq 'name (car files))))
989       (and
990        (setq action (gnus-uu-get-action name))
991        (setcar files (nconc (list (if (string= action "gnus-uu-archive")
992                                       (cons 'action "file")
993                                     (cons 'action action))
994                                   (cons 'execute (gnus-uu-command
995                                                   action name)))
996                             (car files))))
997       (setq files (cdr files)))
998     ofiles))
999
1000 (defun gnus-uu-get-action (file-name)
1001   (let (action)
1002     (setq action
1003           (gnus-uu-choose-action
1004            file-name
1005            (append
1006             gnus-uu-user-view-rules
1007             (if gnus-uu-ignore-default-view-rules
1008                 nil
1009               gnus-uu-default-view-rules)
1010             gnus-uu-user-view-rules-end)))
1011     (when (and (not (string= (or action "") "gnus-uu-archive"))
1012                gnus-uu-view-with-metamail)
1013       (when (setq action
1014                   (gnus-uu-choose-action file-name gnus-uu-ext-to-mime-list))
1015         (setq action (format "metamail -d -b -c \"%s\"" action))))
1016     action))
1017
1018
1019 ;; Functions for treating subjects and collecting series.
1020
1021 (defun gnus-uu-reginize-string (string)
1022   ;; Takes a string and puts a \ in front of every special character;
1023   ;; ignores any leading "version numbers" thingies that they use in
1024   ;; the comp.binaries groups, and either replaces anything that looks
1025   ;; like "2/3" with "[0-9]+/[0-9]+" or, if it can't find something
1026   ;; like that, replaces the last two numbers with "[0-9]+".  This, in
1027   ;; my experience, should get most postings of a series.
1028   (let ((count 2)
1029         (vernum "v[0-9]+[a-z][0-9]+:")
1030         beg)
1031     (save-excursion
1032       (set-buffer (get-buffer-create gnus-uu-output-buffer-name))
1033       (buffer-disable-undo (current-buffer))
1034       (erase-buffer)
1035       (insert (regexp-quote string))
1036       (setq beg 1)
1037
1038       (setq case-fold-search nil)
1039       (goto-char (point-min))
1040       (when (looking-at vernum)
1041         (replace-match vernum t t)
1042         (setq beg (length vernum)))
1043
1044       (goto-char beg)
1045       (if (re-search-forward "[ \t]*[0-9]+/[0-9]+" nil t)
1046           (replace-match " [0-9]+/[0-9]+")
1047
1048         (goto-char beg)
1049         (if (re-search-forward "[0-9]+[ \t]*of[ \t]*[0-9]+" nil t)
1050             (replace-match "[0-9]+ of [0-9]+")
1051
1052           (end-of-line)
1053           (if (re-search-backward "\\([^0-9]\\)[0-9]+\\([^0-9]+\\)[0-9]+"
1054                                   nil t)
1055               (replace-match "\\1[0-9]+\\2[0-9]+" t nil nil nil))))
1056
1057       (goto-char beg)
1058       (while (re-search-forward "[ \t]+" nil t)
1059         (replace-match "[ \t]*" t t))
1060
1061       (buffer-substring 1 (point-max)))))
1062
1063 (defun gnus-uu-get-list-of-articles (n)
1064   ;; If N is non-nil, the article numbers of the N next articles
1065   ;; will be returned.
1066   ;; If any articles have been marked as processable, they will be
1067   ;; returned.
1068   ;; Failing that, articles that have subjects that are part of the
1069   ;; same "series" as the current will be returned.
1070   (let (articles)
1071     (cond
1072      (n
1073       (setq n (prefix-numeric-value n))
1074       (let ((backward (< n 0))
1075             (n (abs n)))
1076         (save-excursion
1077           (while (and (> n 0)
1078                       (push (gnus-summary-article-number)
1079                             articles)
1080                       (gnus-summary-search-forward nil nil backward))
1081             (setq n (1- n))))
1082         (nreverse articles)))
1083      (gnus-newsgroup-processable
1084       (reverse gnus-newsgroup-processable))
1085      (t
1086       (gnus-uu-find-articles-matching)))))
1087
1088 (defun gnus-uu-string< (l1 l2)
1089   (string< (car l1) (car l2)))
1090
1091 (defun gnus-uu-find-articles-matching
1092   (&optional subject only-unread do-not-translate)
1093   ;; Finds all articles that matches the regexp SUBJECT.  If it is
1094   ;; nil, the current article name will be used.  If ONLY-UNREAD is
1095   ;; non-nil, only unread articles are chosen.  If DO-NOT-TRANSLATE is
1096   ;; non-nil, article names are not equalized before sorting.
1097   (let ((subject (or subject
1098                      (gnus-uu-reginize-string (gnus-summary-article-subject))))
1099         list-of-subjects)
1100     (save-excursion
1101       (if (not subject)
1102           ()
1103         ;; Collect all subjects matching subject.
1104         (let ((case-fold-search t)
1105               (data gnus-newsgroup-data)
1106               subj mark d)
1107           (while data
1108             (setq d (pop data))
1109             (and (not (gnus-data-pseudo-p d))
1110                  (or (not only-unread)
1111                      (= (setq mark (gnus-data-mark d))
1112                         gnus-unread-mark)
1113                      (= mark gnus-ticked-mark)
1114                      (= mark gnus-dormant-mark))
1115                  (setq subj (mail-header-subject (gnus-data-header d)))
1116                  (string-match subject subj)
1117                  (push (cons subj (gnus-data-number d))
1118                        list-of-subjects))))
1119
1120         ;; Expand numbers, sort, and return the list of article
1121         ;; numbers.
1122         (mapcar (lambda (sub) (cdr sub))
1123                 (sort (gnus-uu-expand-numbers
1124                        list-of-subjects
1125                        (not do-not-translate))
1126                       'gnus-uu-string<))))))
1127
1128 (defun gnus-uu-expand-numbers (string-list &optional translate)
1129   ;; Takes a list of strings and "expands" all numbers in all the
1130   ;; strings.  That is, this function makes all numbers equal length by
1131   ;; prepending lots of zeroes before each number.  This is to ease later
1132   ;; sorting to find out what sequence the articles are supposed to be
1133   ;; decoded in.  Returns the list of expanded strings.
1134   (let ((out-list string-list)
1135         string)
1136     (save-excursion
1137       (set-buffer (get-buffer-create gnus-uu-output-buffer-name))
1138       (buffer-disable-undo (current-buffer))
1139       (while string-list
1140         (erase-buffer)
1141         (insert (caar string-list))
1142         ;; Translate multiple spaces to one space.
1143         (goto-char (point-min))
1144         (while (re-search-forward "[ \t]+" nil t)
1145           (replace-match " "))
1146         ;; Translate all characters to "a".
1147         (goto-char (point-min))
1148         (when translate
1149           (while (re-search-forward "[A-Za-z]" nil t)
1150             (replace-match "a" t t)))
1151         ;; Expand numbers.
1152         (goto-char (point-min))
1153         (while (re-search-forward "[0-9]+" nil t)
1154           (replace-match
1155            (format "%06d"
1156                    (string-to-int (buffer-substring
1157                                    (match-beginning 0) (match-end 0))))))
1158         (setq string (buffer-substring 1 (point-max)))
1159         (setcar (car string-list) string)
1160         (setq string-list (cdr string-list))))
1161     out-list))
1162
1163
1164 ;; `gnus-uu-grab-articles' is the general multi-article treatment
1165 ;; function.  It takes a list of articles to be grabbed and a function
1166 ;; to apply to each article.
1167 ;;
1168 ;; The function to be called should take two parameters.  The first
1169 ;; parameter is the article buffer.  The function should leave the
1170 ;; result, if any, in this buffer.  Most treatment functions will just
1171 ;; generate files...
1172 ;;
1173 ;; The second parameter is the state of the list of articles, and can
1174 ;; have four values: `first', `middle', `last' and `first-and-last'.
1175 ;;
1176 ;; The function should return a list.  The list may contain the
1177 ;; following symbols:
1178 ;; `error' if an error occurred
1179 ;; `begin' if the beginning of an encoded file has been received
1180 ;;   If the list returned contains a `begin', the first element of
1181 ;;   the list *must* be a string with the file name of the decoded
1182 ;;   file.
1183 ;; `end' if the end of an encoded file has been received
1184 ;; `middle' if the article was a body part of an encoded file
1185 ;; `wrong-type' if the article was not a part of an encoded file
1186 ;; `ok', which can be used everything is ok
1187
1188 (defvar gnus-uu-has-been-grabbed nil)
1189
1190 (defun gnus-uu-unmark-list-of-grabbed (&optional dont-unmark-last-article)
1191   (let (art)
1192     (if (not (and gnus-uu-has-been-grabbed
1193                   gnus-uu-unmark-articles-not-decoded))
1194         ()
1195       (when dont-unmark-last-article
1196         (setq art (car gnus-uu-has-been-grabbed))
1197         (setq gnus-uu-has-been-grabbed (cdr gnus-uu-has-been-grabbed)))
1198       (while gnus-uu-has-been-grabbed
1199         (gnus-summary-tick-article (car gnus-uu-has-been-grabbed) t)
1200         (setq gnus-uu-has-been-grabbed (cdr gnus-uu-has-been-grabbed)))
1201       (when dont-unmark-last-article
1202         (setq gnus-uu-has-been-grabbed (list art))))))
1203
1204 ;; This function takes a list of articles and a function to apply to
1205 ;; each article grabbed.
1206 ;;
1207 ;; This function returns a list of files decoded if the grabbing and
1208 ;; the process-function has been successful and nil otherwise.
1209 (defun gnus-uu-grab-articles (articles process-function
1210                                        &optional sloppy limit no-errors)
1211   (let ((state 'first)
1212         has-been-begin article result-file result-files process-state
1213         gnus-summary-display-article-function
1214         gnus-article-display-hook gnus-article-prepare-hook
1215         article-series files)
1216
1217     (while (and articles
1218                 (not (memq 'error process-state))
1219                 (or sloppy
1220                     (not (memq 'end process-state))))
1221
1222       (setq article (pop articles))
1223       (push article article-series)
1224
1225       (unless articles
1226         (if (eq state 'first)
1227             (setq state 'first-and-last)
1228           (setq state 'last)))
1229
1230       (let ((part (gnus-uu-part-number article)))
1231         (gnus-message 6 "Getting article %d%s..."
1232                       article (if (string= part "") "" (concat ", " part))))
1233       (gnus-summary-display-article article)
1234
1235       ;; Push the article to the processing function.
1236       (save-excursion
1237         (set-buffer gnus-original-article-buffer)
1238         (let ((buffer-read-only nil))
1239           (save-excursion
1240             (set-buffer gnus-summary-buffer)
1241             (setq process-state
1242                   (funcall process-function
1243                            gnus-original-article-buffer state)))))
1244
1245       (gnus-summary-remove-process-mark article)
1246
1247       ;; If this is the beginning of a decoded file, we push it
1248       ;; on to a list.
1249       (when (or (memq 'begin process-state)
1250                 (and (or (eq state 'first)
1251                          (eq state 'first-and-last))
1252                      (memq 'ok process-state)))
1253         (when has-been-begin
1254           ;; If there is a `result-file' here, that means that the
1255           ;; file was unsuccessfully decoded, so we delete it.
1256           (when (and result-file
1257                      (file-exists-p result-file)
1258                      (not gnus-uu-be-dangerous)
1259                      (or (eq gnus-uu-be-dangerous t)
1260                          (gnus-y-or-n-p
1261                           (format "Delete unsuccessfully decoded file %s"
1262                                   result-file))))
1263             (delete-file result-file)))
1264         (when (memq 'begin process-state)
1265           (setq result-file (car process-state)))
1266         (setq has-been-begin t))
1267
1268       ;; Check whether we have decoded one complete file.
1269       (when (memq 'end process-state)
1270         (setq article-series nil)
1271         (setq has-been-begin nil)
1272         (if (stringp result-file)
1273             (setq files (list result-file))
1274           (setq files result-file))
1275         (setq result-file (car files))
1276         (while files
1277           (push (list (cons 'name (pop files))
1278                       (cons 'article article))
1279                 result-files))
1280         ;; Allow user-defined functions to be run on this file.
1281         (when gnus-uu-grabbed-file-functions
1282           (let ((funcs gnus-uu-grabbed-file-functions))
1283             (unless (listp funcs)
1284               (setq funcs (list funcs)))
1285             (while funcs
1286               (funcall (pop funcs) result-file))))
1287         (setq result-file nil)
1288         ;; Check whether we have decoded enough articles.
1289         (and limit (= (length result-files) limit)
1290              (setq articles nil)))
1291
1292       ;; If this is the last article to be decoded, and
1293       ;; we still haven't reached the end, then we delete
1294       ;; the partially decoded file.
1295       (and (or (eq state 'last) (eq state 'first-and-last))
1296            (not (memq 'end process-state))
1297            result-file
1298            (file-exists-p result-file)
1299            (not gnus-uu-be-dangerous)
1300            (or (eq gnus-uu-be-dangerous t)
1301                (gnus-y-or-n-p (format "Delete incomplete file %s? " result-file)))
1302            (delete-file result-file))
1303
1304       ;; If this was a file of the wrong sort, then
1305       (when (and (or (memq 'wrong-type process-state)
1306                      (memq 'error process-state))
1307                  gnus-uu-unmark-articles-not-decoded)
1308         (gnus-summary-tick-article article t))
1309
1310       ;; Set the new series state.
1311       (if (and (not has-been-begin)
1312                (not sloppy)
1313                (or (memq 'end process-state)
1314                    (memq 'middle process-state)))
1315           (progn
1316             (setq process-state (list 'error))
1317             (gnus-message 2 "No begin part at the beginning")
1318             (sleep-for 2))
1319         (setq state 'middle)))
1320
1321     ;; When there are no result-files, then something must be wrong.
1322     (if result-files
1323         (message "")
1324       (cond
1325        ((not has-been-begin)
1326         (gnus-message 2 "Wrong type file"))
1327        ((memq 'error process-state)
1328         (gnus-message 2 "An error occurred during decoding"))
1329        ((not (or (memq 'ok process-state)
1330                  (memq 'end process-state)))
1331         (gnus-message 2 "End of articles reached before end of file")))
1332       ;; Make unsuccessfully decoded articles unread.
1333       (when gnus-uu-unmark-articles-not-decoded
1334         (while article-series
1335           (gnus-summary-tick-article (pop article-series) t))))
1336
1337     result-files))
1338
1339 (defun gnus-uu-grab-view (file)
1340   "View FILE using the gnus-uu methods."
1341   (let ((action (gnus-uu-get-action file)))
1342     (gnus-execute-command
1343      (if (string-match "%" action)
1344          (format action file)
1345        (concat action " " file))
1346      (eq gnus-view-pseudos 'not-confirm))))
1347
1348 (defun gnus-uu-grab-move (file)
1349   "Move FILE to somewhere."
1350   (when gnus-uu-default-dir
1351     (let ((to-file (concat (file-name-as-directory gnus-uu-default-dir)
1352                            (file-name-nondirectory file))))
1353       (rename-file file to-file)
1354       (unless (file-exists-p file)
1355         (make-symbolic-link to-file file)))))
1356
1357 (defun gnus-uu-part-number (article)
1358   (let* ((header (gnus-summary-article-header article))
1359          (subject (and header (mail-header-subject header))))
1360     (if (and subject
1361              (string-match "[0-9]+ */[0-9]+\\|[0-9]+ * of *[0-9]+" subject))
1362         (match-string 0 subject)
1363       "")))
1364
1365 (defun gnus-uu-uudecode-sentinel (process event)
1366   (delete-process (get-process process)))
1367
1368 (defun gnus-uu-uustrip-article (process-buffer in-state)
1369   ;; Uudecodes a file asynchronously.
1370   (save-excursion
1371     (set-buffer process-buffer)
1372     (let ((state (list 'wrong-type))
1373           process-connection-type case-fold-search buffer-read-only
1374           files start-char)
1375       (goto-char (point-min))
1376
1377       ;; Deal with ^M at the end of the lines.
1378       (when gnus-uu-kill-carriage-return
1379         (save-excursion
1380           (while (search-forward "\r" nil t)
1381             (delete-backward-char 1))))
1382
1383       (while (or (re-search-forward gnus-uu-begin-string nil t)
1384                  (re-search-forward gnus-uu-body-line nil t))
1385         (setq state (list 'ok))
1386         ;; Ok, we are at the first uucoded line.
1387         (beginning-of-line)
1388         (setq start-char (point))
1389
1390         (if (not (looking-at gnus-uu-begin-string))
1391             (setq state (list 'middle))
1392           ;; This is the beginning of a uuencoded article.
1393           ;; We replace certain characters that could make things messy.
1394           (setq gnus-uu-file-name
1395                 (let ((nnheader-file-name-translation-alist
1396                        '((?/ . ?,) (? . ?_) (?* . ?_) (?$ . ?_))))
1397                   (nnheader-translate-file-chars (match-string 1))))
1398           (replace-match (concat "begin 644 " gnus-uu-file-name) t t)
1399
1400           ;; Remove any non gnus-uu-body-line right after start.
1401           (forward-line 1)
1402           (while (and (not (eobp))
1403                       (not (looking-at gnus-uu-body-line)))
1404             (gnus-delete-line))
1405
1406           ;; If a process is running, we kill it.
1407           (when (and gnus-uu-uudecode-process
1408                      (memq (process-status gnus-uu-uudecode-process)
1409                            '(run stop)))
1410             (delete-process gnus-uu-uudecode-process)
1411             (gnus-uu-unmark-list-of-grabbed t))
1412
1413           ;; Start a new uudecoding process.
1414           (let ((cdir default-directory))
1415             (unwind-protect
1416                 (progn
1417                   (cd gnus-uu-work-dir)
1418                   (setq gnus-uu-uudecode-process
1419                         (start-process
1420                          "*uudecode*"
1421                          (get-buffer-create gnus-uu-output-buffer-name)
1422                          shell-file-name shell-command-switch
1423                          (format "cd %s %s uudecode" gnus-uu-work-dir
1424                                  gnus-shell-command-separator))))
1425               (cd cdir)))
1426           (set-process-sentinel
1427            gnus-uu-uudecode-process 'gnus-uu-uudecode-sentinel)
1428           (setq state (list 'begin))
1429           (push (concat gnus-uu-work-dir gnus-uu-file-name) files))
1430
1431         ;; We look for the end of the thing to be decoded.
1432         (if (re-search-forward gnus-uu-end-string nil t)
1433             (push 'end state)
1434           (goto-char (point-max))
1435           (re-search-backward gnus-uu-body-line nil t))
1436
1437         (forward-line 1)
1438
1439         (when gnus-uu-uudecode-process
1440           (when (memq (process-status gnus-uu-uudecode-process) '(run stop))
1441             ;; Try to correct mishandled uucode.
1442             (when gnus-uu-correct-stripped-uucode
1443               (gnus-uu-check-correct-stripped-uucode start-char (point)))
1444
1445             ;; Send the text to the process.
1446             (condition-case nil
1447                 (process-send-region
1448                  gnus-uu-uudecode-process start-char (point))
1449               (error
1450                (progn
1451                  (delete-process gnus-uu-uudecode-process)
1452                  (gnus-message 2 "gnus-uu: Couldn't uudecode")
1453                  (setq state (list 'wrong-type)))))
1454
1455             (if (memq 'end state)
1456                 (progn
1457                   ;; Send an EOF, just in case.
1458                   (ignore-errors
1459                     (process-send-eof gnus-uu-uudecode-process))
1460                   (while (memq (process-status gnus-uu-uudecode-process)
1461                                '(open run))
1462                     (accept-process-output gnus-uu-uudecode-process 1)))
1463               (when (or (not gnus-uu-uudecode-process)
1464                         (not (memq (process-status gnus-uu-uudecode-process)
1465                                    '(run stop))))
1466                 (setq state (list 'wrong-type)))))))
1467
1468       (if (memq 'begin state)
1469           (cons (if (= (length files) 1) (car files) files) state)
1470         state))))
1471
1472 ;; This function is used by `gnus-uu-grab-articles' to treat
1473 ;; a shared article.
1474 (defun gnus-uu-unshar-article (process-buffer in-state)
1475   (let ((state (list 'ok))
1476         start-char)
1477     (save-excursion
1478       (set-buffer process-buffer)
1479       (goto-char (point-min))
1480       (if (not (re-search-forward gnus-uu-shar-begin-string nil t))
1481           (setq state (list 'wrong-type))
1482         (beginning-of-line)
1483         (setq start-char (point))
1484         (call-process-region
1485          start-char (point-max) shell-file-name nil
1486          (get-buffer-create gnus-uu-output-buffer-name) nil
1487          shell-command-switch
1488          (concat "cd " gnus-uu-work-dir " "
1489                  gnus-shell-command-separator  " sh"))))
1490     state))
1491
1492 ;; Returns the name of what the shar file is going to unpack.
1493 (defun gnus-uu-find-name-in-shar ()
1494   (let ((oldpoint (point))
1495         res)
1496     (goto-char (point-min))
1497     (when (re-search-forward gnus-uu-shar-name-marker nil t)
1498       (setq res (buffer-substring (match-beginning 1) (match-end 1))))
1499     (goto-char oldpoint)
1500     res))
1501
1502 ;; `gnus-uu-choose-action' chooses what action to perform given the name
1503 ;; and `gnus-uu-file-action-list'.  Returns either nil if no action is
1504 ;; found, or the name of the command to run if such a rule is found.
1505 (defun gnus-uu-choose-action (file-name file-action-list &optional no-ignore)
1506   (let ((action-list (copy-sequence file-action-list))
1507         (case-fold-search t)
1508         rule action)
1509     (and
1510      (unless no-ignore
1511        (and (not
1512              (and gnus-uu-ignore-files-by-name
1513                   (string-match gnus-uu-ignore-files-by-name file-name)))
1514             (not
1515              (and gnus-uu-ignore-files-by-type
1516                   (string-match gnus-uu-ignore-files-by-type
1517                                 (or (gnus-uu-choose-action
1518                                      file-name gnus-uu-ext-to-mime-list t)
1519                                     ""))))))
1520      (while (not (or (eq action-list ()) action))
1521        (setq rule (car action-list))
1522        (setq action-list (cdr action-list))
1523        (when (string-match (car rule) file-name)
1524          (setq action (cadr rule)))))
1525     action))
1526
1527 (defun gnus-uu-treat-archive (file-path)
1528   ;; Unpacks an archive.  Returns t if unpacking is successful.
1529   (let ((did-unpack t)
1530         action command dir)
1531     (setq action (gnus-uu-choose-action
1532                   file-path (append gnus-uu-user-archive-rules
1533                                     (if gnus-uu-ignore-default-archive-rules
1534                                         nil
1535                                       gnus-uu-default-archive-rules))))
1536
1537     (when (not action)
1538       (error "No unpackers for the file %s" file-path))
1539
1540     (string-match "/[^/]*$" file-path)
1541     (setq dir (substring file-path 0 (match-beginning 0)))
1542
1543     (when (member action gnus-uu-destructive-archivers)
1544       (copy-file file-path (concat file-path "~") t))
1545
1546     (setq command (format "cd %s ; %s" dir (gnus-uu-command action file-path)))
1547
1548     (save-excursion
1549       (set-buffer (get-buffer-create gnus-uu-output-buffer-name))
1550       (erase-buffer))
1551
1552     (gnus-message 5 "Unpacking: %s..." (gnus-uu-command action file-path))
1553
1554     (if (= 0 (call-process shell-file-name nil
1555                            (get-buffer-create gnus-uu-output-buffer-name)
1556                            nil shell-command-switch command))
1557         (message "")
1558       (gnus-message 2 "Error during unpacking of archive")
1559       (setq did-unpack nil))
1560
1561     (when (member action gnus-uu-destructive-archivers)
1562       (rename-file (concat file-path "~") file-path t))
1563
1564     did-unpack))
1565
1566 (defun gnus-uu-dir-files (dir)
1567   (let ((dirs (directory-files dir t "[^/][^\\.][^\\.]?$"))
1568         files file)
1569     (while dirs
1570       (if (file-directory-p (setq file (car dirs)))
1571           (setq files (append files (gnus-uu-dir-files file)))
1572         (push file files))
1573       (setq dirs (cdr dirs)))
1574     files))
1575
1576 (defun gnus-uu-unpack-files (files &optional ignore)
1577   ;; Go through FILES and look for files to unpack.
1578   (let* ((totfiles (gnus-uu-ls-r gnus-uu-work-dir))
1579          (ofiles files)
1580          file did-unpack)
1581     (while files
1582       (setq file (cdr (assq 'name (car files))))
1583       (when (and (not (member file ignore))
1584                  (equal (gnus-uu-get-action (file-name-nondirectory file))
1585                         "gnus-uu-archive"))
1586         (push file did-unpack)
1587         (unless (gnus-uu-treat-archive file)
1588           (gnus-message 2 "Error during unpacking of %s" file))
1589         (let* ((newfiles (gnus-uu-ls-r gnus-uu-work-dir))
1590                (nfiles newfiles))
1591           (while nfiles
1592             (unless (member (car nfiles) totfiles)
1593               (push (list (cons 'name (car nfiles))
1594                           (cons 'original file))
1595                     ofiles))
1596             (setq nfiles (cdr nfiles)))
1597           (setq totfiles newfiles)))
1598       (setq files (cdr files)))
1599     (if did-unpack
1600         (gnus-uu-unpack-files ofiles (append did-unpack ignore))
1601       ofiles)))
1602
1603 (defun gnus-uu-ls-r (dir)
1604   (let* ((files (gnus-uu-directory-files dir t))
1605          (ofiles files))
1606     (while files
1607       (when (file-directory-p (car files))
1608         (setq ofiles (delete (car files) ofiles))
1609         (setq ofiles (append ofiles (gnus-uu-ls-r (car files)))))
1610       (setq files (cdr files)))
1611     ofiles))
1612
1613 ;; Various stuff
1614
1615 (defun gnus-uu-directory-files (dir &optional full)
1616   (let (files out file)
1617     (setq files (directory-files dir full))
1618     (while files
1619       (setq file (car files))
1620       (setq files (cdr files))
1621       (unless (member (file-name-nondirectory file) '("." ".."))
1622         (push file out)))
1623     (setq out (nreverse out))
1624     out))
1625
1626 (defun gnus-uu-check-correct-stripped-uucode (start end)
1627   (save-excursion
1628     (let (found beg length)
1629       (if (not gnus-uu-correct-stripped-uucode)
1630           ()
1631         (goto-char start)
1632
1633         (if (re-search-forward " \\|`" end t)
1634             (progn
1635               (goto-char start)
1636               (while (not (eobp))
1637                 (progn
1638                   (when (looking-at "\n")
1639                     (replace-match ""))
1640                   (forward-line 1))))
1641
1642           (while (not (eobp))
1643             (if (looking-at (concat gnus-uu-begin-string "\\|"
1644                                     gnus-uu-end-string))
1645                 ()
1646               (when (not found)
1647                 (beginning-of-line)
1648                 (setq beg (point))
1649                 (end-of-line)
1650                 (setq length (- (point) beg)))
1651               (setq found t)
1652               (beginning-of-line)
1653               (setq beg (point))
1654               (end-of-line)
1655               (when (not (= length (- (point) beg)))
1656                 (insert (make-string (- length (- (point) beg)) ? ))))
1657             (forward-line 1)))))))
1658
1659 (defvar gnus-uu-tmp-alist nil)
1660
1661 (defun gnus-uu-initialize (&optional scan)
1662   (let (entry)
1663     (if (and (not scan)
1664              (when (setq entry (assoc gnus-newsgroup-name gnus-uu-tmp-alist))
1665                (if (file-exists-p (cdr entry))
1666                    (setq gnus-uu-work-dir (cdr entry))
1667                  (setq gnus-uu-tmp-alist (delq entry gnus-uu-tmp-alist))
1668                  nil)))
1669         t
1670       (setq gnus-uu-tmp-dir (file-name-as-directory
1671                              (expand-file-name gnus-uu-tmp-dir)))
1672       (if (not (file-directory-p gnus-uu-tmp-dir))
1673           (error "Temp directory %s doesn't exist" gnus-uu-tmp-dir)
1674         (when (not (file-writable-p gnus-uu-tmp-dir))
1675           (error "Temp directory %s can't be written to"
1676                  gnus-uu-tmp-dir)))
1677
1678       (setq gnus-uu-work-dir
1679             (make-temp-name (concat gnus-uu-tmp-dir "gnus")))
1680       (gnus-make-directory gnus-uu-work-dir)
1681       (set-file-modes gnus-uu-work-dir 448)
1682       (setq gnus-uu-work-dir (file-name-as-directory gnus-uu-work-dir))
1683       (push (cons gnus-newsgroup-name gnus-uu-work-dir)
1684             gnus-uu-tmp-alist))))
1685
1686
1687 ;; Kills the temporary uu buffers, kills any processes, etc.
1688 (defun gnus-uu-clean-up ()
1689   (let (buf)
1690     (and gnus-uu-uudecode-process
1691          (memq (process-status (or gnus-uu-uudecode-process "nevair"))
1692                '(stop run))
1693          (delete-process gnus-uu-uudecode-process))
1694     (when (setq buf (get-buffer gnus-uu-output-buffer-name))
1695       (kill-buffer buf))))
1696
1697 (defun gnus-quote-arg-for-sh-or-csh (arg)
1698   (let ((pos 0) new-pos accum)
1699     ;; *** bug: we don't handle newline characters properly
1700     (while (setq new-pos (string-match "[!`\"$\\& \t{}]" arg pos))
1701       (push (substring arg pos new-pos) accum)
1702       (push "\\" accum)
1703       (push (list (aref arg new-pos)) accum)
1704       (setq pos (1+ new-pos)))
1705     (if (= pos 0)
1706         arg
1707       (apply 'concat (nconc (nreverse accum) (list (substring arg pos)))))))
1708
1709 ;; Inputs an action and a filename and returns a full command, making sure
1710 ;; that the filename will be treated as a single argument when the shell
1711 ;; executes the command.
1712 (defun gnus-uu-command (action file)
1713   (let ((quoted-file (gnus-quote-arg-for-sh-or-csh file)))
1714     (if (string-match "%s" action)
1715         (format action quoted-file)
1716       (concat action " " quoted-file))))
1717
1718 (defun gnus-uu-delete-work-dir (&optional dir)
1719   "Delete recursively all files and directories under `gnus-uu-work-dir'."
1720   (if dir
1721       (gnus-message 7 "Deleting directory %s..." dir)
1722     (setq dir gnus-uu-work-dir))
1723   (when (and dir
1724              (file-exists-p dir))
1725     (let ((files (directory-files dir t nil t))
1726           file)
1727       (while (setq file (pop files))
1728         (unless (member (file-name-nondirectory file) '("." ".."))
1729           (if (file-directory-p file)
1730               (gnus-uu-delete-work-dir file)
1731             (gnus-message 9 "Deleting file %s..." file)
1732             (delete-file file))))
1733       (delete-directory dir)))
1734   (gnus-message 7 ""))
1735
1736 ;; Initializing
1737
1738 (add-hook 'gnus-exit-group-hook 'gnus-uu-clean-up)
1739 (add-hook 'gnus-exit-group-hook 'gnus-uu-delete-work-dir)
1740
1741 \f
1742
1743 ;;;
1744 ;;; uuencoded posting
1745 ;;;
1746
1747 ;; Any function that is to be used as and encoding method will take two
1748 ;; parameters: PATH-NAME and FILE-NAME.  (E.g. "/home/gaga/spiral.jpg"
1749 ;; and "spiral.jpg", respectively.) The function should return nil if
1750 ;; the encoding wasn't successful.
1751 (defcustom gnus-uu-post-encode-method 'gnus-uu-post-encode-uuencode
1752   "Function used for encoding binary files.
1753 There are three functions supplied with gnus-uu for encoding files:
1754 `gnus-uu-post-encode-uuencode', which does straight uuencoding;
1755 `gnus-uu-post-encode-mime', which encodes with base64 and adds MIME
1756 headers; and `gnus-uu-post-encode-mime-uuencode', which encodes with
1757 uuencode and adds MIME headers."
1758   :group 'gnus-extract-post
1759   :type '(radio (function-item gnus-uu-post-encode-uuencode)
1760                 (function-item gnus-uu-post-encode-mime)
1761                 (function-item gnus-uu-post-encode-mime-uuencode)
1762                 (function :tag "Other")))
1763
1764 (defcustom gnus-uu-post-include-before-composing nil
1765   "Non-nil means that gnus-uu will ask for a file to encode before you compose the article.
1766 If this variable is t, you can either include an encoded file with
1767 \\[gnus-uu-post-insert-binary-in-article] or have one included for you when you post the article."
1768   :group 'gnus-extract-post
1769   :type 'boolean)
1770
1771 (defcustom gnus-uu-post-length 990
1772   "Maximum length of an article.
1773 The encoded file will be split into how many articles it takes to
1774 post the entire file."
1775   :group 'gnus-extract-post
1776   :type 'integer)
1777
1778 (defcustom gnus-uu-post-threaded nil
1779   "Non-nil means that gnus-uu will post the encoded file in a thread.
1780 This may not be smart, as no other decoder I have seen are able to
1781 follow threads when collecting uuencoded articles.  (Well, I have seen
1782 one package that does that - gnus-uu, but somehow, I don't think that
1783 counts...)  The default is nil."
1784   :group 'gnus-extract-post
1785   :type 'boolean)
1786
1787 (defcustom gnus-uu-post-separate-description t
1788   "Non-nil means that the description will be posted in a separate article.
1789 The first article will typically be numbered (0/x).  If this variable
1790 is nil, the description the user enters will be included at the
1791 beginning of the first article, which will be numbered (1/x).  Default
1792 is t."
1793   :group 'gnus-extract-post
1794   :type 'boolean)
1795
1796 (defvar gnus-uu-post-binary-separator "--binary follows this line--")
1797 (defvar gnus-uu-post-message-id nil)
1798 (defvar gnus-uu-post-inserted-file-name nil)
1799 (defvar gnus-uu-winconf-post-news nil)
1800
1801 (defun gnus-uu-post-news ()
1802   "Compose an article and post an encoded file."
1803   (interactive)
1804   (setq gnus-uu-post-inserted-file-name nil)
1805   (setq gnus-uu-winconf-post-news (current-window-configuration))
1806
1807   (gnus-summary-post-news)
1808
1809   (use-local-map (copy-keymap (current-local-map)))
1810   (local-set-key "\C-c\C-c" 'gnus-summary-edit-article-done)
1811   (local-set-key "\C-c\C-c" 'gnus-uu-post-news-inews)
1812   (local-set-key "\C-c\C-s" 'gnus-uu-post-news-inews)
1813   (local-set-key "\C-c\C-i" 'gnus-uu-post-insert-binary-in-article)
1814
1815   (when gnus-uu-post-include-before-composing
1816     (save-excursion (setq gnus-uu-post-inserted-file-name
1817                           (gnus-uu-post-insert-binary)))))
1818
1819 (defun gnus-uu-post-insert-binary-in-article ()
1820   "Inserts an encoded file in the buffer.
1821 The user will be asked for a file name."
1822   (interactive)
1823   (save-excursion
1824     (setq gnus-uu-post-inserted-file-name (gnus-uu-post-insert-binary))))
1825
1826 ;; Encodes with uuencode and substitutes all spaces with backticks.
1827 (defun gnus-uu-post-encode-uuencode (path file-name)
1828   (when (gnus-uu-post-encode-file "uuencode" path file-name)
1829     (goto-char (point-min))
1830     (forward-line 1)
1831     (while (re-search-forward " " nil t)
1832       (replace-match "`"))
1833     t))
1834
1835 ;; Encodes with uuencode and adds MIME headers.
1836 (defun gnus-uu-post-encode-mime-uuencode (path file-name)
1837   (when (gnus-uu-post-encode-uuencode path file-name)
1838     (gnus-uu-post-make-mime file-name "x-uue")
1839     t))
1840
1841 ;; Encodes with base64 and adds MIME headers
1842 (defun gnus-uu-post-encode-mime (path file-name)
1843   (when (gnus-uu-post-encode-file "mmencode" path file-name)
1844     (gnus-uu-post-make-mime file-name "base64")
1845     t))
1846
1847 ;; Adds MIME headers.
1848 (defun gnus-uu-post-make-mime (file-name encoding)
1849   (goto-char (point-min))
1850   (insert (format "Content-Type: %s; name=\"%s\"\n"
1851                   (gnus-uu-choose-action file-name gnus-uu-ext-to-mime-list)
1852                   file-name))
1853   (insert (format "Content-Transfer-Encoding: %s\n\n" encoding))
1854   (save-restriction
1855     (set-buffer gnus-message-buffer)
1856     (goto-char (point-min))
1857     (re-search-forward (concat "^" (regexp-quote mail-header-separator) "$"))
1858     (forward-line -1)
1859     (narrow-to-region 1 (point))
1860     (unless (mail-fetch-field "mime-version")
1861       (widen)
1862       (insert "MIME-Version: 1.0\n"))
1863     (widen)))
1864
1865 ;; Encodes a file PATH with COMMAND, leaving the result in the
1866 ;; current buffer.
1867 (defun gnus-uu-post-encode-file (command path file-name)
1868   (= 0 (call-process shell-file-name nil t nil shell-command-switch
1869                      (format "%s %s %s" command path file-name))))
1870
1871 (defun gnus-uu-post-news-inews ()
1872   "Posts the composed news article and encoded file.
1873 If no file has been included, the user will be asked for a file."
1874   (interactive)
1875
1876   (let (file-name)
1877
1878     (if gnus-uu-post-inserted-file-name
1879         (setq file-name gnus-uu-post-inserted-file-name)
1880       (setq file-name (gnus-uu-post-insert-binary)))
1881
1882     (gnus-uu-post-encoded file-name gnus-uu-post-threaded))
1883   (setq gnus-uu-post-inserted-file-name nil)
1884   (when gnus-uu-winconf-post-news
1885     (set-window-configuration gnus-uu-winconf-post-news)))
1886
1887 ;; Asks for a file to encode, encodes it and inserts the result in
1888 ;; the current buffer.  Returns the file name the user gave.
1889 (defun gnus-uu-post-insert-binary ()
1890   (let ((uuencode-buffer-name "*uuencode buffer*")
1891         file-path uubuf file-name)
1892
1893     (setq file-path (read-file-name
1894                      "What file do you want to encode? "))
1895     (when (not (file-exists-p file-path))
1896       (error "%s: No such file" file-path))
1897
1898     (goto-char (point-max))
1899     (insert (format "\n%s\n" gnus-uu-post-binary-separator))
1900
1901     (when (string-match "^~/" file-path)
1902       (setq file-path (concat "$HOME" (substring file-path 1))))
1903     (if (string-match "/[^/]*$" file-path)
1904         (setq file-name (substring file-path (1+ (match-beginning 0))))
1905       (setq file-name file-path))
1906
1907     (unwind-protect
1908         (if (save-excursion
1909               (set-buffer (setq uubuf
1910                                 (get-buffer-create uuencode-buffer-name)))
1911               (erase-buffer)
1912               (funcall gnus-uu-post-encode-method file-path file-name))
1913             (insert-buffer-substring uubuf)
1914           (error "Encoding unsuccessful"))
1915       (kill-buffer uubuf))
1916     file-name))
1917
1918 ;; Posts the article and all of the encoded file.
1919 (defun gnus-uu-post-encoded (file-name &optional threaded)
1920   (let ((send-buffer-name "*uuencode send buffer*")
1921         (encoded-buffer-name "*encoded buffer*")
1922         (top-string "[ cut here %s (%s %d/%d) %s gnus-uu ]")
1923         (separator (concat mail-header-separator "\n\n"))
1924         uubuf length parts header i end beg
1925         beg-line minlen buf post-buf whole-len beg-binary end-binary)
1926
1927     (setq post-buf (current-buffer))
1928
1929     (goto-char (point-min))
1930     (when (not (re-search-forward
1931                 (if gnus-uu-post-separate-description
1932                     (concat "^" (regexp-quote gnus-uu-post-binary-separator)
1933                             "$")
1934                   (concat "^" (regexp-quote mail-header-separator) "$"))
1935                 nil t))
1936       (error "Internal error: No binary/header separator"))
1937     (beginning-of-line)
1938     (forward-line 1)
1939     (setq beg-binary (point))
1940     (setq end-binary (point-max))
1941
1942     (save-excursion
1943       (set-buffer (setq uubuf (get-buffer-create encoded-buffer-name)))
1944       (erase-buffer)
1945       (insert-buffer-substring post-buf beg-binary end-binary)
1946       (goto-char (point-min))
1947       (setq length (count-lines 1 (point-max)))
1948       (setq parts (/ length gnus-uu-post-length))
1949       (unless (< (% length gnus-uu-post-length) 4)
1950         (incf parts)))
1951
1952     (when gnus-uu-post-separate-description
1953       (forward-line -1))
1954     (delete-region (point) (point-max))
1955
1956     (goto-char (point-min))
1957     (re-search-forward
1958      (concat "^" (regexp-quote mail-header-separator) "$") nil t)
1959     (beginning-of-line)
1960     (setq header (buffer-substring 1 (point)))
1961
1962     (goto-char (point-min))
1963     (when gnus-uu-post-separate-description
1964       (when (re-search-forward "^Subject: " nil t)
1965         (end-of-line)
1966         (insert (format " (0/%d)" parts)))
1967       (save-excursion
1968         (message-send))
1969       (setq gnus-uu-post-message-id (message-fetch-field "message-id")))
1970
1971     (save-excursion
1972       (setq i 1)
1973       (setq beg 1)
1974       (while (not (> i parts))
1975         (set-buffer (get-buffer-create send-buffer-name))
1976         (erase-buffer)
1977         (insert header)
1978         (when (and threaded gnus-uu-post-message-id)
1979           (insert "References: " gnus-uu-post-message-id "\n"))
1980         (insert separator)
1981         (setq whole-len
1982               (- 62 (length (format top-string "" file-name i parts ""))))
1983         (when (> 1 (setq minlen (/ whole-len 2)))
1984           (setq minlen 1))
1985         (setq
1986          beg-line
1987          (format top-string
1988                  (make-string minlen ?-)
1989                  file-name i parts
1990                  (make-string
1991                   (if (= 0 (% whole-len 2)) (1- minlen) minlen) ?-)))
1992
1993         (goto-char (point-min))
1994         (when (re-search-forward "^Subject: " nil t)
1995           (end-of-line)
1996           (insert (format " (%d/%d)" i parts)))
1997
1998         (goto-char (point-max))
1999         (save-excursion
2000           (set-buffer uubuf)
2001           (goto-char beg)
2002           (if (= i parts)
2003               (goto-char (point-max))
2004             (forward-line gnus-uu-post-length))
2005           (when (and (= (1+ i) parts) (< (count-lines (point) (point-max)) 4))
2006             (forward-line -4))
2007           (setq end (point)))
2008         (insert-buffer-substring uubuf beg end)
2009         (insert beg-line "\n")
2010         (setq beg end)
2011         (incf i)
2012         (goto-char (point-min))
2013         (re-search-forward
2014          (concat "^" (regexp-quote mail-header-separator) "$") nil t)
2015         (beginning-of-line)
2016         (forward-line 2)
2017         (when (re-search-forward
2018                (concat "^" (regexp-quote gnus-uu-post-binary-separator) "$")
2019                nil t)
2020           (replace-match "")
2021           (forward-line 1))
2022         (insert beg-line)
2023         (insert "\n")
2024         (let (message-sent-message-via)
2025           (save-excursion
2026             (message-send))
2027           (setq gnus-uu-post-message-id
2028                 (concat (message-fetch-field "references") " "
2029                         (message-fetch-field "message-id"))))))
2030
2031     (gnus-kill-buffer send-buffer-name)
2032     (gnus-kill-buffer encoded-buffer-name)
2033
2034     (when (not gnus-uu-post-separate-description)
2035       (set-buffer-modified-p nil)
2036       (when (fboundp 'bury-buffer)
2037         (bury-buffer)))))
2038
2039 (provide 'gnus-uu)
2040
2041 ;; gnus-uu.el ends here