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

Comparing Convert-UUlib/UUlib.pm (file contents):
Revision 1.4 by root, Sun Feb 10 22:47:17 2002 UTC vs.
Revision 1.47 by root, Fri Feb 28 16:57:25 2020 UTC

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

Diff Legend

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

Comparing Convert-UUlib/UUlib.pm (file contents): Revision 1.4 by root, Sun Feb 10 22:47:17 2002 UTC vs. Revision 1.47 by root, Fri Feb 28 16:57:25 2020 UTC

Diff Legend

Comparing Convert-UUlib/UUlib.pm (file contents):
Revision 1.4 by root, Sun Feb 10 22:47:17 2002 UTC vs.
Revision 1.47 by root, Fri Feb 28 16:57:25 2020 UTC