src/util/URL.hpp

/*
 * The Apache Software License, Version 1.1
 * 
 * Copyright (c) 1999 The Apache Software Foundation.  All rights 
 * reserved.
 * 
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer. 
 * 
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 * 
 * 3. The end-user documentation included with the redistribution,
 *    if any, must include the following acknowledgment:  
 *       "This product includes software developed by the
 *        Apache Software Foundation (http://www.apache.org/)."
 *    Alternately, this acknowledgment may appear in the software itself,
 *    if and wherever such third-party acknowledgments normally appear.
 * 
 * 4. The names "Xerces" and "Apache Software Foundation" must
 *    not be used to endorse or promote products derived from this
 *    software without prior written permission. For written 
 *    permission, please contact apache\@apache.org.
 * 
 * 5. Products derived from this software may not be called "Apache",
 *    nor may "Apache" appear in their name, without prior written
 *    permission of the Apache Software Foundation.
 * 
 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 * ====================================================================
 * 
 * This software consists of voluntary contributions made by many
 * individuals on behalf of the Apache Software Foundation, and was
 * originally based on software copyright (c) 1999, International
 * Business Machines, Inc., http://www.ibm.com .  For more information
 * on the Apache Software Foundation, please see
 * <http://www.apache.org/>.
 */

/**
 * $Log$
 * Revision 1.1  1999/11/09 01:05:22  twl
 * Initial revision
 *
 * Revision 1.2  1999/11/08 20:45:16  rahul
 * Swat for adding in Product name and CVS comment log variable.
 *
 */

#if !defined(URL_HPP)
#define URL_HPP

#include <util/XML4CDefs.hpp>
#include <util/XMLException.hpp>
#include <util/XMLUni.hpp>

class BinInputStream;


// Hard coded Unicode text for "MalformedURLException"
static const XMLCh gMalformedURLException_Name[] =
{
        chLatin_M, chLatin_a, chLatin_l, chLatin_f, chLatin_o, chLatin_r
    ,   chLatin_m, chLatin_e, chLatin_d, chLatin_U, chLatin_R, chLatin_L
    ,   chLatin_E, chLatin_x, chLatin_c, chLatin_e, chLatin_p, chLatin_t
    ,   chLatin_i, chLatin_o, chLatin_n, chNull
};

MakeXML4CException(MalformedURLException, XMLUTIL_EXPORT)


//
//  This class provides a minimal URL implementation to be able to deal
//  with file:// protocol URLs. It will be fleshed out in the future.
//
class XMLUTIL_EXPORT URL
{
public:
    // -----------------------------------------------------------------------
    //  Class types
    //
    //  Local MUST be the last one in the list! And they must remain in this
    //  order because they are indexes into an array internally!
    // -----------------------------------------------------------------------
    enum Protocols
    {
        File
        , HTTP
        , FTP
        , Gopher
        , MailTo
        , News
        , NNTP
        , Telnet
        , Wais
        , Prospero

        , Protocols_Count
    };


    // -----------------------------------------------------------------------
    //  Constructors and Destructor
    // -----------------------------------------------------------------------
    URL();
    URL(const URL& toCopy);
    virtual ~URL();


    // -----------------------------------------------------------------------
    //  Operators
    // -----------------------------------------------------------------------
    URL& operator=(const URL& toAssign);
    bool operator==(const URL& toCompare) const;
    bool operator!=(const URL& toCompare) const;


    // -----------------------------------------------------------------------
    //  Getter methods
    // -----------------------------------------------------------------------
    const XMLCh* getHost() const;
    const XMLCh* getProtocol() const;
    const XMLCh* getPath() const;
    URL::Protocols getType() const;
    const XMLCh* getURL() const;


    // -----------------------------------------------------------------------
    //  Getter methods
    // -----------------------------------------------------------------------
    void setURL(const XMLCh* const urlText);
    void setURL(const char* const urlText);


    // -----------------------------------------------------------------------
    //  Miscellaneous methods
    // -----------------------------------------------------------------------
    BinInputStream* makeNewStream() const;


private:
    // -----------------------------------------------------------------------
    //  Private helper methods
    // -----------------------------------------------------------------------
    void cleanup();
    URL::Protocols findType(unsigned int& curPos) const;
    XMLCh getNextCh(unsigned int& pos, const bool endOk = false) const;
    XMLCh peekNextCh(unsigned int pos) const;
    void parse();


    // -----------------------------------------------------------------------
    //  Data members
    //
    //  fFullURL
    //      This is a copy of the original URL.
    //
    //  fHost
    //      The host part of the URL that was parsed out. This one will often
    //      be empty (or "localhost", which also means the current machine.)
    //
    //  fPath
    //      The path part of the URL that was parsed out.
    //
    //  fProtocol
    //      Indicates the type of the URL's source. The text of the prefix
    //      can be gotten from this.
    // -----------------------------------------------------------------------
    XMLCh*      fFullURL;
    XMLCh*      fHost;
    XMLCh*      fPath;
    Protocols   fProtocol;
};


// ---------------------------------------------------------------------------
//  URL: Public operators
// ---------------------------------------------------------------------------
inline bool URL::operator!=(const URL& toCompare) const
{
    return !operator==(toCompare);
}


// ---------------------------------------------------------------------------
//  URL: Getter methods
// ---------------------------------------------------------------------------
inline const XMLCh* URL::getHost() const
{
    return fHost;
}

inline const XMLCh* URL::getPath() const
{
    return fPath;
}

inline URL::Protocols URL::getType() const
{
    return fProtocol;
}

inline const XMLCh* URL::getURL() const
{
    return fFullURL;
}


#endif