[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.13 by root, Tue Oct 15 23:20:29 2002 UTC

…		…
2		2
3	use Carp;	3	use Carp;
4		4
5	require Exporter;	5	require Exporter;
6	require DynaLoader;	6	require DynaLoader;
7	use AutoLoader;
8		7
9	$VERSION = 0.201;	8	$VERSION = 0.31;
10		9
11	@ISA = qw(Exporter DynaLoader);	10	@ISA = qw(Exporter DynaLoader);
12		11
13	@_consts = qw(	12	@_consts = qw(
14	ACT_COPYING ACT_DECODING ACT_ENCODING ACT_IDLE ACT_SCANNING	13	ACT_COPYING ACT_DECODING ACT_ENCODING ACT_IDLE ACT_SCANNING
…		…
19	MSG_ERROR MSG_FATAL MSG_MESSAGE MSG_NOTE MSG_PANIC MSG_WARNING	18	MSG_ERROR MSG_FATAL MSG_MESSAGE MSG_NOTE MSG_PANIC MSG_WARNING
20		19
21	OPT_BRACKPOL OPT_DEBUG OPT_DESPERATE OPT_DUMBNESS OPT_ENCEXT	20	OPT_BRACKPOL OPT_DEBUG OPT_DESPERATE OPT_DUMBNESS OPT_ENCEXT
22	OPT_ERRNO OPT_FAST OPT_IGNMODE OPT_IGNREPLY OPT_OVERWRITE OPT_PREAMB	21	OPT_ERRNO OPT_FAST OPT_IGNMODE OPT_IGNREPLY OPT_OVERWRITE OPT_PREAMB
23	OPT_PROGRESS OPT_SAVEPATH OPT_TINYB64 OPT_USETEXT OPT_VERBOSE	22	OPT_PROGRESS OPT_SAVEPATH OPT_TINYB64 OPT_USETEXT OPT_VERBOSE
24	OPT_VERSION OPT_REMOVE OPT_MOREMIME	23	OPT_VERSION OPT_REMOVE OPT_MOREMIME OPT_DOTDOT
25		24
26	RET_CANCEL RET_CONT RET_EXISTS RET_ILLVAL RET_IOERR RET_NODATA	25	RET_CANCEL RET_CONT RET_EXISTS RET_ILLVAL RET_IOERR RET_NODATA
27	RET_NOEND RET_NOMEM RET_OK RET_UNSUP	26	RET_NOEND RET_NOMEM RET_OK RET_UNSUP
28		27
29	B64ENCODED BH_ENCODED PT_ENCODED QP_ENCODED	28	B64_ENCODED BH_ENCODED PT_ENCODED QP_ENCODED
30	XX_ENCODED UU_ENCODED	29	XX_ENCODED UU_ENCODED YENC_ENCODED
31	);	30	);
32		31
33	@_funcs = qw(	32	@_funcs = qw(
34	Initialize CleanUp GetOption SetOption strerror	33	Initialize CleanUp GetOption SetOption strerror SetMsgCallback
35	SetMsgCallback SetBusyCallback SetFileCallback	34	SetBusyCallback SetFileCallback SetFNameFilter SetFileNameCallback
36	SetFNameFilter FNameFilter LoadFile GetFileListItem	35	FNameFilter LoadFile GetFileListItem RenameFile DecodeToTemp
37	RenameFile DecodeToTemp RemoveTemp DecodeFile	36	RemoveTemp DecodeFile InfoFile Smerge QuickDecode EncodeMulti
38	InfoFile Smerge QuickDecode EncodeMulti EncodePartial	37	EncodePartial EncodeToStream EncodeToFile E_PrepSingle
39	EncodeToStream EncodeToFile E_PrepSingle E_PrepPartial	38	E_PrepPartial
40		39
41	straction strencoding strmsglevel	40	straction strencoding strmsglevel
42	);	41	);
43		42
44	@EXPORT = @_consts;	43	@EXPORT = @_consts;
…		…
62	return 'copying' if $_[0] == &ACT_COPYING;	61	return 'copying' if $_[0] == &ACT_COPYING;
63	return 'decoding' if $_[0] == &ACT_DECODING;	62	return 'decoding' if $_[0] == &ACT_DECODING;
64	return 'encoding' if $_[0] == &ACT_ENCODING;	63	return 'encoding' if $_[0] == &ACT_ENCODING;
65	return 'idle' if $_[0] == &ACT_IDLE;	64	return 'idle' if $_[0] == &ACT_IDLE;
66	return 'scanning' if $_[0] == &ACT_SCANNING;	65	return 'scanning' if $_[0] == &ACT_SCANNING;
67	();	66	'unknown';
68	}	67	}
69		68
70	# encoding type -> string mapping	69	# encoding type -> string mapping
71	sub strencoding($) {	70	sub strencoding($) {
		71	return 'uuencode' if $_[0] == &UU_ENCODED;
72	return 'base64' if $_[0] == &B64ENCODED;	72	return 'base64' if $_[0] == &B64_ENCODED;
		73	return 'yenc' if $_[0] == &YENC_ENCODED;
73	return 'binhex' if $_[0] == &BH_ENCODED;	74	return 'binhex' if $_[0] == &BH_ENCODED;
74	return 'plaintext' if $_[0] == &PT_ENCODED;	75	return 'plaintext' if $_[0] == &PT_ENCODED;
75	return 'quoted-printable' if $_[0] == &QP_ENCODED;	76	return 'quoted-printable' if $_[0] == &QP_ENCODED;
76	return 'xxencode' if $_[0] == &XX_ENCODED;	77	return 'xxencode' if $_[0] == &XX_ENCODED;
77	return 'uuencode' if $_[0] == &UU_ENCODED;	78	'unknown';
78	();
79	}	79	}
80		80
81	sub strmsglevel($) {	81	sub strmsglevel($) {
82	return 'message' if $_[0] == &MSG_MESSAGE;	82	return 'message' if $_[0] == &MSG_MESSAGE;
83	return 'note' if $_[0] == &MSG_NOTE;	83	return 'note' if $_[0] == &MSG_NOTE;
84	return 'warning' if $_[0] == &MSG_WARNING;	84	return 'warning' if $_[0] == &MSG_WARNING;
85	return 'error' if $_[0] == &MSG_ERROR;	85	return 'error' if $_[0] == &MSG_ERROR;
86	return 'panic' if $_[0] == &MSG_PANIC;	86	return 'panic' if $_[0] == &MSG_PANIC;
87	return 'fatal' if $_[0] == &MSG_FATAL;	87	return 'fatal' if $_[0] == &MSG_FATAL;
88	();	88	'unknown';
89	}	89	}
90		90
91	1;	91	1;
92	__END__	92	__END__
93		93
…		…
95		95
96	Convert::UUlib - Perl interface to the uulib library (a.k.a. uudeview/uuenview).	96	Convert::UUlib - Perl interface to the uulib library (a.k.a. uudeview/uuenview).
97		97
98	=head1 SYNOPSIS	98	=head1 SYNOPSIS
99		99
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';	100	use Convert::UUlib ':all';
113		101
		102	# read all the files named on the commandline and decode them
		103	# into the CURRENT directory. See below for a longer example.
114	LoadFile($_) for @ARGV;	104	LoadFile $_ for @ARGV;
115
116	for($i=0; $uu=GetFileListItem($i); $i++) {	105	for (my $i = 0; my $uu = GetFileListItem $i; $i++) {
117	$uu->decode if $uu->state & FILE_OK;	106	if ($uu->state & FILE_OK) {
		107	$uu->decode;
		108	print $uu->filename, "\n";
		109	}
118	}	110	}
		111
		112	=head1 DESCRIPTION
		113
		114	Read the file doc/library.pdf from the distribution for in-depth
		115	information about the C-library used in this interface, and the rest of
		116	this document and especially the non-trivial decoder program at the end.
		117
		118	=head1 EXPORTED CONSTANTS
		119
		120	=head2 Action code constants
		121
		122	ACT_IDLE we don't do anything
		123	ACT_SCANNING scanning an input file
		124	ACT_DECODING decoding into a temp file
		125	ACT_COPYING copying temp to target
		126	ACT_ENCODING encoding a file
		127
		128	=head2 Message severity levels
		129
		130	MSG_MESSAGE just a message, nothing important
		131	MSG_NOTE something that should be noticed
		132	MSG_WARNING important msg, processing continues
		133	MSG_ERROR processing has been terminated
		134	MSG_FATAL decoder cannot process further requests
		135	MSG_PANIC recovery impossible, app must terminate
		136
		137	=head2 Options
		138
		139	OPT_VERSION version number MAJOR.MINORplPATCH (ro)
		140	OPT_FAST assumes only one part per file
		141	OPT_DUMBNESS switch off the program's intelligence
		142	OPT_BRACKPOL give numbers in [] higher precendence
		143	OPT_VERBOSE generate informative messages
		144	OPT_DESPERATE try to decode incomplete files
		145	OPT_IGNREPLY ignore RE:plies (off by default)
		146	OPT_OVERWRITE whether it's OK to overwrite ex. files
		147	OPT_SAVEPATH prefix to save-files on disk
		148	OPT_IGNMODE ignore the original file mode
		149	OPT_DEBUG print messages with FILE/LINE info
		150	OPT_ERRNO get last error code for RET_IOERR (ro)
		151	OPT_PROGRESS retrieve progress information
		152	OPT_USETEXT handle text messages
		153	OPT_PREAMB handle Mime preambles/epilogues
		154	OPT_TINYB64 detect short B64 outside of Mime
		155	OPT_ENCEXT extension for single-part encoded files
		156	OPT_REMOVE remove input files after decoding
		157	OPT_MOREMIME strict MIME adherence
		158	OPT_DOTDOT .. unescaping has not yet been done on input files
		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	=over 4
		209
		210	=item Initialize
		211
		212	Not normally necessary, (re-)initializes the library.
		213
		214	=item CleanUp
		215
		216	Not normally necessary, could be called at the end to release memory
		217	before starting a new decoding round.
		218
		219	=back
		220
		221	=head2 Setting and querying options
		222
		223	=over 4
		224
		225	=item $option = GetOption OPT_xxx
		226
		227	=item SetOption OPT_xxx, opt-value
		228
		229	=back
		230
		231	See the C<OPT_xxx> constants above to see which options exist.
		232
		233	=head2 Setting various callbacks
		234
		235	=over 4
		236
		237	=item SetMsgCallback [callback-function]
		238
		239	=item SetBusyCallback [callback-function]
		240
		241	=item SetFileCallback [callback-function]
		242
		243	=item SetFNameFilter [callback-function]
		244
		245	=back
		246
		247	=head2 Call the currently selected FNameFilter
		248
		249	=over 4
		250
		251	=item $file = FNameFilter $file
		252
		253	=back
		254
		255	=head2 Loading sourcefiles, optionally fuzzy merge and start decoding
		256
		257	=over 4
		258
		259	=item ($retval, $count) = LoadFile $fname, [$id, [$delflag]]
		260
		261	Load the given file and scan it for encoded contents. Optionally tag it
		262	with the given id, and if C<$delflag> is true, delete the file after it is
		263	no longer necessary.
		264
		265	=item $retval = Smerge $pass
		266
		267	If you are desperate, try to call C<Smerge> with increasing C<$pass>
		268	values, beginning at C<0>, to try to merge parts that usually would not
		269	have been merged.
		270
		271	Most probably this will result in garbled files, so never do this by
		272	default.
		273
		274	=item $item = GetFileListItem $item_number
		275
		276	Return the C<$item> structure for the C<$item_number>'th found file, or
		277	C<undef> of no file with that number exists.
		278
		279	The first file has number C<0>, and the series has no holes, so you can
		280	iterate over all files by starting with zero and incrementing until you
		281	hit C<undef>.
		282
		283	=back
		284
		285	=head2 Decoding files
		286
		287	=over 4
		288
		289	=item $retval = $item->rename($newname)
		290
		291	Change the ondisk filename where the decoded file will be saved.
		292
		293	=item $retval = $item->decode_temp
		294
		295	Decode the file into a temporary location, use C<< $item->infile >> to
		296	retrieve the temporary filename.
		297
		298	=item $retval = $item->remove_temp
		299
		300	Remove the temporarily decoded file again.
		301
		302	=item $retval = $item->decode([$target_path])
		303
		304	Decode the file to it's destination, or the given target path.
		305
		306	=item $retval = $item->info(callback-function)
		307
		308	=back
		309
		310	=head2 Querying (and setting) item attributes
		311
		312	=over 4
		313
		314	=item $state = $item->state
		315
		316	=item $mode = $item->mode([newmode])
		317
		318	=item $uudet = $item->uudet
		319
		320	=item $size = $item->size
		321
		322	=item $filename = $item->filename([newfilename})
		323
		324	=item $subfname = $item->subfname
		325
		326	=item $mimeid = $item->mimeid
		327
		328	=item $mimetype = $item->mimetype
		329
		330	=item $binfile = $item->binfile
		331
		332	=back
		333
		334	=head2 Information about source parts
		335
		336	=over 4
		337
		338	=item $parts = $item->parts
		339
		340	Return information about all parts (source files) used to decode the file
		341	as a list of hashrefs with the following structure:
		342
		343	{
		344	partno => <integer describing the part number, starting with 1>,
		345	# the following member sonly exist when they contain useful information
		346	sfname => <local pathname of the file where this part is from>,
		347	filename => <the ondisk filename of the decoded file>,
		348	subfname => <used to cluster postings, possibly the posting filename>,
		349	subject => <the subject of the posting/mail>,
		350	origin => <the possible source (From) address>,
		351	mimetype => <the possible mimetype of the decoded file>,
		352	mimeid => <the id part of the Content-Type>,
		353	}
		354
		355	Usually you are interested mostly the C<sfname> and possibly the C<partno>
		356	and C<filename> members.
		357
		358	=back
		359
		360	=head2 Functions below not documented and not very well tested
		361
		362	QuickDecode
		363	EncodeMulti
		364	EncodePartial
		365	EncodeToStream
		366	EncodeToFile
		367	E_PrepSingle
		368	E_PrepPartial
		369
		370	=head2 EXTENSION FUNCTIONS
		371
		372	Functions found in this module but not documented in the uulib documentation:
		373
		374	=over 4
		375
		376	=item $msg = straction ACT_xxx
		377
		378	Return a human readable string representing the given action code.
		379
		380	=item $msg = strerror RET_xxx
		381
		382	Return a human readable string representing the given error code.
		383
		384	=item $str = strencoding xxx_ENCODED
		385
		386	Return the name of the encoding type as a string.
		387
		388	=item $str = strmsglevel MSG_xxx
		389
		390	Returns the message level as a string.
		391
		392	=item SetFileNameCallback $cb
		393
		394	Sets (or queries) the FileNameCallback, which is called whenever the
		395	decoding library can't find a filename and wants to extract a filename
		396	from the subject line of a posting. The callback will be called with
		397	two arguments, the subject line and the current candidate for the
		398	filename. The latter argument can be C<undef>, which means that no
		399	filename could be found (and likely no one exists, so it is safe to also
		400	return C<undef> in this case). If it doesn't return anything (not even
		401	C<undef>!), then nothing happens, so this is a no-op callback:
		402
		403	sub cb {
		404	return ();
		405	}
		406
		407	If it returns C<undef>, then this indicates that no filename could be
		408	found. In all other cases, the return value is taken to be the filename.
		409
		410	This is a slightly more useful callback:
		411
		412	sub cb {
		413	return unless $_[1]; # skip "Re:"-plies et al.
		414	my ($subject, $filename) = @_;
		415	# if we find some *.rar, take it
		416	return $1 if $subject =~ /(\w+\.rar)/;
		417	# otherwise just pass what we have
		418	return ();
		419	}
		420
		421	=back
119		422
120	=head1 LARGE EXAMPLE DECODER	423	=head1 LARGE EXAMPLE DECODER
121		424
122	This is the file C<example-decoder> from the distribution, put here	425	This is the file C<example-decoder> from the distribution, put here
123	instead of more thorough documentation.	426	instead of more thorough documentation.
…		…
132	$path=~s/^.*[\/\\]//;	435	$path=~s/^.*[\/\\]//;
133	$path;	436	$path;
134	}	437	}
135		438
136	sub busycb {	439	sub busycb {
137	my($action,$curfile,$partno,$numparts,$percent,$fsize)=@_;	440	my ($action, $curfile, $partno, $numparts, $percent, $fsize) = @_;
138	$_[0]=straction($action);	441	$_[0]=straction($action);
139	print "busy_callback(",join(",",@_),")\n";	442	print "busy_callback(", (join ",",@_), ")\n";
140	0;	443	0;
141	}	444	}
142		445
143	SetOption (OPT_IGNMODE, 1);	446	SetOption OPT_IGNMODE, 1;
144	SetOption (OPT_VERBOSE, 1);	447	SetOption OPT_VERBOSE, 1;
145		448
146	# show the three ways you can set callback functions	449	# show the three ways you can set callback functions. I normally
		450	# prefer the one with the sub inplace.
147	SetFNameFilter (\&namefilter);	451	SetFNameFilter \&namefilter;
148		452
149	SetBusyCallback ("busycb",333);	453	SetBusyCallback "busycb", 333;
150		454
151	SetMsgCallback (sub {	455	SetMsgCallback sub {
152	my($msg,$level)=@_;	456	my ($msg, $level) = @_;
153	print uc(strmsglevel($_[1])),": $msg\n";	457	print uc strmsglevel $_[1], ": $msg\n";
154	});	458	};
155		459
		460	# the following non-trivial FileNameCallback takes care
		461	# of some subject lines not detected properly by uulib:
		462	SetFileNameCallback sub {
		463	return unless $_[1]; # skip "Re:"-plies et al.
		464	local $_ = $_[0];
		465
		466	# the following rules are rather effective on some newsgroups,
		467	# like alt.binaries.games.anime, where non-mime, uuencoded data
		468	# is very common
		469
		470	# if we find some *.rar, take it as the filename
		471	return $1 if /(\S{3,}\.(?:[rstuvwxyz]\d\d\|rar))\s/i;
		472
		473	# one common subject format
		474	return $1 if /- "(.{2,}?\..+?)" (?:yenc )?$\d+\/\d+$/i;
		475
		476	# - filename.par (04/55)
		477	return $1 if /- "?(\S{3,}\.\S+?)"? (?:yenc )?$\d+\/\d+$/i;
		478
		479	# - (xxx) No. 1 sayuri81.jpg 756565 bytes
		480	# - (20 files) No.17 Roseanne.jpg [2/2]
		481	return $1 if /No\.[ 0-9]+ (\S+\....) (?:\d+ bytes )?\[/;
		482
		483	# otherwise just pass what we have
		484	return ();
		485	};
		486
		487	# now read all files in the directory uusrc/*
156	for(<uusrc/*>) {	488	for(<uusrc/*>) {
157	my($retval,$count)=LoadFile ($_,$_,1);	489	my($retval,$count)=LoadFile ($_, $_, 1);
158	print "file($_), status(",strerror($retval),") parts($count)\n";	490	print "file($_), status(", strerror $retval, ") parts($count)\n";
159	}	491	}
160		492
161	SetOption (OPT_SAVEPATH, "uudst/");	493	SetOption OPT_SAVEPATH, "uudst/";
162		494
		495	# now wade through all files and their source parts
163	$i=0;	496	$i = 0;
164	while($uu=GetFileListItem($i)) {	497	while ($uu = GetFileListItem($i)) {
165	$i++;	498	$i++;
166	print "file nr. $i";	499	print "file nr. $i";
167	print " state ",$uu->state;	500	print " state ", $uu->state;
168	print " mode ",$uu->mode;	501	print " mode ", $uu->mode;
169	print " uudet ",strencoding($uu->uudet);	502	print " uudet ", strencoding $uu->uudet;
170	print " size ",$uu->size;	503	print " size ", $uu->size;
171	print " filename ",$uu->filename;	504	print " filename ", $uu->filename;
172	print " subfname ",$uu->subfname;	505	print " subfname ", $uu->subfname;
173	print " mimeid ",$uu->mimeid;	506	print " mimeid ", $uu->mimeid;
174	print " mimetype ",$uu->mimetype;	507	print " mimetype ", $uu->mimetype;
175	print "\n";	508	print "\n";
176		509
177	# print additional info about all parts	510	# print additional info about all parts
178	for($uu->parts) {	511	for ($uu->parts) {
179	while(my($k,$v)=each(%$_)) {	512	while (my ($k, $v) = each %$_) {
180	print "$k > $v, ";	513	print "$k > $v, ";
181	}	514	}
182	print "\n";	515	print "\n";
183	}	516	}
184		517
185	$uu->decode_temp;	518	$uu->decode_temp;
186	print " temporarily decoded to ",$uu->binfile,"\n";	519	print " temporarily decoded to ", $uu->binfile, "\n";
187	$uu->remove_temp;	520	$uu->remove_temp;
188		521
189	print strerror($uu->decode);	522	print strerror $uu->decode;
190	print " saved as uudst/",$uu->filename,"\n";	523	print " saved as uudst/", $uu->filename, "\n";
191	}	524	}
192		525
193	print "cleanup...\n";	526	print "cleanup...\n";
194		527
195	CleanUp();	528	CleanUp();
196		529
197	=head1 Exported constants
198
199	Action code constants:
200
201	ACT_COPYING ACT_DECODING ACT_ENCODING
202	ACT_IDLE ACT_SCANNING
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;
273	$retval = $item->remove_temp;
274	$retval = $item->decode([$target_path]);
275	$retval = $item->info(callback-function);
276
277	Querying (and setting) item attributes:
278
279	$state = $item->state;
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
289	Totally undocumented and unsupported(!):
290
291	$parts = $item->parts;
292
293	Functions below not documented and not very well tested:
294
295	int QuickDecode () ;
296	int EncodeMulti () ;
297	int EncodePartial () ;
298	int EncodeToStream () ;
299	int EncodeToFile () ;
300	int E_PrepSingle () ;
301	int E_PrepPartial () ;
302
303	=head1 AUTHOR	530	=head1 AUTHOR
304		531
305	Marc Lehmann <pcg@goof.com>, the original uulib library was written by	532	Marc Lehmann <pcg@goof.com>, the original uulib library was written
306	Frank Pilhofer <fp@informatik.uni-frankfurt.de>.	533	by Frank Pilhofer <fp@informatik.uni-frankfurt.de>, and later heavily
		534	bugfixed by Marc Lehmann.
307		535
308	=head1 SEE ALSO	536	=head1 SEE ALSO
309		537
310	perl(1), uudeview homepage at http://www.uni-frankfurt.de/~fp/uudeview/.	538	perl(1), uudeview homepage at http://www.uni-frankfurt.de/~fp/uudeview/.
311		539

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.13 by root, Tue Oct 15 23:20:29 2002 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.13 by root, Tue Oct 15 23:20:29 2002 UTC