ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/Convert-UUlib/UUlib.pm
(Generate patch)

Comparing Convert-UUlib/UUlib.pm (file contents):
Revision 1.11 by root, Sun Oct 13 13:47:09 2002 UTC vs.
Revision 1.58 by root, Sun Jan 29 05:04:51 2023 UTC

1package Convert::UUlib; 1package Convert::UUlib;
2
3use common::sense;
2 4
3use Carp; 5use Carp;
4 6
5require Exporter; 7require Exporter;
6require DynaLoader; 8require DynaLoader;
7use AutoLoader;
8 9
9$VERSION = 0.214; 10our $VERSION = 1.8;
10 11
11@ISA = qw(Exporter DynaLoader); 12our @ISA = qw(Exporter DynaLoader);
12 13
13@_consts = qw( 14our @_consts = qw(
14 ACT_COPYING ACT_DECODING ACT_ENCODING ACT_IDLE ACT_SCANNING 15 ACT_COPYING ACT_DECODING ACT_ENCODING ACT_IDLE ACT_SCANNING
15 16
16 FILE_DECODED FILE_ERROR FILE_MISPART FILE_NOBEGIN FILE_NODATA 17 FILE_DECODED FILE_ERROR FILE_MISPART FILE_NOBEGIN FILE_NODATA
17 FILE_NOEND FILE_OK FILE_READ FILE_TMPFILE 18 FILE_NOEND FILE_OK FILE_READ FILE_TMPFILE
18 19
19 MSG_ERROR MSG_FATAL MSG_MESSAGE MSG_NOTE MSG_PANIC MSG_WARNING 20 MSG_ERROR MSG_FATAL MSG_MESSAGE MSG_NOTE MSG_PANIC MSG_WARNING
20 21
22 OPT_RBUF OPT_WBUF
21 OPT_BRACKPOL OPT_DEBUG OPT_DESPERATE OPT_DUMBNESS OPT_ENCEXT 23 OPT_BRACKPOL OPT_DEBUG OPT_DESPERATE OPT_DUMBNESS OPT_ENCEXT
22 OPT_ERRNO OPT_FAST OPT_IGNMODE OPT_IGNREPLY OPT_OVERWRITE OPT_PREAMB 24 OPT_ERRNO OPT_FAST OPT_IGNMODE OPT_IGNREPLY OPT_OVERWRITE OPT_PREAMB
23 OPT_PROGRESS OPT_SAVEPATH OPT_TINYB64 OPT_USETEXT OPT_VERBOSE 25 OPT_PROGRESS OPT_SAVEPATH OPT_TINYB64 OPT_USETEXT OPT_VERBOSE
24 OPT_VERSION OPT_REMOVE OPT_MOREMIME OPT_DOTDOT 26 OPT_VERSION OPT_REMOVE OPT_MOREMIME OPT_DOTDOT OPT_AUTOCHECK
25 27
26 RET_CANCEL RET_CONT RET_EXISTS RET_ILLVAL RET_IOERR RET_NODATA 28 RET_CANCEL RET_CONT RET_EXISTS RET_ILLVAL RET_IOERR RET_NODATA
27 RET_NOEND RET_NOMEM RET_OK RET_UNSUP 29 RET_NOEND RET_NOMEM RET_OK RET_UNSUP
28 30
29 B64_ENCODED BH_ENCODED PT_ENCODED QP_ENCODED 31 B64_ENCODED BH_ENCODED PT_ENCODED QP_ENCODED
30 XX_ENCODED UU_ENCODED YENC_ENCODED 32 XX_ENCODED UU_ENCODED YENC_ENCODED
31); 33);
32 34
33@_funcs = qw( 35our @_funcs = qw(
34 Initialize CleanUp GetOption SetOption strerror SetMsgCallback 36 Initialize CleanUp GetOption SetOption strerror SetMsgCallback
35 SetBusyCallback SetFileCallback SetFNameFilter SetFileNameCallback 37 SetBusyCallback SetFileCallback SetFNameFilter SetFileNameCallback
36 FNameFilter LoadFile GetFileListItem RenameFile DecodeToTemp 38 FNameFilter LoadFile GetFileListItem GetFileList RenameFile DecodeToTemp
37 RemoveTemp DecodeFile InfoFile Smerge QuickDecode EncodeMulti 39 RemoveTemp DecodeFile InfoFile Smerge QuickDecode EncodeMulti
38 EncodePartial EncodeToStream EncodeToFile E_PrepSingle 40 EncodePartial EncodeToStream EncodeToFile E_PrepSingle
39 E_PrepPartial 41 E_PrepPartial
40 42
41 straction strencoding strmsglevel 43 straction strencoding strmsglevel
42); 44);
43 45
44@EXPORT = @_consts; 46our @EXPORT = @_consts;
45@EXPORT_OK = @_funcs; 47our @EXPORT_OK = @_funcs;
46%EXPORT_TAGS = (all => [@_consts,@_funcs], constants => \@_consts); 48our %EXPORT_TAGS = (all => [@_consts,@_funcs], constants => \@_consts);
47 49
48bootstrap Convert::UUlib $VERSION; 50bootstrap Convert::UUlib $VERSION;
49 51
50Initialize(); 52# dummy function for compatiiblity with pre-1.7 versions
51 53sub Initialize { }
52# not when < 5.005_6x
53# END { CleanUp() }
54
55for (@_consts) {
56 my $constant = constant($_);
57 *$_ = sub () { $constant };
58}
59 54
60# action code -> string mapping 55# action code -> string mapping
61sub straction($) { 56sub straction($) {
62 return 'copying' if $_[0] == &ACT_COPYING; 57 return 'copying' if $_[0] == &ACT_COPYING;
63 return 'decoding' if $_[0] == &ACT_DECODING; 58 return 'decoding' if $_[0] == &ACT_DECODING;
921; 871;
93__END__ 88__END__
94 89
95=head1 NAME 90=head1 NAME
96 91
97Convert::UUlib - Perl interface to the uulib library (a.k.a. uudeview/uuenview). 92Convert::UUlib - decode uu/xx/b64/mime/yenc/etc-encoded data from a massive number of files
98 93
99=head1 SYNOPSIS 94=head1 SYNOPSIS
100 95
101 use Convert::UUlib ':all'; 96 use Convert::UUlib ':all';
102 97
103 # read all the files named on the commandline and decode them 98 # read all the files named on the commandline and decode them
99 # into the CURRENT directory. See below for a longer example.
104 LoadFile($_) for @ARGV; 100 LoadFile $_ for @ARGV;
105 for($i=0; $uu=GetFileListItem($i); $i++) { 101
102 for my $uu (GetFileList) {
106 $uu->decode if $uu->state & FILE_OK; 103 if ($uu->state & FILE_OK) {
104 $uu->decode;
105 print $uu->filename, "\n";
106 }
107 } 107 }
108 108
109=head1 DESCRIPTION 109=head1 DESCRIPTION
110
111This module started as an interface to the uulib/uudeview library by Frank
112Pilhofer that can be used to decode all kinds of usenet (and other)
113binary messages.
114
115After upstream abondoned the project, the library was continuously bugfixed
116and improved in this module, with major focuses on security fixes,
117correctness and speed (that does not mean that this library is considered
118safe with untrusted data, but it surely is safer than the original
119uudeview).
110 120
111Read the file doc/library.pdf from the distribution for in-depth 121Read the file doc/library.pdf from the distribution for in-depth
112information about the C-library used in this interface, and the rest of 122information about the C-library used in this interface, and the rest of
113this document and especially the non-trivial decoder program at the end. 123this document and especially the non-trivial decoder program at the end.
114 124
134=head2 Options 144=head2 Options
135 145
136 OPT_VERSION version number MAJOR.MINORplPATCH (ro) 146 OPT_VERSION version number MAJOR.MINORplPATCH (ro)
137 OPT_FAST assumes only one part per file 147 OPT_FAST assumes only one part per file
138 OPT_DUMBNESS switch off the program's intelligence 148 OPT_DUMBNESS switch off the program's intelligence
139 OPT_BRACKPOL give numbers in [] higher precendence 149 OPT_BRACKPOL give numbers in [] higher precedence
140 OPT_VERBOSE generate informative messages 150 OPT_VERBOSE generate informative messages
141 OPT_DESPERATE try to decode incomplete files 151 OPT_DESPERATE try to decode incomplete files
142 OPT_IGNREPLY ignore RE:plies (off by default) 152 OPT_IGNREPLY ignore RE:plies (off by default)
143 OPT_OVERWRITE whether it's OK to overwrite ex. files 153 OPT_OVERWRITE whether it's OK to overwrite ex. files
144 OPT_SAVEPATH prefix to save-files on disk 154 OPT_SAVEPATH prefix to save-files on disk
148 OPT_PROGRESS retrieve progress information 158 OPT_PROGRESS retrieve progress information
149 OPT_USETEXT handle text messages 159 OPT_USETEXT handle text messages
150 OPT_PREAMB handle Mime preambles/epilogues 160 OPT_PREAMB handle Mime preambles/epilogues
151 OPT_TINYB64 detect short B64 outside of Mime 161 OPT_TINYB64 detect short B64 outside of Mime
152 OPT_ENCEXT extension for single-part encoded files 162 OPT_ENCEXT extension for single-part encoded files
153 OPT_REMOVE remove input files after decoding 163 OPT_REMOVE remove input files after decoding (dangerous)
154 OPT_MOREMIME strict MIME adherence 164 OPT_MOREMIME strict MIME adherence
155 OPT_DOTDOT .. unescaping has not yet been done on input files 165 OPT_DOTDOT ".."-unescaping has not yet been done on input files
166 OPT_RBUF set default read I/O buffer size in bytes
167 OPT_WBUF set default write I/O buffer size in bytes
168 OPT_AUTOCHECK automatically check file list after every loadfile
156 169
157=head2 Result/Error codes 170=head2 Result/Error codes
158 171
159 RET_OK everything went fine 172 RET_OK everything went fine
160 RET_IOERR I/O Error - examine errno 173 RET_IOERR I/O Error - examine errno
171 184
172 This code is zero, i.e. "false": 185 This code is zero, i.e. "false":
173 186
174 UUFILE_READ Read in, but not further processed 187 UUFILE_READ Read in, but not further processed
175 188
176 The following state codes are ored together: 189 The following state codes are or'ed together:
177 190
178 FILE_MISPART Missing Part(s) detected 191 FILE_MISPART Missing Part(s) detected
179 FILE_NOBEGIN No 'begin' found 192 FILE_NOBEGIN No 'begin' found
180 FILE_NOEND No 'end' found 193 FILE_NOEND No 'end' found
181 FILE_NODATA File does not contain valid uudata 194 FILE_NODATA File does not contain valid uudata
197=head1 EXPORTED FUNCTIONS 210=head1 EXPORTED FUNCTIONS
198 211
199=head2 Initializing and cleanup 212=head2 Initializing and cleanup
200 213
201Initialize is automatically called when the module is loaded and allocates 214Initialize is automatically called when the module is loaded and allocates
202quite a bit of memory. CleanUp releases that again. 215quite a small amount of memory for todays machines ;) CleanUp releases that
216again.
203 217
204 Initialize; # not normally necessary 218On my machine, a fairly complete decode with DBI backend needs about 10MB
205 CleanUp; # could be called at the end to release memory 219RSS to decode 20000 files.
220
221=over
222
223=item CleanUp
224
225Release memory, file items and clean up files. Should be called after a
226decoidng run, if you want to start a new one.
227
228=back
206 229
207=head2 Setting and querying options 230=head2 Setting and querying options
208 231
232=over
233
209 $option = GetOption OPT_xxx; 234=item $option = GetOption OPT_xxx
235
210 SetOption OPT_xxx, opt-value; 236=item SetOption OPT_xxx, opt-value
237
238=back
239
240See the C<OPT_xxx> constants above to see which options exist.
211 241
212=head2 Setting various callbacks 242=head2 Setting various callbacks
213 243
244=over
245
214 SetMsgCallback [callback-function]; 246=item SetMsgCallback [callback-function]
247
215 SetBusyCallback [callback-function]; 248=item SetBusyCallback [callback-function]
249
216 SetFileCallback [callback-function]; 250=item SetFileCallback [callback-function]
251
217 SetFNameFilter [callback-function]; 252=item SetFNameFilter [callback-function]
253
254=back
218 255
219=head2 Call the currently selected FNameFilter 256=head2 Call the currently selected FNameFilter
220 257
258=over
259
221 $file = FNameFilter $file; 260=item $file = FNameFilter $file
261
262=back
222 263
223=head2 Loading sourcefiles, optionally fuzzy merge and start decoding 264=head2 Loading sourcefiles, optionally fuzzy merge and start decoding
224 265
266=over
267
225 ($retval, $count) = LoadFile $fname, [$id, [$delflag]]; 268=item ($retval, $count) = LoadFile $fname, [$id, [$delflag, [$partno]]]
269
270Load the given file and scan it for encoded contents. Optionally tag it
271with the given id, and if C<$delflag> is true, delete the file after it
272is no longer necessary. If you are certain of the part number, you can
273specify it as the last argument.
274
275A better (usually faster) way of doing this is using the C<SetFNameFilter>
276functionality.
277
226 $retval = Smerge $pass; 278=item $retval = Smerge $pass
279
280If you are desperate, try to call C<Smerge> with increasing C<$pass>
281values, beginning at C<0>, to try to merge parts that usually would not
282have been merged.
283
284Most probably this will result in garbled files, so never do this by
285default, except:
286
287If the C<OPT_AUTOCHECK> option has been disabled (by default it is
288enabled) to speed up file loading, then you I<have> to call C<Smerge -1>
289after loading all files as an additional pre-pass (which is normally done
290by C<LoadFile>).
291
227 $item = GetFileListItem $item_number; 292=item $item = GetFileListItem $item_number
228 293
229=head2 The procedural interface is undocumented, use the following methods instead 294Return the C<$item> structure for the C<$item_number>'th found file, or
295C<undef> of no file with that number exists.
230 296
297The first file has number C<0>, and the series has no holes, so you can
298iterate over all files by starting with zero and incrementing until you
299hit C<undef>.
300
301This function has to walk the linear list of fils on each access, so
302if you want to iterate over all items, it is usually faster to use
303C<GetFileList>.
304
305=item @items = GetFileList
306
307Similar to C<GetFileListItem>, but returns all files in one go, which is
308very much faster for large number of items, and has no drawbacks when used
309for a small number of items.
310
311=back
312
313=head2 Decoding files
314
315=over
316
231 $retval = $item->rename($newname); 317=item $retval = $item->rename ($newname)
318
319Change the ondisk filename where the decoded file will be saved.
320
232 $retval = $item->decode_temp; 321=item $retval = $item->decode_temp
322
323Decode the file into a temporary location, use C<< $item->infile >> to
324retrieve the temporary filename.
325
233 $retval = $item->remove_temp; 326=item $retval = $item->remove_temp
327
328Remove the temporarily decoded file again.
329
234 $retval = $item->decode([$target_path]); 330=item $retval = $item->decode ([$target_path])
331
332Decode the file to its destination, or the given target path.
333
235 $retval = $item->info(callback-function); 334=item $retval = $item->info (callback-function)
335
336=back
236 337
237=head2 Querying (and setting) item attributes 338=head2 Querying (and setting) item attributes
238 339
340=over
341
239 $state = $item->state; 342=item $state = $item->state
343
240 $mode = $item->mode([newmode]); 344=item $mode = $item->mode ([newmode])
345
241 $uudet = $item->uudet; 346=item $uudet = $item->uudet
347
242 $size = $item->size; 348=item $size = $item->size
349
243 $filename = $item->filename([newfilename}); 350=item $filename = $item->filename ([newfilename})
351
244 $subfname = $item->subfname; 352=item $subfname = $item->subfname
353
245 $mimeid = $item->mimeid; 354=item $mimeid = $item->mimeid
355
246 $mimetype = $item->mimetype; 356=item $mimetype = $item->mimetype
357
247 $binfile = $item->binfile; 358=item $binfile = $item->binfile
248 359
249=head2 Totally undocumented but well tested ;) 360=back
250 361
362=head2 Information about source parts
363
364=over
365
251 $parts = $item->parts; 366=item $parts = $item->parts
252 367
368Return information about all parts (source files) used to decode the file
369as a list of hashrefs with the following structure:
370
371 {
372 partno => <integer describing the part number, starting with 1>,
373 # the following member sonly exist when they contain useful information
374 sfname => <local pathname of the file where this part is from>,
375 filename => <the ondisk filename of the decoded file>,
376 subfname => <used to cluster postings, possibly the posting filename>,
377 subject => <the subject of the posting/mail>,
378 origin => <the possible source (From) address>,
379 mimetype => <the possible mimetype of the decoded file>,
380 mimeid => <the id part of the Content-Type>,
381 }
382
383Usually you are interested mostly the C<sfname> and possibly the C<partno>
384and C<filename> members.
385
386=back
387
253=head2 Functions below not documented and not very well tested 388=head2 Functions below are not documented and not very well tested - feedback welcome
254 389
255 QuickDecode 390 QuickDecode
256 EncodeMulti 391 EncodeMulti
257 EncodePartial 392 EncodePartial
258 EncodeToStream 393 EncodeToStream
262 397
263=head2 EXTENSION FUNCTIONS 398=head2 EXTENSION FUNCTIONS
264 399
265Functions found in this module but not documented in the uulib documentation: 400Functions found in this module but not documented in the uulib documentation:
266 401
267=over 4 402=over
268 403
269=item $msg = straction ACT_xxx 404=item $msg = straction ACT_xxx
270 405
271Return a human readable string representing the given action code. 406Return a human readable string representing the given action code.
272 407
313 448
314=back 449=back
315 450
316=head1 LARGE EXAMPLE DECODER 451=head1 LARGE EXAMPLE DECODER
317 452
453The general workflow for decoding is like this:
454
455=over
456
457=item 1. Configure options with C<SetOption> or C<SetXXXCallback>.
458
459=item 2. Load all source files with C<LoadFile>.
460
461=item 3. Optionally C<Smerge>.
462
463=item 4. Iterate over all C<GetFileList> items (i.e. result files).
464
465=item 5. C<CleanUp> to delete files and free items.
466
467=back
468
318This is the file C<example-decoder> from the distribution, put here 469What follows is the file C<example-decoder> from the distribution that
319instead of more thorough documentation. 470illustrates the above worklfow in a non-trivial example.
320 471
472 #!/usr/bin/perl
473
321 # decode all the files in the directory uusrc/ and copy 474 # decode all the files in the directory uusrc/ and copy
322 # the resulting files to uudst/ 475 # the resulting files to uudst/
323 476
324 use Convert::UUlib ':all'; 477 use Convert::UUlib ':all';
325 478
326 sub namefilter { 479 sub namefilter {
327 my($path)=@_; 480 my ($path) = @_;
481
328 $path=~s/^.*[\/\\]//; 482 $path=~s/^.*[\/\\]//;
483
329 $path; 484 $path
330 } 485 }
331 486
332 sub busycb { 487 sub busycb {
333 my ($action, $curfile, $partno, $numparts, $percent, $fsize) = @_; 488 my ($action, $curfile, $partno, $numparts, $percent, $fsize) = @_;
334 $_[0]=straction($action); 489 $_[0]=straction($action);
335 print "busy_callback(", (join ",",@_), ")\n"; 490 print "busy_callback(", (join ",",@_), ")\n";
336 0; 491 0
337 } 492 }
338 493
494 SetOption OPT_RBUF, 128*1024;
495 SetOption OPT_WBUF, 1024*1024;
339 SetOption OPT_IGNMODE, 1; 496 SetOption OPT_IGNMODE, 1;
497 SetOption OPT_IGNMODE, 1;
340 SetOption OPT_VERBOSE, 1; 498 SetOption OPT_VERBOSE, 1;
499 SetOption OPT_AUTOCHK, 0;
341 500
342 # show the three ways you can set callback functions. I normally 501 # show the three ways you can set callback functions. I normally
343 # prefer the one with the sub inplace. 502 # prefer the one with the sub inplace.
344 SetFNameFilter \&namefilter; 503 SetFNameFilter \&namefilter;
345 504
346 SetBusyCallback "busycb", 333; 505 SetBusyCallback "busycb", 333;
347 506
348 SetMsgCallback sub { 507 SetMsgCallback sub {
349 my ($msg, $level) = @_; 508 my ($msg, $level) = @_;
350 print uc strmsglevel $_[1], ": $msg\n"; 509 print uc strmsglevel $_[1], ": $msg\n";
351 }; 510 };
352 511
353 # the following non-trivial FileNameCallback takes care 512 # the following non-trivial FileNameCallback takes care
354 # of some subject lines not detected properly by uulib: 513 # of some subject lines not detected properly by uulib:
355 SetFileNameCallback sub { 514 SetFileNameCallback sub {
356 return unless $_[1]; # skip "Re:"-plies et al. 515 return unless $_[1]; # skip "Re:"-plies et al.
357 local $_ = $_[0]; 516 local $_ = $_[0];
358 517
359 # the following rules are rather effective on some newsgroups, 518 # the following rules are rather effective on some newsgroups,
360 # like alt.binaries.games.anime, where non-mime, uuencoded data 519 # like alt.binaries.games.anime, where non-mime, uuencoded data
361 # is very common 520 # is very common
362 521
363 # if we find some *.rar, take it as the filename 522 # if we find some *.rar, take it as the filename
364 return $1 if /(\S{3,}\.(?:[rstuvwxyz]\d\d|rar))\s/i; 523 return $1 if /(\S{3,}\.(?:[rstuvwxyz]\d\d|rar))\s/i;
365 524
366 # one common subject format 525 # one common subject format
367 return $1 if /- "(.{2,}?\..+?)" (?:yenc )?\(\d+\/\d+\)/i; 526 return $1 if /- "(.{2,}?\..+?)" (?:yenc )?\(\d+\/\d+\)/i;
368 527
369 # - filename.par (04/55) 528 # - filename.par (04/55)
370 return $1 if /- "?(\S{3,}\.\S+?)"? (?:yenc )?\(\d+\/\d+\)/i; 529 return $1 if /- "?(\S{3,}\.\S+?)"? (?:yenc )?\(\d+\/\d+\)/i;
371 530
372 # - (xxx) No. 1 sayuri81.jpg 756565 bytes 531 # - (xxx) No. 1 sayuri81.jpg 756565 bytes
373 # - (20 files) No.17 Roseanne.jpg [2/2] 532 # - (20 files) No.17 Roseanne.jpg [2/2]
374 return $1 if /No\.[ 0-9]+ (\S+\....) (?:\d+ bytes )?\[/; 533 return $1 if /No\.[ 0-9]+ (\S+\....) (?:\d+ bytes )?\[/;
375 534
535 # try to detect some common forms of filenames
536 return $1 if /([a-z0-9_\-+.]{3,}\.[a-z]{3,4}(?:.\d+))/i;
537
376 # otherwise just pass what we have 538 # otherwise just pass what we have
377 return (); 539 ()
378 }; 540 };
379 541
380 # now read all files in the directory uusrc/* 542 # now read all files in the directory uusrc/*
381 for(<uusrc/*>) { 543 for (<uusrc/*>) {
382 my($retval,$count)=LoadFile ($_, $_, 1); 544 my ($retval, $count) = LoadFile ($_, $_, 1);
383 print "file($_), status(", strerror $retval, ") parts($count)\n"; 545 print "file($_), status(", strerror $retval, ") parts($count)\n";
384 } 546 }
385 547
548 Smerge -1;
549
386 SetOption OPT_SAVEPATH, "uudst/"; 550 SetOption OPT_SAVEPATH, "uudst/";
387 551
388 # now wade through all files and their source parts 552 # now wade through all files and their source parts
389 $i = 0; 553 for my $uu (GetFileList) {
390 while ($uu = GetFileListItem($i)) { 554 print "file ", $uu->filename, "\n";
391 $i++;
392 print "file nr. $i";
393 print " state ", $uu->state; 555 print " state ", $uu->state, "\n";
394 print " mode ", $uu->mode; 556 print " mode ", $uu->mode, "\n";
395 print " uudet ", strencoding $uu->uudet; 557 print " uudet ", strencoding $uu->uudet, "\n";
396 print " size ", $uu->size; 558 print " size ", $uu->size, "\n";
397 print " filename ", $uu->filename;
398 print " subfname ", $uu->subfname; 559 print " subfname ", $uu->subfname, "\n";
399 print " mimeid ", $uu->mimeid; 560 print " mimeid ", $uu->mimeid, "\n";
400 print " mimetype ", $uu->mimetype; 561 print " mimetype ", $uu->mimetype, "\n";
401 print "\n";
402 562
403 # print additional info about all parts 563 # print additional info about all parts
564 print " parts";
404 for ($uu->parts) { 565 for ($uu->parts) {
405 while (my ($k, $v) = each %$_) { 566 for my $k (sort keys %$_) {
406 print "$k > $v, "; 567 print " $k=$_->{$k}";
407 } 568 }
408 print "\n"; 569 print "\n";
409 } 570 }
410 571
411 $uu->decode_temp;
412 print " temporarily decoded to ", $uu->binfile, "\n";
413 $uu->remove_temp; 572 $uu->remove_temp;
414 573
415 print strerror $uu->decode; 574 if (my $err = $uu->decode) {
575 print " ERROR ", strerror $err, "\n";
576 } else {
416 print " saved as uudst/", $uu->filename, "\n"; 577 print " successfully saved as uudst/", $uu->filename, "\n";
417 } 578 }
579 }
418 580
419 print "cleanup...\n"; 581 print "cleanup...\n";
420 582
421 CleanUp(); 583 CleanUp;
584
585=head1 PERLMULTICORE SUPPORT
586
587This module supports the perlmulticore standard (see
588L<http://perlmulticore.schmorp.de/> for more info) for the following
589functions - generally these are functions accessing the disk and/or using
590considerable CPU time:
591
592 LoadFile
593 $item->decode
594 $item->decode_temp
595 $item->remove_temp
596 $item->info
597
598The perl interpreter will be reacquired/released on every callback
599invocation, so for performance reasons, callbacks should be avoided if
600that is costly.
601
602Future versions might enable multicore support for more functions.
603
604=head1 BUGS AND LIMITATIONS
605
606The original uulib library this module uses was written at a time where
607main memory was measured in megabytes and buffer overflows as a security
608thing didn't exist. While a lot of security fixes have been applied over
609the years (including some defense in depth mechanism that can shield
610against a lot of as-of-yet undetected bugs), using this library for
611security purposes requires care.
612
613Likewise, file sizes when the uulib library was written were tiny compared
614to today, so do not expect this library to handle files larger than 2GB,
615certainly not on a 32 bit host.
616
617Lastly, this module uses a very "C-like" interface, which means it doesn't
618protect you from invalid pointers as you might expect from "more perlish"
619modules - for example, accessing a file item object after calling
620C<CleanUp> will likely result in crashes, memory corruption, or worse.
422 621
423=head1 AUTHOR 622=head1 AUTHOR
424 623
425Marc Lehmann <pcg@goof.com>, the original uulib library was written 624Marc Lehmann <schmorp@schmorp.de>, the original uulib library was written
426by Frank Pilhofer <fp@informatik.uni-frankfurt.de>, and later heavily 625by Frank Pilhofer <fp@informatik.uni-frankfurt.de>, and later heavily
427bugfixed by Marc Lehmann. 626bugfixed by Marc Lehmann.
428 627
429=head1 SEE ALSO 628=head1 SEE ALSO
430 629
431perl(1), uudeview homepage at http://www.uni-frankfurt.de/~fp/uudeview/. 630perl(1), uudeview homepage at L<http://www.fpx.de/fp/Software/UUDeview/>.
432 631
433=cut 632=cut
633

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines