// Copyright Epic Games, Inc. All Rights Reserved. using AutomationTool; using EpicGames.BuildGraph; using System; using System.Collections.Generic; using System.IO.Compression; using System.Linq; using System.Text; using System.Threading.Tasks; using System.Xml; using EpicGames.Core; using UnrealBuildTool; using Microsoft.Extensions.Logging; using System.IO; namespace AutomationTool.Tasks { /// /// Parameters for a zip task /// public class ZipTaskParameters { /// /// The directory to read compressed files from. /// [TaskParameter] public DirectoryReference FromDir; /// /// List of file specifications separated by semicolons (for example, *.cpp;Engine/.../*.bat), or the name of a tag set. Relative paths are taken from FromDir. /// [TaskParameter(Optional = true, ValidationType = TaskParameterValidationType.FileSpec)] public string Files; /// /// List of files that should have an executable bit set. /// [TaskParameter(Optional = true, ValidationType = TaskParameterValidationType.FileSpec)] public string ExecutableFiles; /// /// The zip file to create. /// [TaskParameter] public FileReference ZipFile; /// /// Tag to be applied to the created zip file. /// [TaskParameter(Optional = true, ValidationType = TaskParameterValidationType.TagList)] public string Tag; } /// /// Compresses files into a zip archive. /// [TaskElement("Zip", typeof(ZipTaskParameters))] public class ZipTask : BgTaskImpl { /// /// Parameters for this task /// ZipTaskParameters Parameters; /// /// Constructor /// /// Parameters for this task public ZipTask(ZipTaskParameters 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) { // Find all the input files List Files; if(Parameters.Files == null) { Files = DirectoryReference.EnumerateFiles(Parameters.FromDir, "*", System.IO.SearchOption.AllDirectories).ToList(); } else { Files = ResolveFilespec(Parameters.FromDir, Parameters.Files, TagNameToFileSet).ToList(); } // Create the zip file Logger.LogInformation("Adding {NumFiles} files to {ZipFile}...", Files.Count, Parameters.ZipFile); HashSet ExecutableFiles = null; if (Parameters.ExecutableFiles != null) { ExecutableFiles = ResolveFilespec(Parameters.FromDir, Parameters.ExecutableFiles, TagNameToFileSet); foreach (FileReference ExecutableFile in Files.Intersect(ExecutableFiles)) { Logger.LogInformation(" Executable file: {File}", ExecutableFile); } } CommandUtils.ZipFiles(Parameters.ZipFile, Parameters.FromDir, Files, ExecutableFiles); // Apply the optional tag to the produced archive foreach (string TagName in FindTagNamesFromList(Parameters.Tag)) { FindOrAddTagSet(TagNameToFileSet, TagName).Add(Parameters.ZipFile); } // Add the archive to the set of build products BuildProducts.Add(Parameters.ZipFile); 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() { return FindTagNamesFromList(Parameters.Tag); } } }