IPlatformFileSandboxWrapper.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
 
#pragma once
 
#include "Containers/Array.h"
#include "Containers/UnrealString.h"
#include "CoreMinimal.h"
#include "GenericPlatform/GenericPlatformFile.h"
#include "HAL/Platform.h"
#include "Logging/LogMacros.h"
#include "Misc/DateTime.h"
#include "Misc/Paths.h"
#include "Templates/UniquePtr.h"
 
class IAsyncReadFileHandle;
class IMappedFileHandle;
 
DECLARE_LOG_CATEGORY_EXTERN(SandboxFile, Log, All);
 
class FSandboxPlatformFile : public IPlatformFile
{
    IPlatformFile*      LowerLevel;
    FString         SandboxDirectory;
    FString         GameSandboxDirectoryName;
    FString         RelativeRootDirectory;
    FString         AbsoluteRootDirectory;
    FString         AbsoluteGameDirectory;
    FString         AbsolutePathToGameDirectory;
    TArray<FString>     FileExclusionWildcards;
    TArray<FString>     DirectoryExclusionWildcards;
    bool                bEntireEngineWillUseThisSandbox;
 
    bool                bSandboxEnabled;
 
    FString             InjectedSourceDirectory;
    FString             InjectedSourceDirectoryParent;
    FString             InjectedTargetDirectory;
    FString             InjectedTargetDirectoryParent;
 
    bool                bSandboxOnly;
 
    SANDBOXFILE_API bool WipeSandboxFolder( const TCHAR* AbsolutePath );    
 
    SANDBOXFILE_API void FindFiles( TArray<FString>& Result, const TCHAR* InFilename, bool Files, bool Directories );
    
    using IPlatformFile::FindFiles;
 
    SANDBOXFILE_API bool DeleteDirectory( const TCHAR* Path, bool Tree );
 
    SANDBOXFILE_API bool OkForInnerAccess(const TCHAR* InFilenameOrDirectoryName, bool bIsDirectory = false) const;
 
    static const TCHAR* GetTypeName()
    {
        return TEXT("SandboxFile");
    }
 
    SANDBOXFILE_API FSandboxPlatformFile(bool bInEntireEngineWillUseThisSandbox);
 
public:
    static SANDBOXFILE_API TUniquePtr<FSandboxPlatformFile> Create(bool bInEntireEngineWillUseThisSandbox);
 
    SANDBOXFILE_API virtual ~FSandboxPlatformFile();
 
    //~ For visibility of overloads we don't override
    using IPlatformFile::IterateDirectory;
    using IPlatformFile::IterateDirectoryRecursively;
    using IPlatformFile::IterateDirectoryStat;
    using IPlatformFile::IterateDirectoryStatRecursively;
 
    SANDBOXFILE_API virtual void SetSandboxEnabled(bool bInEnabled) override;
 
    SANDBOXFILE_API virtual bool            IsSandboxEnabled() const override;
 
    SANDBOXFILE_API virtual bool            ShouldBeUsed(IPlatformFile* Inner, const TCHAR* CmdLine) const override;
    SANDBOXFILE_API virtual bool            Initialize(IPlatformFile* Inner, const TCHAR* CmdLine) override;
 
    SANDBOXFILE_API virtual IPlatformFile*  GetLowerLevel() override;
    SANDBOXFILE_API virtual void            SetLowerLevel(IPlatformFile* NewLowerLevel) override;
    SANDBOXFILE_API virtual const TCHAR*    GetName() const override;
 
    SANDBOXFILE_API FString ConvertToSandboxPath(const TCHAR* Filename) const;
    SANDBOXFILE_API FString ConvertFromSandboxPath(const TCHAR* Filename) const;
 
    SANDBOXFILE_API const FString& GetSandboxDirectory() const;
 
    SANDBOXFILE_API const FString& GetGameSandboxDirectoryName();
 
    SANDBOXFILE_API const FString& GetAbsoluteRootDirectory() const;
 
    SANDBOXFILE_API const FString& GetAbsoluteGameDirectory();
 
    SANDBOXFILE_API const FString& GetAbsolutePathToGameDirectory();
 
    SANDBOXFILE_API void AddExclusion(const TCHAR* Wildcard, bool bIsDirectory = false);
    SANDBOXFILE_API void RemoveExclusion(const TCHAR* Wildcard, bool bIsDirectory = false);
 
    SANDBOXFILE_API void SetSandboxOnly(bool bInSandboxOnly);
 
    // IPlatformFile Interface
 
    SANDBOXFILE_API virtual bool                    FileExists(const TCHAR* Filename) override;
    SANDBOXFILE_API virtual int64                   FileSize(const TCHAR* Filename) override;
    SANDBOXFILE_API virtual bool                    DeleteFile(const TCHAR* Filename) override;
    SANDBOXFILE_API virtual bool                    IsReadOnly(const TCHAR* Filename) override;
    SANDBOXFILE_API virtual bool                    MoveFile(const TCHAR* To, const TCHAR* From) override;
    SANDBOXFILE_API virtual bool                    SetReadOnly(const TCHAR* Filename, bool bNewReadOnlyValue) override;
    SANDBOXFILE_API virtual FDateTime               GetTimeStamp(const TCHAR* Filename) override;
    SANDBOXFILE_API virtual void                    SetTimeStamp(const TCHAR* Filename, FDateTime DateTime) override;
    SANDBOXFILE_API virtual FDateTime               GetAccessTimeStamp(const TCHAR* Filename) override;
    SANDBOXFILE_API virtual FString                 GetFilenameOnDisk(const TCHAR* Filename) override;
    SANDBOXFILE_API virtual IFileHandle*            OpenRead(const TCHAR* Filename, bool bAllowWrite = false) override;
    SANDBOXFILE_API virtual IFileHandle*            OpenWrite(const TCHAR* Filename, bool bAppend = false, bool bAllowRead = false) override;
    SANDBOXFILE_API virtual bool                    DirectoryExists(const TCHAR* Directory) override;
    SANDBOXFILE_API virtual bool                    CreateDirectory(const TCHAR* Directory) override;
    SANDBOXFILE_API virtual bool                    DeleteDirectory(const TCHAR* Directory) override;
    SANDBOXFILE_API virtual FFileStatData           GetStatData(const TCHAR* FilenameOrDirectory) override;
 
    SANDBOXFILE_API virtual bool                    IterateDirectory(const TCHAR* Directory, IPlatformFile::FDirectoryVisitor& Visitor) override;
    SANDBOXFILE_API virtual bool                    IterateDirectoryRecursively(const TCHAR* Directory, IPlatformFile::FDirectoryVisitor& Visitor) override;
 
    SANDBOXFILE_API virtual bool                    IterateDirectoryStat(const TCHAR* Directory, IPlatformFile::FDirectoryStatVisitor& Visitor) override;
    SANDBOXFILE_API virtual bool                    IterateDirectoryStatRecursively(const TCHAR* Directory, IPlatformFile::FDirectoryStatVisitor& Visitor) override;
 
    SANDBOXFILE_API virtual bool                    DeleteDirectoryRecursively(const TCHAR* Directory) override;
    SANDBOXFILE_API virtual bool                    CreateDirectoryTree(const TCHAR* Directory) override;
 
    SANDBOXFILE_API virtual bool                    CopyFile(const TCHAR* To, const TCHAR* From, EPlatformFileRead ReadFlags = EPlatformFileRead::None, EPlatformFileWrite WriteFlags = EPlatformFileWrite::None) override;
    SANDBOXFILE_API virtual FString                 ConvertToAbsolutePathForExternalAppForRead( const TCHAR* Filename ) override;
    SANDBOXFILE_API virtual FString                 ConvertToAbsolutePathForExternalAppForWrite( const TCHAR* Filename ) override;
 
    SANDBOXFILE_API virtual IAsyncReadFileHandle*   OpenAsyncRead(const TCHAR* Filename, bool bAllowWrite = false) override;
    SANDBOXFILE_API virtual void                    SetAsyncMinimumPriority(EAsyncIOPriorityAndFlags Priority) override;
 
    UE_DEPRECATED(5.6, "Please use overloaded value that returns error values properly")
    SANDBOXFILE_API virtual IMappedFileHandle*      OpenMapped(const TCHAR* Filename) override;
    SANDBOXFILE_API virtual FOpenMappedResult       OpenMappedEx(const TCHAR* Filename, EOpenReadFlags OpenOptions = EOpenReadFlags::None, int64 MaximumSize = 0) override;
 
    friend class FSandboxVisitor;
    friend class FSandboxStatVisitor;
};