// Copyright Epic Games, Inc. All Rights Reserved.
using EpicGames.BuildGraph;
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Text.RegularExpressions;
using System.Threading.Tasks;
using System.Xml;
using EpicGames.Core;
using UnrealBuildBase;
using UnrealBuildTool;
using Microsoft.Extensions.Logging;
using static AutomationTool.CommandUtils;
namespace AutomationTool.Tasks
{
///
/// Parameters for the submit task
///
public class SubmitTaskParameters
{
///
/// The description for the submitted changelist.
///
[TaskParameter]
public string Description;
///
/// The files to submit.
///
[TaskParameter(ValidationType = TaskParameterValidationType.FileSpec)]
public string Files;
///
/// The Perforce file type for the submitted files (for example, binary+FS32).
///
[TaskParameter(Optional = true)]
public string FileType;
///
/// The workspace name. If specified, a new workspace will be created using the given stream and root directory to submit the files. If not, the current workspace will be used.
///
[TaskParameter(Optional=true)]
public string Workspace;
///
/// The stream for the workspace -- defaults to the current stream. Ignored unless the Workspace attribute is also specified.
///
[TaskParameter(Optional = true)]
public string Stream;
///
/// Branch for the workspace (legacy P4 depot path). May not be used in conjunction with Stream.
///
[TaskParameter(Optional = true)]
public string Branch;
///
/// Root directory for the stream. If not specified, defaults to the current root directory.
///
[TaskParameter(Optional = true)]
public DirectoryReference RootDir;
///
/// Whether to revert unchanged files before attempting to submit.
///
[TaskParameter(Optional = true)]
public bool RevertUnchanged;
///
/// Force the submit to happen -- even if a resolve is needed (always accept current version).
///
[TaskParameter(Optional = true)]
public bool Force;
///
/// Allow verbose P4 output (spew).
///
[TaskParameter(Optional = true)]
public bool P4Verbose;
}
///
/// Creates a new changelist and submits a set of files to a Perforce stream.
///
[TaskElement("Submit", typeof(SubmitTaskParameters))]
public class SubmitTask : BgTaskImpl
{
///
/// Parameters for the task
///
SubmitTaskParameters Parameters;
///
/// Construct a version task
///
/// Parameters for this task
public SubmitTask(SubmitTaskParameters InParameters)
{
Parameters = InParameters;
}
///
/// Execute the task.
///
/// Information about the current job
/// Set of build products produced by this node.
/// Mapping from tag names to the set of files they include
public override Task ExecuteAsync(JobContext Job, HashSet BuildProducts, Dictionary> TagNameToFileSet)
{
HashSet Files = ResolveFilespec(Unreal.RootDirectory, Parameters.Files, TagNameToFileSet);
if (Files.Count == 0)
{
Logger.LogInformation("No files to submit.");
}
else if (!CommandUtils.AllowSubmit)
{
Logger.LogWarning("Submitting to Perforce is disabled by default. Run with the -submit argument to allow.");
}
else
{
try
{
// Get the connection that we're going to submit with
P4Connection SubmitP4 = CommandUtils.P4;
if (Parameters.Workspace != null)
{
// Create a brand new workspace
P4ClientInfo Client = new P4ClientInfo();
Client.Owner = CommandUtils.P4Env.User;
Client.Host = Unreal.MachineName;
Client.RootPath = Parameters.RootDir.FullName ?? Unreal.RootDirectory.FullName;
Client.Name = $"{Parameters.Workspace}_{Regex.Replace(Client.Host, "[^a-zA-Z0-9]", "-")}_{ContentHash.MD5((CommandUtils.P4Env.ServerAndPort ?? "").ToUpperInvariant())}";
Client.Options = P4ClientOption.NoAllWrite | P4ClientOption.Clobber | P4ClientOption.NoCompress | P4ClientOption.Unlocked | P4ClientOption.NoModTime | P4ClientOption.RmDir;
Client.LineEnd = P4LineEnd.Local;
if (!String.IsNullOrEmpty(Parameters.Branch))
{
Client.View.Add(new KeyValuePair($"{Parameters.Branch}/...", $"/..."));
}
else
{
Client.Stream = Parameters.Stream ?? CommandUtils.P4Env.Branch;
}
CommandUtils.P4.CreateClient(Client, AllowSpew: Parameters.P4Verbose);
// Create a new connection for it
SubmitP4 = new P4Connection(Client.Owner, Client.Name);
}
// Get the latest version of it
int NewCL = SubmitP4.CreateChange(Description: Parameters.Description.Replace("\\n", "\n"));
foreach(FileReference File in Files)
{
SubmitP4.Revert(String.Format("-k \"{0}\"", File.FullName), AllowSpew: Parameters.P4Verbose);
SubmitP4.Sync(String.Format("-k \"{0}\"", File.FullName), AllowSpew: Parameters.P4Verbose);
SubmitP4.Add(NewCL, String.Format("\"{0}\"", File.FullName));
SubmitP4.Edit(NewCL, String.Format("\"{0}\"", File.FullName), AllowSpew: Parameters.P4Verbose);
if (Parameters.FileType != null)
{
SubmitP4.P4(String.Format("reopen -t \"{0}\" \"{1}\"", Parameters.FileType, File.FullName), AllowSpew: Parameters.P4Verbose);
}
}
// Revert any unchanged files
if(Parameters.RevertUnchanged)
{
SubmitP4.RevertUnchanged(NewCL);
if(SubmitP4.TryDeleteEmptyChange(NewCL))
{
Logger.LogInformation("No files to submit; ignored.");
return Task.CompletedTask;
}
}
// Submit it
int SubmittedCL;
SubmitP4.Submit(NewCL, out SubmittedCL, Force: Parameters.Force);
if (SubmittedCL <= 0)
{
throw new AutomationException("Submit failed.");
}
Logger.LogInformation("Submitted in changelist {SubmittedCL}", SubmittedCL);
}
catch (P4Exception Ex)
{
Logger.LogError(KnownLogEvents.Systemic_Perforce, "{Message}", Ex.Message);
throw new AutomationException(Ex.ErrorCode, Ex, "{0}", Ex.Message) { OutputFormat = AutomationExceptionOutputFormat.Silent };
}
}
return Task.CompletedTask;
}
///
/// Output this task out to an XML writer.
///
public override void Write(XmlWriter Writer)
{
Write(Writer, Parameters);
}
///
/// Find all the tags which are used as inputs to this task
///
/// The tag names which are read by this task
public override IEnumerable FindConsumedTagNames()
{
return FindTagNamesFromFilespec(Parameters.Files);
}
///
/// Find all the tags which are modified by this task
///
/// The tag names which are modified by this task
public override IEnumerable FindProducedTagNames()
{
yield break;
}
}
}