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

Comparing Convert-UUlib/UUlib.pm (file contents):
Revision 1.27 by root, Sat Dec 16 22:53:30 2006 UTC vs.
Revision 1.46 by root, Fri Feb 28 06: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		10
8	$VERSION = '1.08';	11	our $VERSION = 1.62;
9		12
10	@ISA = qw(Exporter DynaLoader);	13	our @ISA = qw(Exporter DynaLoader);
11		14
12	@_consts = qw(	15	our @_consts = qw(
13	ACT_COPYING ACT_DECODING ACT_ENCODING ACT_IDLE ACT_SCANNING	16	ACT_COPYING ACT_DECODING ACT_ENCODING ACT_IDLE ACT_SCANNING
14		17
15	FILE_DECODED FILE_ERROR FILE_MISPART FILE_NOBEGIN FILE_NODATA	18	FILE_DECODED FILE_ERROR FILE_MISPART FILE_NOBEGIN FILE_NODATA
16	FILE_NOEND FILE_OK FILE_READ FILE_TMPFILE	19	FILE_NOEND FILE_OK FILE_READ FILE_TMPFILE
17		20
19		22
20	OPT_RBUF OPT_WBUF	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 OPT_DOTDOT	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	B64_ENCODED BH_ENCODED PT_ENCODED QP_ENCODED	32	B64_ENCODED BH_ENCODED PT_ENCODED QP_ENCODED
30	XX_ENCODED UU_ENCODED YENC_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 SetMsgCallback	37	Initialize CleanUp GetOption SetOption strerror SetMsgCallback
35	SetBusyCallback SetFileCallback SetFNameFilter SetFileNameCallback	38	SetBusyCallback SetFileCallback SetFNameFilter SetFileNameCallback
36	FNameFilter LoadFile GetFileListItem RenameFile DecodeToTemp	39	FNameFilter LoadFile GetFileListItem RenameFile DecodeToTemp
37	RemoveTemp DecodeFile InfoFile Smerge QuickDecode EncodeMulti	40	RemoveTemp DecodeFile InfoFile Smerge QuickDecode EncodeMulti
38	EncodePartial EncodeToStream EncodeToFile E_PrepSingle	41	EncodePartial EncodeToStream EncodeToFile E_PrepSingle
39	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($) {
…		…
155	OPT_TINYB64 detect short B64 outside of Mime	159	OPT_TINYB64 detect short B64 outside of Mime
156	OPT_ENCEXT extension for single-part encoded files	160	OPT_ENCEXT extension for single-part encoded files
157	OPT_REMOVE remove input files after decoding (dangerous)	161	OPT_REMOVE remove input files after decoding (dangerous)
158	OPT_MOREMIME strict MIME adherence	162	OPT_MOREMIME strict MIME adherence
159	OPT_DOTDOT ".."-unescaping has not yet been done on input files	163	OPT_DOTDOT ".."-unescaping has not yet been done on input files
160	OPT_RBUF set default read I/O buffer size in bytes EXPERIMENTAL	164	OPT_RBUF set default read I/O buffer size in bytes
161	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
162		167
163	=head2 Result/Error codes	168	=head2 Result/Error codes
164		169
165	RET_OK everything went fine	170	RET_OK everything went fine
166	RET_IOERR I/O Error - examine errno	171	RET_IOERR I/O Error - examine errno
…		…
209	again.	214	again.
210		215
211	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
212	RSS to decode 20000 files.	217	RSS to decode 20000 files.
213		218
214	=over 4	219	=over
215		220
216	=item Initialize	221	=item Initialize
217		222
218	Not normally necessary, (re-)initializes the library.	223	Not normally necessary, (re-)initializes the library.
219		224
…		…
224		229
225	=back	230	=back
226		231
227	=head2 Setting and querying options	232	=head2 Setting and querying options
228		233
229	=over 4	234	=over
230		235
231	=item $option = GetOption OPT_xxx	236	=item $option = GetOption OPT_xxx
232		237
233	=item SetOption OPT_xxx, opt-value	238	=item SetOption OPT_xxx, opt-value
234		239
…		…
236		241
237	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.
238		243
239	=head2 Setting various callbacks	244	=head2 Setting various callbacks
240		245
241	=over 4	246	=over
242		247
243	=item SetMsgCallback [callback-function]	248	=item SetMsgCallback [callback-function]
244		249
245	=item SetBusyCallback [callback-function]	250	=item SetBusyCallback [callback-function]
246		251
…		…
250		255
251	=back	256	=back
252		257
253	=head2 Call the currently selected FNameFilter	258	=head2 Call the currently selected FNameFilter
254		259
255	=over 4	260	=over
256		261
257	=item $file = FNameFilter $file	262	=item $file = FNameFilter $file
258		263
259	=back	264	=back
260		265
261	=head2 Loading sourcefiles, optionally fuzzy merge and start decoding	266	=head2 Loading sourcefiles, optionally fuzzy merge and start decoding
262		267
263	=over 4	268	=over
264		269
265	=item ($retval, $count) = LoadFile $fname, [$id, [$delflag, [$partno]]]	270	=item ($retval, $count) = LoadFile $fname, [$id, [$delflag, [$partno]]]
266		271
267	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
268	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
…		…
277	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>
278	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
279	have been merged.	284	have been merged.
280		285
281	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
282	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>).
283		293
284	=item $item = GetFileListItem $item_number	294	=item $item = GetFileListItem $item_number
285		295
286	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
287	C<undef> of no file with that number exists.	297	C<undef> of no file with that number exists.
…		…
292		302
293	=back	303	=back
294		304
295	=head2 Decoding files	305	=head2 Decoding files
296		306
297	=over 4	307	=over
298		308
299	=item $retval = $item->rename($newname)	309	=item $retval = $item->rename ($newname)
300		310
301	Change the ondisk filename where the decoded file will be saved.	311	Change the ondisk filename where the decoded file will be saved.
302		312
303	=item $retval = $item->decode_temp	313	=item $retval = $item->decode_temp
304		314
…		…
307		317
308	=item $retval = $item->remove_temp	318	=item $retval = $item->remove_temp
309		319
310	Remove the temporarily decoded file again.	320	Remove the temporarily decoded file again.
311		321
312	=item $retval = $item->decode([$target_path])	322	=item $retval = $item->decode ([$target_path])
313		323
314	Decode the file to it's destination, or the given target path.	324	Decode the file to its destination, or the given target path.
315		325
316	=item $retval = $item->info(callback-function)	326	=item $retval = $item->info (callback-function)
317		327
318	=back	328	=back
319		329
320	=head2 Querying (and setting) item attributes	330	=head2 Querying (and setting) item attributes
321		331
322	=over 4	332	=over
323		333
324	=item $state = $item->state	334	=item $state = $item->state
325		335
326	=item $mode = $item->mode([newmode])	336	=item $mode = $item->mode ([newmode])
327		337
328	=item $uudet = $item->uudet	338	=item $uudet = $item->uudet
329		339
330	=item $size = $item->size	340	=item $size = $item->size
331		341
332	=item $filename = $item->filename([newfilename})	342	=item $filename = $item->filename ([newfilename})
333		343
334	=item $subfname = $item->subfname	344	=item $subfname = $item->subfname
335		345
336	=item $mimeid = $item->mimeid	346	=item $mimeid = $item->mimeid
337		347
…		…
341		351
342	=back	352	=back
343		353
344	=head2 Information about source parts	354	=head2 Information about source parts
345		355
346	=over 4	356	=over
347		357
348	=item $parts = $item->parts	358	=item $parts = $item->parts
349		359
350	Return information about all parts (source files) used to decode the file	360	Return information about all parts (source files) used to decode the file
351	as a list of hashrefs with the following structure:	361	as a list of hashrefs with the following structure:
…		…
365	Usually you are interested mostly the C<sfname> and possibly the C<partno>	375	Usually you are interested mostly the C<sfname> and possibly the C<partno>
366	and C<filename> members.	376	and C<filename> members.
367		377
368	=back	378	=back
369		379
370	=head2 Functions below not documented and not very well tested	380	=head2 Functions below are not documented and not very well tested - feedback welcome
371		381
372	QuickDecode	382	QuickDecode
373	EncodeMulti	383	EncodeMulti
374	EncodePartial	384	EncodePartial
375	EncodeToStream	385	EncodeToStream
…		…
379		389
380	=head2 EXTENSION FUNCTIONS	390	=head2 EXTENSION FUNCTIONS
381		391
382	Functions found in this module but not documented in the uulib documentation:	392	Functions found in this module but not documented in the uulib documentation:
383		393
384	=over 4	394	=over
385		395
386	=item $msg = straction ACT_xxx	396	=item $msg = straction ACT_xxx
387		397
388	Return a human readable string representing the given action code.	398	Return a human readable string representing the given action code.
389		399
…		…
433	=head1 LARGE EXAMPLE DECODER	443	=head1 LARGE EXAMPLE DECODER
434		444
435	This is the file C<example-decoder> from the distribution, put here	445	This is the file C<example-decoder> from the distribution, put here
436	instead of more thorough documentation.	446	instead of more thorough documentation.
437		447
		448	#!/usr/bin/perl
		449
438	# decode all the files in the directory uusrc/ and copy	450	# decode all the files in the directory uusrc/ and copy
439	# the resulting files to uudst/	451	# the resulting files to uudst/
440		452
441	use Convert::UUlib ':all';	453	use Convert::UUlib ':all';
442		454
443	sub namefilter {	455	sub namefilter {
444	my($path)=@_;	456	my ($path) = @_;
		457
445	$path=~s/^.*[\/\\]//;	458	$path=~s/^.*[\/\\]//;
		459
446	$path;	460	$path
447	}	461	}
448		462
449	sub busycb {	463	sub busycb {
450	my ($action, $curfile, $partno, $numparts, $percent, $fsize) = @_;	464	my ($action, $curfile, $partno, $numparts, $percent, $fsize) = @_;
451	$_[0]=straction($action);	465	$_[0]=straction($action);
452	print "busy_callback(", (join ",",@_), ")\n";	466	print "busy_callback(", (join ",",@_), ")\n";
453	0;	467	0
454	}	468	}
455		469
		470	SetOption OPT_RBUF, 128*1024;
		471	SetOption OPT_WBUF, 1024*1024;
456	SetOption OPT_IGNMODE, 1;	472	SetOption OPT_IGNMODE, 1;
		473	SetOption OPT_IGNMODE, 1;
457	SetOption OPT_VERBOSE, 1;	474	SetOption OPT_VERBOSE, 1;
458		475
459	# show the three ways you can set callback functions. I normally	476	# show the three ways you can set callback functions. I normally
460	# prefer the one with the sub inplace.	477	# prefer the one with the sub inplace.
461	SetFNameFilter \&namefilter;	478	SetFNameFilter \&namefilter;
462		479
463	SetBusyCallback "busycb", 333;	480	SetBusyCallback "busycb", 333;
464		481
465	SetMsgCallback sub {	482	SetMsgCallback sub {
466	my ($msg, $level) = @_;	483	my ($msg, $level) = @_;
467	print uc strmsglevel $_[1], ": $msg\n";	484	print uc strmsglevel $_[1], ": $msg\n";
468	};	485	};
469		486
470	# the following non-trivial FileNameCallback takes care	487	# the following non-trivial FileNameCallback takes care
471	# of some subject lines not detected properly by uulib:	488	# of some subject lines not detected properly by uulib:
472	SetFileNameCallback sub {	489	SetFileNameCallback sub {
473	return unless $_[1]; # skip "Re:"-plies et al.	490	return unless $_[1]; # skip "Re:"-plies et al.
474	local $_ = $_[0];	491	local $_ = $_[0];
475		492
476	# the following rules are rather effective on some newsgroups,	493	# the following rules are rather effective on some newsgroups,
477	# like alt.binaries.games.anime, where non-mime, uuencoded data	494	# like alt.binaries.games.anime, where non-mime, uuencoded data
478	# is very common	495	# is very common
479		496
480	# if we find some *.rar, take it as the filename	497	# if we find some *.rar, take it as the filename
481	return $1 if /(\S{3,}\.(?:[rstuvwxyz]\d\d\|rar))\s/i;	498	return $1 if /(\S{3,}\.(?:[rstuvwxyz]\d\d\|rar))\s/i;
482		499
483	# one common subject format	500	# one common subject format
484	return $1 if /- "(.{2,}?\..+?)" (?:yenc )?$\d+\/\d+$/i;	501	return $1 if /- "(.{2,}?\..+?)" (?:yenc )?$\d+\/\d+$/i;
485		502
486	# - filename.par (04/55)	503	# - filename.par (04/55)
487	return $1 if /- "?(\S{3,}\.\S+?)"? (?:yenc )?$\d+\/\d+$/i;	504	return $1 if /- "?(\S{3,}\.\S+?)"? (?:yenc )?$\d+\/\d+$/i;
488		505
489	# - (xxx) No. 1 sayuri81.jpg 756565 bytes	506	# - (xxx) No. 1 sayuri81.jpg 756565 bytes
490	# - (20 files) No.17 Roseanne.jpg [2/2]	507	# - (20 files) No.17 Roseanne.jpg [2/2]
491	return $1 if /No\.[ 0-9]+ (\S+\....) (?:\d+ bytes )?\[/;	508	return $1 if /No\.[ 0-9]+ (\S+\....) (?:\d+ bytes )?\[/;
492		509
		510	# try to detect some common forms of filenames
		511	return $1 if /([a-z0-9_\-+.]{3,}\.[a-z]{3,4}(?:.\d+))/i;
		512
493	# otherwise just pass what we have	513	# otherwise just pass what we have
494	return ();	514	()
495	};	515	};
496		516
497	# now read all files in the directory uusrc/*	517	# now read all files in the directory uusrc/*
498	for(<uusrc/*>) {	518	for(<uusrc/*>) {
499	my($retval,$count)=LoadFile ($_, $_, 1);	519	my ($retval, $count) = LoadFile ($_, $_, 1);
500	print "file($_), status(", strerror $retval, ") parts($count)\n";	520	print "file($_), status(", strerror $retval, ") parts($count)\n";
501	}	521	}
502		522
503	SetOption OPT_SAVEPATH, "uudst/";	523	SetOption OPT_SAVEPATH, "uudst/";
504		524
505	# now wade through all files and their source parts	525	# now wade through all files and their source parts
506	$i = 0;	526	$i = 0;
507	while ($uu = GetFileListItem($i)) {	527	while ($uu = GetFileListItem $i) {
508	$i++;	528	$i++;
509	print "file nr. $i";	529	print "file nr. $i";
510	print " state ", $uu->state;	530	print " state ", $uu->state;
511	print " mode ", $uu->mode;	531	print " mode ", $uu->mode;
512	print " uudet ", strencoding $uu->uudet;	532	print " uudet ", strencoding $uu->uudet;
513	print " size ", $uu->size;	533	print " size ", $uu->size;
514	print " filename ", $uu->filename;	534	print " filename ", $uu->filename;
515	print " subfname ", $uu->subfname;	535	print " subfname ", $uu->subfname;
516	print " mimeid ", $uu->mimeid;	536	print " mimeid ", $uu->mimeid;
517	print " mimetype ", $uu->mimetype;	537	print " mimetype ", $uu->mimetype;
518	print "\n";	538	print "\n";
519		539
520	# print additional info about all parts	540	# print additional info about all parts
521	for ($uu->parts) {	541	for ($uu->parts) {
522	while (my ($k, $v) = each %$_) {	542	while (my ($k, $v) = each %$_) {
523	print "$k > $v, ";	543	print "$k > $v, ";
524	}	544	}
525	print "\n";	545	print "\n";
526	}	546	}
527		547
528	$uu->decode_temp;	548	print $uu->filename;
529	print " temporarily decoded to ", $uu->binfile, "\n";	549
530	$uu->remove_temp;	550	$uu->remove_temp;
531		551
532	print strerror $uu->decode;	552	if (my $err = $uu->decode ()) {
		553	print ", ", strerror $err, "\n";
		554	} else {
533	print " saved as uudst/", $uu->filename, "\n";	555	print ", saved as uudst/", $uu->filename, "\n";
534	}	556	}
		557	}
535		558
536	print "cleanup...\n";	559	print "cleanup...\n";
537		560
538	CleanUp();	561	CleanUp;
		562
		563	=head1 PERLMULTICORE SUPPORT
		564
		565	This module supports the perlmulticore standard (see
		566	L<http://perlmulticore.schmorp.de/> for more info) for the following
		567	functions - generally these are functions accessing the disk and/or using
		568	considerable CPU time:
		569
		570	LoadFile
		571	$item->decode
		572	$item->decode_temp
		573	$item->remove_temp
		574	$item->info
		575
		576	The perl interpreter will be reacquired/released on every callback
		577	invocation, so for performance reasons, callbacks should be avoided if
		578	that is costly.
		579
		580	Future versions might enable multicore support for more functions.
		581
		582	=head1 BUGS AND LIMITATIONS
		583
		584	The original uulib library this module uses was written at a time where
		585	main memory of measured in megabytes and buffer overflows as a security
		586	thign didn't exist. While a lot of security fixes have been applied over
		587	the years (includign some defense in depth mechanism that can shield
		588	against a lot of as-of-yet undetected bugs), using this library for
		589	security purposes requires care.
		590
		591	Likewise, file sizes when the uulib library was written were tiny compared
		592	to today, so do not expect this library to handle files larger than 2GB.
539		593
540	=head1 AUTHOR	594	=head1 AUTHOR
541		595
542	Marc Lehmann <schmorp@schmorp.de>, the original uulib library was written	596	Marc Lehmann <schmorp@schmorp.de>, the original uulib library was written
543	by Frank Pilhofer <fp@informatik.uni-frankfurt.de>, and later heavily	597	by Frank Pilhofer <fp@informatik.uni-frankfurt.de>, and later heavily
544	bugfixed by Marc Lehmann.	598	bugfixed by Marc Lehmann.
545		599
546	=head1 SEE ALSO	600	=head1 SEE ALSO
547		601
548	perl(1), uudeview homepage at http://www.uni-frankfurt.de/~fp/uudeview/.	602	perl(1), uudeview homepage at L<http://www.fpx.de/fp/Software/UUDeview/>.
549		603
550	=cut	604	=cut
		605

Diff Legend

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

Comparing Convert-UUlib/UUlib.pm (file contents): Revision 1.27 by root, Sat Dec 16 22:53:30 2006 UTC vs. Revision 1.46 by root, Fri Feb 28 06:57:25 2020 UTC

Diff Legend

Comparing Convert-UUlib/UUlib.pm (file contents):
Revision 1.27 by root, Sat Dec 16 22:53:30 2006 UTC vs.
Revision 1.46 by root, Fri Feb 28 06:57:25 2020 UTC