NetworkFileServerConnection.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "Misc/CoreMisc.h"
#include "INetworkFileSystemModule.h"
 
class FSandboxPlatformFile;
class ITargetPlatform;
 
 
class FNetworkFileServerClientConnection : public FSelfRegisteringExec
{
public:
 
    FNetworkFileServerClientConnection(const FNetworkFileServerOptions& InFileServerOptions);
 
    virtual ~FNetworkFileServerClientConnection( );
 
public:
 
    bool ProcessPayload(FArchive& Ar);
 
    FString GetDescription() const;
 
protected:
 
    void ConvertClientFilenameToServerFilename(FString& FilenameToConvert);
 
    void ConvertLocalFilenameToServerFilename(FString& FilenameToConvert);
 
    // void ConvertServerFilenameToClientFilename(FString& FilenameToConvert);
    
    void ProcessOpenFile(FArchive& In, FArchive& Out, bool bIsWriting);
 
    void ProcessReadFile(FArchive& In, FArchive& Out);
 
    void ProcessWriteFile(FArchive& In, FArchive& Out);
 
    void ProcessSeekFile(FArchive& In, FArchive& Out);
 
    void ProcessCloseFile(FArchive& In, FArchive& Out);
 
    void ProcessGetFileInfo(FArchive& In, FArchive& Out);
 
    void ProcessMoveFile(FArchive& In, FArchive& Out);
 
    void ProcessDeleteFile(FArchive& In, FArchive& Out);
 
    void ProcessCopyFile(FArchive& In, FArchive& Out);
 
    void ProcessSetTimeStamp(FArchive& In, FArchive& Out);
 
    void ProcessSetReadOnly(FArchive& In, FArchive& Out);
 
    void ProcessCreateDirectory(FArchive& In, FArchive& Out);
 
    void ProcessDeleteDirectory(FArchive& In, FArchive& Out);
 
    void ProcessDeleteDirectoryRecursively(FArchive& In, FArchive& Out);
 
    void ProcessToAbsolutePathForRead(FArchive& In, FArchive& Out);
 
    void ProcessToAbsolutePathForWrite(FArchive& In, FArchive& Out);
 
    void ProcessReportLocalFiles(FArchive& In, FArchive& Out);
 
    bool ProcessGetFileList(FArchive& In, FArchive& Out);
 
    void ProcessHeartbeat(FArchive& In, FArchive& Out);
 
    FORCEINLINE IFileHandle* FindOpenFile( uint64 HandleId )
    {
        IFileHandle** OpenFile = OpenFiles.Find(HandleId);
 
        return OpenFile ? *OpenFile : NULL;
    }
 
    bool PackageFile( FString& Filename, FString& TargetFilename, FArchive& Out);
 
    bool ProcessSyncFile( FArchive& In, FArchive& Out );
 
 
    virtual bool SendPayload( TArray<uint8> &Out ) = 0; 
 
    void FileModifiedCallback( const FString& Filename );
    
    
    virtual bool Exec_Runtime(class UWorld* InWorld, const TCHAR* Cmd, FOutputDevice& Ar) override;
 
 
    FString FixupSandboxPathForClient(const FString& Filename);
 
    TMap<FString,FDateTime> FixupSandboxPathsForClient(const TMap<FString, FDateTime>& SandboxPaths);
    
private:
 
    // Hold the name of the currently connected platform.
    FString ConnectedPlatformName;
 
    // Hold the ip address of the currently connected platform.
    FString ConnectedIPAddress;
 
    // Hold the engine directory from the connected platform.
    FString ConnectedEngineDir;
 
    // Hold the game directory from the connected platform.
    FString ConnectedProjectDir;
 
    // Hold the engine platform extensions directory from the connected platform.
    FString ConnectedEnginePlatformExtensionsDir;
 
    // Hold the project platform extensions directory from the connected platform.
    FString ConnectedProjectPlatformExtensionsDir;
 
    // Hold the sandbox engine directory for the connected platform
    FString SandboxEngine;
 
    // hold the sandbox game directory for the connected platform
    FString SandboxProject;
 
    // hold the engine sandbox platform extensions directory for the connected platform
    FString SandboxEnginePlatformExtensions;
 
    // hold the project sandbox platform extensions directory for the connected platform
    FString SandboxProjectPlatformExtensions;
 
    // Should we send the filenames in lowercase
    bool bSendLowerCase;
 
    // Holds the last assigned handle id (0 = invalid).
    uint64 LastHandleId;
 
    // Holds the list of files found by the directory watcher.
    TArray<FString> ModifiedFiles;
 
    // Holds a critical section to protect the ModifiedFiles array.
    FCriticalSection ModifiedFilesSection;
 
    // Holds all currently open file handles.
    TMap<uint64, IFileHandle*> OpenFiles;
 
    // Holds the file interface for local (to the server) files - all file ops MUST go through here, NOT IFileManager.
    TUniquePtr<FSandboxPlatformFile> Sandbox;
 
    // Holds the list of unsolicited files to send in separate packets.
    TArray<FString> UnsolictedFiles;
 
    // Holds the list of directories being watched.
    TArray<FString> WatchedDirectories;
 
    // Local path to the engine directory
    FString LocalEngineDir;
 
    // Absolute local path to the engine directory
    FString LocalEngineDirAbs;
 
    // Local path to the project directory
    FString LocalProjectDir;
 
    // Absolute local path to the project directory
    FString LocalProjectDirAbs;
 
    // Local path to the engine platform extensions directory
    FString LocalEnginePlatformExtensionsDir;
 
    // Absolute local path to the engine platform extensions directory
    FString LocalEnginePlatformExtensionsDirAbs;
 
    // Local path to the project platform extensions directory
    FString LocalProjectPlatformExtensionsDir;
 
    // Absolute local path to the project platform extensions directory
    FString LocalProjectPlatformExtensionsDirAbs;
 
    const FNetworkFileDelegateContainer* NetworkFileDelegates;
 
    // cached copy of the active target platforms (if any)
    const TArray<ITargetPlatform*>& ActiveTargetPlatforms;
 
    // connected TargetPlatform object, if ActiveTargetPlatforms existed
    ITargetPlatform* ConnectedTargetPlatform;
 
    // custom key-value pair data for the curently connected target platform
    TMap<FString,FString> ConnectedTargetCustomData;
 
    // whether to restrict sending package assets from outside the sandbox
    bool bRestrictPackageAssetsToSandbox;
 
    //stats
    double FileRequestDelegateTime;
    double PackageFileTime;
    double UnsolicitedFilesTime;
 
    int32 FileRequestCount;
    int32 UnsolicitedFilesCount;
    int32 PackageRequestsSucceeded;
    int32 PackageRequestsFailed;
    int32 FileBytesSent;
    
};