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

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.25 by root, Mon May 2 19:58:40 2005 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.25 by root, Mon May 2 19:58:40 2005 UTC