windows-server-2003/inetcore/urlmon/inc/urlmon.hxx

//+---------------------------------------------------------------------------
//
//  Microsoft Windows
//  Copyright (C) Microsoft Corporation, 1992 - 1995.
//
//  File:       urlmon.hxx
//
//  Contents:
//
//  Classes:
//
//  Functions:
//
//  History:    12-22-95   JohannP (Johann Posch)   Created
//
//----------------------------------------------------------------------------
#ifndef _URLMON_HXX_
#define _URLMON_HXX_

#include <urlint.h>
#include <wininet.h>
#include <sem.hxx>
#include <debug.h>
#include <w95wraps.h>

#ifdef _SBS_
#define CLSID_StdURLMoniker             CLSID_SBS_StdURLMoniker
#define CLSID_UrlMkBindCtx              CLSID_SBS_UrlMkBindCtx
#define CLSID_HttpSProtocol             CLSID_SBS_HttpSProtocol
#define CLSID_HttpProtocol              CLSID_SBS_HttpProtocol 
#define CLSID_FtpProtocol               CLSID_SBS_FtpProtocol 
#define CLSID_GopherProtocol            CLSID_SBS_GopherProtocol
#define CLSID_FileProtocol              CLSID_SBS_FileProtocol 
#define CLSID_MkProtocol                CLSID_SBS_MkProtocol 
#define CLSID_SoftDistExt               CLSID_SBS_SoftDistExt
#define CLSID_InternetSecurityManager   CLSID_SBS_InternetSecurityManager 
#define CLSID_InternetZoneManager       CLSID_SBS_InternetZoneManager 
#define CLSID_DeCompMimeFilter          CLSID_SBS_DeCompMimeFilter
#define CLSID_StdEncodingFilterFac      CLSID_SBS_StdEncodingFilterFac
#define CLSID_CdlProtocol               CLSID_SBS_CdlProtocol
#define CLSID_ClassInstallFilter        CLSID_SBS_ClassInstallFilter
#endif //_SBS_

#define SZPROTOCOLROOT  "PROTOCOLS\\Handler\\"
#define SZCLASS         "CLSID"
#define SZALL           "*"
#define SZNAMESPACEROOT "PROTOCOLS\\Name-Space Handler\\"
#define SZHANDLER       "HANDLER"
#define SZFILTERROOT    "PROTOCOLS\\Filter\\"
#define ULPROTOCOLLEN    32
#define SZ_SH_PROTOCOLROOT  "SOFTWARE\\Classes\\PROTOCOLS\\Handler\\"
#define SZ_SH_NAMESPACEROOT "SOFTWARE\\Classes\\PROTOCOLS\\Name-Space Handler\\"
#define SZ_SH_FILTERROOT    "SOFTWARE\\Classes\\PROTOCOLS\\Filter\\"


//extern char szMimeKey[]     = "MIME\\Database\\Content Type\\";
//const ULONG ulMimeKeyLen    = ((sizeof(szMimeKey)/sizeof(char))-1);

#define SZMIMEKEY       "MIME\\Database\\Content Type\\"
#define ULMIMEKEYLEN    32

// move this to public header file
#define S_NEEDMOREDATA                                ((HRESULT)0x00000002L)
#define BSCF_ASYNCDATANOTIFICATION  0x00010000

#define BINDSTATUS_ERROR            ((BINDSTATUS)0xf0000000)
#define BINDSTATUS_INTERNAL         ((BINDSTATUS)0xf1000000)
#define BINDSTATUS_INTERNALASYNC    ((BINDSTATUS)0xf2000000)
#define BINDSTATUS_RESULT           ((BINDSTATUS)0xf4000000)

// BUGBUG: find maximum mime size
#define SZMIMESIZE_MAX 128

// download buffer per request, can this
#define  DNLD_BUFFER_SIZE           8192
#define  SNIFFDATA_SIZE             2048
#define  MAX_URL_SIZE    INTERNET_MAX_URL_LENGTH


#define CU_NO_CANONICALIZE  0x00000000
#define CU_CANONICALIZE     0x00000001
#define CU_STANDARD_FORM    0x00000002

STDAPI ConstructURL(LPBC pBC, LPMONIKER pmkContext, LPMONIKER pmkToLeft,
            LPWSTR pwzURLRelative, LPWSTR pwzURLFull, DWORD cURLSize,
            DWORD dwFlags);

// global variable
extern HINTERNET g_hSession;

LPCSTR GetUserAgentString();
void   WideCharToMultiByteWithMlang(LPCWSTR wzFrom, LPSTR szTo, int cchTo, DWORD dwCodePage);

inline void W2A(LPCWSTR lpwszWide, LPSTR lpszAnsi, int cchAnsi, DWORD dwCodePage = 0)
{
    if( !dwCodePage )
    {
        if(!WideCharToMultiByte(CP_ACP,0,lpwszWide,-1,lpszAnsi,cchAnsi,NULL,NULL))
        {
            // truncated - make sure to null terminate
            lpszAnsi[cchAnsi - 1] = 0;
        }
    }
    else
    {
        WideCharToMultiByteWithMlang(lpwszWide,lpszAnsi,cchAnsi,dwCodePage);
    }
}


inline void A2W(LPSTR lpszAnsi,LPWSTR lpwszWide, int cchAnsi)
{
    if(!MultiByteToWideChar(CP_ACP,0,lpszAnsi,-1,lpwszWide,cchAnsi))
    {
        // truncated - make sure to null terminate
        lpwszWide[cchAnsi - 1] = 0;
    }
}
#define CchWzLen(x) wcslen(x)
#define CchSzLen(x) strlen(x)
LPSTR SzW2ADynamic(LPCWSTR wzFrom, LPSTR szTo, int cchTo, BOOL fTaskMalloc);
LPWSTR WzA2WDynamic(LPCSTR szFrom, LPWSTR wzTo, int cwchTo, BOOL fTaskMalloc);


LPWSTR OLESTRDuplicate(LPCWSTR ws);

// Security manager functions.

// functions called by the security manager
BOOL IsHierarchicalScheme(DWORD dwScheme);
BOOL IsHierarchicalUrl(LPCWSTR pwszUrl);

// functions exported by the security manager.
STDAPI InternetCreateSecurityManager(IUnknown *pUnkOuter, REFIID riid, void **ppvObj, DWORD dwReserved);
STDAPI InternetCreateZoneManager(IUnknown *pUnkOuter, REFIID riid, void **ppvObj, DWORD dwReserved);

BOOL ZonesInit( );
VOID ZonesUnInit( );

//+---------------------------------------------------------------------------
//
//  Function:   DupA2W
//
//  Synopsis:   duplicates an ansi string to a wide string
//
//  Arguments:  [lpszAnsi] --
//
//  History:    7-20-96   JohannP (Johann Posch)   Created
//
//  Notes:
//
//----------------------------------------------------------------------------
inline LPWSTR DupA2W(const LPSTR lpszAnsi)
{
    return WzA2WDynamic(lpszAnsi, NULL, 0, FALSE);
}

//+---------------------------------------------------------------------------
//
//  Function:   DupW2A
//
//  Synopsis:   duplicates a wide string to an ansi string
//
//  Arguments:  [pwz] --
//
//  History:    7-20-96   JohannP (Johann Posch)   Created
//
//  Notes:
//
//----------------------------------------------------------------------------
inline LPSTR DupW2A(const WCHAR *pwz)
{
    return SzW2ADynamic(pwz, NULL, 0, FALSE);
}

/*---------------------------------------------------------------------------
        SzDupWzToSz
        Duplicate a wide string to an ansi string.
        If 'fTaskMalloc', allocation is done thru IMalloc,
        otherwise it is done thru new.
        The caller must destroy it using IMalloc or
        delete operator, as appropriate.
-----------------------------------------------------------------------------*/
inline char *SzDupWzToSz(const WCHAR *pwz, BOOL fTaskMalloc)
{
    return SzW2ADynamic(pwz, NULL, 0, fTaskMalloc);
}

/*----------------------------------------------------------------------------
        IsStatusOK 
        Checks for status codes that are considered "normal" from an urlmon 
        perspective i.e. no special action or error code paths should be taken
        in these cases.
-----------------------------------------------------------------------------*/

inline BOOL IsStatusOk(DWORD dwStatus)
{
    return ((dwStatus == HTTP_STATUS_OK) || (dwStatus == HTTP_STATUS_RETRY_WITH));
}

//+---------------------------------------------------------------------------
//
//  Class:      CRefCount ()
//
//  Purpose:    Safe class for refcounting
//
//  Interface:  CRefCount()
//              CRefCount(LONG lValue)
//              LONG operator++()       prefix
//              LONG operator--()       prefix
//              LONG operator++(int)    postfix
//              LONG operator--(int)    postfix
//              LONG operator++(int)    cast operator
//
//  History:    1-19-96   JohannP (Johann Posch)   Created
//
//  Notes:
//
//----------------------------------------------------------------------------
class CRefCount
{
public:
    CRefCount()
    {
        _cRefs = 1;
    }
    CRefCount(LONG lVal)
    {
        _cRefs = lVal;
    }
    LONG Set(ULONG newValue)
    {
        return InterlockedExchange(&_cRefs, newValue);
    }

    // prefix operators
    LONG operator++()
    {
        return InterlockedIncrement(&_cRefs);
    }
    LONG operator--()
    {
        return InterlockedDecrement(&_cRefs);
    }
    // postfix operators
    LONG operator++(int)
    {
        return InterlockedIncrement(&_cRefs) - 1;
    }
    LONG operator--(int)
    {
        return InterlockedDecrement(&_cRefs) + 1;
    }
    // LONG cast operator
    operator LONG()
    {
        return _cRefs;
    }

private:
    LONG _cRefs;
};

#define DLD_PROTOCOL_NONE   0
#define DLD_PROTOCOL_HTTP   1
#define DLD_PROTOCOL_FTP    2
#define DLD_PROTOCOL_GOPHER 3
#define DLD_PROTOCOL_FILE   4
#define DLD_PROTOCOL_LOCAL  5
#define DLD_PROTOCOL_HTTPS  6
#define DLD_PROTOCOL_STREAM 7

// # of internal Protocols
#define INTERNAL_PROTOCOL_MAX 8


//+---------------------------------------------------------------------------
//
//  Class:      CEnumFmtEtc ()
//
//  Purpose:    Class for formatetc enumerator
//
//  Interface:  Create --
//              QueryInterface --
//              AddRef --
//              Release --
//              Next --
//              Skip --
//              Reset --
//              Clone --
//              Initialize --
//
//  History:    1-19-96   JohannP (Johann Posch)   Created
//
//  Notes:
//
//----------------------------------------------------------------------------
class CEnumFmtEtc : public IEnumFORMATETC
{
public:

    // Create and return a IEnumFormatEtc object.
    // Return the object if successful, NULL otherwise.
    static CEnumFmtEtc * Create(UINT cfmtetc, FORMATETC* rgfmtetc);

    // *** IUnknown methods ***
    STDMETHODIMP QueryInterface(REFIID iid, void **ppvObj);
    STDMETHODIMP_(ULONG) AddRef(void);
    STDMETHODIMP_(ULONG) Release(void);

    // *** IEnumFormatEtc methods ***
    STDMETHODIMP Next(ULONG celt, FORMATETC * rgelt, ULONG * pceltFetched);
    STDMETHODIMP Skip(ULONG celt);
    STDMETHODIMP Reset(void);
    STDMETHODIMP Clone(IEnumFORMATETC ** ppenum);

private:
    CEnumFmtEtc() : _CRefs()
    {
        _iNext = 0;
        _cElements = 0;
        _pFmtEtc = NULL;
    }

    ~CEnumFmtEtc()
    {
        if (_pFmtEtc)
        {
            delete _pFmtEtc;
        }
    }

    BOOL Initialize(UINT cfmtetc, FORMATETC* rgfmtetc,  UINT iPos);

private:
    CRefCount   _CRefs;         // refcount
    UINT        _iNext;         // zero-based item that will next be enumerated
    UINT        _cElements;
    FORMATETC  *_pFmtEtc;       // has at least one item
};

class CMediaType;
class CMediaTypeHolder;
class CMediaTypeNode;

typedef enum _tagDATAFORMAT
{
     DATAFORMAT_UNKNOWN         = 0
    ,DATAFORMAT_AMBIGUOUS
    ,DATAFORMAT_KNOWN
    ,DATAFORMAT_TEXT
    ,DATAFORMAT_BINARY
    ,DATAFORMAT_TEXTORBINARY
} DATAFORMAT;

#define MI_GOTCLSID            0x00000010
#define MI_GOTMIMEFLAGS        0x00000020
#define MI_GOTCLSINFO          0x00000040
#define MI_CLASSLOOKUP         0x00000100

typedef struct _tagMediaInfo
{
    LPSTR       _pszType;
    CLIPFORMAT  _cfFormat;
    DWORD       _dwDataFormat;
    CLSID       _clsID;
    DWORD       _dwInitFlags;
    DWORD       _dwMimeFlags;
    DWORD       _dwClsCtx;
}   MediaInfo;

class CMediaType : public  MediaInfo
{
public:
    CMediaType()
    {
        _pszType = 0;
        _cfFormat = 0;
        _clsID = CLSID_NULL;
        _dwDataFormat = 0;
    }
    void Initialize(LPSTR szType, CLIPFORMAT cfFormat);
    void Initialize(CLIPFORMAT cfFormat, CLSID *pClsID);

    LPSTR GetTypeString(void)
    {
        return _pszType;
    }
    CLIPFORMAT GetClipFormat(void)
    {
        return _cfFormat;
    }
    void SetClipFormat(CLIPFORMAT cf)
    {
        _cfFormat = cf;
    }
    DWORD GetDataFormat()
    {
        return _dwDataFormat;
    }
    void SetClsID(CLSID *pClsID)
    {
        _clsID = *pClsID;
        _dwInitFlags |= (MI_GOTCLSID | MI_CLASSLOOKUP);
    }
    HRESULT GetClsID(CLSID *pClsID)
    {
        if (_dwInitFlags & MI_GOTCLSID)
        {
            UrlMkAssert((_clsID != CLSID_NULL));
            *pClsID = _clsID;
        }
        
        return (_dwInitFlags & MI_GOTCLSID) ? S_OK : E_FAIL;
    }
    void SetMimeInfo(CLSID &rClsID, DWORD dwMimeFlags)
    {
        _clsID = rClsID;
        _dwMimeFlags = dwMimeFlags;
        _dwInitFlags |= (MI_GOTCLSID | MI_GOTMIMEFLAGS | MI_CLASSLOOKUP);
    }

    void SetClsCtx(DWORD dwClsCtx)
    {
        _dwClsCtx = dwClsCtx;
        _dwInitFlags |= MI_GOTCLSINFO;
    }
    
    HRESULT GetClsCtx(DWORD *pdwClsCtx)
    {
        if (_dwInitFlags & MI_GOTCLSINFO)
        {
            UrlMkAssert((_clsID != CLSID_NULL));
            *pdwClsCtx = _dwClsCtx;
        }
        
        return (_dwInitFlags & MI_GOTCLSINFO) ? S_OK : E_FAIL;
    }
    
    BOOL IsLookupDone()
    {
        return (_dwInitFlags & MI_CLASSLOOKUP);
    }

    void SetLookupDone(BOOL fSet = TRUE)
    {
        if (fSet)
        {
            _dwInitFlags |= MI_CLASSLOOKUP;
        }
        else
        {
            _dwInitFlags &= ~MI_CLASSLOOKUP;
        }
    }



private:
//    LPSTR       _pszType;
//    CLIPFORMAT  _cfFormat;
//    CLSID       _clsID;
//    DWORD       _dwDataFormat;
};

class CMediaTypeHolder : public IMediaHolder
{
public:
    CMediaTypeHolder();
    ~CMediaTypeHolder();

    // unknown methods
    STDMETHOD(QueryInterface) ( REFIID riid, LPVOID FAR* ppvObj);
    STDMETHOD_(ULONG,AddRef) (void);
    STDMETHOD_(ULONG,Release) (void);

    // mediahoder methods

    STDMETHOD(RegisterClassMapping)(
        DWORD    ctypes,
        LPCSTR   rgszNames[],
        CLSID    rgClsIDs[],
        DWORD    dwReserved);

    STDMETHOD(FindClassMapping)(
        LPCSTR szMime,
        CLSID    *pClassID,
        DWORD    dwReserved);

    HRESULT RegisterW(UINT ctypes, const LPCWSTR* rgszTypes, CLIPFORMAT* rgcfTypes);
    HRESULT Register(UINT ctypes, const LPCSTR* rgszTypes, CLIPFORMAT* rgcfTypes);
    HRESULT RegisterMediaInfo(UINT ctypes, MediaInfo *pMediaInfo, BOOL fFree);
    HRESULT RegisterClass(UINT ctypes, const LPCSTR* rgszTypes, CLSID *rgclsID);
    HRESULT FindCMediaType(LPCSTR pszMimeStr, CMediaType **ppCMType);
    HRESULT FindCMediaType(CLIPFORMAT cfFormat, CMediaType **ppCMType);


private: // methods

private:    // data
    CRefCount        _CRefs;         // refcount class
    CMediaTypeNode  *_pCMTNode;
};

class CMediaTypeNode
{
public:
    CMediaTypeNode(CMediaType *pCMType, LPSTR pszTextBuffer, UINT cElements,
                    CMediaTypeNode *pNext, BOOL fFree = TRUE)
    {
        _pCMType = pCMType;
        _pszTextBuffer = pszTextBuffer;
        _cElements = cElements;
        _pNext = pNext;
        _fFree = fFree;
    }
    ~CMediaTypeNode()
    {

        if (_pszTextBuffer)
        {
            delete _pszTextBuffer;
        }
        if (_fFree)
        {
            delete _pCMType;
        }

    }

    CMediaType *GetMediaTypeArray(void)
    {
        return _pCMType;
    }
    LPSTR GetTextBuffer(void)
    {
        return _pszTextBuffer;
    }
    UINT GetElementCount(void)
    {
        return _cElements;
    }
    CMediaTypeNode *GetNextNode()
    {
        return _pNext;
    }
    void SetNextNode(CMediaTypeNode *pNode)
    {
        _pNext = pNode;
    }


private:    // data
    CMediaType     *_pCMType;
    LPSTR           _pszTextBuffer;
    UINT            _cElements;
    BOOL            _fFree;
    CMediaTypeNode *_pNext;

};

CMediaTypeHolder *GetMediaTypeHolder();

extern CMediaTypeHolder *g_pCMHolder;
extern CMutexSem g_mxsMedia;            // single access to media holder

HRESULT FindMediaString(CLIPFORMAT cfFormat, LPSTR *ppStr);
HRESULT FindMediaType(LPSTR pszType, CLIPFORMAT *cfType);
HRESULT RegisterDefaultMediaType();
inline HRESULT InternalRegisterDefaultMediaType();

LPSTR   FindFileExtension(LPSTR pszFileName);
HRESULT GetMimeFromExt(LPSTR pszExt, LPSTR pszMime, DWORD *pcbMime);

HRESULT GetMimeInfo(LPSTR pszMime, CLSID *pclsid, DWORD dwFlags, DWORD *pdwMimeFlags);

//
// MIME FLAGS 
//
#define  MIMEFLAGS_IGNOREMIME_CLASSID           0x00000001

//HRESULT FindMediaTypeClsID(LPCSTR pszType, LPCLSID pclsid, DWORD dwFlags);
HRESULT FindMediaTypeClassInfo(LPCSTR pszType, LPCSTR pszFileName, LPCLSID pclsid, DWORD *pdwClsCtx, DWORD dwFlags);
HRESULT GetClsIDInfo(CLSID *pclsid, DWORD ClsCtxIn, DWORD *pClsCtx);

// helper routines
LPSTR StringAFromCLSID(CLSID *pclsid);
HRESULT CLSIDFromStringA(LPSTR pszClsid, CLSID *pclsid);


#define GUIDSTR_MAX (1+ 8 + 1 + 4 + 1 + 4 + 1 + 4 + 1 + 12 + 1 + 1)
#define CLSIDSTR_MAX (GUIDSTR_MAX)


class CLifePtr
{
public:
    CLifePtr() : _CRefs()
    {
    }
    virtual ~CLifePtr()
    {
    }

    STDMETHODIMP_(ULONG) AddRef(void)
    {
        #ifdef _EAPP_HXX_
        EProtAssert((_CRefs));
        #else
        TransAssert((_CRefs));
        #endif

        LONG lRet = ++_CRefs;

        #ifdef _EAPP_HXX_
        EProtDebugOut((DEB_SESSION, "%p IN/OUT CLifePtr::AddRef (cRefs:%ld)\n", this,lRet));
        #else
        TransDebugOut((DEB_SESSION, "%p IN/OUT CLifePtr::AddRef (cRefs:%ld)\n", this,lRet));
        #endif
        return lRet;
    }

    STDMETHODIMP_(ULONG) Release(void)
    {
        #ifdef _EAPP_HXX_
        EProtAssert((_CRefs));
        #else
        TransAssert((_CRefs));
        #endif

        LONG lRet = --_CRefs;
        if (_CRefs == 0)
        {
            delete this;
        }

        #ifdef _EAPP_HXX_
        EProtDebugOut((DEB_SESSION, "%p IN/OUT CLifePtr::Release (cRefs:%ld)\n",this,lRet));
        #else
        TransDebugOut((DEB_SESSION, "%p IN/OUT CLifePtr::Release (cRefs:%ld)\n",this,lRet));
        #endif

        return lRet;
    }

private:
    CRefCount           _CRefs;          // the total refcount of this object
};

#endif //_URLMON_HXX_