NamePermissionList.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "Containers/Array.h"
#include "Containers/DirectoryTree.h"
#include "Containers/Map.h"
#include "Containers/StringFwd.h"
#include "Containers/StringView.h"
#include "CoreTypes.h"
#include "Delegates/Delegate.h"
#include "HAL/PlatformCrt.h"
#include "Templates/SharedPointer.h"
#include "UObject/NameTypes.h"
 
class FString;
 
typedef TArray<FName> FPermissionListOwners;
 
class FNamePermissionList : public TSharedFromThis<FNamePermissionList>
{
public:
    FNamePermissionList() {}
    virtual ~FNamePermissionList() {}
 
    CORE_API bool PassesFilter(const FName Item) const;
 
    CORE_API bool AddDenyListItem(const FName OwnerName, const FName Item);
 
    CORE_API bool AddAllowListItem(const FName OwnerName, const FName Item);
 
    CORE_API bool RemoveDenyListItem(const FName OwnerName, const FName Item);
 
    CORE_API bool RemoveAllowListItem(const FName OwnerName, const FName Item);
 
    CORE_API bool AddDenyListAll(const FName OwnerName);
    
    CORE_API bool HasFiltering() const;
 
    CORE_API TArray<FName> GetOwnerNames() const;
 
    CORE_API bool UnregisterOwner(const FName OwnerName);
 
    CORE_API bool UnregisterOwners(const TArray<FName>& OwnerNames);
 
    CORE_API bool Append(const FNamePermissionList& Other);
 
    CORE_API bool UnregisterOwnersAndAppend(const TArray<FName>& OwnerNamesToRemove, const FNamePermissionList& FiltersToAdd);
 
    const TMap<FName, FPermissionListOwners>& GetDenyList() const { return DenyList; }
    
    const TMap<FName, FPermissionListOwners>& GetAllowList() const { return AllowList; }
 
    bool IsDenyListAll() const { return DenyListAll.Num() > 0; }
 
    FSimpleMulticastDelegate& OnFilterChanged() { return OnFilterChangedDelegate; }
 
protected:
 
    TMap<FName, FPermissionListOwners> DenyList;
 
    TMap<FName, FPermissionListOwners> AllowList;
 
    FPermissionListOwners DenyListAll;
 
    FSimpleMulticastDelegate OnFilterChangedDelegate;
 
    bool bSuppressOnFilterChanged = false;
};
 
enum class EPathPermissionListType
{
    Default,    // Default path permission list
    ClassPaths  // Class permission list
};
 
// Result of non-exact filtering on path prefixes
enum class EPathPermissionPrefixResult
{
    // The query against the list failed because of one of the following:
    //  * There was an explicit allow-list and none of the entries was a parent path of the query path
    //      (or a child of the query path when bAllowParentPaths = true)
    //  * There were deny-list entries and one of the entries was a parent path of the query path
    Fail,
    // The query against the list failed and either:
    //  * All paths are denied, so queries for child paths will also fail
    //  * The query failed on a deny-list entry, so child paths will fail on this same entry
    //  * There is an explicit allow-list and there are no entries with more components than the query path,
    //    so children can never pass.
    FailRecursive,
    // The query against the list succeeded, but queries for child paths may fail because there are longer
    // paths in the deny-list with more components
    Pass,
    // The query against the list succeeded and queries for child paths will all succeed no deny-list entry can
    // possibly fail them
    PassRecursive,
};
 
class FPathPermissionList : public TSharedFromThis<FPathPermissionList>
{
public:
    CORE_API FPathPermissionList(EPathPermissionListType InType = EPathPermissionListType::Default);
    PRAGMA_DISABLE_DEPRECATION_WARNINGS
    virtual ~FPathPermissionList() { }
    PRAGMA_ENABLE_DEPRECATION_WARNINGS
 
    FPathPermissionList(const FPathPermissionList&) = default;
    FPathPermissionList& operator=(const FPathPermissionList&) = default;
 
    FPathPermissionList(FPathPermissionList&&) = default;
    FPathPermissionList& operator=(FPathPermissionList&&) = default;
 
    CORE_API bool PassesFilter(const FStringView Item) const;
 
    CORE_API bool PassesFilter(const FName Item) const;
 
    CORE_API bool PassesFilter(const TCHAR* Item) const;
 
    CORE_API bool PassesStartsWithFilter(const FStringView Item, const bool bAllowParentPaths = false) const;
 
    CORE_API bool PassesStartsWithFilter(const FName Item, const bool bAllowParentPaths = false) const;
 
    CORE_API bool PassesStartsWithFilter(const TCHAR* Item, const bool bAllowParentPaths = false) const;
 
    CORE_API EPathPermissionPrefixResult PassesStartsWithFilterRecursive(const FStringView Item,
        const bool bAllowParentPaths = false) const;
 
    CORE_API bool AddDenyListItem(const FName OwnerName, const FStringView Item);
 
    CORE_API bool AddDenyListItem(const FName OwnerName, const FName Item);
 
    CORE_API bool AddDenyListItem(const FName OwnerName, const TCHAR* Item);
 
    CORE_API bool ContainsDenyListItem(FStringView Item) const;
 
    CORE_API bool HasDenyListEntries() const;
 
    CORE_API TArray<FString> GetDenyListEntries() const;
 
    CORE_API bool RemoveDenyListItem(const FName OwnerName, const FStringView Item);
 
    CORE_API bool RemoveDenyListItem(const FName OwnerName, const FName Item);
 
    CORE_API bool RemoveDenyListItem(const FName OwnerName, const TCHAR* Item);
 
    CORE_API FPermissionListOwners RemoveDenyListItemAndGetOwners(FStringView Item);
 
    CORE_API bool AddAllowListItem(const FName OwnerName, const FStringView Item);
 
    CORE_API bool AddAllowListItem(const FName OwnerName, const FName Item);
 
    CORE_API bool AddAllowListItem(const FName OwnerName, const TCHAR* Item);
 
    CORE_API bool HasAllowListEntries() const;
 
    CORE_API TArray<FString> GetAllowListEntries() const;
 
    CORE_API bool RemoveAllowListItem(const FName OwnerName, const FStringView Item);
 
    CORE_API bool RemoveAllowListItem(const FName OwnerName, const FName Item);
 
    CORE_API bool RemoveAllowListItem(const FName OwnerName, const TCHAR* Item);
 
    CORE_API bool AddDenyListAll(const FName OwnerName);
    
    CORE_API bool HasFiltering() const;
 
    CORE_API TArray<FName> GetOwnerNames() const;
 
    CORE_API bool UnregisterOwner(const FName OwnerName);
 
    CORE_API bool UnregisterOwners(const TArray<FName>& OwnerNames);
    
    CORE_API bool Append(const FPathPermissionList& Other);
 
    [[nodiscard]] CORE_API FPathPermissionList CombinePathFilters(const FPathPermissionList& OtherFilter) const;
 
    CORE_API bool UnregisterOwnersAndAppend(const TArray<FName>& OwnerNamesToRemove, const FPathPermissionList& FiltersToAdd);
 
    UE_DEPRECATED(5.5, "GetDenyList is deprecated. Use GetDenyListEntries instead.")
    const TMap<FString, FPermissionListOwners>& GetDenyList() const;
 
    UE_DEPRECATED(5.5, "GetAllowList is deprecated. Use GetAllowListEntries instead.")
    const TMap<FString, FPermissionListOwners>& GetAllowList() const;
 
    bool IsDenyListAll() const { return DenyListAll.Num() > 0; }
    
    FSimpleMulticastDelegate& OnFilterChanged() { return OnFilterChangedDelegate; }
 
    CORE_API FString ToString() const;
 
protected:
 
    CORE_API void VerifyItemMatchesListType(const FStringView Item) const;
 
    TDirectoryTree<FPermissionListOwners> DenyTree;
 
    TDirectoryTree<FPermissionListOwners> AllowTree;
 
    FPermissionListOwners DenyListAll;
    
    FSimpleMulticastDelegate OnFilterChangedDelegate;
 
    bool bSuppressOnFilterChanged = false;
 
    EPathPermissionListType ListType;
};