diff options
Diffstat (limited to 'Master/tlpkg/tlperl/lib/MIME')
-rwxr-xr-x | Master/tlpkg/tlperl/lib/MIME/Base64.pm | 175 | ||||
-rwxr-xr-x | Master/tlpkg/tlperl/lib/MIME/QuotedPrint.pm | 114 |
2 files changed, 289 insertions, 0 deletions
diff --git a/Master/tlpkg/tlperl/lib/MIME/Base64.pm b/Master/tlpkg/tlperl/lib/MIME/Base64.pm new file mode 100755 index 00000000000..2bcd5857795 --- /dev/null +++ b/Master/tlpkg/tlperl/lib/MIME/Base64.pm @@ -0,0 +1,175 @@ +package MIME::Base64; + +use strict; +use vars qw(@ISA @EXPORT $VERSION); + +require Exporter; +@ISA = qw(Exporter); +@EXPORT = qw(encode_base64 decode_base64); + +$VERSION = '3.09'; + +require XSLoader; +XSLoader::load('MIME::Base64', $VERSION); + +*encode = \&encode_base64; +*decode = \&decode_base64; + +1; + +__END__ + +=head1 NAME + +MIME::Base64 - Encoding and decoding of base64 strings + +=head1 SYNOPSIS + + use MIME::Base64; + + $encoded = encode_base64('Aladdin:open sesame'); + $decoded = decode_base64($encoded); + +=head1 DESCRIPTION + +This module provides functions to encode and decode strings into and from the +base64 encoding specified in RFC 2045 - I<MIME (Multipurpose Internet +Mail Extensions)>. The base64 encoding is designed to represent +arbitrary sequences of octets in a form that need not be humanly +readable. A 65-character subset ([A-Za-z0-9+/=]) of US-ASCII is used, +enabling 6 bits to be represented per printable character. + +The following functions are provided: + +=over 4 + +=item encode_base64($str) + +=item encode_base64($str, $eol); + +Encode data by calling the encode_base64() function. The first +argument is the string to encode. The second argument is the +line-ending sequence to use. It is optional and defaults to "\n". The +returned encoded string is broken into lines of no more than 76 +characters each and it will end with $eol unless it is empty. Pass an +empty string as second argument if you do not want the encoded string +to be broken into lines. + +=item decode_base64($str) + +Decode a base64 string by calling the decode_base64() function. This +function takes a single argument which is the string to decode and +returns the decoded data. + +Any character not part of the 65-character base64 subset is +silently ignored. Characters occurring after a '=' padding character +are never decoded. + +If the length of the string to decode, after ignoring +non-base64 chars, is not a multiple of 4 or if padding occurs too early, +then a warning is generated if perl is running under C<-w>. + +=back + +If you prefer not to import these routines into your namespace, you can +call them as: + + use MIME::Base64 (); + $encoded = MIME::Base64::encode($decoded); + $decoded = MIME::Base64::decode($encoded); + +=head1 DIAGNOSTICS + +The following warnings can be generated if perl is invoked with the +C<-w> switch: + +=over 4 + +=item Premature end of base64 data + +The number of characters to decode is not a multiple of 4. Legal +base64 data should be padded with one or two "=" characters to make +its length a multiple of 4. The decoded result will be the same +whether the padding is present or not. + +=item Premature padding of base64 data + +The '=' padding character occurs as the first or second character +in a base64 quartet. + +=back + +The following exception can be raised: + +=over 4 + +=item Wide character in subroutine entry + +The string passed to encode_base64() contains characters with code +above 255. The base64 encoding is only defined for single-byte +characters. Use the Encode module to select the byte encoding you +want. + +=back + +=head1 EXAMPLES + +If you want to encode a large file, you should encode it in chunks +that are a multiple of 57 bytes. This ensures that the base64 lines +line up and that you do not end up with padding in the middle. 57 +bytes of data fills one complete base64 line (76 == 57*4/3): + + use MIME::Base64 qw(encode_base64); + + open(FILE, "/var/log/wtmp") or die "$!"; + while (read(FILE, $buf, 60*57)) { + print encode_base64($buf); + } + +or if you know you have enough memory + + use MIME::Base64 qw(encode_base64); + local($/) = undef; # slurp + print encode_base64(<STDIN>); + +The same approach as a command line: + + perl -MMIME::Base64 -0777 -ne 'print encode_base64($_)' <file + +Decoding does not need slurp mode if every line contains a multiple +of four base64 chars: + + perl -MMIME::Base64 -ne 'print decode_base64($_)' <file + +Perl v5.8 and better allow extended Unicode characters in strings. +Such strings cannot be encoded directly, as the base64 +encoding is only defined for single-byte characters. The solution is +to use the Encode module to select the byte encoding you want. For +example: + + use MIME::Base64 qw(encode_base64); + use Encode qw(encode); + + $encoded = encode_base64(encode("UTF-8", "\x{FFFF}\n")); + print $encoded; + +=head1 COPYRIGHT + +Copyright 1995-1999, 2001-2004 Gisle Aas. + +This library is free software; you can redistribute it and/or +modify it under the same terms as Perl itself. + +Distantly based on LWP::Base64 written by Martijn Koster +<m.koster@nexor.co.uk> and Joerg Reichelt <j.reichelt@nexor.co.uk> and +code posted to comp.lang.perl <3pd2lp$6gf@wsinti07.win.tue.nl> by Hans +Mulder <hansm@wsinti07.win.tue.nl> + +The XS implementation uses code from metamail. Copyright 1991 Bell +Communications Research, Inc. (Bellcore) + +=head1 SEE ALSO + +L<MIME::QuotedPrint> + +=cut diff --git a/Master/tlpkg/tlperl/lib/MIME/QuotedPrint.pm b/Master/tlpkg/tlperl/lib/MIME/QuotedPrint.pm new file mode 100755 index 00000000000..ca3a042edb3 --- /dev/null +++ b/Master/tlpkg/tlperl/lib/MIME/QuotedPrint.pm @@ -0,0 +1,114 @@ +package MIME::QuotedPrint; + +use strict; +use vars qw(@ISA @EXPORT $VERSION); + +require Exporter; +@ISA = qw(Exporter); +@EXPORT = qw(encode_qp decode_qp); + +$VERSION = "3.09"; + +use MIME::Base64; # will load XS version of {en,de}code_qp() + +*encode = \&encode_qp; +*decode = \&decode_qp; + +1; + +__END__ + +=head1 NAME + +MIME::QuotedPrint - Encoding and decoding of quoted-printable strings + +=head1 SYNOPSIS + + use MIME::QuotedPrint; + + $encoded = encode_qp($decoded); + $decoded = decode_qp($encoded); + +=head1 DESCRIPTION + +This module provides functions to encode and decode strings into and from the +quoted-printable encoding specified in RFC 2045 - I<MIME (Multipurpose +Internet Mail Extensions)>. The quoted-printable encoding is intended +to represent data that largely consists of bytes that correspond to +printable characters in the ASCII character set. Each non-printable +character (as defined by English Americans) is represented by a +triplet consisting of the character "=" followed by two hexadecimal +digits. + +The following functions are provided: + +=over 4 + +=item encode_qp($str) + +=item encode_qp($str, $eol) + +=item encode_qp($str, $eol, $binmode) + +This function returns an encoded version of the string ($str) given as +argument. + +The second argument ($eol) is the line-ending sequence to use. It is +optional and defaults to "\n". Every occurrence of "\n" is replaced +with this string, and it is also used for additional "soft line +breaks" to ensure that no line end up longer than 76 characters. Pass +it as "\015\012" to produce data suitable for external consumption. +The string "\r\n" produces the same result on many platforms, but not +all. + +The third argument ($binmode) will select binary mode if passed as a +TRUE value. In binary mode "\n" will be encoded in the same way as +any other non-printable character. This ensures that a decoder will +end up with exactly the same string whatever line ending sequence it +uses. In general it is preferable to use the base64 encoding for +binary data; see L<MIME::Base64>. + +An $eol of "" (the empty string) is special. In this case, no "soft +line breaks" are introduced and binary mode is effectively enabled so +that any "\n" in the original data is encoded as well. + +=item decode_qp($str); + +This function returns the plain text version of the string given +as argument. The lines of the result are "\n" terminated, even if +the $str argument contains "\r\n" terminated lines. + +=back + + +If you prefer not to import these routines into your namespace, you can +call them as: + + use MIME::QuotedPrint (); + $encoded = MIME::QuotedPrint::encode($decoded); + $decoded = MIME::QuotedPrint::decode($encoded); + +Perl v5.8 and better allow extended Unicode characters in strings. +Such strings cannot be encoded directly, as the quoted-printable +encoding is only defined for single-byte characters. The solution is +to use the Encode module to select the byte encoding you want. For +example: + + use MIME::QuotedPrint qw(encode_qp); + use Encode qw(encode); + + $encoded = encode_qp(encode("UTF-8", "\x{FFFF}\n")); + print $encoded; + +=head1 COPYRIGHT + +Copyright 1995-1997,2002-2004 Gisle Aas. + +This library is free software; you can redistribute it and/or +modify it under the same terms as Perl itself. + +=head1 SEE ALSO + +L<MIME::Base64> + +=cut |