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

Comparing Convert-UUlib/UUlib.pm (file contents):
Revision 1.24 by root, Sat Mar 26 14:26:29 2005 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.06";	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
18	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
19		22
		23	OPT_RBUF OPT_WBUF
20	OPT_BRACKPOL OPT_DEBUG OPT_DESPERATE OPT_DUMBNESS OPT_ENCEXT	24	OPT_BRACKPOL OPT_DEBUG OPT_DESPERATE OPT_DUMBNESS OPT_ENCEXT
21	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
22	OPT_PROGRESS OPT_SAVEPATH OPT_TINYB64 OPT_USETEXT OPT_VERBOSE	26	OPT_PROGRESS OPT_SAVEPATH OPT_TINYB64 OPT_USETEXT OPT_VERBOSE
23	OPT_VERSION OPT_REMOVE OPT_MOREMIME OPT_DOTDOT	27	OPT_VERSION OPT_REMOVE OPT_MOREMIME OPT_DOTDOT OPT_AUTOCHECK
24		28
25	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
26	RET_NOEND RET_NOMEM RET_OK RET_UNSUP	30	RET_NOEND RET_NOMEM RET_OK RET_UNSUP
27		31
28	B64_ENCODED BH_ENCODED PT_ENCODED QP_ENCODED	32	B64_ENCODED BH_ENCODED PT_ENCODED QP_ENCODED
29	XX_ENCODED UU_ENCODED YENC_ENCODED	33	XX_ENCODED UU_ENCODED YENC_ENCODED
30	);	34	);
31		35
32	@_funcs = qw(	36	our @_funcs = qw(
33	Initialize CleanUp GetOption SetOption strerror SetMsgCallback	37	Initialize CleanUp GetOption SetOption strerror SetMsgCallback
34	SetBusyCallback SetFileCallback SetFNameFilter SetFileNameCallback	38	SetBusyCallback SetFileCallback SetFNameFilter SetFileNameCallback
35	FNameFilter LoadFile GetFileListItem RenameFile DecodeToTemp	39	FNameFilter LoadFile GetFileListItem RenameFile DecodeToTemp
36	RemoveTemp DecodeFile InfoFile Smerge QuickDecode EncodeMulti	40	RemoveTemp DecodeFile InfoFile Smerge QuickDecode EncodeMulti
37	EncodePartial EncodeToStream EncodeToFile E_PrepSingle	41	EncodePartial EncodeToStream EncodeToFile E_PrepSingle
38	E_PrepPartial	42	E_PrepPartial
39		43
40	straction strencoding strmsglevel	44	straction strencoding strmsglevel
41	);	45	);
42		46
43	@EXPORT = @_consts;	47	our @EXPORT = @_consts;
44	@EXPORT_OK = @_funcs;	48	our @EXPORT_OK = @_funcs;
45	%EXPORT_TAGS = (all => [@_consts,@_funcs], constants => \@_consts);	49	our %EXPORT_TAGS = (all => [@_consts,@_funcs], constants => \@_consts);
46		50
47	bootstrap Convert::UUlib $VERSION;	51	bootstrap Convert::UUlib $VERSION;
48		52
49	Initialize();	53	Initialize();
50		54
51	# not when < 5.005_6x	55	# not when < 5.005_6x
52	# END { CleanUp() }	56	# END { CleanUp() }
53		57
54	for (@_consts) {	58	for (@_consts) {
55	my $constant = constant($_);	59	my $constant = constant($_);
		60	no strict 'refs';
56	*$_ = sub () { $constant };	61	*$_ = sub () { $constant };
57	}	62	}
58		63
59	# action code -> string mapping	64	# action code -> string mapping
60	sub straction($) {	65	sub straction($) {
154	OPT_TINYB64 detect short B64 outside of Mime	159	OPT_TINYB64 detect short B64 outside of Mime
155	OPT_ENCEXT extension for single-part encoded files	160	OPT_ENCEXT extension for single-part encoded files
156	OPT_REMOVE remove input files after decoding (dangerous)	161	OPT_REMOVE remove input files after decoding (dangerous)
157	OPT_MOREMIME strict MIME adherence	162	OPT_MOREMIME strict MIME adherence
158	OPT_DOTDOT ".."-unescaping has not yet been done on input files	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
159		167
160	=head2 Result/Error codes	168	=head2 Result/Error codes
161		169
162	RET_OK everything went fine	170	RET_OK everything went fine
163	RET_IOERR I/O Error - examine errno	171	RET_IOERR I/O Error - examine errno
…		…
206	again.	214	again.
207		215
208	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
209	RSS to decode 20000 files.	217	RSS to decode 20000 files.
210		218
211	=over 4	219	=over
212		220
213	=item Initialize	221	=item Initialize
214		222
215	Not normally necessary, (re-)initializes the library.	223	Not normally necessary, (re-)initializes the library.
216		224
…		…
221		229
222	=back	230	=back
223		231
224	=head2 Setting and querying options	232	=head2 Setting and querying options
225		233
226	=over 4	234	=over
227		235
228	=item $option = GetOption OPT_xxx	236	=item $option = GetOption OPT_xxx
229		237
230	=item SetOption OPT_xxx, opt-value	238	=item SetOption OPT_xxx, opt-value
231		239
…		…
233		241
234	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.
235		243
236	=head2 Setting various callbacks	244	=head2 Setting various callbacks
237		245
238	=over 4	246	=over
239		247
240	=item SetMsgCallback [callback-function]	248	=item SetMsgCallback [callback-function]
241		249
242	=item SetBusyCallback [callback-function]	250	=item SetBusyCallback [callback-function]
243		251
…		…
247		255
248	=back	256	=back
249		257
250	=head2 Call the currently selected FNameFilter	258	=head2 Call the currently selected FNameFilter
251		259
252	=over 4	260	=over
253		261
254	=item $file = FNameFilter $file	262	=item $file = FNameFilter $file
255		263
256	=back	264	=back
257		265
258	=head2 Loading sourcefiles, optionally fuzzy merge and start decoding	266	=head2 Loading sourcefiles, optionally fuzzy merge and start decoding
259		267
260	=over 4	268	=over
261		269
262	=item ($retval, $count) = LoadFile $fname, [$id, [$delflag, [$partno]]]	270	=item ($retval, $count) = LoadFile $fname, [$id, [$delflag, [$partno]]]
263		271
264	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
265	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
…		…
274	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>
275	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
276	have been merged.	284	have been merged.
277		285
278	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
279	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>).
280		293
281	=item $item = GetFileListItem $item_number	294	=item $item = GetFileListItem $item_number
282		295
283	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
284	C<undef> of no file with that number exists.	297	C<undef> of no file with that number exists.
…		…
289		302
290	=back	303	=back
291		304
292	=head2 Decoding files	305	=head2 Decoding files
293		306
294	=over 4	307	=over
295		308
296	=item $retval = $item->rename($newname)	309	=item $retval = $item->rename ($newname)
297		310
298	Change the ondisk filename where the decoded file will be saved.	311	Change the ondisk filename where the decoded file will be saved.
299		312
300	=item $retval = $item->decode_temp	313	=item $retval = $item->decode_temp
301		314
…		…
304		317
305	=item $retval = $item->remove_temp	318	=item $retval = $item->remove_temp
306		319
307	Remove the temporarily decoded file again.	320	Remove the temporarily decoded file again.
308		321
309	=item $retval = $item->decode([$target_path])	322	=item $retval = $item->decode ([$target_path])
310		323
311	Decode the file to it's destination, or the given target path.	324	Decode the file to its destination, or the given target path.
312		325
313	=item $retval = $item->info(callback-function)	326	=item $retval = $item->info (callback-function)
314		327
315	=back	328	=back
316		329
317	=head2 Querying (and setting) item attributes	330	=head2 Querying (and setting) item attributes
318		331
319	=over 4	332	=over
320		333
321	=item $state = $item->state	334	=item $state = $item->state
322		335
323	=item $mode = $item->mode([newmode])	336	=item $mode = $item->mode ([newmode])
324		337
325	=item $uudet = $item->uudet	338	=item $uudet = $item->uudet
326		339
327	=item $size = $item->size	340	=item $size = $item->size
328		341
329	=item $filename = $item->filename([newfilename})	342	=item $filename = $item->filename ([newfilename})
330		343
331	=item $subfname = $item->subfname	344	=item $subfname = $item->subfname
332		345
333	=item $mimeid = $item->mimeid	346	=item $mimeid = $item->mimeid
334		347
…		…
338		351
339	=back	352	=back
340		353
341	=head2 Information about source parts	354	=head2 Information about source parts
342		355
343	=over 4	356	=over
344		357
345	=item $parts = $item->parts	358	=item $parts = $item->parts
346		359
347	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
348	as a list of hashrefs with the following structure:	361	as a list of hashrefs with the following structure:
…		…
362	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>
363	and C<filename> members.	376	and C<filename> members.
364		377
365	=back	378	=back
366		379
367	=head2 Functions below not documented and not very well tested	380	=head2 Functions below are not documented and not very well tested - feedback welcome
368		381
369	QuickDecode	382	QuickDecode
370	EncodeMulti	383	EncodeMulti
371	EncodePartial	384	EncodePartial
372	EncodeToStream	385	EncodeToStream
…		…
376		389
377	=head2 EXTENSION FUNCTIONS	390	=head2 EXTENSION FUNCTIONS
378		391
379	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:
380		393
381	=over 4	394	=over
382		395
383	=item $msg = straction ACT_xxx	396	=item $msg = straction ACT_xxx
384		397
385	Return a human readable string representing the given action code.	398	Return a human readable string representing the given action code.
386		399
…		…
430	=head1 LARGE EXAMPLE DECODER	443	=head1 LARGE EXAMPLE DECODER
431		444
432	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
433	instead of more thorough documentation.	446	instead of more thorough documentation.
434		447
		448	#!/usr/bin/perl
		449
435	# decode all the files in the directory uusrc/ and copy	450	# decode all the files in the directory uusrc/ and copy
436	# the resulting files to uudst/	451	# the resulting files to uudst/
437		452
438	use Convert::UUlib ':all';	453	use Convert::UUlib ':all';
439		454
440	sub namefilter {	455	sub namefilter {
441	my($path)=@_;	456	my ($path) = @_;
		457
442	$path=~s/^.*[\/\\]//;	458	$path=~s/^.*[\/\\]//;
		459
443	$path;	460	$path
444	}	461	}
445		462
446	sub busycb {	463	sub busycb {
447	my ($action, $curfile, $partno, $numparts, $percent, $fsize) = @_;	464	my ($action, $curfile, $partno, $numparts, $percent, $fsize) = @_;
448	$_[0]=straction($action);	465	$_[0]=straction($action);
449	print "busy_callback(", (join ",",@_), ")\n";	466	print "busy_callback(", (join ",",@_), ")\n";
450	0;	467	0
451	}	468	}
452		469
		470	SetOption OPT_RBUF, 128*1024;
		471	SetOption OPT_WBUF, 1024*1024;
453	SetOption OPT_IGNMODE, 1;	472	SetOption OPT_IGNMODE, 1;
		473	SetOption OPT_IGNMODE, 1;
454	SetOption OPT_VERBOSE, 1;	474	SetOption OPT_VERBOSE, 1;
455		475
456	# show the three ways you can set callback functions. I normally	476	# show the three ways you can set callback functions. I normally
457	# prefer the one with the sub inplace.	477	# prefer the one with the sub inplace.
458	SetFNameFilter \&namefilter;	478	SetFNameFilter \&namefilter;
459		479
460	SetBusyCallback "busycb", 333;	480	SetBusyCallback "busycb", 333;
461		481
462	SetMsgCallback sub {	482	SetMsgCallback sub {
463	my ($msg, $level) = @_;	483	my ($msg, $level) = @_;
464	print uc strmsglevel $_[1], ": $msg\n";	484	print uc strmsglevel $_[1], ": $msg\n";
465	};	485	};
466		486
467	# the following non-trivial FileNameCallback takes care	487	# the following non-trivial FileNameCallback takes care
468	# of some subject lines not detected properly by uulib:	488	# of some subject lines not detected properly by uulib:
469	SetFileNameCallback sub {	489	SetFileNameCallback sub {
470	return unless $_[1]; # skip "Re:"-plies et al.	490	return unless $_[1]; # skip "Re:"-plies et al.
471	local $_ = $_[0];	491	local $_ = $_[0];
472		492
473	# the following rules are rather effective on some newsgroups,	493	# the following rules are rather effective on some newsgroups,
474	# like alt.binaries.games.anime, where non-mime, uuencoded data	494	# like alt.binaries.games.anime, where non-mime, uuencoded data
475	# is very common	495	# is very common
476		496
477	# if we find some *.rar, take it as the filename	497	# if we find some *.rar, take it as the filename
478	return $1 if /(\S{3,}\.(?:[rstuvwxyz]\d\d\|rar))\s/i;	498	return $1 if /(\S{3,}\.(?:[rstuvwxyz]\d\d\|rar))\s/i;
479		499
480	# one common subject format	500	# one common subject format
481	return $1 if /- "(.{2,}?\..+?)" (?:yenc )?$\d+\/\d+$/i;	501	return $1 if /- "(.{2,}?\..+?)" (?:yenc )?$\d+\/\d+$/i;
482		502
483	# - filename.par (04/55)	503	# - filename.par (04/55)
484	return $1 if /- "?(\S{3,}\.\S+?)"? (?:yenc )?$\d+\/\d+$/i;	504	return $1 if /- "?(\S{3,}\.\S+?)"? (?:yenc )?$\d+\/\d+$/i;
485		505
486	# - (xxx) No. 1 sayuri81.jpg 756565 bytes	506	# - (xxx) No. 1 sayuri81.jpg 756565 bytes
487	# - (20 files) No.17 Roseanne.jpg [2/2]	507	# - (20 files) No.17 Roseanne.jpg [2/2]
488	return $1 if /No\.[ 0-9]+ (\S+\....) (?:\d+ bytes )?\[/;	508	return $1 if /No\.[ 0-9]+ (\S+\....) (?:\d+ bytes )?\[/;
489		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
490	# otherwise just pass what we have	513	# otherwise just pass what we have
491	return ();	514	()
492	};	515	};
493		516
494	# now read all files in the directory uusrc/*	517	# now read all files in the directory uusrc/*
495	for(<uusrc/*>) {	518	for(<uusrc/*>) {
496	my($retval,$count)=LoadFile ($_, $_, 1);	519	my ($retval, $count) = LoadFile ($_, $_, 1);
497	print "file($_), status(", strerror $retval, ") parts($count)\n";	520	print "file($_), status(", strerror $retval, ") parts($count)\n";
498	}	521	}
499		522
500	SetOption OPT_SAVEPATH, "uudst/";	523	SetOption OPT_SAVEPATH, "uudst/";
501		524
502	# now wade through all files and their source parts	525	# now wade through all files and their source parts
503	$i = 0;	526	$i = 0;
504	while ($uu = GetFileListItem($i)) {	527	while ($uu = GetFileListItem $i) {
505	$i++;	528	$i++;
506	print "file nr. $i";	529	print "file nr. $i";
507	print " state ", $uu->state;	530	print " state ", $uu->state;
508	print " mode ", $uu->mode;	531	print " mode ", $uu->mode;
509	print " uudet ", strencoding $uu->uudet;	532	print " uudet ", strencoding $uu->uudet;
510	print " size ", $uu->size;	533	print " size ", $uu->size;
511	print " filename ", $uu->filename;	534	print " filename ", $uu->filename;
512	print " subfname ", $uu->subfname;	535	print " subfname ", $uu->subfname;
513	print " mimeid ", $uu->mimeid;	536	print " mimeid ", $uu->mimeid;
514	print " mimetype ", $uu->mimetype;	537	print " mimetype ", $uu->mimetype;
515	print "\n";	538	print "\n";
516		539
517	# print additional info about all parts	540	# print additional info about all parts
518	for ($uu->parts) {	541	for ($uu->parts) {
519	while (my ($k, $v) = each %$_) {	542	while (my ($k, $v) = each %$_) {
520	print "$k > $v, ";	543	print "$k > $v, ";
521	}	544	}
522	print "\n";	545	print "\n";
523	}	546	}
524		547
525	$uu->decode_temp;	548	print $uu->filename;
526	print " temporarily decoded to ", $uu->binfile, "\n";	549
527	$uu->remove_temp;	550	$uu->remove_temp;
528		551
529	print strerror $uu->decode;	552	if (my $err = $uu->decode ()) {
		553	print ", ", strerror $err, "\n";
		554	} else {
530	print " saved as uudst/", $uu->filename, "\n";	555	print ", saved as uudst/", $uu->filename, "\n";
531	}	556	}
		557	}
532		558
533	print "cleanup...\n";	559	print "cleanup...\n";
534		560
535	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.
536		593
537	=head1 AUTHOR	594	=head1 AUTHOR
538		595
539	Marc Lehmann <schmorp@schmorp.de>, the original uulib library was written	596	Marc Lehmann <schmorp@schmorp.de>, the original uulib library was written
540	by Frank Pilhofer <fp@informatik.uni-frankfurt.de>, and later heavily	597	by Frank Pilhofer <fp@informatik.uni-frankfurt.de>, and later heavily
541	bugfixed by Marc Lehmann.	598	bugfixed by Marc Lehmann.
542		599
543	=head1 SEE ALSO	600	=head1 SEE ALSO
544		601
545	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/>.
546		603
547	=cut	604	=cut
		605

Diff Legend

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

Comparing Convert-UUlib/UUlib.pm (file contents): Revision 1.24 by root, Sat Mar 26 14:26:29 2005 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.24 by root, Sat Mar 26 14:26:29 2005 UTC vs.
Revision 1.46 by root, Fri Feb 28 06:57:25 2020 UTC