/* ***** BEGIN LICENSE BLOCK *****
 * Source last modified: $Id: CHXClientContext.h,v 1.9.2.4 2004/07/09 01:49:47 hubbe Exp $
 * 
 * Portions Copyright (c) 1995-2004 RealNetworks, Inc. All Rights Reserved.
 * 
 * The contents of this file, and the files included with this file,
 * are subject to the current version of the RealNetworks Public
 * Source License (the "RPSL") available at
 * http://www.helixcommunity.org/content/rpsl unless you have licensed
 * the file under the current version of the RealNetworks Community
 * Source License (the "RCSL") available at
 * http://www.helixcommunity.org/content/rcsl, in which case the RCSL
 * will apply. You may also obtain the license terms directly from
 * RealNetworks.  You may not use this file except in compliance with
 * the RPSL or, if you have a valid RCSL with RealNetworks applicable
 * to this file, the RCSL.  Please see the applicable RPSL or RCSL for
 * the rights, obligations and limitations governing use of the
 * contents of the file.
 * 
 * Alternatively, the contents of this file may be used under the
 * terms of the GNU General Public License Version 2 or later (the
 * "GPL") in which case the provisions of the GPL are applicable
 * instead of those above. If you wish to allow use of your version of
 * this file only under the terms of the GPL, and not to allow others
 * to use your version of this file under the terms of either the RPSL
 * or RCSL, indicate your decision by deleting the provisions above
 * and replace them with the notice and other provisions required by
 * the GPL. If you do not delete the provisions above, a recipient may
 * use your version of this file under the terms of any one of the
 * RPSL, the RCSL or the GPL.
 * 
 * This file is part of the Helix DNA Technology. RealNetworks is the
 * developer of the Original Code and owns the copyrights in the
 * portions it created.
 * 
 * This file, and the files included with this file, is distributed
 * and made available on an 'AS IS' basis, WITHOUT WARRANTY OF ANY
 * KIND, EITHER EXPRESS OR IMPLIED, AND REALNETWORKS HEREBY DISCLAIMS
 * ALL SUCH WARRANTIES, INCLUDING WITHOUT LIMITATION, ANY WARRANTIES
 * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, QUIET
 * ENJOYMENT OR NON-INFRINGEMENT.
 * 
 * Technology Compatibility Kit Test Suite(s) Location:
 *    http://www.helixcommunity.org/content/tck
 * 
 * Contributor(s):
 * 
 * ***** END LICENSE BLOCK ***** */

/* Helix client player context.
 * Aggregates all interfaces required by IHXPlayer::SetClientContext.
 */

#ifndef _CHXCLIENT_CONTEXT_H_
#define _CHXCLIENT_CONTEXT_H_

#include "CHXClientUnknown.h"

#include "enter_hx_headers.h"
#include "hxhyper.h"
//#include "hxclsnk.h"
#include "hxupgrd.h" // IHXUpgradeHandler
#include "hxwintyp.h"
#include "hxwin.h"   // IHXStatusMessage
#include "hxauth.h"

#include "hxsmartptr.h"
HX_SMART_POINTER_INLINE( SPIHXAuthenticationManagerResponse, IHXAuthenticationManagerResponse );
#include "exit_hx_headers.h"

#include "HXClientCallbacks.h"

_INTERFACE IHXPlayer;
class IHXClientPlayer;

	typedef int HXBOOL;

class CHXClientContext
	: public CHXClientUnknown
	, public IHXHyperNavigate
	, public IHXHyperNavigate2
	, public IHXHyperNavigateWithContext
//	, public IHXClientRequestSink
	, public IHXUpgradeHandler
	, public IHXStatusMessage
	, public IHXAuthenticationManager // XXXSEH: Should we wrap these with #ifdef HELIX_FEATURE_AUTHENTICATION
	, public IHXAuthenticationManager2
{
    DECLARE_UNKNOWN_NOCREATE( CHXClientContext )
	
private:

	void* m_UserInfo;
	IHXClientPlayer* m_pClientPlayer;
	IUnknown* m_pIUnkSiteSupplier;
	IUnknown* m_pIUnkErrorSink;
	const HXClientCallbacks* m_pClientCallbacks;
	SPIHXAuthenticationManagerResponse m_spPendingAuthManagerResponse;
	bool m_hasRequestedUpgrade;
	
	bool HandleURLCommand( const char* pCommand, const char* pTargetInstance );
	bool CallGoToURLCallback( const char* pURL, const char* pTargetInstance );

protected:

	inline void* GetUserInfo( void ) const
	{
		return m_UserInfo;
	}
	inline const HXClientCallbacks* GetClientCallbacks( void ) const
	{
		return m_pClientCallbacks;
	}
	
public:

    virtual ~CHXClientContext( void );
    CHXClientContext( IHXClientPlayer* pIClientPlayer, IUnknown* pIUnkSiteSupplier, IUnknown* pIUnkErrorSink, void* userInfo, const HXClientCallbacks* pClientCallbacks );

	// IRMAHyperNavigate
	STDMETHOD ( GoToURL ) ( THIS_ const char* pURL,
								  const char* pTarget );
	
	// IRMAHyperNavigate2
	STDMETHOD ( Execute ) ( THIS_ const char* pURL,
								  const char* pTargetInstance,
								  const char* pTargetApplication,
								  const char* pTargetRegion,
								  IHXValues*  pParams );
					   
	// IHXHyperNavigateWithContext
	STDMETHOD ( ExecuteWithContext ) ( THIS_ const char* pURL,
											 const char* pTargetInstance,
											 const char* pTargetApplication,
											 const char* pTargetRegion,
											 IHXValues*  pParams,
											 IUnknown*   pContext );
	
	// IHXClientRequestSink
	//STDMETHOD ( OnNewRequest ) ( THIS_ IHXRequest* pNewRequest );
	
	// IHXUpgradeHandler
	STDMETHOD ( RequestUpgrade ) ( THIS_ IHXUpgradeCollection* pComponents, HXBOOL bBlocking );
	STDMETHOD ( HasComponents ) ( THIS_ IHXUpgradeCollection* pComponents );
	
	// IHXStatusMessage
	STDMETHOD ( SetStatus ) ( THIS_ const char* pText );
	
	inline bool HasRequestedUpgrade( void ) const
	{
		return m_hasRequestedUpgrade;
	}
	inline void ResetHasRequestedUpgradeFlag( void )
	{
		m_hasRequestedUpgrade = false;
	}
	inline bool IsAuthenticationPending( void ) const
	{
		return m_spPendingAuthManagerResponse.IsValid();
	}
	inline void ClearPendingAuthentication( void )
	{
		m_spPendingAuthManagerResponse.Clear();
	}
	HX_RESULT Authenticate( bool shouldValidateUser, const char* pUsername, const char* pPassword );
	
	// IHXAuthenticationManager
	STDMETHOD ( HandleAuthenticationRequest ) ( THIS_ IHXAuthenticationManagerResponse* pResponse );
	
	// IHXAuthenticationManager2
	STDMETHOD ( HandleAuthenticationRequest2 ) ( THIS_ IHXAuthenticationManagerResponse* pResponse, IHXValues* pHeader );
};

#endif
