FileStream.h File Reference

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	_PART_FILE_HEADER
struct	_PART_FILE_MAP_ENTRY
struct	_FILE_BITMAP_FOOTER
union	TBaseProviderData
struct	TFileStream
struct	TBlockStream
struct	TEncryptedStream

Macros
#define	ID_FILE_BITMAP_FOOTER   0x33767470
#define	DEFAULT_BLOCK_SIZE   0x00004000
#define	DEFAULT_BUILD_NUMBER   10958
#define	ENCRYPTED_CHUNK_SIZE   0x40

Typedefs
typedef void(*	STREAM_INIT )(struct TFileStream *pStream)
typedef bool(*	STREAM_CREATE )(struct TFileStream *pStream)
typedef bool(*	STREAM_OPEN )(struct TFileStream *pStream, const TCHAR *szFileName, DWORD dwStreamFlags)
typedef bool(*	STREAM_READ )(struct TFileStream *pStream, ULONGLONG *pByteOffset, void *pvBuffer, DWORD dwBytesToRead)
typedef bool(*	STREAM_WRITE )(struct TFileStream *pStream, ULONGLONG *pByteOffset, const void *pvBuffer, DWORD dwBytesToWrite)
typedef bool(*	STREAM_RESIZE )(struct TFileStream *pStream, ULONGLONG FileSize)
typedef bool(*	STREAM_GETSIZE )(struct TFileStream *pStream, ULONGLONG *pFileSize)
typedef bool(*	STREAM_GETPOS )(struct TFileStream *pStream, ULONGLONG *pByteOffset)
typedef void(*	STREAM_CLOSE )(struct TFileStream *pStream)
typedef bool(*	BLOCK_READ )(struct TFileStream *pStream, ULONGLONG StartOffset, ULONGLONG EndOffset, LPBYTE BlockBuffer, DWORD BytesNeeded, bool bAvailable)
typedef bool(*	BLOCK_CHECK )(struct TFileStream *pStream, ULONGLONG BlockOffset)
typedef void(*	BLOCK_SAVEMAP )(struct TFileStream *pStream)
typedef struct _PART_FILE_HEADER	PART_FILE_HEADER
typedef struct _PART_FILE_HEADER *	PPART_FILE_HEADER
typedef struct _PART_FILE_MAP_ENTRY	PART_FILE_MAP_ENTRY
typedef struct _PART_FILE_MAP_ENTRY *	PPART_FILE_MAP_ENTRY
typedef struct _FILE_BITMAP_FOOTER	FILE_BITMAP_FOOTER
typedef struct _FILE_BITMAP_FOOTER *	PFILE_BITMAP_FOOTER

Functions
TFileStream *	FileStream_CreateFile (const TCHAR *szFileName, DWORD dwStreamFlags)
TFileStream *	FileStream_OpenFile (const TCHAR *szFileName, DWORD dwStreamFlags)
const TCHAR *	FileStream_GetFileName (TFileStream *pStream)
size_t	FileStream_Prefix (const TCHAR *szFileName, DWORD *pdwProvider)
bool	FileStream_SetCallback (TFileStream *pStream, STREAM_DOWNLOAD_CALLBACK pfnCallback, void *pvUserData)
bool	FileStream_Read (TFileStream *pStream, ULONGLONG *pByteOffset, void *pvBuffer, DWORD dwBytesToRead)
bool	FileStream_Write (TFileStream *pStream, ULONGLONG *pByteOffset, const void *pvBuffer, DWORD dwBytesToWrite)
bool	FileStream_SetSize (TFileStream *pStream, ULONGLONG NewFileSize)
bool	FileStream_GetSize (TFileStream *pStream, ULONGLONG *pFileSize)
bool	FileStream_GetPos (TFileStream *pStream, ULONGLONG *pByteOffset)
bool	FileStream_GetTime (TFileStream *pStream, ULONGLONG *pFT)
bool	FileStream_GetFlags (TFileStream *pStream, PDWORD pdwStreamFlags)
bool	FileStream_Replace (TFileStream *pStream, TFileStream *pNewStream)
void	FileStream_Close (TFileStream *pStream)

Macro Definition Documentation

#define DEFAULT_BLOCK_SIZE   0x00004000

#define DEFAULT_BUILD_NUMBER   10958

#define ENCRYPTED_CHUNK_SIZE   0x40

#define ID_FILE_BITMAP_FOOTER   0x33767470

Typedef Documentation

typedef bool(* BLOCK_CHECK)(struct TFileStream *pStream,ULONGLONG BlockOffset)

typedef bool(* BLOCK_READ)(struct TFileStream *pStream,ULONGLONG StartOffset,ULONGLONG EndOffset,LPBYTE BlockBuffer,DWORD BytesNeeded,bool bAvailable)

typedef void(* BLOCK_SAVEMAP)(struct TFileStream *pStream)

typedef struct _FILE_BITMAP_FOOTER FILE_BITMAP_FOOTER

typedef struct _PART_FILE_HEADER PART_FILE_HEADER

typedef struct _PART_FILE_MAP_ENTRY PART_FILE_MAP_ENTRY

typedef struct _FILE_BITMAP_FOOTER * PFILE_BITMAP_FOOTER

typedef struct _PART_FILE_HEADER * PPART_FILE_HEADER

typedef struct _PART_FILE_MAP_ENTRY * PPART_FILE_MAP_ENTRY

typedef void(* STREAM_CLOSE)(struct TFileStream *pStream)

typedef bool(* STREAM_CREATE)(struct TFileStream *pStream)

typedef bool(* STREAM_GETPOS)(struct TFileStream *pStream,ULONGLONG *pByteOffset)

typedef bool(* STREAM_GETSIZE)(struct TFileStream *pStream,ULONGLONG *pFileSize)

typedef void(* STREAM_INIT)(struct TFileStream *pStream)

typedef bool(* STREAM_OPEN)(struct TFileStream *pStream,const TCHAR *szFileName,DWORD dwStreamFlags)

typedef bool(* STREAM_READ)(struct TFileStream *pStream,ULONGLONG *pByteOffset,void *pvBuffer,DWORD dwBytesToRead)

typedef bool(* STREAM_RESIZE)(struct TFileStream *pStream,ULONGLONG FileSize)

typedef bool(* STREAM_WRITE)(struct TFileStream *pStream,ULONGLONG *pByteOffset,const void *pvBuffer,DWORD dwBytesToWrite)

Function Documentation

void FileStream_Close

(

TFileStream *

pStream

)

This function closes an archive file and frees any data buffers that have been allocated for stream management. The function must also support partially allocated structure, i.e. one or more buffers can be NULL, if there was an allocation failure during the process

pStream Pointer to an open stream

{
 // Check if the stream structure is allocated at all
 if(pStream != NULL)
 {
 // Free the master stream, if any
 if(pStream->pMaster != NULL)
 FileStream_Close(pStream->pMaster);
 pStream->pMaster = NULL;

 // Close the stream provider.
 if(pStream->StreamClose != NULL)
 pStream->StreamClose(pStream);

 // Also close base stream, if any
 else if(pStream->BaseClose != NULL)
 pStream->BaseClose(pStream);

 // Free the stream itself
 CASC_FREE(pStream);
 }
}

Here is the call graph for this function:

Here is the caller graph for this function:

TFileStream* FileStream_CreateFile	(	const TCHAR *	szFileName,
		DWORD	dwStreamFlags
	)

This function creates a new file for read-write access

• If the current platform supports file sharing, the file must be created for read sharing (i.e. another application can open the file for read, but not for write)
• If the file does not exist, the function must create new one
• If the file exists, the function must rewrite it and set to zero size
• The parameters of the function must be validate by the caller
• The function must initialize all stream function pointers in TFileStream
• If the function fails from any reason, it must close all handles and free all memory that has been allocated in the process of stream creation, including the TFileStream structure itself

szFileName Name of the file to create

{
 TFileStream * pStream;

 // We only support creation of flat, local file
 if((dwStreamFlags & (STREAM_PROVIDERS_MASK)) != (STREAM_PROVIDER_FLAT | BASE_PROVIDER_FILE))
 {
 SetLastError(ERROR_NOT_SUPPORTED);
 return NULL;
 }

 // Allocate file stream structure for flat stream
 pStream = AllocateFileStream(szFileName, sizeof(TBlockStream), dwStreamFlags);
 if(pStream != NULL)
 {
 // Attempt to create the disk file
 if(BaseFile_Create(pStream))
 {
 // Fill the stream provider functions
 pStream->StreamRead = pStream->BaseRead;
 pStream->StreamWrite = pStream->BaseWrite;
 pStream->StreamResize = pStream->BaseResize;
 pStream->StreamGetSize = pStream->BaseGetSize;
 pStream->StreamGetPos = pStream->BaseGetPos;
 pStream->StreamClose = pStream->BaseClose;
 return pStream;
 }

 // File create failed, delete the stream
 CASC_FREE(pStream);
 pStream = NULL;
 }

 // Return the stream
 return pStream;
}

Here is the call graph for this function:

Here is the caller graph for this function:

const TCHAR* FileStream_GetFileName

(

TFileStream *

pStream

)

Returns the file name of the stream

pStream Pointer to an open stream

{
 assert(pStream != NULL);
 return pStream->szFileName;
}

bool FileStream_GetFlags	(	TFileStream *	pStream,
		PDWORD	pdwStreamFlags
	)

Returns the stream flags

pStream Pointer to an open stream pdwStreamFlags Pointer where to store the stream flags

{
 *pdwStreamFlags = pStream->dwFlags;
 return true;
}

bool FileStream_GetPos	(	TFileStream *	pStream,
		ULONGLONG *	pByteOffset
	)

This function returns the current file position pStream pByteOffset

{
 assert(pStream->StreamGetPos != NULL);
 return pStream->StreamGetPos(pStream, pByteOffset);
}

bool FileStream_GetSize	(	TFileStream *	pStream,
		ULONGLONG *	pFileSize
	)

Returns the size of a file

pStream Pointer to an open stream FileSize Pointer where to store the file size

{
 assert(pStream->StreamGetSize != NULL);
 return pStream->StreamGetSize(pStream, pFileSize);
}

Here is the caller graph for this function:

bool FileStream_GetTime	(	TFileStream *	pStream,
		ULONGLONG *	pFileTime
	)

Returns the last write time of a file

pStream Pointer to an open stream pFileType Pointer where to store the file last write time

{
 // Just use the saved filetime value
 *pFileTime = pStream->Base.File.FileTime;
 return true;
}

TFileStream* FileStream_OpenFile	(	const TCHAR *	szFileName,
		DWORD	dwStreamFlags
	)

This function opens an existing file for read or read-write access

• If the current platform supports file sharing, the file must be open for read sharing (i.e. another application can open the file for read, but not for write)
• If the file does not exist, the function must return NULL
• If the file exists but cannot be open, then function must return NULL
• The parameters of the function must be validate by the caller
• The function must initialize all stream function pointers in TFileStream
• If the function fails from any reason, it must close all handles and free all memory that has been allocated in the process of stream creation, including the TFileStream structure itself

szFileName Name of the file to open dwStreamFlags specifies the provider and base storage type

{
 DWORD dwProvider = dwStreamFlags & STREAM_PROVIDERS_MASK;
 size_t nPrefixLength = FileStream_Prefix(szFileName, &dwProvider);

 // Re-assemble the stream flags
 dwStreamFlags = (dwStreamFlags & STREAM_OPTIONS_MASK) | dwProvider;
 szFileName += nPrefixLength;

 // Perform provider-specific open
 switch(dwStreamFlags & STREAM_PROVIDER_MASK)
 {
 case STREAM_PROVIDER_FLAT:
 return FlatStream_Open(szFileName, dwStreamFlags);

 case STREAM_PROVIDER_PARTIAL:
 return PartStream_Open(szFileName, dwStreamFlags);

 case STREAM_PROVIDER_ENCRYPTED:
 return EncrStream_Open(szFileName, dwStreamFlags);

 case STREAM_PROVIDER_BLOCK4:
 return Block4Stream_Open(szFileName, dwStreamFlags);

 default:
 SetLastError(ERROR_INVALID_PARAMETER);
 return NULL;
 }
}

Here is the call graph for this function:

Here is the caller graph for this function:

size_t FileStream_Prefix	(	const TCHAR *	szFileName,
		DWORD *	pdwProvider
	)

Returns the length of the provider prefix. Returns zero if no prefix

szFileName Pointer to a stream name (file, mapped file, URL) pdwStreamProvider Pointer to a DWORD variable that receives stream provider (STREAM_PROVIDER_XXX)

{
 size_t nPrefixLength1 = 0;
 size_t nPrefixLength2 = 0;
 DWORD dwProvider = 0;

 if(szFileName != NULL)
 {
 //
 // Determine the stream provider
 //

 if(!_tcsnicmp(szFileName, _T("flat-"), 5))
 {
 dwProvider |= STREAM_PROVIDER_FLAT;
 nPrefixLength1 = 5;
 }

 else if(!_tcsnicmp(szFileName, _T("part-"), 5))
 {
 dwProvider |= STREAM_PROVIDER_PARTIAL;
 nPrefixLength1 = 5;
 }

 else if(!_tcsnicmp(szFileName, _T("mpqe-"), 5))
 {
 dwProvider |= STREAM_PROVIDER_ENCRYPTED;
 nPrefixLength1 = 5;
 }

 else if(!_tcsnicmp(szFileName, _T("blk4-"), 5))
 {
 dwProvider |= STREAM_PROVIDER_BLOCK4;
 nPrefixLength1 = 5;
 }

 //
 // Determine the base provider
 //

 if(!_tcsnicmp(szFileName+nPrefixLength1, _T("file:"), 5))
 {
 dwProvider |= BASE_PROVIDER_FILE;
 nPrefixLength2 = 5;
 }

 else if(!_tcsnicmp(szFileName+nPrefixLength1, _T("map:"), 4))
 {
 dwProvider |= BASE_PROVIDER_MAP;
 nPrefixLength2 = 4;
 }

 else if(!_tcsnicmp(szFileName+nPrefixLength1, _T("http:"), 5))
 {
 dwProvider |= BASE_PROVIDER_HTTP;
 nPrefixLength2 = 5;
 }

 // Only accept stream provider if we recognized the base provider
 if(nPrefixLength2 != 0)
 {
 // It is also allowed to put "//" after the base provider, e.g. "file://", "http://"
 if(szFileName[nPrefixLength1+nPrefixLength2] == '/' && szFileName[nPrefixLength1+nPrefixLength2+1] == '/')
 nPrefixLength2 += 2;

 if(pdwProvider != NULL)
 *pdwProvider = dwProvider;
 return nPrefixLength1 + nPrefixLength2;
 }
 }

 return 0;
}

Here is the caller graph for this function:

bool FileStream_Read	(	TFileStream *	pStream,
		ULONGLONG *	pByteOffset,
		void *	pvBuffer,
		DWORD	dwBytesToRead
	)

Reads data from the stream

• Returns true if the read operation succeeded and all bytes have been read
• Returns false if either read failed or not all bytes have been read
• If the pByteOffset is NULL, the function must read the data from the current file position
• The function can be called with dwBytesToRead = 0. In that case, pvBuffer is ignored and the function just adjusts file pointer.

pStream Pointer to an open stream pByteOffset Pointer to file byte offset. If NULL, it reads from the current position pvBuffer Pointer to data to be read dwBytesToRead Number of bytes to read from the file

Returns

• If the function reads the required amount of bytes, it returns true.
• If the function reads less than required bytes, it returns false and GetLastError() returns ERROR_HANDLE_EOF
• If the function fails, it reads false and GetLastError() returns an error code different from ERROR_HANDLE_EOF

{
 //FILE * fp = fopen("E:\\Loading.txt", "at");
 //if(fp != NULL)
 //{
 // ULONGLONG ByteOffset = (pByteOffset != NULL) ? pByteOffset[0] : 0;
 // fprintf(fp, "%-32ws\t%08X\t%08X\n", GetPlainFileName(pStream->szFileName), (ULONG)ByteOffset, dwBytesToRead);
 // fclose(fp);
 //}

 assert(pStream->StreamRead != NULL);
 return pStream->StreamRead(pStream, pByteOffset, pvBuffer, dwBytesToRead);
}

Here is the caller graph for this function:

bool FileStream_Replace	(	TFileStream *	pStream,
		TFileStream *	pNewStream
	)

Switches a stream with another. Used for final phase of archive compacting. Performs these steps:

1) Closes the handle to the existing file 2) Renames the temporary file to the original file, overwrites existing one 3) Opens the file stores the handle and stream position to the new stream structure

pStream Pointer to an open stream pNewStream Temporary ("working") stream (created during archive compacting)

{
 // Only supported on flat files
 if((pStream->dwFlags & STREAM_PROVIDERS_MASK) != (STREAM_PROVIDER_FLAT | BASE_PROVIDER_FILE))
 {
 SetLastError(ERROR_NOT_SUPPORTED);
 return false;
 }

 // Not supported on read-only streams
 if(pStream->dwFlags & STREAM_FLAG_READ_ONLY)
 {
 SetLastError(ERROR_ACCESS_DENIED);
 return false;
 }

 // Close both stream's base providers
 pNewStream->BaseClose(pNewStream);
 pStream->BaseClose(pStream);

 // Now we have to delete the (now closed) old file and rename the new file
 if(!BaseFile_Replace(pStream, pNewStream))
 return false;

 // Now open the base file again
 if(!BaseFile_Open(pStream, pStream->szFileName, pStream->dwFlags))
 return false;

 // Cleanup the new stream
 FileStream_Close(pNewStream);
 return true;
}

Here is the call graph for this function:

bool FileStream_SetCallback	(	TFileStream *	pStream,
		STREAM_DOWNLOAD_CALLBACK	pfnCallback,
		void *	pvUserData
	)

Sets a download callback. Whenever the stream needs to download one or more blocks from the server, the callback is called

pStream Pointer to an open stream pfnCallback Pointer to callback function pvUserData Arbitrary user pointer passed to the download callback

{
 TBlockStream * pBlockStream = (TBlockStream *)pStream;

 if(pStream->BlockRead == NULL)
 {
 SetLastError(ERROR_NOT_SUPPORTED);
 return false;
 }

 pBlockStream->pfnCallback = pfnCallback;
 pBlockStream->UserData = pvUserData;
 return true;
}

Here is the call graph for this function:

bool FileStream_SetSize	(	TFileStream *	pStream,
		ULONGLONG	NewFileSize
	)

Sets the size of a file

pStream Pointer to an open stream NewFileSize File size to set

{
 if(pStream->dwFlags & STREAM_FLAG_READ_ONLY)
 {
 SetLastError(ERROR_ACCESS_DENIED);
 return false;
 }

 assert(pStream->StreamResize != NULL);
 return pStream->StreamResize(pStream, NewFileSize);
}

Here is the call graph for this function:

bool FileStream_Write	(	TFileStream *	pStream,
		ULONGLONG *	pByteOffset,
		const void *	pvBuffer,
		DWORD	dwBytesToWrite
	)

This function writes data to the stream

• Returns true if the write operation succeeded and all bytes have been written
• Returns false if either write failed or not all bytes have been written
• If the pByteOffset is NULL, the function must write the data to the current file position

pStream Pointer to an open stream pByteOffset Pointer to file byte offset. If NULL, it reads from the current position pvBuffer Pointer to data to be written dwBytesToWrite Number of bytes to write to the file

{
 if(pStream->dwFlags & STREAM_FLAG_READ_ONLY)
 {
 SetLastError(ERROR_ACCESS_DENIED);
 return false;
 }

 assert(pStream->StreamWrite != NULL);
 return pStream->StreamWrite(pStream, pByteOffset, pvBuffer, dwBytesToWrite);
}

Here is the call graph for this function:

Here is the caller graph for this function: