[ViewVC] Diff of: cvs/Convert-UUlib/UUlib.pm

Comparing Convert-UUlib/UUlib.pm (file contents):
Revision 1.5 by root, Sun Mar 31 20:19:09 2002 UTC vs.
Revision 1.51 by root, Sun Mar 1 05:14:55 2020 UTC

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

Diff Legend

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

Comparing Convert-UUlib/UUlib.pm (file contents): Revision 1.5 by root, Sun Mar 31 20:19:09 2002 UTC vs. Revision 1.51 by root, Sun Mar 1 05:14:55 2020 UTC

Diff Legend

Comparing Convert-UUlib/UUlib.pm (file contents):
Revision 1.5 by root, Sun Mar 31 20:19:09 2002 UTC vs.
Revision 1.51 by root, Sun Mar 1 05:14:55 2020 UTC