filesup.h File Reference

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

Go to the source code of this file.

Macros
#define	MOVEFILE_REPLACE_EXISTING   1
#define	MOVEFILE_COPY_ALLOWED   2
#define	MOVEFILE_WRITE_THROUGH   8
#define	DoesDirExist(RootDirectory, DirName)    DoesPathExist((RootDirectory), (DirName), TRUE)
#define	DoesFileExist(RootDirectory, FileName)    DoesPathExist((RootDirectory), (FileName), FALSE)
#define	UnMapAndCloseFile(FileHandle, SectionHandle, BaseAddress)

Functions
NTSTATUS	SetupCreateDirectory (_In_ PCWSTR PathName)
	Create a new directory, specified by the given path. Any intermediate non-existing directory is created as well.
NTSTATUS	SetupDeleteFile (IN PCWSTR FileName, IN BOOLEAN ForceDelete)
NTSTATUS	SetupCopyFile (IN PCWSTR SourceFileName, IN PCWSTR DestinationFileName, IN BOOLEAN FailIfExists)
NTSTATUS	SetupMoveFile (IN PCWSTR ExistingFileName, IN PCWSTR NewFileName, IN ULONG Flags)
NTSTATUS	ConcatPathsV (IN OUT PWSTR PathBuffer, IN SIZE_T cchPathSize, IN ULONG NumberOfPathComponents, IN va_list PathComponentsList)
NTSTATUS	CombinePathsV (OUT PWSTR PathBuffer, IN SIZE_T cchPathSize, IN ULONG NumberOfPathComponents, IN va_list PathComponentsList)
NTSTATUS	ConcatPaths (IN OUT PWSTR PathBuffer, IN SIZE_T cchPathSize, IN ULONG NumberOfPathComponents, IN ...)
NTSTATUS	CombinePaths (OUT PWSTR PathBuffer, IN SIZE_T cchPathSize, IN ULONG NumberOfPathComponents, IN ...)
BOOLEAN	DoesPathExist_UStr (_In_opt_ HANDLE RootDirectory, _In_ PCUNICODE_STRING PathName, _In_ BOOLEAN IsDirectory)
BOOLEAN	DoesPathExist (_In_opt_ HANDLE RootDirectory, _In_ PCWSTR PathName, _In_ BOOLEAN IsDirectory)
BOOLEAN	DoesFileExist_2 (IN PCWSTR PathName OPTIONAL, IN PCWSTR FileName)
BOOLEAN	NtPathToDiskPartComponents (IN PCWSTR NtPath, OUT PULONG pDiskNumber, OUT PULONG pPartNumber, OUT PCWSTR *PathComponent OPTIONAL)
NTSTATUS	OpenAndMapFile (_In_opt_ HANDLE RootDirectory, _In_ PCWSTR PathNameToFile, _Out_opt_ PHANDLE FileHandle, _Out_opt_ PULONG FileSize, _Out_ PHANDLE SectionHandle, _Out_ PVOID *BaseAddress, _In_ BOOLEAN ReadWriteAccess)
	Opens and maps a file in memory.
NTSTATUS	MapFile (_In_ HANDLE FileHandle, _Out_ PHANDLE SectionHandle, _Out_ PVOID *BaseAddress, _In_ BOOLEAN ReadWriteAccess)
	Maps an opened file in memory.
BOOLEAN	UnMapFile (_In_ HANDLE SectionHandle, _In_ PVOID BaseAddress)
	Unmaps a mapped file by section.

Macro Definition Documentation

DoesDirExist

#define DoesDirExist	(		RootDirectory,
			DirName
	)		DoesPathExist((RootDirectory), (DirName), TRUE)

Definition at line 80 of file filesup.h.

DoesFileExist

#define DoesFileExist	(		RootDirectory,
			FileName
	)		DoesPathExist((RootDirectory), (FileName), FALSE)

Definition at line 83 of file filesup.h.

MOVEFILE_COPY_ALLOWED

#define MOVEFILE_COPY_ALLOWED   2

Definition at line 29 of file filesup.h.

MOVEFILE_REPLACE_EXISTING

#define MOVEFILE_REPLACE_EXISTING   1

Definition at line 28 of file filesup.h.

MOVEFILE_WRITE_THROUGH

#define MOVEFILE_WRITE_THROUGH   8

Definition at line 30 of file filesup.h.

UnMapAndCloseFile

#define UnMapAndCloseFile	(		FileHandle,
			SectionHandle,
			BaseAddress
	)

Value:

do {    \
    UnMapFile((SectionHandle), (BaseAddress));  \
    NtClose(FileHandle);                        \
} while (0)

Definition at line 121 of file filesup.h.

Function Documentation

CombinePaths()

NTSTATUS CombinePaths	(	OUT PWSTR	PathBuffer,
		IN SIZE_T	cchPathSize,
		IN ULONG	NumberOfPathComponents,
		IN ...
	)

Definition at line 664 of file filesup.c.

{
    NTSTATUS Status;
    va_list PathComponentsList;
 
    if (cchPathSize < 1)
        return STATUS_SUCCESS;
 
    *PathBuffer = UNICODE_NULL;
 
    va_start(PathComponentsList, NumberOfPathComponents);
    Status = CombinePathsV(PathBuffer, cchPathSize,
                           NumberOfPathComponents,
                           PathComponentsList);
    va_end(PathComponentsList);
 
    return Status;
}

Referenced by AddSectionToCopyQueue(), AddSectionToCopyQueueCab(), BuildFullDirectoryPath(), CheckUnattendedSetup(), ConnectRegistry(), CreateRegistryFile(), DoesFileExist_2(), ImportRegistryFile(), InitDestinationPaths(), InstallBootloaderFiles(), InstallBootManagerAndBootEntriesWorker(), InstallBtrfsBootcodeToPartition(), InstallFatBootcodeToPartition(), InstallMbrBootCodeToDisk(), InstallNtfsBootcodeToPartition(), InstallSetupInfFile(), LoadSetupInf(), PrepareFileCopy(), RegCleanupRegistry(), and SetupCommitFileQueueW().

CombinePathsV()

NTSTATUS CombinePathsV	(	OUT PWSTR	PathBuffer,
		IN SIZE_T	cchPathSize,
		IN ULONG	NumberOfPathComponents,
		IN va_list	PathComponentsList
	)

Definition at line 626 of file filesup.c.

{
    if (cchPathSize < 1)
        return STATUS_SUCCESS;
 
    *PathBuffer = UNICODE_NULL;
    return ConcatPathsV(PathBuffer, cchPathSize,
                        NumberOfPathComponents,
                        PathComponentsList);
}

Referenced by CombinePaths().

ConcatPaths()

NTSTATUS ConcatPaths	(	IN OUT PWSTR	PathBuffer,
		IN SIZE_T	cchPathSize,
		IN ULONG	NumberOfPathComponents,
		IN ...
	)

Definition at line 642 of file filesup.c.

{
    NTSTATUS Status;
    va_list PathComponentsList;
 
    if (cchPathSize < 1)
        return STATUS_SUCCESS;
 
    va_start(PathComponentsList, NumberOfPathComponents);
    Status = ConcatPathsV(PathBuffer, cchPathSize,
                          NumberOfPathComponents,
                          PathComponentsList);
    va_end(PathComponentsList);
 
    return Status;
}

Referenced by ArcPathToNtPath(), InitDestinationPaths(), and SetupCommitFileQueueW().

ConcatPathsV()

NTSTATUS ConcatPathsV	(	IN OUT PWSTR	PathBuffer,
		IN SIZE_T	cchPathSize,
		IN ULONG	NumberOfPathComponents,
		IN va_list	PathComponentsList
	)

Definition at line 579 of file filesup.c.

{
    NTSTATUS Status = STATUS_SUCCESS;
    SIZE_T cchPathLen;
    PCWSTR PathComponent;
 
    if (cchPathSize < 1)
        return STATUS_SUCCESS;
 
    while (NumberOfPathComponents--)
    {
        PathComponent = va_arg(PathComponentsList, PCWSTR);
        if (!PathComponent)
            continue;
 
        cchPathLen = min(cchPathSize, wcslen(PathBuffer));
        if (cchPathLen >= cchPathSize)
            return STATUS_BUFFER_OVERFLOW;
 
        if (PathComponent[0] != OBJ_NAME_PATH_SEPARATOR &&
            cchPathLen > 0 && PathBuffer[cchPathLen-1] != OBJ_NAME_PATH_SEPARATOR)
        {
            /* PathComponent does not start with '\' and PathBuffer does not end with '\' */
            Status = RtlStringCchCatW(PathBuffer, cchPathSize, L"\\");
            if (!NT_SUCCESS(Status))
                return Status;
        }
        else if (PathComponent[0] == OBJ_NAME_PATH_SEPARATOR &&
                 cchPathLen > 0 && PathBuffer[cchPathLen-1] == OBJ_NAME_PATH_SEPARATOR)
        {
            /* PathComponent starts with '\' and PathBuffer ends with '\' */
            while (*PathComponent == OBJ_NAME_PATH_SEPARATOR)
                ++PathComponent; // Skip any backslash
        }
        Status = RtlStringCchCatW(PathBuffer, cchPathSize, PathComponent);
        if (!NT_SUCCESS(Status))
            return Status;
    }
 
    return Status;
}

Referenced by CombinePathsV(), and ConcatPaths().

DoesFileExist_2()

BOOLEAN DoesFileExist_2	(	IN PCWSTR PathName	OPTIONAL,
		IN PCWSTR	FileName
	)

Definition at line 740 of file filesup.c.

{
    WCHAR FullName[MAX_PATH];
    CombinePaths(FullName, ARRAYSIZE(FullName), 2, PathName, FileName);
    return DoesFileExist(NULL, FullName);
}

Referenced by InstallBtrfsBootcodeToPartition(), InstallFatBootcodeToPartition(), and InstallNtfsBootcodeToPartition().

DoesPathExist()

BOOLEAN DoesPathExist	(	_In_opt_ HANDLE	RootDirectory,
		_In_ PCWSTR	PathName,
		_In_ BOOLEAN	IsDirectory
	)

Definition at line 728 of file filesup.c.

{
    UNICODE_STRING PathNameU;
    RtlInitUnicodeString(&PathNameU, PathName);
    return DoesPathExist_UStr(RootDirectory, &PathNameU, IsDirectory);
}

DoesPathExist_UStr()

BOOLEAN DoesPathExist_UStr	(	_In_opt_ HANDLE	RootDirectory,
		_In_ PCUNICODE_STRING	PathName,
		_In_ BOOLEAN	IsDirectory
	)

Definition at line 688 of file filesup.c.

{
    NTSTATUS Status;
    HANDLE FileHandle;
    OBJECT_ATTRIBUTES ObjectAttributes;
    IO_STATUS_BLOCK IoStatusBlock;
 
    InitializeObjectAttributes(&ObjectAttributes,
                               (PUNICODE_STRING)PathName,
                               OBJ_CASE_INSENSITIVE,
                               RootDirectory,
                               NULL);
 
    Status = NtOpenFile(&FileHandle,
                        IsDirectory ? (FILE_LIST_DIRECTORY | SYNCHRONIZE)
                                    :  FILE_GENERIC_READ, // Contains SYNCHRONIZE
                        &ObjectAttributes,
                        &IoStatusBlock,
                        FILE_SHARE_READ | FILE_SHARE_WRITE,
                        FILE_SYNCHRONOUS_IO_NONALERT |
                            (IsDirectory ? FILE_DIRECTORY_FILE
                                         : FILE_NON_DIRECTORY_FILE));
    if (NT_SUCCESS(Status))
    {
        NtClose(FileHandle);
    }
    else
    {
        DPRINT("Failed to open %s '%wZ', Status 0x%08lx\n",
               IsDirectory ? "directory" : "file",
               PathName, Status);
    }
 
    return NT_SUCCESS(Status);
}

Referenced by DoesPathExist(), and SetupCreateDirectory().

MapFile()

NTSTATUS MapFile	(	_In_ HANDLE	FileHandle,
		_Out_ PHANDLE	SectionHandle,
		_Out_ PVOID *	BaseAddress,
		_In_ BOOLEAN	ReadWriteAccess
	)

Maps an opened file in memory.

Parameters

[in]	FileHandle	A handle to an opened file to map.
[out]	SectionHandle	A pointer to a variable receiving a handle to a section mapping the file.
[out]	BaseAddress	A pointer to a variable receiving the address where the file is mapped.
[in]	ReadWriteAccess	A boolean variable specifying whether to map the file for read and write access (TRUE), or read-only access (FALSE).

Returns

STATUS_SUCCESS in case of success, or a status code in case of error.

Definition at line 981 of file filesup.c.

{
    NTSTATUS Status;
    ULONG SectionPageProtection;
    SIZE_T ViewSize;
    PVOID ViewBase;
 
    SectionPageProtection = (ReadWriteAccess ? PAGE_READWRITE : PAGE_READONLY);
 
    /* Create the section */
    *SectionHandle = NULL;
    Status = NtCreateSection(SectionHandle,
                             STANDARD_RIGHTS_REQUIRED | SECTION_QUERY |
                             SECTION_MAP_READ |
                                (ReadWriteAccess ? SECTION_MAP_WRITE : 0),
                             NULL,
                             NULL,
                             SectionPageProtection,
                             SEC_COMMIT /* | SEC_IMAGE (_NO_EXECUTE) */,
                             FileHandle);
    if (!NT_SUCCESS(Status))
    {
        DPRINT1("Failed to create a memory section for file 0x%p (Status 0x%08lx)\n",
                FileHandle, Status);
        return Status;
    }
 
    /* Map the section */
    ViewSize = 0;
    ViewBase = NULL;
    Status = NtMapViewOfSection(*SectionHandle,
                                NtCurrentProcess(),
                                &ViewBase,
                                0, 0,
                                NULL,
                                &ViewSize,
                                ViewShare,
                                0,
                                SectionPageProtection);
    if (!NT_SUCCESS(Status))
    {
        DPRINT1("Failed to map a view for file 0x%p (Status 0x%08lx)\n",
                FileHandle, Status);
        NtClose(*SectionHandle);
        *SectionHandle = NULL;
        return Status;
    }
 
    *BaseAddress = ViewBase;
    return STATUS_SUCCESS;
}

Referenced by OpenAndMapFile(), and OpenIniBootLoaderStore().

NtPathToDiskPartComponents()

BOOLEAN NtPathToDiskPartComponents	(	IN PCWSTR	NtPath,
		OUT PULONG	pDiskNumber,
		OUT PULONG	pPartNumber,
		OUT PCWSTR *PathComponent	OPTIONAL
	)

Definition at line 763 of file filesup.c.

{
    ULONG DiskNumber, PartNumber;
    PCWSTR Path;
 
    *pDiskNumber = 0;
    *pPartNumber = 0;
    if (PathComponent) *PathComponent = NULL;
 
    Path = NtPath;
 
    if (_wcsnicmp(Path, L"\\Device\\Harddisk", 16) != 0)
    {
        /* The NT path doesn't start with the prefix string, thus it cannot be a hard disk device path */
        DPRINT1("'%S' : Not a possible hard disk device.\n", NtPath);
        return FALSE;
    }
 
    Path += 16;
 
    /* A number must be present now */
    if (!iswdigit(*Path))
    {
        DPRINT1("'%S' : expected a number! Not a regular hard disk device.\n", Path);
        return FALSE;
    }
    DiskNumber = wcstoul(Path, (PWSTR*)&Path, 10);
 
    /* Either NULL termination, or a path separator must be present now */
    if (*Path && *Path != OBJ_NAME_PATH_SEPARATOR)
    {
        DPRINT1("'%S' : expected a path separator!\n", Path);
        return FALSE;
    }
 
    if (!*Path)
    {
        DPRINT1("The path only specified a hard disk (and nothing else, like a partition...), so we stop there.\n");
        goto Quit;
    }
 
    /* Here, *Path == L'\\' */
 
    if (_wcsnicmp(Path, L"\\Partition", 10) != 0)
    {
        /* Actually, \Partition is optional so, if we don't have it, we still return success. Or should we? */
        DPRINT1("'%S' : unexpected format!\n", NtPath);
        goto Quit;
    }
 
    Path += 10;
 
    /* A number must be present now */
    if (!iswdigit(*Path))
    {
        /* If we don't have a number it means this part of path is actually not a partition specifier, so we shouldn't fail either. Or should we? */
        DPRINT1("'%S' : expected a number!\n", Path);
        goto Quit;
    }
    PartNumber = wcstoul(Path, (PWSTR*)&Path, 10);
 
    /* Either NULL termination, or a path separator must be present now */
    if (*Path && *Path != OBJ_NAME_PATH_SEPARATOR)
    {
        /* We shouldn't fail here because it just means this part of path is actually not a partition specifier. Or should we? */
        DPRINT1("'%S' : expected a path separator!\n", Path);
        goto Quit;
    }
 
    /* OK, here we really have a partition specifier: return its number */
    *pPartNumber = PartNumber;
 
Quit:
    /* Return the disk number */
    *pDiskNumber = DiskNumber;
 
    /* Return the path component also, if the user wants it */
    if (PathComponent) *PathComponent = Path;
 
    return TRUE;
}

Referenced by CreateFreeLoaderIniForReactOSAndBootSector(), and EnumerateInstallations().

OpenAndMapFile()

NTSTATUS OpenAndMapFile	(	_In_opt_ HANDLE	RootDirectory,
		_In_ PCWSTR	PathNameToFile,
		_Out_opt_ PHANDLE	FileHandle,
		_Out_opt_ PULONG	FileSize,
		_Out_ PHANDLE	SectionHandle,
		_Out_ PVOID *	BaseAddress,
		_In_ BOOLEAN	ReadWriteAccess
	)

Opens and maps a file in memory.

Parameters

[in]	RootDirectory
[in]	PathNameToFile	Path to the file, either in absolute form, or relative to the opened root directory given by the RootDirectory handle.
[out]	FileHandle	An optional pointer to a variable receiving a handle to the opened file. If NULL, the underlying file handle is closed.
[out]	FileSize	An optional pointer to a variable receiving the size of the opened file.
[out]	SectionHandle	A pointer to a variable receiving a handle to a section mapping the file.
[out]	BaseAddress	A pointer to a variable receiving the address where the file is mapped.
[in]	ReadWriteAccess	A boolean variable specifying whether to map the file for read and write access (TRUE), or read-only access (FALSE).

Returns

STATUS_SUCCESS in case of success, or a status code in case of error.

Definition at line 879 of file filesup.c.

{
    NTSTATUS Status;
    UNICODE_STRING FileName;
    OBJECT_ATTRIBUTES ObjectAttributes;
    IO_STATUS_BLOCK IoStatusBlock;
    HANDLE LocalFileHandle;
 
    /* Open the file */
    RtlInitUnicodeString(&FileName, PathNameToFile);
    InitializeObjectAttributes(&ObjectAttributes,
                               &FileName,
                               OBJ_CASE_INSENSITIVE,
                               RootDirectory,
                               NULL);
 
    if (FileHandle) *FileHandle = NULL;
    Status = NtOpenFile(&LocalFileHandle,
                        FILE_GENERIC_READ | // Contains SYNCHRONIZE
                            (ReadWriteAccess ? FILE_GENERIC_WRITE : 0),
                        &ObjectAttributes,
                        &IoStatusBlock,
                        FILE_SHARE_READ,
                        FILE_SYNCHRONOUS_IO_NONALERT | FILE_NON_DIRECTORY_FILE);
    if (!NT_SUCCESS(Status))
    {
        DPRINT1("Failed to open file '%wZ' (Status 0x%08lx)\n", &FileName, Status);
        return Status;
    }
 
    if (FileSize)
    {
        /* Query the file size */
        FILE_STANDARD_INFORMATION FileInfo;
        Status = NtQueryInformationFile(LocalFileHandle,
                                        &IoStatusBlock,
                                        &FileInfo,
                                        sizeof(FileInfo),
                                        FileStandardInformation);
        if (!NT_SUCCESS(Status))
        {
            DPRINT("NtQueryInformationFile() failed (Status 0x%08lx)\n", Status);
            goto Quit;
        }
 
        if (FileInfo.EndOfFile.HighPart != 0)
            DPRINT1("WARNING!! The file '%wZ' is too large!\n", &FileName);
 
        *FileSize = FileInfo.EndOfFile.LowPart;
        DPRINT("File size: %lu\n", *FileSize);
    }
 
    /* Map the whole file into memory */
    Status = MapFile(LocalFileHandle,
                     SectionHandle,
                     BaseAddress,
                     ReadWriteAccess);
    if (!NT_SUCCESS(Status))
    {
        DPRINT1("Failed to map file '%wZ' (Status 0x%08lx)\n", &FileName, Status);
        goto Quit;
    }
 
Quit:
    /* If we succeeded, return the opened file handle if needed.
     * If we failed or the caller does not need the handle, close it now. */
    if (NT_SUCCESS(Status) && FileHandle)
        *FileHandle = LocalFileHandle;
    else
        NtClose(LocalFileHandle);
 
    return Status;
}

Referenced by CheckForValidPEAndVendor(), FindBootStore(), and InstallSetupInfFile().

SetupCopyFile()

NTSTATUS SetupCopyFile	(	IN PCWSTR	SourceFileName,
		IN PCWSTR	DestinationFileName,
		IN BOOLEAN	FailIfExists
	)

Definition at line 223 of file filesup.c.

{
    NTSTATUS Status;
    UNICODE_STRING FileName;
    OBJECT_ATTRIBUTES ObjectAttributes;
    HANDLE FileHandleSource;
    HANDLE FileHandleDest;
    IO_STATUS_BLOCK IoStatusBlock;
    FILE_STANDARD_INFORMATION FileStandard;
    FILE_BASIC_INFORMATION FileBasic;
    ULONG RegionSize;
    HANDLE SourceFileSection;
    PVOID SourceFileMap = NULL;
    SIZE_T SourceSectionSize = 0;
    LARGE_INTEGER ByteOffset;
 
    RtlInitUnicodeString(&FileName, SourceFileName);
    InitializeObjectAttributes(&ObjectAttributes,
                               &FileName,
                               OBJ_CASE_INSENSITIVE,
                               NULL,
                               NULL);
 
    Status = NtOpenFile(&FileHandleSource,
                        GENERIC_READ,
                        &ObjectAttributes,
                        &IoStatusBlock,
                        FILE_SHARE_READ,
                        FILE_SEQUENTIAL_ONLY);
    if (!NT_SUCCESS(Status))
    {
        DPRINT1("NtOpenFile failed: %x, %wZ\n", Status, &FileName);
        goto done;
    }
 
    Status = NtQueryInformationFile(FileHandleSource,
                                    &IoStatusBlock,
                                    &FileStandard,
                                    sizeof(FILE_STANDARD_INFORMATION),
                                    FileStandardInformation);
    if (!NT_SUCCESS(Status))
    {
        DPRINT1("NtQueryInformationFile failed: %x\n", Status);
        goto closesrc;
    }
 
    Status = NtQueryInformationFile(FileHandleSource,
                                    &IoStatusBlock,
                                    &FileBasic,
                                    sizeof(FILE_BASIC_INFORMATION),
                                    FileBasicInformation);
    if (!NT_SUCCESS(Status))
    {
        DPRINT1("NtQueryInformationFile failed: %x\n", Status);
        goto closesrc;
    }
 
    Status = NtCreateSection(&SourceFileSection,
                             SECTION_MAP_READ,
                             NULL,
                             NULL,
                             PAGE_READONLY,
                             SEC_COMMIT,
                             FileHandleSource);
    if (!NT_SUCCESS(Status))
    {
        DPRINT1("NtCreateSection failed: %x, %S\n", Status, SourceFileName);
        goto closesrc;
    }
 
    Status = NtMapViewOfSection(SourceFileSection,
                                NtCurrentProcess(),
                                &SourceFileMap,
                                0,
                                0,
                                NULL,
                                &SourceSectionSize,
                                ViewUnmap,
                                0,
                                PAGE_READONLY);
    if (!NT_SUCCESS(Status))
    {
        DPRINT1("NtMapViewOfSection failed: %x, %S\n", Status, SourceFileName);
        goto closesrcsec;
    }
 
    RtlInitUnicodeString(&FileName, DestinationFileName);
    InitializeObjectAttributes(&ObjectAttributes,
                               &FileName,
                               OBJ_CASE_INSENSITIVE,
                               NULL,
                               NULL);
 
    Status = NtCreateFile(&FileHandleDest,
                          GENERIC_WRITE | SYNCHRONIZE,
                          &ObjectAttributes,
                          &IoStatusBlock,
                          NULL,
                          FileBasic.FileAttributes, // FILE_ATTRIBUTE_NORMAL,
                          0,
                          FailIfExists ? FILE_CREATE : FILE_OVERWRITE_IF,
                          FILE_NO_INTERMEDIATE_BUFFERING |
                          FILE_SEQUENTIAL_ONLY |
                          FILE_SYNCHRONOUS_IO_NONALERT,
                          NULL,
                          0);
    if (!NT_SUCCESS(Status))
    {
        /*
         * Open may have failed because the file to overwrite
         * is in readonly mode.
         */
        if (Status == STATUS_ACCESS_DENIED)
        {
            FILE_BASIC_INFORMATION FileBasicInfo;
 
            /* Reattempt to open it with limited access */
            Status = NtCreateFile(&FileHandleDest,
                                  FILE_WRITE_ATTRIBUTES | SYNCHRONIZE,
                                  &ObjectAttributes,
                                  &IoStatusBlock,
                                  NULL,
                                  FILE_ATTRIBUTE_NORMAL,
                                  0,
                                  FILE_OPEN,
                                  FILE_NO_INTERMEDIATE_BUFFERING |
                                  FILE_SEQUENTIAL_ONLY |
                                  FILE_SYNCHRONOUS_IO_NONALERT,
                                  NULL,
                                  0);
            /* Fail for real if we cannot open it that way */
            if (!NT_SUCCESS(Status))
            {
                DPRINT1("NtCreateFile failed: %x, %wZ\n", Status, &FileName);
                goto unmapsrcsec;
            }
 
            /* Zero our basic info, just to set attributes */
            RtlZeroMemory(&FileBasicInfo, sizeof(FileBasicInfo));
            /* Reset attributes to normal, no read-only */
            FileBasicInfo.FileAttributes = FILE_ATTRIBUTE_NORMAL;
            /*
             * We basically don't care about whether it succeed:
             * if it didn't, later open will fail.
             */
            NtSetInformationFile(FileHandleDest, &IoStatusBlock, &FileBasicInfo,
                                 sizeof(FileBasicInfo), FileBasicInformation);
 
            /* Close file */
            NtClose(FileHandleDest);
 
            /* And re-attempt overwrite */
            Status = NtCreateFile(&FileHandleDest,
                                  GENERIC_WRITE | SYNCHRONIZE,
                                  &ObjectAttributes,
                                  &IoStatusBlock,
                                  NULL,
                                  FILE_ATTRIBUTE_NORMAL,
                                  0,
                                  FILE_OVERWRITE_IF,
                                  FILE_NO_INTERMEDIATE_BUFFERING |
                                  FILE_SEQUENTIAL_ONLY |
                                  FILE_SYNCHRONOUS_IO_NONALERT,
                                  NULL,
                                  0);
        }
 
        /* We failed */
        if (!NT_SUCCESS(Status))
        {
            DPRINT1("NtCreateFile failed: %x, %wZ\n", Status, &FileName);
            goto unmapsrcsec;
        }
    }
 
    RegionSize = (ULONG)PAGE_ROUND_UP(FileStandard.EndOfFile.u.LowPart);
    IoStatusBlock.Status = 0;
    ByteOffset.QuadPart = 0ULL;
    Status = NtWriteFile(FileHandleDest,
                         NULL,
                         NULL,
                         NULL,
                         &IoStatusBlock,
                         SourceFileMap,
                         RegionSize,
                         &ByteOffset,
                         NULL);
    if (!NT_SUCCESS(Status))
    {
        DPRINT1("NtWriteFile failed: %x:%x, iosb: %p src: %p, size: %x\n",
                Status, IoStatusBlock.Status, &IoStatusBlock, SourceFileMap, RegionSize);
        goto closedest;
    }
 
    /* Copy file date/time from source file */
    Status = NtSetInformationFile(FileHandleDest,
                                  &IoStatusBlock,
                                  &FileBasic,
                                  sizeof(FILE_BASIC_INFORMATION),
                                  FileBasicInformation);
    if (!NT_SUCCESS(Status))
    {
        DPRINT1("NtSetInformationFile failed: %x\n", Status);
        goto closedest;
    }
 
    /* Shorten the file back to its real size after completing the write */
    Status = NtSetInformationFile(FileHandleDest,
                                  &IoStatusBlock,
                                  &FileStandard.EndOfFile,
                                  sizeof(FILE_END_OF_FILE_INFORMATION),
                                  FileEndOfFileInformation);
    if (!NT_SUCCESS(Status))
    {
        DPRINT1("NtSetInformationFile failed: %x\n", Status);
    }
 
closedest:
    NtClose(FileHandleDest);
 
unmapsrcsec:
    NtUnmapViewOfSection(NtCurrentProcess(), SourceFileMap);
 
closesrcsec:
    NtClose(SourceFileSection);
 
closesrc:
    NtClose(FileHandleSource);
 
done:
    return Status;
}

Referenced by InstallBootloaderFiles(), RegCleanupRegistry(), SetupCommitFileQueueW(), and SetupMoveFile().

SetupCreateDirectory()

NTSTATUS SetupCreateDirectory

(

_In_ PCWSTR

PathName

)

Create a new directory, specified by the given path. Any intermediate non-existing directory is created as well.

Parameters

[in]

PathName

The path of the directory to be created.

Returns

An NTSTATUS code indicating success or failure.

Definition at line 72 of file filesup.c.

{
    NTSTATUS Status = STATUS_SUCCESS;
    UNICODE_STRING PathNameU;
    PCWSTR Buffer;
    PCWCH Ptr, End;
 
    RtlInitUnicodeString(&PathNameU, PathName);
    Buffer = PathNameU.Buffer;
    End = Buffer + (PathNameU.Length / sizeof(WCHAR));
 
    /* Find the deepest existing sub-directory: start from the
     * end and go back, verifying each sub-directory in turn */
    for (Ptr = End; Ptr > Buffer;)
    {
        BOOLEAN bExists;
 
        /* If we are on a separator, truncate at the next character.
         * The trailing separator is kept for the existence check. */
        if ((Ptr < End) && (*Ptr == OBJ_NAME_PATH_SEPARATOR))
            PathNameU.Length = (ULONG_PTR)(Ptr+1) - (ULONG_PTR)Buffer;
 
        /* Check if the sub-directory exists and stop
         * if so: this is the deepest existing one */
        DPRINT("PathName: %wZ\n", &PathNameU);
        bExists = DoesPathExist_UStr(NULL, &PathNameU, TRUE);
        if (bExists)
            break;
 
        /* Skip back any consecutive path separators */
        while ((Ptr > Buffer) && (*Ptr == OBJ_NAME_PATH_SEPARATOR))
            --Ptr;
        /* Go to the beginning of the path component, stop at the separator */
        while ((Ptr > Buffer) && (*Ptr != OBJ_NAME_PATH_SEPARATOR))
            --Ptr;
    }
 
    /* Skip any consecutive path separators */
    while ((Ptr < End) && (*Ptr == OBJ_NAME_PATH_SEPARATOR))
        ++Ptr;
 
    /* Create all the remaining sub-directories */
    for (; Ptr < End; ++Ptr)
    {
        /* Go to the end of the current path component, stop at
         * the separator or terminating NUL and truncate it */
        while ((Ptr < End) && (*Ptr != OBJ_NAME_PATH_SEPARATOR))
            ++Ptr;
        PathNameU.Length = (ULONG_PTR)Ptr - (ULONG_PTR)Buffer;
 
        DPRINT("Create: %wZ\n", &PathNameU);
        Status = SetupCreateSingleDirectory(&PathNameU);
        if (!NT_SUCCESS(Status))
            break;
    }
 
    DPRINT("Done.\n");
    return Status;
}

Referenced by PrepareCopyInfFile().

SetupDeleteFile()

NTSTATUS SetupDeleteFile	(	IN PCWSTR	FileName,
		IN BOOLEAN	ForceDelete
	)

Definition at line 134 of file filesup.c.

{
    NTSTATUS Status;
    UNICODE_STRING NtPathU;
    OBJECT_ATTRIBUTES ObjectAttributes;
    IO_STATUS_BLOCK IoStatusBlock;
    HANDLE FileHandle;
    FILE_DISPOSITION_INFORMATION FileDispInfo;
    BOOLEAN RetryOnce = FALSE;
 
    /* Open the directory name that was passed in */
    RtlInitUnicodeString(&NtPathU, FileName);
    InitializeObjectAttributes(&ObjectAttributes,
                               &NtPathU,
                               OBJ_CASE_INSENSITIVE,
                               NULL,
                               NULL);
 
Retry: // We go back there once if RetryOnce == TRUE
    Status = NtOpenFile(&FileHandle,
                        DELETE | FILE_READ_ATTRIBUTES |
                        (RetryOnce ? FILE_WRITE_ATTRIBUTES : 0),
                        &ObjectAttributes,
                        &IoStatusBlock,
                        FILE_SHARE_READ | FILE_SHARE_WRITE | FILE_SHARE_DELETE,
                        FILE_NON_DIRECTORY_FILE | FILE_OPEN_FOR_BACKUP_INTENT);
    if (!NT_SUCCESS(Status))
    {
        DPRINT1("NtOpenFile failed with Status 0x%08lx\n", Status);
        return Status;
    }
 
    if (RetryOnce)
    {
        FILE_BASIC_INFORMATION FileInformation;
 
        Status = NtQueryInformationFile(FileHandle,
                                        &IoStatusBlock,
                                        &FileInformation,
                                        sizeof(FILE_BASIC_INFORMATION),
                                        FileBasicInformation);
        if (!NT_SUCCESS(Status))
        {
            DPRINT1("NtQueryInformationFile failed with Status 0x%08lx\n", Status);
            NtClose(FileHandle);
            return Status;
        }
 
        FileInformation.FileAttributes = FILE_ATTRIBUTE_NORMAL;
        Status = NtSetInformationFile(FileHandle,
                                      &IoStatusBlock,
                                      &FileInformation,
                                      sizeof(FILE_BASIC_INFORMATION),
                                      FileBasicInformation);
        NtClose(FileHandle);
        if (!NT_SUCCESS(Status))
        {
            DPRINT1("NtSetInformationFile failed with Status 0x%08lx\n", Status);
            return Status;
        }
    }
 
    /* Ask for the file to be deleted */
    FileDispInfo.DeleteFile = TRUE;
    Status = NtSetInformationFile(FileHandle,
                                  &IoStatusBlock,
                                  &FileDispInfo,
                                  sizeof(FILE_DISPOSITION_INFORMATION),
                                  FileDispositionInformation);
    NtClose(FileHandle);
 
    if (!NT_SUCCESS(Status))
        DPRINT1("Deletion of file '%S' failed, Status 0x%08lx\n", FileName, Status);
 
    // FIXME: Check the precise value of Status!
    if (!NT_SUCCESS(Status) && ForceDelete && !RetryOnce)
    {
        /* Retry once */
        RetryOnce = TRUE;
        goto Retry;
    }
 
    /* Return result to the caller */
    return Status;
}

Referenced by SetupCommitFileQueueW(), and SetupMoveFile().

SetupMoveFile()

NTSTATUS SetupMoveFile	(	IN PCWSTR	ExistingFileName,
		IN PCWSTR	NewFileName,
		IN ULONG	Flags
	)

Definition at line 463 of file filesup.c.

{
    NTSTATUS Status;
    IO_STATUS_BLOCK IoStatusBlock;
    OBJECT_ATTRIBUTES ObjectAttributes;
    PFILE_RENAME_INFORMATION RenameInfo;
    UNICODE_STRING NewPathU, ExistingPathU;
    HANDLE SourceHandle = NULL;
    BOOLEAN ReplaceIfExists;
 
    RtlInitUnicodeString(&ExistingPathU, ExistingFileName);
    RtlInitUnicodeString(&NewPathU, NewFileName);
 
    _SEH2_TRY
    {
        ReplaceIfExists = !!(Flags & MOVEFILE_REPLACE_EXISTING);
 
        /* Unless we manage a proper opening, we'll attempt to reopen without reparse support */
        InitializeObjectAttributes(&ObjectAttributes,
                                   &ExistingPathU,
                                   OBJ_CASE_INSENSITIVE,
                                   NULL,
                                   NULL);
        /* Attempt to open source file */
        Status = NtOpenFile(&SourceHandle,
                            FILE_READ_ATTRIBUTES | DELETE | SYNCHRONIZE,
                            &ObjectAttributes,
                            &IoStatusBlock,
                            FILE_SHARE_READ | FILE_SHARE_WRITE | FILE_SHARE_DELETE,
                            FILE_OPEN_FOR_BACKUP_INTENT | ((Flags & MOVEFILE_WRITE_THROUGH) ? FILE_WRITE_THROUGH : 0));
        if (!NT_SUCCESS(Status))
        {
            if (Status != STATUS_INVALID_PARAMETER)
            {
                _SEH2_LEAVE;
            }
        }
 
        /* At that point, we MUST have a source handle */
        ASSERT(SourceHandle);
 
        /* Allocate renaming buffer and fill it */
        RenameInfo = RtlAllocateHeap(RtlGetProcessHeap(), 0, NewPathU.Length + sizeof(FILE_RENAME_INFORMATION));
        if (RenameInfo == NULL)
        {
            Status = STATUS_NO_MEMORY;
            _SEH2_LEAVE;
        }
 
        RtlCopyMemory(&RenameInfo->FileName, NewPathU.Buffer, NewPathU.Length);
        RenameInfo->ReplaceIfExists = ReplaceIfExists;
        RenameInfo->RootDirectory = NULL;
        RenameInfo->FileNameLength = NewPathU.Length;
 
        /* Attempt to rename the file */
        Status = NtSetInformationFile(SourceHandle,
                                      &IoStatusBlock,
                                      RenameInfo,
                                      NewPathU.Length + sizeof(FILE_RENAME_INFORMATION),
                                      FileRenameInformation);
        RtlFreeHeap(RtlGetProcessHeap(), 0, RenameInfo);
        if (NT_SUCCESS(Status))
        {
            /* If it succeeded, all fine, quit */
            _SEH2_LEAVE;
        }
        /*
         * If we failed for any other reason than not the same device, fail.
         * If we failed because of different devices, only allow renaming
         * if user allowed copy.
         */
        if (Status != STATUS_NOT_SAME_DEVICE || !(Flags & MOVEFILE_COPY_ALLOWED))
        {
            /* ReactOS hack! To be removed once all FSD have proper renaming support
             * Just leave status to error and leave
             */
            if (Status == STATUS_NOT_IMPLEMENTED)
            {
                DPRINT1("Forcing copy, renaming not supported by FSD\n");
            }
            else
            {
                _SEH2_LEAVE;
            }
        }
 
        /* Close the source file */
        NtClose(SourceHandle);
        SourceHandle = NULL;
 
        /* Perform the file copy */
        Status = SetupCopyFile(ExistingFileName,
                               NewFileName,
                               !ReplaceIfExists);
 
        /* If it succeeded, delete the source file */
        if (NT_SUCCESS(Status))
        {
            /* Force-delete files even if read-only */
            SetupDeleteFile(ExistingFileName, TRUE);
        }
    }
    _SEH2_FINALLY
    {
        if (SourceHandle)
            NtClose(SourceHandle);
    }
    _SEH2_END;
 
    return Status;
}

Referenced by CreateRegistryFile(), and SetupCommitFileQueueW().

UnMapFile()

BOOLEAN UnMapFile	(	_In_ HANDLE	SectionHandle,
		_In_ PVOID	BaseAddress
	)

Unmaps a mapped file by section.

Parameters

[in]	SectionHandle	The handle to the section mapping the file.
[in]	BaseAddress	The base address where the file is mapped.

Returns

TRUE if the file was successfully unmapped; FALSE if an error occurred.

Definition at line 1051 of file filesup.c.

{
    NTSTATUS Status;
    BOOLEAN Success = TRUE;
 
    Status = NtUnmapViewOfSection(NtCurrentProcess(), BaseAddress);
    if (!NT_SUCCESS(Status))
    {
        DPRINT1("NtUnmapViewOfSection(0x%p) failed (Status 0x%08lx)\n",
                BaseAddress, Status);
        Success = FALSE;
    }
    Status = NtClose(SectionHandle);
    if (!NT_SUCCESS(Status))
    {
        DPRINT1("NtClose(0x%p) failed (Status 0x%08lx)\n",
                SectionHandle, Status);
        Success = FALSE;
    }
 
    return Success;
}