Base64.hpp Source File

00001 /*
00002  * The Apache Software License, Version 1.1
00003  * 
00004  * Copyright (c) 2001 The Apache Software Foundation.  All rights
00005  * reserved.
00006  * 
00007  * Redistribution and use in source and binary forms, with or without
00008  * modification, are permitted provided that the following conditions
00009  * are met:
00010  * 
00011  * 1. Redistributions of source code must retain the above copyright
00012  *    notice, this list of conditions and the following disclaimer. 
00013  * 
00014  * 2. Redistributions in binary form must reproduce the above copyright
00015  *    notice, this list of conditions and the following disclaimer in
00016  *    the documentation and/or other materials provided with the
00017  *    distribution.
00018  * 
00019  * 3. The end-user documentation included with the redistribution,
00020  *    if any, must include the following acknowledgment:  
00021  *       "This product includes software developed by the
00022  *        Apache Software Foundation (http://www.apache.org/)."
00023  *    Alternately, this acknowledgment may appear in the software itself,
00024  *    if and wherever such third-party acknowledgments normally appear.
00025  * 
00026  * 4. The names "Xerces" and "Apache Software Foundation" must
00027  *    not be used to endorse or promote products derived from this
00028  *    software without prior written permission. For written 
00029  *    permission, please contact apache\@apache.org.
00030  * 
00031  * 5. Products derived from this software may not be called "Apache",
00032  *    nor may "Apache" appear in their name, without prior written
00033  *    permission of the Apache Software Foundation.
00034  * 
00035  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
00036  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
00037  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
00038  * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
00039  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
00040  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
00041  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
00042  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
00043  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
00044  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
00045  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
00046  * SUCH DAMAGE.
00047  * ====================================================================
00048  * 
00049  * This software consists of voluntary contributions made by many
00050  * individuals on behalf of the Apache Software Foundation, and was
00051  * originally based on software copyright (c) 2001, International
00052  * Business Machines, Inc., http://www.ibm.com .  For more information
00053  * on the Apache Software Foundation, please see
00054  * <http://www.apache.org/>.
00055  */
00056 
00057 /*
00058  * $Id: Base64.hpp,v 1.3 2001/10/10 19:14:08 peiyongz Exp $
00059  */
00060 
00061 #ifndef BASE64_HPP
00062 #define BASE64_HPP
00063 
00064 #include <util/XercesDefs.hpp>
00065 #include <util/XMLUniDefs.hpp>
00066 
00067 //
00068 // This class provides encode/decode for RFC 2045 Base64 as
00069 // defined by RFC 2045, N. Freed and N. Borenstein.
00070 // RFC 2045: Multipurpose Internet Mail Extensions (MIME)
00071 // Part One: Format of Internet Message Bodies. Reference
00072 // 1996 Available at: http://www.ietf.org/rfc/rfc2045.txt
00073 // This class is used by XML Schema binary format validation
00074 //  
00075 //
00076 class  Base64
00077 {
00078 public :
00079 
00081 
00092     static XMLCh* encode (
00093         const XMLCh* const inputData,
00094         const int inputLength,
00095         int *outputLength = 0 );
00096 
00106     static int getDataLength(
00107         const XMLCh* const inputData );
00108 
00118     static XMLCh* decode(
00119         const XMLCh* const inputData,
00120         int& outputLength );
00121 
00123 
00124 private :
00125 
00126     // -----------------------------------------------------------------------
00127     //  Helper methods
00128     // -----------------------------------------------------------------------
00129 
00130     static void init();
00131 
00132     static bool isData(const XMLCh& octet);
00133     static bool isPad(const XMLCh& octet);
00134 
00135     static XMLCh set1stOctet(const XMLCh&, const XMLCh&);
00136     static XMLCh set2ndOctet(const XMLCh&, const XMLCh&);
00137     static XMLCh set3rdOctet(const XMLCh&, const XMLCh&);
00138 
00139     static void split1stOctet(const XMLCh&, XMLCh&, XMLCh&);
00140     static void split2ndOctet(const XMLCh&, XMLCh&, XMLCh&);
00141     static void split3rdOctet(const XMLCh&, XMLCh&, XMLCh&);
00142 
00143     // -----------------------------------------------------------------------
00144     //  Unimplemented constructors and operators
00145     // -----------------------------------------------------------------------
00146     Base64();
00147     Base64(const Base64&);
00148 
00149     // -----------------------------------------------------------------------
00150     //  Private data members
00151     //
00152     //  base64Alphabet
00153     //     The Base64 alphabet (see RFC 2045).
00154     //
00155     //  base64Padding
00156     //     Padding character (see RFC 2045).
00157     //
00158     //  base64Inverse
00159     //     Table used in decoding base64.
00160     //
00161     //  isInitialized
00162     //     Set once base64Inverse is initalized.
00163     //
00164     //  quadsPerLine
00165     //     Number of quadruplets per one line. The encoded output
00166     //     stream must be represented in lines of no more 
00167     //     than 19 quadruplets each.
00168     //
00169     // -----------------------------------------------------------------------
00170 
00171     static const XMLCh  base64Alphabet[];
00172     static const XMLCh  base64Padding;
00173 
00174     static XMLCh  base64Inverse[];
00175     static bool  isInitialized;
00176 
00177     static const unsigned int  quadsPerLine;
00178 };
00179 
00180 // -----------------------------------------------------------------------
00181 //  Helper methods
00182 // -----------------------------------------------------------------------
00183 inline bool Base64::isPad(const XMLCh& octet) 
00184 {
00185     return ( octet == base64Padding );
00186 }
00187 
00188 inline XMLCh Base64::set1stOctet(const XMLCh& b1, const XMLCh& b2)
00189 {
00190     return (( b1 << 2 ) | ( b2 >> 4 ));
00191 }
00192 
00193 inline XMLCh Base64::set2ndOctet(const XMLCh& b2, const XMLCh& b3)
00194 {
00195     return (( b2 << 4 ) | ( b3 >> 2 ));
00196 }
00197 
00198 inline XMLCh Base64::set3rdOctet(const XMLCh& b3, const XMLCh& b4)
00199 {
00200     return (( b3 << 6 ) | b4 );
00201 }
00202 
00203 inline void Base64::split1stOctet(const XMLCh& ch, XMLCh& b1, XMLCh& b2) {
00204     b1 = ch >> 2;
00205     b2 = ( ch & 0x3 ) << 4;
00206 }
00207 
00208 inline void Base64::split2ndOctet(const XMLCh& ch, XMLCh& b2, XMLCh& b3) {
00209     b2 |= ch >> 4;  // combine with previous value
00210     b3 = ( ch & 0xf ) << 2;
00211 }
00212 
00213 inline void Base64::split3rdOctet(const XMLCh& ch, XMLCh& b3, XMLCh& b4) {
00214     b3 |= ch >> 6;  // combine with previous value 
00215     b4 = ( ch & 0x3f );
00216 }
00217 
00218 #endif