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.48 by root, Fri Feb 28 17:19:02 2020 UTC vs.
Revision 1.58 by root, Sun Jan 29 05:04:51 2023 UTC

1package Convert::UUlib; 1package Convert::UUlib;
2 2
3no warnings; 3use common::sense;
4use strict;
5 4
6use Carp; 5use Carp;
7 6
8require Exporter; 7require Exporter;
9require DynaLoader; 8require DynaLoader;
10 9
11our $VERSION = 1.62; 10our $VERSION = 1.8;
12 11
13our @ISA = qw(Exporter DynaLoader); 12our @ISA = qw(Exporter DynaLoader);
14 13
15our @_consts = qw( 14our @_consts = qw(
16 ACT_COPYING ACT_DECODING ACT_ENCODING ACT_IDLE ACT_SCANNING 15 ACT_COPYING ACT_DECODING ACT_ENCODING ACT_IDLE ACT_SCANNING
… …
50 49
51bootstrap Convert::UUlib $VERSION; 50bootstrap Convert::UUlib $VERSION;
52 51
53# dummy function for compatiiblity with pre-1.7 versions 52# dummy function for compatiiblity with pre-1.7 versions
54sub Initialize { } 53sub Initialize { }
55
56for (@_consts) {
57 my $constant = constant ($_);
58 no strict 'refs';
59 *$_ = sub () { $constant };
60}
61 54
62# action code -> string mapping 55# action code -> string mapping
63sub straction($) { 56sub straction($) {
64 return 'copying' if $_[0] == &ACT_COPYING; 57 return 'copying' if $_[0] == &ACT_COPYING;
65 return 'decoding' if $_[0] == &ACT_DECODING; 58 return 'decoding' if $_[0] == &ACT_DECODING;
… …
941; 871;
95__END__ 88__END__
96 89
97=head1 NAME 90=head1 NAME
98 91
99Convert::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
100 93
101=head1 SYNOPSIS 94=head1 SYNOPSIS
102 95
103 use Convert::UUlib ':all'; 96 use Convert::UUlib ':all';
104 97
… …
113 } 106 }
114 } 107 }
115 108
116=head1 DESCRIPTION 109=head1 DESCRIPTION
117 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).
120
118Read the file doc/library.pdf from the distribution for in-depth 121Read the file doc/library.pdf from the distribution for in-depth
119information 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
120this document and especially the non-trivial decoder program at the end. 123this document and especially the non-trivial decoder program at the end.
121 124
122=head1 EXPORTED CONSTANTS 125=head1 EXPORTED CONSTANTS
… …
141=head2 Options 144=head2 Options
142 145
143 OPT_VERSION version number MAJOR.MINORplPATCH (ro) 146 OPT_VERSION version number MAJOR.MINORplPATCH (ro)
144 OPT_FAST assumes only one part per file 147 OPT_FAST assumes only one part per file
145 OPT_DUMBNESS switch off the program's intelligence 148 OPT_DUMBNESS switch off the program's intelligence
146 OPT_BRACKPOL give numbers in [] higher precendence 149 OPT_BRACKPOL give numbers in [] higher precedence
147 OPT_VERBOSE generate informative messages 150 OPT_VERBOSE generate informative messages
148 OPT_DESPERATE try to decode incomplete files 151 OPT_DESPERATE try to decode incomplete files
149 OPT_IGNREPLY ignore RE:plies (off by default) 152 OPT_IGNREPLY ignore RE:plies (off by default)
150 OPT_OVERWRITE whether it's OK to overwrite ex. files 153 OPT_OVERWRITE whether it's OK to overwrite ex. files
151 OPT_SAVEPATH prefix to save-files on disk 154 OPT_SAVEPATH prefix to save-files on disk
… …
299if you want to iterate over all items, it is usually faster to use 302if you want to iterate over all items, it is usually faster to use
300C<GetFileList>. 303C<GetFileList>.
301 304
302=item @items = GetFileList 305=item @items = GetFileList
303 306
304Similar to C<GetFileListItem>, but returns all files in one go. 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.
305 310
306=back 311=back
307 312
308=head2 Decoding files 313=head2 Decoding files
309 314
… …
489 SetOption OPT_RBUF, 128*1024; 494 SetOption OPT_RBUF, 128*1024;
490 SetOption OPT_WBUF, 1024*1024; 495 SetOption OPT_WBUF, 1024*1024;
491 SetOption OPT_IGNMODE, 1; 496 SetOption OPT_IGNMODE, 1;
492 SetOption OPT_IGNMODE, 1; 497 SetOption OPT_IGNMODE, 1;
493 SetOption OPT_VERBOSE, 1; 498 SetOption OPT_VERBOSE, 1;
499 SetOption OPT_AUTOCHK, 0;
494 500
495 # show the three ways you can set callback functions. I normally 501 # show the three ways you can set callback functions. I normally
496 # prefer the one with the sub inplace. 502 # prefer the one with the sub inplace.
497 SetFNameFilter \&namefilter; 503 SetFNameFilter \&namefilter;
498 504
… …
536 # now read all files in the directory uusrc/* 542 # now read all files in the directory uusrc/*
537 for (<uusrc/*>) { 543 for (<uusrc/*>) {
538 my ($retval, $count) = LoadFile ($_, $_, 1); 544 my ($retval, $count) = LoadFile ($_, $_, 1);
539 print "file($_), status(", strerror $retval, ") parts($count)\n"; 545 print "file($_), status(", strerror $retval, ") parts($count)\n";
540 } 546 }
547
548 Smerge -1;
541 549
542 SetOption OPT_SAVEPATH, "uudst/"; 550 SetOption OPT_SAVEPATH, "uudst/";
543 551
544 # now wade through all files and their source parts 552 # now wade through all files and their source parts
545 for my $uu (GetFileList) { 553 for my $uu (GetFileList) {
… …
594Future versions might enable multicore support for more functions. 602Future versions might enable multicore support for more functions.
595 603
596=head1 BUGS AND LIMITATIONS 604=head1 BUGS AND LIMITATIONS
597 605
598The original uulib library this module uses was written at a time where 606The original uulib library this module uses was written at a time where
599main memory of measured in megabytes and buffer overflows as a security 607main memory was measured in megabytes and buffer overflows as a security
600thign didn't exist. While a lot of security fixes have been applied over 608thing didn't exist. While a lot of security fixes have been applied over
601the years (includign some defense in depth mechanism that can shield 609the years (including some defense in depth mechanism that can shield
602against a lot of as-of-yet undetected bugs), using this library for 610against a lot of as-of-yet undetected bugs), using this library for
603security purposes requires care. 611security purposes requires care.
604 612
605Likewise, file sizes when the uulib library was written were tiny compared 613Likewise, file sizes when the uulib library was written were tiny compared
606to today, so do not expect this library to handle files larger than 2GB. 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.
607 621
608=head1 AUTHOR 622=head1 AUTHOR
609 623
610Marc Lehmann <schmorp@schmorp.de>, the original uulib library was written 624Marc Lehmann <schmorp@schmorp.de>, the original uulib library was written
611by Frank Pilhofer <fp@informatik.uni-frankfurt.de>, and later heavily 625by Frank Pilhofer <fp@informatik.uni-frankfurt.de>, and later heavily

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines