New Source Control option: Revert To Status Branch

Source/GitSourceControl/GitSourceControl.Build.cs

@@ -21,7 +21,8 @@ public GitSourceControl(ReadOnlyTargetRules Target) : base(Target)
 				"UnrealEd",
 				"SourceControl",
 				"SourceControlWindows",
-				"Projects"
+				"Projects",
+				"Engine",
 			}
 		);
 

Source/GitSourceControl/Private/GitSourceControlModule.cpp

@@ -22,6 +22,7 @@
 #include "GitSourceControlUtils.h"
 #include "ISourceControlModule.h"
 #include "SourceControlHelpers.h"
+#include "Engine/World.h"
 #include "Framework/Commands/UIAction.h"
 #include "Framework/MultiBox/MultiBoxExtender.h"
 #include "Framework/MultiBox/MultiBoxBuilder.h"
@@ -199,6 +200,42 @@ void FGitSourceControlModule::CreateGitContentBrowserAssetMenu(FMenuBuilder& Men
 #endif
 		FUIAction(FExecuteAction::CreateRaw( this, &FGitSourceControlModule::DiffAssetAgainstGitOriginBranch, SelectedAssets, BranchName ))
 	);
+
+	const FString WorldAssetName = UWorld::StaticClass()->GetName();
+	const bool bSelectedAssetsContainsWorld = SelectedAssets.ContainsByPredicate([&WorldAssetName](const FAssetData& AssetData)
+	{
+		return AssetData.AssetClassPath.GetAssetName() == WorldAssetName;
+	});
+	const bool bCanRevertToStatusBranch = !bSelectedAssetsContainsWorld;
+
+	MenuBuilder.AddMenuEntry(
+		FText::Format(LOCTEXT("StatusRevert", "Revert to status branch: {0}"), FText::FromString(BranchName)),
+		FText::Format(LOCTEXT("StatusRevertDesc", "Revert this asset back to its state in status branch: {0}"), FText::FromString(BranchName)),
+		#if ENGINE_MAJOR_VERSION == 5 && ENGINE_MINOR_VERSION >= 1
+		FSlateIcon(FAppStyle::GetAppStyleSetName(), "SourceControl.Actions.Revert"),
+		#else
+		FSlateIcon(FEditorStyle::GetStyleSetName(), "SourceControl.Actions.Revert"),
+		#endif
+		FUIAction(
+			FExecuteAction::CreateLambda([SelectedAssets, BranchName]
+			{
+				const FText Message = FText::Format(LOCTEXT("StatusRevertAskForConfirmation", "Are you sure you want to revert the selected files to status branch {0}"), FText::FromString(BranchName));
+				const EAppReturnType::Type ConfirmationAnswer = FMessageDialog::Open(EAppMsgCategory::Warning, EAppMsgType::YesNoCancel, Message);
+
+				if (ConfirmationAnswer == EAppReturnType::Yes)
+				{
+					const FGitSourceControlModule& GitSourceControl = FModuleManager::GetModuleChecked<FGitSourceControlModule>("GitSourceControl");
+					const FString& PathToGitBinary = GitSourceControl.AccessSettings().GetBinaryPath();
+					const FString& PathToRepositoryRoot = GitSourceControl.GetProvider().GetPathToRepositoryRoot();
+					GitSourceControlUtils::SyncAssetsFromBranch(PathToGitBinary, PathToRepositoryRoot, SelectedAssets, BranchName);
+				}
+			}),
+			FCanExecuteAction::CreateLambda([bCanRevertToStatusBranch]
+			{
+				return bCanRevertToStatusBranch;
+			})
+		)
+	);
 }
 
 void FGitSourceControlModule::DiffAssetAgainstGitOriginBranch(const TArray<FAssetData> SelectedAssets, FString BranchName) const

Source/GitSourceControl/Private/GitSourceControlUtils.cpp

@@ -43,6 +43,10 @@
 #include "Async/Async.h"
 #include "UObject/Linker.h"
 
+#include "SourceControlHelpers.h"
+#include "SourceControlOperations.h"
+#include "SourceControlWindows.h"
+
 #ifndef GIT_DEBUG_STATUS
 #define GIT_DEBUG_STATUS 0
 #endif
@@ -2529,6 +2533,106 @@ TSharedPtr<ISourceControlRevision, ESPMode::ThreadSafe> GetOriginRevisionOnBranc
 	return nullptr;
 }
 
+void SyncAssetsFromBranch(const FString& InPathToGitBinary, const FString& InRepositoryRoot, const TArray<FAssetData>& SelectedAssets, const FString& BranchName)
+{
+	TArray<FString> FilesToDiff;
+
+	for (const FAssetData& AssetData : SelectedAssets)
+	{
+		FString AbsoluteFilePath = SourceControlHelpers::PackageFilename(AssetData.PackageName.ToString());		
+		FilesToDiff.Add(AbsoluteFilePath);
+	}
+
+	TArray<FString> DiffResults;
+	TArray<FString> ErrorMessages;
+	TArray<FString> DiffParametersLog{ TEXT("--pretty="), TEXT("--name-only"), FString::Printf(TEXT("HEAD..%s"), *BranchName), TEXT(""), TEXT("--") };
+	RunCommand(TEXT("diff"), InPathToGitBinary, InRepositoryRoot, DiffParametersLog, FilesToDiff, DiffResults, ErrorMessages);
+
+	// DiffResults is repo relative and we need to be
+	// in absolute so we can compare against FilesToSync
+	AbsoluteFilenames(InRepositoryRoot, DiffResults);
+
+	const TArray<FString> FilesToSync = DiffResults;
+
+	if (!FilesToSync.IsEmpty())
+	{
+		// Source control checkout is lock the file and mark for read.
+		FGitSourceControlModule* GitSourceControl = FGitSourceControlModule::GetThreadSafe();
+		if (!GitSourceControl)
+		{
+			return;
+		}
+		FGitSourceControlProvider& Provider = GitSourceControl->GetProvider();
+
+		TArray<FString> FilesToLock;
+		TArray<FString> UneditableAssets;
+
+		TArray<TSharedRef<ISourceControlState, ESPMode::ThreadSafe>> OutStates;
+		Provider.GetState(FilesToSync, OutStates, EStateCacheUsage::ForceUpdate);
+
+		FString FilePath;
+		for (const auto& SourceControlState : OutStates)
+		{
+			FilePath = SourceControlState->GetFilename();
+			if (SourceControlState->CanCheckout())
+			{
+				FilesToLock.Add(FilePath);
+			}
+			else if (!SourceControlState->IsCheckedOut())
+			{
+				UE_LOG(LogSourceControl, Warning, TEXT("File %s is not checked out, and cannot be checked out - failed to sync."), *FilePath);
+				UneditableAssets.Add(FilePath);
+			}
+		}
+
+		if (UneditableAssets.Num() != 0)
+		{
+			FString JoinedFiles = FString::Join(UneditableAssets, TEXT("\n"));
+			FMessageDialog::Open(EAppMsgCategory::Error, EAppMsgType::Ok, FText::Format(LOCTEXT("FailedBranchSync", "Failed to sync file from branch {0} because the following files cannot be checked out \n{1}"), { FText::FromString(BranchName), FText::FromString(JoinedFiles) }));
+			return;
+		}
+
+		Provider.Execute(ISourceControlOperation::Create<FCheckOut>(), FilesToLock);
+
+		const bool bOperationSuccess = USourceControlHelpers::ApplyOperationAndReloadPackages(FilesToSync,
+			[&InPathToGitBinary, &InRepositoryRoot, &BranchName, &FilesToSync](const TArray<FString>&)
+		{
+			// "checkout" in the context of git will download the file whereas "checkout"
+			// in the context of Unreal Engine/Perforce will add a lock and make it writable
+			TArray<FString> Results;
+			TArray<FString> Errors;
+			const FString GitCommand = TEXT("checkout");
+			bool bCommandSuccess = RunCommand(GitCommand, InPathToGitBinary, InRepositoryRoot, { BranchName, TEXT("--") }, FilesToSync, Results, Errors);
+
+			if (!bCommandSuccess)
+			{
+				UE_LOG(LogSourceControl, Error, TEXT("Git command %s failed"), *GitCommand);
+				for (const auto& Error : Errors)
+				{
+					UE_LOG(LogSourceControl, Error, TEXT("%s"), *Error);
+				}
+			}
+			return bCommandSuccess;
+		});
+
+		if (bOperationSuccess)
+		{
+			FText Message = FText::Format(LOCTEXT("SyncAssetsFromBranchSuccess", "Successfully reverted file(s) to match {0}"), FText::FromString(BranchName));
+			FMessageDialog::Open(EAppMsgCategory::Success, EAppMsgType::Ok, Message);
+		}
+		else
+		{
+			const FText Message = LOCTEXT("SyncAssetsFromBranchFailedGitCheckout", "Revert To Status Branch failed - git checkout failed. See the log for details and carefully review all files");
+			FMessageDialog::Open(EAppMsgCategory::Error, EAppMsgType::Ok, Message);
+		}
+	}
+	else
+	{
+		FMessageDialog::Open(EAppMsgCategory::Info, EAppMsgType::Ok, LOCTEXT("SyncAssetsFromBranchAssetsUnchanged", "Failed to sync files because the selected file(s) were unchanged"));
+	}
+}
+
+
 } // namespace GitSourceControlUtils
 
 #undef LOCTEXT_NAMESPACE

Source/GitSourceControl/Public/GitSourceControlUtils.h

@@ -387,4 +387,6 @@ bool PullOrigin(const FString& InPathToGitBinary, const FString& InPathToReposit
 
 GITSOURCECONTROL_API TSharedPtr< class ISourceControlRevision, ESPMode::ThreadSafe > GetOriginRevisionOnBranch( const FString & InPathToGitBinary, const FString & InRepositoryRoot, const FString & InRelativeFileName, TArray< FString > & OutErrorMessages, const FString & BranchName );
 
+void SyncAssetsFromBranch(const FString& InPathToGitBinary, const FString& InRepositoryRoot, const TArray<FAssetData>& SelectedAssets, const FString& BranchName);
+
 }