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

Comparing Convert-UUlib/UUlib.pm (file contents):
Revision 1.31 by root, Fri Jun 13 13:33:08 2008 UTC vs.
Revision 1.46 by root, Fri Feb 28 06:57:25 2020 UTC

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

Diff Legend

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

Comparing Convert-UUlib/UUlib.pm (file contents): Revision 1.31 by root, Fri Jun 13 13:33:08 2008 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.31 by root, Fri Jun 13 13:33:08 2008 UTC vs.
Revision 1.46 by root, Fri Feb 28 06:57:25 2020 UTC