… | |
… | |
6 | use Carp; |
6 | use Carp; |
7 | |
7 | |
8 | require Exporter; |
8 | require Exporter; |
9 | require DynaLoader; |
9 | require DynaLoader; |
10 | |
10 | |
11 | our $VERSION = '1.12'; |
11 | our $VERSION = 1.62; |
12 | |
12 | |
13 | our @ISA = qw(Exporter DynaLoader); |
13 | our @ISA = qw(Exporter DynaLoader); |
14 | |
14 | |
15 | our @_consts = qw( |
15 | our @_consts = qw( |
16 | ACT_COPYING ACT_DECODING ACT_ENCODING ACT_IDLE ACT_SCANNING |
16 | ACT_COPYING ACT_DECODING ACT_ENCODING ACT_IDLE ACT_SCANNING |
… | |
… | |
22 | |
22 | |
23 | OPT_RBUF OPT_WBUF |
23 | OPT_RBUF OPT_WBUF |
24 | OPT_BRACKPOL OPT_DEBUG OPT_DESPERATE OPT_DUMBNESS OPT_ENCEXT |
24 | OPT_BRACKPOL OPT_DEBUG OPT_DESPERATE OPT_DUMBNESS OPT_ENCEXT |
25 | OPT_ERRNO OPT_FAST OPT_IGNMODE OPT_IGNREPLY OPT_OVERWRITE OPT_PREAMB |
25 | OPT_ERRNO OPT_FAST OPT_IGNMODE OPT_IGNREPLY OPT_OVERWRITE OPT_PREAMB |
26 | OPT_PROGRESS OPT_SAVEPATH OPT_TINYB64 OPT_USETEXT OPT_VERBOSE |
26 | OPT_PROGRESS OPT_SAVEPATH OPT_TINYB64 OPT_USETEXT OPT_VERBOSE |
27 | OPT_VERSION OPT_REMOVE OPT_MOREMIME OPT_DOTDOT |
27 | OPT_VERSION OPT_REMOVE OPT_MOREMIME OPT_DOTDOT OPT_AUTOCHECK |
28 | |
28 | |
29 | RET_CANCEL RET_CONT RET_EXISTS RET_ILLVAL RET_IOERR RET_NODATA |
29 | RET_CANCEL RET_CONT RET_EXISTS RET_ILLVAL RET_IOERR RET_NODATA |
30 | RET_NOEND RET_NOMEM RET_OK RET_UNSUP |
30 | RET_NOEND RET_NOMEM RET_OK RET_UNSUP |
31 | |
31 | |
32 | B64_ENCODED BH_ENCODED PT_ENCODED QP_ENCODED |
32 | B64_ENCODED BH_ENCODED PT_ENCODED QP_ENCODED |
… | |
… | |
34 | ); |
34 | ); |
35 | |
35 | |
36 | our @_funcs = qw( |
36 | our @_funcs = qw( |
37 | Initialize CleanUp GetOption SetOption strerror SetMsgCallback |
37 | Initialize CleanUp GetOption SetOption strerror SetMsgCallback |
38 | SetBusyCallback SetFileCallback SetFNameFilter SetFileNameCallback |
38 | SetBusyCallback SetFileCallback SetFNameFilter SetFileNameCallback |
39 | FNameFilter LoadFile GetFileListItem RenameFile DecodeToTemp |
39 | FNameFilter LoadFile GetFileListItem GetFileList RenameFile DecodeToTemp |
40 | RemoveTemp DecodeFile InfoFile Smerge QuickDecode EncodeMulti |
40 | RemoveTemp DecodeFile InfoFile Smerge QuickDecode EncodeMulti |
41 | EncodePartial EncodeToStream EncodeToFile E_PrepSingle |
41 | EncodePartial EncodeToStream EncodeToFile E_PrepSingle |
42 | E_PrepPartial |
42 | E_PrepPartial |
43 | |
43 | |
44 | straction strencoding strmsglevel |
44 | straction strencoding strmsglevel |
… | |
… | |
105 | use Convert::UUlib ':all'; |
105 | use Convert::UUlib ':all'; |
106 | |
106 | |
107 | # read all the files named on the commandline and decode them |
107 | # read all the files named on the commandline and decode them |
108 | # into the CURRENT directory. See below for a longer example. |
108 | # into the CURRENT directory. See below for a longer example. |
109 | LoadFile $_ for @ARGV; |
109 | LoadFile $_ for @ARGV; |
110 | for (my $i = 0; my $uu = GetFileListItem $i; $i++) { |
110 | for my $uu (GetFileList) { |
111 | if ($uu->state & FILE_OK) { |
111 | if ($uu->state & FILE_OK) { |
112 | $uu->decode; |
112 | $uu->decode; |
113 | print $uu->filename, "\n"; |
113 | print $uu->filename, "\n"; |
114 | } |
114 | } |
115 | } |
115 | } |
… | |
… | |
159 | OPT_TINYB64 detect short B64 outside of Mime |
159 | OPT_TINYB64 detect short B64 outside of Mime |
160 | OPT_ENCEXT extension for single-part encoded files |
160 | OPT_ENCEXT extension for single-part encoded files |
161 | OPT_REMOVE remove input files after decoding (dangerous) |
161 | OPT_REMOVE remove input files after decoding (dangerous) |
162 | OPT_MOREMIME strict MIME adherence |
162 | OPT_MOREMIME strict MIME adherence |
163 | OPT_DOTDOT ".."-unescaping has not yet been done on input files |
163 | OPT_DOTDOT ".."-unescaping has not yet been done on input files |
164 | OPT_RBUF set default read I/O buffer size in bytes *EXPERIMENTAL* |
164 | OPT_RBUF set default read I/O buffer size in bytes |
165 | OPT_WBUF set default write I/O buffer size in bytes *EXPERIMENTAL* |
165 | OPT_WBUF set default write I/O buffer size in bytes |
|
|
166 | OPT_AUTOCHECK automatically check file list after every loadfile |
166 | |
167 | |
167 | =head2 Result/Error codes |
168 | =head2 Result/Error codes |
168 | |
169 | |
169 | RET_OK everything went fine |
170 | RET_OK everything went fine |
170 | RET_IOERR I/O Error - examine errno |
171 | RET_IOERR I/O Error - examine errno |
… | |
… | |
213 | again. |
214 | again. |
214 | |
215 | |
215 | On my machine, a fairly complete decode with DBI backend needs about 10MB |
216 | On my machine, a fairly complete decode with DBI backend needs about 10MB |
216 | RSS to decode 20000 files. |
217 | RSS to decode 20000 files. |
217 | |
218 | |
218 | =over 4 |
219 | =over |
219 | |
220 | |
220 | =item Initialize |
221 | =item Initialize |
221 | |
222 | |
222 | Not normally necessary, (re-)initializes the library. |
223 | Not normally necessary, (re-)initializes the library. |
223 | |
224 | |
… | |
… | |
228 | |
229 | |
229 | =back |
230 | =back |
230 | |
231 | |
231 | =head2 Setting and querying options |
232 | =head2 Setting and querying options |
232 | |
233 | |
233 | =over 4 |
234 | =over |
234 | |
235 | |
235 | =item $option = GetOption OPT_xxx |
236 | =item $option = GetOption OPT_xxx |
236 | |
237 | |
237 | =item SetOption OPT_xxx, opt-value |
238 | =item SetOption OPT_xxx, opt-value |
238 | |
239 | |
… | |
… | |
240 | |
241 | |
241 | See the C<OPT_xxx> constants above to see which options exist. |
242 | See the C<OPT_xxx> constants above to see which options exist. |
242 | |
243 | |
243 | =head2 Setting various callbacks |
244 | =head2 Setting various callbacks |
244 | |
245 | |
245 | =over 4 |
246 | =over |
246 | |
247 | |
247 | =item SetMsgCallback [callback-function] |
248 | =item SetMsgCallback [callback-function] |
248 | |
249 | |
249 | =item SetBusyCallback [callback-function] |
250 | =item SetBusyCallback [callback-function] |
250 | |
251 | |
… | |
… | |
254 | |
255 | |
255 | =back |
256 | =back |
256 | |
257 | |
257 | =head2 Call the currently selected FNameFilter |
258 | =head2 Call the currently selected FNameFilter |
258 | |
259 | |
259 | =over 4 |
260 | =over |
260 | |
261 | |
261 | =item $file = FNameFilter $file |
262 | =item $file = FNameFilter $file |
262 | |
263 | |
263 | =back |
264 | =back |
264 | |
265 | |
265 | =head2 Loading sourcefiles, optionally fuzzy merge and start decoding |
266 | =head2 Loading sourcefiles, optionally fuzzy merge and start decoding |
266 | |
267 | |
267 | =over 4 |
268 | =over |
268 | |
269 | |
269 | =item ($retval, $count) = LoadFile $fname, [$id, [$delflag, [$partno]]] |
270 | =item ($retval, $count) = LoadFile $fname, [$id, [$delflag, [$partno]]] |
270 | |
271 | |
271 | Load the given file and scan it for encoded contents. Optionally tag it |
272 | Load the given file and scan it for encoded contents. Optionally tag it |
272 | with the given id, and if C<$delflag> is true, delete the file after it |
273 | with the given id, and if C<$delflag> is true, delete the file after it |
… | |
… | |
281 | If you are desperate, try to call C<Smerge> with increasing C<$pass> |
282 | If you are desperate, try to call C<Smerge> with increasing C<$pass> |
282 | values, beginning at C<0>, to try to merge parts that usually would not |
283 | values, beginning at C<0>, to try to merge parts that usually would not |
283 | have been merged. |
284 | have been merged. |
284 | |
285 | |
285 | Most probably this will result in garbled files, so never do this by |
286 | Most probably this will result in garbled files, so never do this by |
286 | default. |
287 | default, except: |
|
|
288 | |
|
|
289 | If the C<OPT_AUTOCHECK> option has been disabled (by default it is |
|
|
290 | enabled) to speed up file loading, then you I<have> to call C<Smerge -1> |
|
|
291 | after loading all files as an additional pre-pass (which is normally done |
|
|
292 | by C<LoadFile>). |
287 | |
293 | |
288 | =item $item = GetFileListItem $item_number |
294 | =item $item = GetFileListItem $item_number |
289 | |
295 | |
290 | Return the C<$item> structure for the C<$item_number>'th found file, or |
296 | Return the C<$item> structure for the C<$item_number>'th found file, or |
291 | C<undef> of no file with that number exists. |
297 | C<undef> of no file with that number exists. |
292 | |
298 | |
293 | The first file has number C<0>, and the series has no holes, so you can |
299 | The first file has number C<0>, and the series has no holes, so you can |
294 | iterate over all files by starting with zero and incrementing until you |
300 | iterate over all files by starting with zero and incrementing until you |
295 | hit C<undef>. |
301 | hit C<undef>. |
296 | |
302 | |
|
|
303 | This function has to walk the linear list of fils on each access, so |
|
|
304 | if you want to iterate over all items, it is usually faster to use |
|
|
305 | C<GetFileList>. |
|
|
306 | |
|
|
307 | =item @items = GetFileList |
|
|
308 | |
|
|
309 | Similar to C<GetFileListItem>, but returns all files in one go. |
|
|
310 | |
297 | =back |
311 | =back |
298 | |
312 | |
299 | =head2 Decoding files |
313 | =head2 Decoding files |
300 | |
314 | |
301 | =over 4 |
315 | =over |
302 | |
316 | |
303 | =item $retval = $item->rename($newname) |
317 | =item $retval = $item->rename ($newname) |
304 | |
318 | |
305 | Change the ondisk filename where the decoded file will be saved. |
319 | Change the ondisk filename where the decoded file will be saved. |
306 | |
320 | |
307 | =item $retval = $item->decode_temp |
321 | =item $retval = $item->decode_temp |
308 | |
322 | |
… | |
… | |
311 | |
325 | |
312 | =item $retval = $item->remove_temp |
326 | =item $retval = $item->remove_temp |
313 | |
327 | |
314 | Remove the temporarily decoded file again. |
328 | Remove the temporarily decoded file again. |
315 | |
329 | |
316 | =item $retval = $item->decode([$target_path]) |
330 | =item $retval = $item->decode ([$target_path]) |
317 | |
331 | |
318 | Decode the file to it's destination, or the given target path. |
332 | Decode the file to its destination, or the given target path. |
319 | |
333 | |
320 | =item $retval = $item->info(callback-function) |
334 | =item $retval = $item->info (callback-function) |
321 | |
335 | |
322 | =back |
336 | =back |
323 | |
337 | |
324 | =head2 Querying (and setting) item attributes |
338 | =head2 Querying (and setting) item attributes |
325 | |
339 | |
326 | =over 4 |
340 | =over |
327 | |
341 | |
328 | =item $state = $item->state |
342 | =item $state = $item->state |
329 | |
343 | |
330 | =item $mode = $item->mode([newmode]) |
344 | =item $mode = $item->mode ([newmode]) |
331 | |
345 | |
332 | =item $uudet = $item->uudet |
346 | =item $uudet = $item->uudet |
333 | |
347 | |
334 | =item $size = $item->size |
348 | =item $size = $item->size |
335 | |
349 | |
336 | =item $filename = $item->filename([newfilename}) |
350 | =item $filename = $item->filename ([newfilename}) |
337 | |
351 | |
338 | =item $subfname = $item->subfname |
352 | =item $subfname = $item->subfname |
339 | |
353 | |
340 | =item $mimeid = $item->mimeid |
354 | =item $mimeid = $item->mimeid |
341 | |
355 | |
… | |
… | |
345 | |
359 | |
346 | =back |
360 | =back |
347 | |
361 | |
348 | =head2 Information about source parts |
362 | =head2 Information about source parts |
349 | |
363 | |
350 | =over 4 |
364 | =over |
351 | |
365 | |
352 | =item $parts = $item->parts |
366 | =item $parts = $item->parts |
353 | |
367 | |
354 | Return information about all parts (source files) used to decode the file |
368 | Return information about all parts (source files) used to decode the file |
355 | as a list of hashrefs with the following structure: |
369 | as a list of hashrefs with the following structure: |
… | |
… | |
369 | Usually you are interested mostly the C<sfname> and possibly the C<partno> |
383 | Usually you are interested mostly the C<sfname> and possibly the C<partno> |
370 | and C<filename> members. |
384 | and C<filename> members. |
371 | |
385 | |
372 | =back |
386 | =back |
373 | |
387 | |
374 | =head2 Functions below not documented and not very well tested |
388 | =head2 Functions below are not documented and not very well tested - feedback welcome |
375 | |
389 | |
376 | QuickDecode |
390 | QuickDecode |
377 | EncodeMulti |
391 | EncodeMulti |
378 | EncodePartial |
392 | EncodePartial |
379 | EncodeToStream |
393 | EncodeToStream |
… | |
… | |
383 | |
397 | |
384 | =head2 EXTENSION FUNCTIONS |
398 | =head2 EXTENSION FUNCTIONS |
385 | |
399 | |
386 | Functions found in this module but not documented in the uulib documentation: |
400 | Functions found in this module but not documented in the uulib documentation: |
387 | |
401 | |
388 | =over 4 |
402 | =over |
389 | |
403 | |
390 | =item $msg = straction ACT_xxx |
404 | =item $msg = straction ACT_xxx |
391 | |
405 | |
392 | Return a human readable string representing the given action code. |
406 | Return a human readable string representing the given action code. |
393 | |
407 | |
… | |
… | |
507 | # otherwise just pass what we have |
521 | # otherwise just pass what we have |
508 | () |
522 | () |
509 | }; |
523 | }; |
510 | |
524 | |
511 | # now read all files in the directory uusrc/* |
525 | # now read all files in the directory uusrc/* |
512 | for(<uusrc/*>) { |
526 | for (<uusrc/*>) { |
513 | my ($retval, $count) = LoadFile ($_, $_, 1); |
527 | my ($retval, $count) = LoadFile ($_, $_, 1); |
514 | print "file($_), status(", strerror $retval, ") parts($count)\n"; |
528 | print "file($_), status(", strerror $retval, ") parts($count)\n"; |
515 | } |
529 | } |
516 | |
530 | |
517 | SetOption OPT_SAVEPATH, "uudst/"; |
531 | SetOption OPT_SAVEPATH, "uudst/"; |
518 | |
532 | |
519 | # now wade through all files and their source parts |
533 | # now wade through all files and their source parts |
520 | $i = 0; |
534 | for my $uu (GetFileList) { |
521 | while ($uu = GetFileListItem $i) { |
535 | print "file ", $uu->filename, "\n"; |
522 | $i++; |
|
|
523 | print "file nr. $i"; |
|
|
524 | print " state ", $uu->state; |
536 | print " state ", $uu->state, "\n"; |
525 | print " mode ", $uu->mode; |
537 | print " mode ", $uu->mode, "\n"; |
526 | print " uudet ", strencoding $uu->uudet; |
538 | print " uudet ", strencoding $uu->uudet, "\n"; |
527 | print " size ", $uu->size; |
539 | print " size ", $uu->size, "\n"; |
528 | print " filename ", $uu->filename; |
|
|
529 | print " subfname ", $uu->subfname; |
540 | print " subfname ", $uu->subfname, "\n"; |
530 | print " mimeid ", $uu->mimeid; |
541 | print " mimeid ", $uu->mimeid, "\n"; |
531 | print " mimetype ", $uu->mimetype; |
542 | print " mimetype ", $uu->mimetype, "\n"; |
532 | print "\n"; |
|
|
533 | |
543 | |
534 | # print additional info about all parts |
544 | # print additional info about all parts |
|
|
545 | print " parts"; |
535 | for ($uu->parts) { |
546 | for ($uu->parts) { |
536 | while (my ($k, $v) = each %$_) { |
547 | for my $k (sort keys %$_) { |
537 | print "$k > $v, "; |
548 | print " $k=$_->{$k}"; |
538 | } |
549 | } |
539 | print "\n"; |
550 | print "\n"; |
540 | } |
551 | } |
541 | |
552 | |
542 | print $uu->filename; |
|
|
543 | |
|
|
544 | $uu->remove_temp; |
553 | $uu->remove_temp; |
545 | |
554 | |
546 | if (my $err = $uu->decode ()) { |
555 | if (my $err = $uu->decode) { |
547 | print ", ", strerror $err, "\n"; |
556 | print " ERROR ", strerror $err, "\n"; |
548 | } else { |
557 | } else { |
549 | print ", saved as uudst/", $uu->filename, "\n"; |
558 | print " successfully saved as uudst/", $uu->filename, "\n"; |
550 | } |
559 | } |
551 | } |
560 | } |
552 | |
561 | |
553 | print "cleanup...\n"; |
562 | print "cleanup...\n"; |
554 | |
563 | |
555 | CleanUp; |
564 | CleanUp; |
|
|
565 | |
|
|
566 | =head1 PERLMULTICORE SUPPORT |
|
|
567 | |
|
|
568 | This module supports the perlmulticore standard (see |
|
|
569 | L<http://perlmulticore.schmorp.de/> for more info) for the following |
|
|
570 | functions - generally these are functions accessing the disk and/or using |
|
|
571 | considerable CPU time: |
|
|
572 | |
|
|
573 | LoadFile |
|
|
574 | $item->decode |
|
|
575 | $item->decode_temp |
|
|
576 | $item->remove_temp |
|
|
577 | $item->info |
|
|
578 | |
|
|
579 | The perl interpreter will be reacquired/released on every callback |
|
|
580 | invocation, so for performance reasons, callbacks should be avoided if |
|
|
581 | that is costly. |
|
|
582 | |
|
|
583 | Future versions might enable multicore support for more functions. |
|
|
584 | |
|
|
585 | =head1 BUGS AND LIMITATIONS |
|
|
586 | |
|
|
587 | The original uulib library this module uses was written at a time where |
|
|
588 | main memory of measured in megabytes and buffer overflows as a security |
|
|
589 | thign didn't exist. While a lot of security fixes have been applied over |
|
|
590 | the years (includign some defense in depth mechanism that can shield |
|
|
591 | against a lot of as-of-yet undetected bugs), using this library for |
|
|
592 | security purposes requires care. |
|
|
593 | |
|
|
594 | Likewise, file sizes when the uulib library was written were tiny compared |
|
|
595 | to today, so do not expect this library to handle files larger than 2GB. |
556 | |
596 | |
557 | =head1 AUTHOR |
597 | =head1 AUTHOR |
558 | |
598 | |
559 | Marc Lehmann <schmorp@schmorp.de>, the original uulib library was written |
599 | Marc Lehmann <schmorp@schmorp.de>, the original uulib library was written |
560 | by Frank Pilhofer <fp@informatik.uni-frankfurt.de>, and later heavily |
600 | by Frank Pilhofer <fp@informatik.uni-frankfurt.de>, and later heavily |
561 | bugfixed by Marc Lehmann. |
601 | bugfixed by Marc Lehmann. |
562 | |
602 | |
563 | =head1 SEE ALSO |
603 | =head1 SEE ALSO |
564 | |
604 | |
565 | perl(1), uudeview homepage at http://www.uni-frankfurt.de/~fp/uudeview/. |
605 | perl(1), uudeview homepage at L<http://www.fpx.de/fp/Software/UUDeview/>. |
566 | |
606 | |
567 | =cut |
607 | =cut |
|
|
608 | |