EM_Task/UnrealEd/Private/PackageAutoSaver.h

// Copyright Epic Games, Inc. All Rights Reserved.

#pragma once

#include "CoreMinimal.h"
#include "SlateFwd.h"
#include "UObject/WeakObjectPtr.h"
#include "IPackageAutoSaver.h"

namespace ECloseNotification
{
enum Type
{
    NothingToDo,
    Success,
    Postponed,
    Failed
};
}  // namespace ECloseNotification

/** A class to handle the creation, destruction, and restoration of auto-saved packages */
class FPackageAutoSaver: public IPackageAutoSaver
{
public:
    FPackageAutoSaver();
    virtual ~FPackageAutoSaver();

    /** IPackageAutoSaver */
    virtual void UpdateAutoSaveCount(const float DeltaSeconds) override;
    virtual void ResetAutoSaveTimer() override;
    virtual void ForceAutoSaveTimer() override;
    virtual void ForceMinimumTimeTillAutoSave(const float TimeTillAutoSave = 10.0f) override;
    virtual void AttemptAutoSave() override;
    virtual void LoadRestoreFile() override;
    virtual void UpdateRestoreFile(const bool bRestoreEnabled) override;
    virtual bool HasPackagesToRestore() const override;
    virtual void OfferToRestorePackages() override;
    virtual void OnPackagesDeleted(const TArray<UPackage*>& DeletedPackages) override;
    virtual bool IsAutoSaving() const override { return bIsAutoSaving; }
    virtual void DisableRestorePromptAndDeclinePackageRecovery() override { bAutoDeclineRecovery = true; }

private:
    /**
     * Called when a package dirty state has been updated
     *
     * @param Pkg The package that was changed
     */
    void OnPackageDirtyStateUpdated(UPackage* Pkg);

    /**
     * Called when a package is marked as dirty
     *
     * @param Pkg The package that was marked as dirty
     * @param bWasDirty Whether the package was previously dirty before the call to MarkPackageDirty
     */
    void OnMarkPackageDirty(UPackage* Pkg, bool bWasDirty);

    /**
     * Called when a package has been saved
     *
     * @param Filename The filename the package was saved to
     * @param Obj The package that was saved
     */
    void OnPackageSaved(const FString& Filename, UObject* Obj);

    /**
     * Update the dirty lists for the current package
     *
     * @param Pkg The package to update the lists for
     */
    void UpdateDirtyListsForPackage(UPackage* Pkg);

    /** @return Returns whether or not the user is able to auto-save. */
    bool CanAutoSave() const;

    /** @return Returns whether or not we would need to perform an auto-save (note: does not check if we can perform an auto-save, only that we should if we could). */
    bool DoPackagesNeedAutoSave() const;

    /** @return The notification text to be displayed during auto-saving */
    FText GetAutoSaveNotificationText(const int32 TimeInSecondsUntilAutosave);

    /**
     * @param bIgnoreCanAutoSave if True this function returns the time regardless of whether auto-save is enabled.
     *
     * @return Returns the amount of time until the next auto-save in seconds. Or -1 if auto-save is disabled.
     */
    int32 GetTimeTillAutoSave(const bool bIgnoreCanAutoSave = false) const;

    /**
     * Attempts to launch a auto-save warning notification if auto-save is imminent, if this is already the case
     * it will update the time remaining.
     */
    void UpdateAutoSaveNotification();

    /** Closes the auto-save warning notification if open, with an appropriate message based on whether it was successful */
    void CloseAutoSaveNotification(const bool Success);

    /** Closes the auto-save warning notification if open, with an appropriate message based on type */
    void CloseAutoSaveNotification(ECloseNotification::Type Type);

    /** Used as a callback for auto-save warning buttons, called when auto-save is forced early */
    void OnAutoSaveSave();

    /** Used as a callback for auto-save warning buttons, called when auto-save is postponed */
    void OnAutoSaveCancel();

    /** Clear out any stale pointers in the dirty packages containers */
    void ClearStalePointers();

    /** The current auto-save number, appended to the auto-save map name, wraps after 10 */
    int32 AutoSaveIndex;

    /** The number of 10-sec intervals that have passed since last auto-save. */
    float AutoSaveCount;

    /** If we are currently auto-saving */
    bool bIsAutoSaving;

    /** Flag for whether auto-save warning notification has been launched */
    bool bAutoSaveNotificationLaunched;

    /** If we are delaying the time a little bit because we failed to save */
    bool bDelayingDueToFailedSave;

    /** Flag as true if recovery prompt is disabled. Should be true if another system is restoring, replacing the auto-saver recovery, like the Disaster Recovery plugin. */
    bool bAutoDeclineRecovery;

    /** Indicate that we need to update the restore file. */
    bool bNeedRestoreFileUpdate = false;

    /** Used to reference to the active auto-save warning notification */
    TWeakPtr<SNotificationItem> AutoSaveNotificationPtr;

    /** Packages that have been dirtied and not saved by the user, mapped to their latest auto-save file */
    TMap<TWeakObjectPtr<UPackage>, FString> DirtyPackagesForUserSave;

    /** Maps that have been dirtied and not saved by the auto-saver */
    TSet<TWeakObjectPtr<UPackage>> DirtyMapsForAutoSave;

    /** Content that has been dirtied and not saved by the auto-saver */
    TSet<TWeakObjectPtr<UPackage>> DirtyContentForAutoSave;

    /** Restore information that was loaded following a crash */
    TMap<FString, FString> PackagesThatCanBeRestored;
};