/*
 *
 * @APPLE_LICENSE_HEADER_START@
 *
 * Copyright (c) 1999-2001 Apple Computer, Inc.  All Rights Reserved. The
 * contents of this file constitute Original Code as defined in and are
 * subject to the Apple Public Source License Version 1.2 (the 'License').
 * You may not use this file except in compliance with the License.  Please
 * obtain a copy of the License at http://www.apple.com/publicsource and
 * read it before using this file.
 *
 * This Original Code and all software distributed under the License are
 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY, FITNESS
 * FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.  Please
 * see the License for the specific language governing rights and
 * limitations under the License.
 *
 *
 * @APPLE_LICENSE_HEADER_END@
 *
 */
/*
	File:		QTAccessFile.h

	Contains:	This object contains an interface for finding and parsing qtaccess files.
				

*/
#ifndef _QT_ACCESS_FILE_H_
#define _QT_ACCESS_FILE_H_

#include <stdlib.h>
#include "QTSS.h"
#include "StrPtrLen.h"
#include "OSHeaders.h"

class QTAccessFile
{
	public:
		static UInt8 sWhitespaceAndGreaterThanMask[];
		static void Initialize();
		
		static char * GetUserNameCopy(QTSS_UserProfileObject inUserProfile);

		//GetGroupsArrayCopy 
		//
		// GetGroupsArrayCopy allocates outGroupCharPtrArray. Caller must "delete [] outGroupCharPtrArray" when done.
		static char*  GetAccessFile_Copy( const char* movieRootDir, const char* dirPath);

		//AccessAllowed
		//
		// This routine is used to get the Realm to send back to a user and to check if a user has access
		// userName: may be null.
		// accessFileBufPtr:If accessFileBufPtr is NULL or contains a NULL PTR or 0 LEN then false is returned
		// ioRealmNameStr:	ioRealmNameStr and ioRealmNameStr->Ptr may be null. 
		// 					To get a returned ioRealmNameStr value the ioRealmNameStr and ioRealmNameStr->Ptr must be non-NULL
		//					valid pointers. The ioRealmNameStr.Len should be set to the ioRealmNameStr->Ptr's allocated len.
		// numGroups:		The number of groups in the groupArray. Use GetGroupsArrayCopy to create the groupArray.
		static Bool16 AccessAllowed	(	char *userName, char**groupArray, UInt32 numGroups, 
										StrPtrLen *accessFileBufPtr,QTSS_ActionFlags inFlags,StrPtrLen* ioRealmNameStr
									);

		static void SetAccessFileName(const char *inQTAccessFileName); //makes a copy and stores it
		static char* GetAccessFileName() { return sQTAccessFileName; }; // a reference. Don't delete!
		
                // allocates memory for outUsersFilePath and outGroupsFilePath - remember to delete
                // returns the auth scheme
                static QTSS_AuthScheme FindUsersAndGroupsFilesAndAuthScheme(char* inAccessFilePath, QTSS_ActionFlags inAction, char** outUsersFilePath, char** outGroupsFilePath);
                
		static QTSS_Error AuthorizeRequest(QTSS_StandardRTSP_Params* inParams, Bool16 allowNoAccessFiles, QTSS_ActionFlags noAction, QTSS_ActionFlags authorizeAction);

	private:	
		static char* sQTAccessFileName; // managed by the QTAccess module
		static Bool16 sAllocatedName;
		static OSMutex* sAccessFileMutex;
};

#endif //_QT_ACCESS_FILE_H_