// Copyright 1998-2019 Epic Games, Inc. All Rights Reserved. using System; using System.Collections; using System.Collections.Generic; using System.Diagnostics; using System.IO; using System.Net; using System.Runtime.Serialization; using System.Runtime.Serialization.Json; using System.Text; using System.Threading; using UnrealBuildTool; using System.Runtime.CompilerServices; using System.Linq; using System.Reflection; using System.Threading.Tasks; using Tools.DotNETCommon; using System.Xml; using System.Xml.Serialization; namespace AutomationTool { #region ParamList /// /// Wrapper around List with support for multi parameter constructor, i.e: /// var Maps = new ParamList("Map1", "Map2"); /// /// public class ParamList : List { public ParamList(params T[] Args) { AddRange(Args); } public ParamList(ICollection Collection) : base(Collection != null ? Collection : new T[] {}) { } public override string ToString() { var Text = ""; for (int Index = 0; Index < Count; ++Index) { if (Index > 0) { Text += ", "; } Text += this[Index].ToString(); } return Text; } } #endregion #region PathSeparator public enum PathSeparator { Default = 0, Slash, Backslash, Depot, Local } #endregion /// /// Base utility function for script commands. /// public partial class CommandUtils { #region Environment Setup static private CommandEnvironment CmdEnvironment; /// /// BuildEnvironment to use for this buildcommand. This is initialized by InitBuildEnvironment. As soon /// as the script execution in ExecuteBuild begins, the BuildEnv is set up and ready to use. /// static public CommandEnvironment CmdEnv { get { if (CmdEnvironment == null) { throw new AutomationException("Attempt to use CommandEnvironment before it was initialized."); } return CmdEnvironment; } } /// /// Initializes build environment. If the build command needs a specific env-var mapping or /// has an extended BuildEnvironment, it must implement this method accordingly. /// /// Initialized and ready to use BuildEnvironment static internal void InitCommandEnvironment() { CmdEnvironment = new CommandEnvironment(); } #endregion /// /// Returns true if AutomationTool is running using installed Engine components /// /// True if running using installed Engine components static public bool IsEngineInstalled() { if (!bIsEngineInstalled.HasValue) { bIsEngineInstalled = FileReference.Exists(FileReference.Combine(CommandUtils.EngineDirectory, "Build", "InstalledBuild.txt")); } return bIsEngineInstalled.Value; } static private bool? bIsEngineInstalled; #region Logging /// /// Writes formatted text to log (with LogEventType.Console). /// /// Format string /// Parameters [MethodImplAttribute(MethodImplOptions.NoInlining)] public static void LogInformation(string Format, params object[] Args) { Tools.DotNETCommon.Log.WriteLine(1, Tools.DotNETCommon.LogEventType.Console, Format, Args); } /// /// Writes formatted text to log (with LogEventType.Console). /// /// Text [MethodImplAttribute(MethodImplOptions.NoInlining)] public static void LogInformation(string Message) { Tools.DotNETCommon.Log.WriteLine(1, Tools.DotNETCommon.LogEventType.Console, Message); } /// /// Writes formatted text to log (with LogEventType.Error). /// /// Format string /// Parameters [MethodImplAttribute(MethodImplOptions.NoInlining)] public static void LogError(string Format, params object[] Args) { Tools.DotNETCommon.Log.WriteLine(1, Tools.DotNETCommon.LogEventType.Error, Format, Args); } /// /// Writes formatted text to log (with LogEventType.Error). /// /// Text [MethodImplAttribute(MethodImplOptions.NoInlining)] public static void LogError(string Message) { Tools.DotNETCommon.Log.WriteLine(1, Tools.DotNETCommon.LogEventType.Error, Message); } /// /// Writes formatted text to log (with LogEventType.Warning). /// /// Format string /// Parameters [MethodImplAttribute(MethodImplOptions.NoInlining)] public static void LogWarning(string Format, params object[] Args) { Tools.DotNETCommon.Log.WriteLine(1, Tools.DotNETCommon.LogEventType.Warning, Format, Args); } /// /// Writes a message to log (with LogEventType.Warning). /// /// Text [MethodImplAttribute(MethodImplOptions.NoInlining)] public static void LogWarning(string Message) { Tools.DotNETCommon.Log.WriteLine(1, Tools.DotNETCommon.LogEventType.Warning, Message); } /// /// Writes formatted text to log (with LogEventType.Verbose). /// /// Format string /// Arguments [MethodImplAttribute(MethodImplOptions.NoInlining)] public static void LogVerbose(string Format, params object[] Args) { Tools.DotNETCommon.Log.WriteLine(1, Tools.DotNETCommon.LogEventType.Verbose, Format, Args); } /// /// Writes formatted text to log (with LogEventType.Verbose). /// /// Text [MethodImplAttribute(MethodImplOptions.NoInlining)] public static void LogVerbose(string Message) { Tools.DotNETCommon.Log.WriteLine(1, Tools.DotNETCommon.LogEventType.Verbose, Message); } /// /// Writes formatted text to log (with LogEventType.VeryVerbose). /// /// Format string /// Arguments [MethodImplAttribute(MethodImplOptions.NoInlining)] public static void LogVeryVerbose(string Format, params object[] Args) { Tools.DotNETCommon.Log.WriteLine(1, Tools.DotNETCommon.LogEventType.VeryVerbose, Format, Args); } /// /// Writes formatted text to log (with LogEventType.VeryVerbose). /// /// Text [MethodImplAttribute(MethodImplOptions.NoInlining)] public static void LogVeryVerbose(string Message) { Tools.DotNETCommon.Log.WriteLine(1, Tools.DotNETCommon.LogEventType.VeryVerbose, Message); } /// /// Writes formatted text to log (with LogEventType.Log). /// /// Format string /// Arguments [MethodImplAttribute(MethodImplOptions.NoInlining)] public static void LogLog(string Format, params object[] Args) { Tools.DotNETCommon.Log.WriteLine(1, Tools.DotNETCommon.LogEventType.Log, Format, Args); } /// /// Writes formatted text to log (with LogEventType.Log). /// /// Text [MethodImplAttribute(MethodImplOptions.NoInlining)] public static void LogLog(string Message) { Tools.DotNETCommon.Log.WriteLine(1, LogEventType.Log, Message); } /// /// Writes formatted text to log. /// /// Verbosity /// Format string /// Arguments [MethodImplAttribute(MethodImplOptions.NoInlining)] public static void LogWithVerbosity(Tools.DotNETCommon.LogEventType Verbosity, string Format, params object[] Args) { Tools.DotNETCommon.Log.WriteLine(1, Verbosity, Format, Args); } /// /// Writes formatted text to log. /// /// Verbosity /// Text [MethodImplAttribute(MethodImplOptions.NoInlining)] public static void LogWithVerbosity(Tools.DotNETCommon.LogEventType Verbosity, string Message) { Tools.DotNETCommon.Log.WriteLine(1, Verbosity, Message); } /// /// Dumps exception to log. /// /// Verbosity /// Exception [MethodImplAttribute(MethodImplOptions.NoInlining)] public static void LogWithVerbosity(Tools.DotNETCommon.LogEventType Verbosity, Exception Ex) { Tools.DotNETCommon.Log.WriteLine(1, Verbosity, LogUtils.FormatException(Ex)); } #endregion #region Progress Logging public static void LogPushProgress(bool bShowProgress, int Numerator, int Denominator) { if(bShowProgress) { LogInformation("[@progress push {0}/{1} skipline]", Numerator, Denominator); } } public static void LogPopProgress(bool bShowProgress) { if(bShowProgress) { LogInformation("[@progress pop skipline]"); } } public static void LogIncrementProgress(bool bShowProgress, int Numerator, int Denominator) { if(bShowProgress) { LogInformation("[@progress increment {0}/{1} skipline]", Numerator, Denominator); } } public static void LogSetProgress(bool bShowProgress, string Format, params string[] Args) { if(bShowProgress) { LogInformation("[@progress '{0}' skipline]", String.Format(Format, Args)); } } public static void LogSetProgress(bool bShowProgress, int Numerator, int Denominator, string Format, params string[] Args) { if(bShowProgress) { LogInformation("[@progress {0}/{1} '{2}' skipline]", Numerator, Denominator, String.Format(Format, Args)); } } #endregion #region IO /// /// Finds files in specified paths. /// /// Pattern /// Recursive search /// Paths to search /// An array of files found in the specified paths public static string[] FindFiles(string SearchPattern, bool Recursive, string PathToSearch) { List FoundFiles = new List(); var NormalizedPath = ConvertSeparators(PathSeparator.Default, PathToSearch); if (DirectoryExists(NormalizedPath)) { var FoundInPath = InternalUtils.SafeFindFiles(NormalizedPath, SearchPattern, Recursive); if (FoundInPath == null) { throw new AutomationException(String.Format("Failed to find files in '{0}'", NormalizedPath)); } FoundFiles.AddRange(FoundInPath); } return FoundFiles.ToArray(); } /// /// Finds files in specified paths. /// /// Pattern /// Recursive search /// Paths to search /// An array of files found in the specified paths public static FileReference[] FindFiles(string SearchPattern, bool Recursive, DirectoryReference PathToSearch) { return FindFiles(SearchPattern, Recursive, PathToSearch.FullName).Select(x => new FileReference(x)).ToArray(); } /// /// Finds files in specified paths. /// /// Pattern /// Recursive search /// Paths to search /// An array of files found in the specified paths public static string[] FindFiles_NoExceptions(string SearchPattern, bool Recursive, string PathToSearch) { List FoundFiles = new List(); var NormalizedPath = ConvertSeparators(PathSeparator.Default, PathToSearch); if (DirectoryExists(NormalizedPath)) { var FoundInPath = InternalUtils.SafeFindFiles(NormalizedPath, SearchPattern, Recursive); if (FoundInPath != null) { FoundFiles.AddRange(FoundInPath); } } return FoundFiles.ToArray(); } /// /// Finds files in specified paths. /// /// When true, logging is suppressed. /// Pattern /// Recursive search /// Paths to search /// An array of files found in the specified paths public static string[] FindFiles_NoExceptions(bool bQuiet, string SearchPattern, bool Recursive, string PathToSearch) { List FoundFiles = new List(); var NormalizedPath = ConvertSeparators(PathSeparator.Default, PathToSearch); if (DirectoryExists(NormalizedPath)) { var FoundInPath = InternalUtils.SafeFindFiles(NormalizedPath, SearchPattern, Recursive, bQuiet); if (FoundInPath != null) { FoundFiles.AddRange(FoundInPath); } } return FoundFiles.ToArray(); } /// /// Finds files in specified paths. /// /// When true, logging is suppressed. /// Pattern /// Recursive search /// Paths to search /// An array of files found in the specified paths public static string[] FindDirectories(bool bQuiet, string SearchPattern, bool Recursive, string PathToSearch) { List FoundDirs = new List(); var NormalizedPath = ConvertSeparators(PathSeparator.Default, PathToSearch); if (DirectoryExists(NormalizedPath)) { var FoundInPath = InternalUtils.SafeFindDirectories(NormalizedPath, SearchPattern, Recursive, bQuiet); if (FoundInPath == null) { throw new AutomationException(String.Format("Failed to find directories in '{0}'", NormalizedPath)); } FoundDirs.AddRange(FoundInPath); } return FoundDirs.ToArray(); } /// /// Finds Directories in specified paths. /// /// When true, logging is suppressed. /// Pattern /// Recursive search /// Paths to search /// An array of files found in the specified paths public static string[] FindDirectories_NoExceptions(bool bQuiet, string SearchPattern, bool Recursive, string PathToSearch) { List FoundDirs = new List(); var NormalizedPath = ConvertSeparators(PathSeparator.Default, PathToSearch); if (DirectoryExists(NormalizedPath)) { var FoundInPath = InternalUtils.SafeFindDirectories(NormalizedPath, SearchPattern, Recursive, bQuiet); if (FoundInPath != null) { FoundDirs.AddRange(FoundInPath); } } return FoundDirs.ToArray(); } /// /// Deletes a file(s). /// If the file does not exist, silently succeeds. /// If the deletion of the file fails, this function throws an Exception. /// /// Filename public static void DeleteFile(string FileName) { var NormalizedFilename = ConvertSeparators(PathSeparator.Default, FileName); if (!InternalUtils.SafeDeleteFile(NormalizedFilename)) { throw new AutomationException(String.Format("Failed to delete file '{0}'", NormalizedFilename)); } } /// /// Deletes a file(s). /// If the file does not exist, silently succeeds. /// If the deletion of the file fails, this function throws an Exception. /// /// Filename public static void DeleteFile(FileReference FileName) { DeleteFile(FileName.FullName); } /// /// Deletes a file(s). /// If the file does not exist, silently succeeds. /// If the deletion of the file fails, this function throws an Exception. /// /// When true, logging is suppressed. /// Filename public static void DeleteFile(bool bQuiet, string FileName) { var NormalizedFilename = ConvertSeparators(PathSeparator.Default, FileName); if (!InternalUtils.SafeDeleteFile(NormalizedFilename, bQuiet)) { throw new AutomationException(String.Format("Failed to delete file '{0}'", NormalizedFilename)); } } /// /// Deletes a file(s). /// If the deletion of the file fails, prints a warning. /// /// Filename public static bool DeleteFile_NoExceptions(string FileName) { bool Result = true; var NormalizedFilename = ConvertSeparators(PathSeparator.Default, FileName); if (!InternalUtils.SafeDeleteFile(NormalizedFilename)) { LogWarning("Failed to delete file '{0}'", NormalizedFilename); Result = false; } return Result; } /// /// Deletes a file(s). /// If the deletion of the file fails, prints a warning. /// /// Filename /// if true, then don't retry and don't print much. public static bool DeleteFile_NoExceptions(string Filename, bool bQuiet = false) { bool Result = true; var NormalizedFilename = ConvertSeparators(PathSeparator.Default, Filename); if (!InternalUtils.SafeDeleteFile(NormalizedFilename, bQuiet)) { LogWithVerbosity(bQuiet ? LogEventType.Log : LogEventType.Warning, "Failed to delete file '{0}'", NormalizedFilename); Result = false; } return Result; } /// /// Deletes a directory(or directories) including its contents (recursively, will delete read-only files). /// If the deletion of the directory fails, this function throws an Exception. /// /// Suppresses log output if true /// Directories public static void DeleteDirectory(bool bQuiet, string Directory) { var NormalizedDirectory = ConvertSeparators(PathSeparator.Default, Directory); if (!InternalUtils.SafeDeleteDirectory(NormalizedDirectory, bQuiet)) { throw new AutomationException(String.Format("Failed to delete directory '{0}'", NormalizedDirectory)); } } /// /// Deletes a directory(or directories) including its contents (recursively, will delete read-only files). /// If the deletion of the directory fails, this function throws an Exception. /// /// Directories public static void DeleteDirectory(string Directory) { DeleteDirectory(false, Directory); } /// /// Deletes a directory(or directories) including its contents (recursively, will delete read-only files). /// If the deletion of the directory fails, this function throws an Exception. /// /// Directories public static void DeleteDirectory(DirectoryReference Directory) { DeleteDirectory(Directory.FullName); } /// /// Deletes a directory(or directories) including its contents (recursively, will delete read-only files). /// If the deletion of the directory fails, prints a warning. /// /// Suppresses log output if true /// Directories public static bool DeleteDirectory_NoExceptions(bool bQuiet, string Directory) { bool Result = true; var NormalizedDirectory = ConvertSeparators(PathSeparator.Default, Directory); try { if (!InternalUtils.SafeDeleteDirectory(NormalizedDirectory, bQuiet)) { LogWarning("Failed to delete directory '{0}'", NormalizedDirectory); Result = false; } } catch (Exception Ex) { if (!bQuiet) { LogWarning("Failed to delete directory, exception '{0}'", NormalizedDirectory); LogWarning(Ex.Message); } Result = false; } return Result; } /// /// Deletes a directory(or directories) including its contents (recursively, will delete read-only files). /// If the deletion of the directory fails, prints a warning. /// /// Directories public static bool DeleteDirectory_NoExceptions(string DirectoryName) { return DeleteDirectory_NoExceptions(false, DirectoryName); } /// /// Attempts to delete a directory, if that fails deletes all files and folder from the specified directory. /// This works around the issue when the user has a file open in a notepad from that directory. Somehow deleting the file works but /// deleting the directory with the file that's open, doesn't. /// /// public static void DeleteDirectoryContents(string DirectoryName) { LogVerbose("DeleteDirectoryContents({0})", DirectoryName); const bool bQuiet = true; var Files = CommandUtils.FindFiles_NoExceptions(bQuiet, "*", false, DirectoryName); foreach (var Filename in Files) { CommandUtils.DeleteFile_NoExceptions(Filename); } var Directories = CommandUtils.FindDirectories_NoExceptions(bQuiet, "*", false, DirectoryName); foreach (var SubDirectoryName in Directories) { CommandUtils.DeleteDirectory_NoExceptions(bQuiet, SubDirectoryName); } } /// /// Attempts to delete a directory, if that fails deletes all files and folder from the specified directory. /// This works around the issue when the user has a file open in a notepad from that directory. Somehow deleting the file works but /// deleting the directory with the file that's open, doesn't. /// /// public static void DeleteDirectoryContents(DirectoryReference DirectoryName) { DeleteDirectoryContents(DirectoryName.FullName); } /// /// Checks if a directory(or directories) exists. /// /// Directories /// True if the directory exists, false otherwise. public static bool DirectoryExists(string DirectoryName) { var NormalizedDirectory = ConvertSeparators(PathSeparator.Default, DirectoryName); return System.IO.Directory.Exists(NormalizedDirectory); } /// /// Checks if a directory(or directories) exists. /// /// Directories /// True if the directory exists, false otherwise. public static bool DirectoryExists_NoExceptions(string DirectoryName) { var NormalizedDirectory = ConvertSeparators(PathSeparator.Default, DirectoryName); try { return System.IO.Directory.Exists(NormalizedDirectory); } catch (Exception Ex) { LogWarning("Unable to check if directory exists: {0}", NormalizedDirectory); LogWarning(Ex.Message); return false; } } /// /// Creates a directory. Throws an exception on failure. /// /// Name of the directory to create public static void CreateDirectory(string DirectoryName) { string NormalizedDirectory = ConvertSeparators(PathSeparator.Default, DirectoryName); try { Directory.CreateDirectory(DirectoryName); } catch (Exception Ex) { throw new AutomationException(Ex, "Failed to create directory '{0}'", NormalizedDirectory); } } /// /// Creates a directory. Throws an exception on failure. /// /// Name of the directory to create public static void CreateDirectory(DirectoryReference Location) { CreateDirectory(Location.FullName); } /// /// Renames/moves a file. /// If the rename of the file fails, this function throws an Exception. /// /// When true, logging is suppressed. /// Old name /// new name public static void RenameFile(string OldName, string NewName, bool bQuiet = false) { var OldNormalized = ConvertSeparators(PathSeparator.Default, OldName); var NewNormalized = ConvertSeparators(PathSeparator.Default, NewName); if (!InternalUtils.SafeRenameFile(OldNormalized, NewNormalized, bQuiet)) { throw new AutomationException(String.Format("Failed to rename/move file '{0}' to '{1}'", OldNormalized, NewNormalized)); } } /// /// Renames/moves a file. /// If the rename of the file fails, this function prints a warning. /// /// Old name /// new name public static bool RenameFile_NoExceptions(string OldName, string NewName) { var OldNormalized = ConvertSeparators(PathSeparator.Default, OldName); var NewNormalized = ConvertSeparators(PathSeparator.Default, NewName); var Result = InternalUtils.SafeRenameFile(OldNormalized, NewNormalized); if (!Result) { LogWarning("Failed to rename/move file '{0}' to '{1}'", OldName, NewName); } return Result; } /// /// Checks if a file(s) exists. /// /// Filename. /// True if the file exists, false otherwise. public static bool FileExists(string FileName) { var NormalizedFilename = ConvertSeparators(PathSeparator.Default, FileName); return InternalUtils.SafeFileExists(NormalizedFilename); } /// /// Checks if a file(s) exists. /// /// Filename. /// True if the file exists, false otherwise. public static bool FileExists_NoExceptions(string FileName) { // Standard version doesn't throw, but keep this function for consistency. return FileExists(FileName); } /// /// Checks if a file(s) exists. /// /// When true, logging is suppressed. /// Filename. /// True if the file exists, false otherwise. public static bool FileExists(bool bQuiet, string FileName) { var NormalizedFilename = ConvertSeparators(PathSeparator.Default, FileName); return InternalUtils.SafeFileExists(NormalizedFilename, bQuiet); } /// /// Checks if a file(s) exists. /// /// When true, logging is suppressed. /// Filename. /// True if the file exists, false otherwise. public static bool FileExists_NoExceptions(bool bQuiet, string FileName) { // Standard version doesn't throw, but keep this function for consistency. return FileExists(bQuiet, FileName); } static Stack WorkingDirectoryStack = new Stack(); /// /// Pushes the current working directory onto a stack and sets CWD to a new value. /// /// New working direcotry. public static void PushDir(string WorkingDirectory) { string OrigCurrentDirectory = Environment.CurrentDirectory; WorkingDirectory = ConvertSeparators(PathSeparator.Default, WorkingDirectory); try { Environment.CurrentDirectory = WorkingDirectory; } catch (Exception Ex) { throw new AutomationException(Ex, "Unable to change current directory to {0}", WorkingDirectory); } WorkingDirectoryStack.Push(OrigCurrentDirectory); } /// /// Pushes the current working directory onto a stack and sets CWD to a new value. /// /// New working direcotry. public static bool PushDir_NoExceptions(string WorkingDirectory) { bool Result = true; string OrigCurrentDirectory = Environment.CurrentDirectory; WorkingDirectory = ConvertSeparators(PathSeparator.Default, WorkingDirectory); try { Environment.CurrentDirectory = WorkingDirectory; WorkingDirectoryStack.Push(OrigCurrentDirectory); } catch { LogWarning("Unable to change current directory to {0}", WorkingDirectory); Result = false; } return Result; } /// /// Pops the last working directory from a stack and sets it as the current working directory. /// public static void PopDir() { if (WorkingDirectoryStack.Count > 0) { Environment.CurrentDirectory = WorkingDirectoryStack.Pop(); } else { throw new AutomationException("Unable to PopDir. WorkingDirectoryStack is empty."); } } /// /// Pops the last working directory from a stack and sets it as the current working directory. /// public static bool PopDir_NoExceptions() { bool Result = true; if (WorkingDirectoryStack.Count > 0) { Environment.CurrentDirectory = WorkingDirectoryStack.Pop(); } else { LogWarning("Unable to PopDir. WorkingDirectoryStack is empty."); Result = false; } return Result; } /// /// Clears the directory stack /// public static void ClearDirStack() { while (WorkingDirectoryStack.Count > 0) { PopDir(); } } /// /// Changes the current working directory. /// /// New working directory. public static void ChDir(string WorkingDirectory) { WorkingDirectory = ConvertSeparators(PathSeparator.Default, WorkingDirectory); try { Environment.CurrentDirectory = WorkingDirectory; } catch (Exception Ex) { throw new ArgumentException(String.Format("Unable to change current directory to {0}", WorkingDirectory), Ex); } } /// /// Changes the current working directory. /// /// New working directory. public static bool ChDir_NoExceptions(string WorkingDirectory) { bool Result = true; WorkingDirectory = ConvertSeparators(PathSeparator.Default, WorkingDirectory); try { Environment.CurrentDirectory = WorkingDirectory; } catch { LogWarning("Unable to change current directory to {0}", WorkingDirectory); Result = false; } return Result; } /// /// Updates a file with the specified modified and access date, creating the file if it does not already exist. /// An exception will be thrown if the directory does not already exist. /// /// The filename to touch, will be created if it does not exist. /// The accessed and modified date to set. If not specified, defaults to the current date and time. public static void TouchFile(string Filename, DateTime? UtcDate = null) { var Date = UtcDate ?? DateTime.UtcNow; Filename = ConvertSeparators(PathSeparator.Slash, Filename); if (!File.Exists(Filename)) { var Dir = GetDirectoryName(Filename); if (!DirectoryExists_NoExceptions(Dir)) { throw new AutomationException(new DirectoryNotFoundException("Directory not found: " + Dir), "Unable to create file {0} as directory does not exist.", Filename); } File.Create(Filename).Dispose(); } File.SetLastAccessTimeUtc(Filename, Date); File.SetLastWriteTimeUtc(Filename, Date); } /// /// Determines whether the given file is read-only /// /// Filename /// True if the file is read-only public static bool IsReadOnly(string Filename) { Filename = ConvertSeparators(PathSeparator.Default, Filename); if (!File.Exists(Filename)) { throw new AutomationException(new FileNotFoundException("File not found.", Filename), "Unable to set attributes for a non-existing file."); } FileAttributes Attributes = File.GetAttributes(Filename); return (Attributes & FileAttributes.ReadOnly) != 0; } /// /// Sets file attributes. Will not change attributes that have not been specified. /// /// Filename /// Read-only attribute /// Hidden attribute. /// Archive attribute. public static void SetFileAttributes(string Filename, bool? ReadOnly = null, bool? Hidden = null, bool? Archive = null) { Filename = ConvertSeparators(PathSeparator.Default, Filename); if (!File.Exists(Filename)) { throw new AutomationException(new FileNotFoundException("File not found.", Filename), "Unable to set attributes for a non-existing file."); } FileAttributes Attributes = File.GetAttributes(Filename); Attributes = InternalSetAttributes(ReadOnly, Hidden, Archive, Attributes); File.SetAttributes(Filename, Attributes); } /// /// Sets file attributes. Will not change attributes that have not been specified. /// /// Filename /// Read-only attribute /// Hidden attribute. /// Archive attribute. public static bool SetFileAttributes_NoExceptions(string Filename, bool? ReadOnly = null, bool? Hidden = null, bool? Archive = null) { Filename = ConvertSeparators(PathSeparator.Default, Filename); if (!File.Exists(Filename)) { LogWarning("Unable to set attributes for a non-exisiting file ({0})", Filename); return false; } bool Result = true; try { FileAttributes Attributes = File.GetAttributes(Filename); Attributes = InternalSetAttributes(ReadOnly, Hidden, Archive, Attributes); File.SetAttributes(Filename, Attributes); } catch (Exception Ex) { LogWarning("Error trying to set file attributes for: {0}", Filename); LogWarning(Ex.Message); Result = false; } return Result; } private static FileAttributes InternalSetAttributes(bool? ReadOnly, bool? Hidden, bool? Archive, FileAttributes Attributes) { if (ReadOnly != null) { if ((bool)ReadOnly) { Attributes |= FileAttributes.ReadOnly; } else { Attributes &= ~FileAttributes.ReadOnly; } } if (Hidden != null) { if ((bool)Hidden) { Attributes |= FileAttributes.Hidden; } else { Attributes &= ~FileAttributes.Hidden; } } if (Archive != null) { if ((bool)Archive) { Attributes |= FileAttributes.Archive; } else { Attributes &= ~FileAttributes.Archive; } } return Attributes; } /// /// Writes a line of formatted string to a file. Creates the file if it does not exists. /// If the file does exists, appends a new line. /// /// Filename /// Text to write public static void WriteToFile(string Filename, string Text) { Filename = ConvertSeparators(PathSeparator.Default, Filename); try { File.AppendAllText(Filename, Text + Environment.NewLine); } catch (Exception Ex) { throw new AutomationException(Ex, "Failed to Write to file {0}", Filename); } } /// /// Reads all text lines from a file. /// /// Filename /// Array of lines of text read from the file. null if the file did not exist or could not be read. public static string[] ReadAllLines(string Filename) { Filename = ConvertSeparators(PathSeparator.Default, Filename); return InternalUtils.SafeReadAllLines(Filename); } /// /// Reads all text from a file. /// /// Filename /// All text read from the file. null if the file did not exist or could not be read. public static string ReadAllText(string Filename) { Filename = ConvertSeparators(PathSeparator.Default, Filename); return InternalUtils.SafeReadAllText(Filename); } /// /// Writes lines to a file. /// /// Filename /// Text public static void WriteAllLines(string Filename, string[] Lines) { Filename = ConvertSeparators(PathSeparator.Default, Filename); if (!InternalUtils.SafeWriteAllLines(Filename, Lines)) { throw new AutomationException("Unable to write to file: {0}", Filename); } } /// /// Writes lines to a file. /// /// Filename /// Text public static bool WriteAllLines_NoExceptions(string Filename, string[] Lines) { Filename = ConvertSeparators(PathSeparator.Default, Filename); return InternalUtils.SafeWriteAllLines(Filename, Lines); } /// /// Writes text to a file. /// /// Filename /// Text public static void WriteAllText(string Filename, string Text) { Filename = ConvertSeparators(PathSeparator.Default, Filename); if (!InternalUtils.SafeWriteAllText(Filename, Text)) { throw new AutomationException("Unable to write to file: {0}", Filename); } } /// /// Writes text to a file. /// /// Filename /// Text public static bool WriteAllText_NoExceptions(string Filename, string Text) { Filename = ConvertSeparators(PathSeparator.Default, Filename); return InternalUtils.SafeWriteAllText(Filename, Text); } /// /// Writes byte array to a file. /// /// Filename /// Byte array public static void WriteAllBytes(string Filename, byte[] Bytes) { Filename = ConvertSeparators(PathSeparator.Default, Filename); if (!InternalUtils.SafeWriteAllBytes(Filename, Bytes)) { throw new AutomationException("Unable to write to file: {0}", Filename); } } /// /// Writes byte array to a file. /// /// Filename /// Byte array public static bool WriteAllBytes_NoExceptions(string Filename, byte[] Bytes) { Filename = ConvertSeparators(PathSeparator.Default, Filename); return InternalUtils.SafeWriteAllBytes(Filename, Bytes); } /// /// Gets a character representing the specified separator type. /// /// Separator type. /// Separator character public static char GetPathSeparatorChar(PathSeparator SeparatorType) { char Separator; switch (SeparatorType) { case PathSeparator.Slash: case PathSeparator.Depot: Separator = '/'; break; case PathSeparator.Backslash: Separator = '\\'; break; default: Separator = Path.DirectorySeparatorChar; break; } return Separator; } /// /// Checks if the character is one of the two sperator types ('\' or '/') /// /// Character to check. /// True if the character is a separator, false otherwise. public static bool IsPathSeparator(char Character) { return (Character == '/' || Character == '\\'); } /// /// Combines paths and replaces all path separators with the system default separator. /// /// /// Combined Path public static string CombinePaths(params string[] Paths) { return CombinePaths(PathSeparator.Default, Paths); } /// /// Combines paths and replaces all path separators wth the system specified separator. /// /// Type of separartor to use when combining paths. /// /// Combined Path public static string CombinePaths(PathSeparator SeparatorType, params string[] Paths) { // Pick a separator to use. var SeparatorToUse = GetPathSeparatorChar(SeparatorType); var SeparatorToReplace = SeparatorToUse == '/' ? '\\' : '/'; // Allocate string builder int CombinePathMaxLength = 0; foreach (var PathPart in Paths) { CombinePathMaxLength += (PathPart != null) ? PathPart.Length : 0; } CombinePathMaxLength += Paths.Length; var CombinedPath = new StringBuilder(CombinePathMaxLength); // Combine all paths CombinedPath.Append(Paths[0]); for (int PathIndex = 1; PathIndex < Paths.Length; ++PathIndex) { var NextPath = Paths[PathIndex]; if (String.IsNullOrEmpty(NextPath) == false) { int NextPathStartIndex = 0; if (CombinedPath.Length != 0) { var LastChar = CombinedPath[CombinedPath.Length - 1]; var NextChar = NextPath[0]; var IsLastCharPathSeparator = IsPathSeparator(LastChar); var IsNextCharPathSeparator = IsPathSeparator(NextChar); // Check if a separator between paths is required if (!IsLastCharPathSeparator && !IsNextCharPathSeparator) { CombinedPath.Append(SeparatorToUse); } // Check if one of the saprators needs to be skipped. else if (IsLastCharPathSeparator && IsNextCharPathSeparator) { NextPathStartIndex = 1; } } CombinedPath.Append(NextPath, NextPathStartIndex, NextPath.Length - NextPathStartIndex); } } // Make sure there's only one separator type used. CombinedPath.Replace(SeparatorToReplace, SeparatorToUse); return CombinedPath.ToString(); } /// /// Converts all separators in path to the specified separator type. /// /// Desired separator type. /// Path /// Path where all separators have been converted to the specified type. public static string ConvertSeparators(PathSeparator ToSperatorType, string PathToConvert) { return CombinePaths(ToSperatorType, PathToConvert); } /// /// Copies a file, throwing an exception on failure. /// /// /// /// When true, logging is suppressed. public static void CopyFile(string Source, string Dest, bool bQuiet = false) { Source = ConvertSeparators(PathSeparator.Default, Source); Dest = ConvertSeparators(PathSeparator.Default, Dest); String DestDirName = ""; try { DestDirName = Path.GetDirectoryName(Dest); } catch (Exception Ex) { throw new AutomationException(String.Format("Failed to get directory name for dest: {0}, {1}", Dest, Ex.Message)); } if (InternalUtils.SafeFileExists(Dest, true)) { InternalUtils.SafeDeleteFile(Dest, bQuiet); } else if (!InternalUtils.SafeDirectoryExists(DestDirName, true)) { if (!InternalUtils.SafeCreateDirectory(DestDirName, bQuiet)) { throw new AutomationException("Failed to create directory {0} for copy", DestDirName); } } if (InternalUtils.SafeFileExists(Dest, true)) { throw new AutomationException("Failed to delete {0} for copy", Dest); } if (!InternalUtils.SafeCopyFile(Source, Dest, bQuiet)) { throw new AutomationException("Failed to copy {0} to {1}", Source, Dest); } } /// /// Copies a file. Does not throw exceptions. /// /// /// /// When true, logging is suppressed. /// True if the operation was successful, false otherwise. public static bool CopyFile_NoExceptions(string Source, string Dest, bool bQuiet = false) { Source = ConvertSeparators(PathSeparator.Default, Source); Dest = ConvertSeparators(PathSeparator.Default, Dest); if (InternalUtils.SafeFileExists(Dest, true)) { InternalUtils.SafeDeleteFile(Dest, bQuiet); } else if (!InternalUtils.SafeDirectoryExists(Path.GetDirectoryName(Dest), true)) { if (!InternalUtils.SafeCreateDirectory(Path.GetDirectoryName(Dest))) { return false; } } if (InternalUtils.SafeFileExists(Dest, true)) { return false; } return InternalUtils.SafeCopyFile(Source, Dest, bQuiet); } /// /// Checks if the given target file is up to date with the source file (ie. it exists, and the timestamp matches) /// /// The target file to check /// The source file to check /// True if the files have the same timestamp, false otherwise. public static bool IsTargetFileUpToDate(FileReference Target, FileReference Source) { if(FileReference.Exists(Target)) { TimeSpan Diff = FileReference.GetLastWriteTimeUtc(Target) - FileReference.GetLastWriteTimeUtc(Source); if (Math.Abs(Diff.TotalSeconds) < 1) { return true; } } return false; } /// /// Copies a file if the dest doesn't exist or (optionally) if the dest timestamp is different; after a copy, copies the timestamp /// /// The full path to the source file /// The full path to the destination file /// If true, will always skip a file if the destination exists, even if timestamp differs; defaults to false /// True if the operation was successful, false otherwise. public static void CopyFileIncremental(FileReference Source, FileReference Dest, bool bAllowDifferingTimestamps = false, bool bFilterSpecialLinesFromIniFiles = false) { if (InternalUtils.SafeFileExists(Dest.FullName, true)) { if (bAllowDifferingTimestamps == true) { LogVerbose("CopyFileIncremental Skipping {0}, already exists", Dest); return; } TimeSpan Diff = File.GetLastWriteTimeUtc(Dest.FullName) - File.GetLastWriteTimeUtc(Source.FullName); if (Diff.TotalSeconds > -1 && Diff.TotalSeconds < 1) { LogVerbose("CopyFileIncremental Skipping {0}, up to date.", Dest); return; } InternalUtils.SafeDeleteFile(Dest.FullName); } else if (!InternalUtils.SafeDirectoryExists(Path.GetDirectoryName(Dest.FullName), true)) { if (!InternalUtils.SafeCreateDirectory(Path.GetDirectoryName(Dest.FullName))) { throw new AutomationException("Failed to create directory {0} for copy", Path.GetDirectoryName(Dest.FullName)); } } if (InternalUtils.SafeFileExists(Dest.FullName, true)) { throw new AutomationException("Failed to delete {0} for copy", Dest); } if (!InternalUtils.SafeCopyFile(Source.FullName, Dest.FullName, bFilterSpecialLinesFromIniFiles:bFilterSpecialLinesFromIniFiles)) { throw new AutomationException("Failed to copy {0} to {1}", Source, Dest); } FileAttributes Attributes = File.GetAttributes(Dest.FullName); if ((Attributes & FileAttributes.ReadOnly) != 0) { File.SetAttributes(Dest.FullName, Attributes & ~FileAttributes.ReadOnly); } File.SetLastWriteTimeUtc(Dest.FullName, File.GetLastWriteTimeUtc(Source.FullName)); } /// /// Copies a directory and all of it's contents recursively. Does not throw exceptions. /// /// /// /// When true, logging is suppressed. /// True if the operation was successful, false otherwise. public static bool CopyDirectory_NoExceptions(string Source, string Dest, bool bQuiet = false) { Source = ConvertSeparators(PathSeparator.Default, Source); Dest = ConvertSeparators(PathSeparator.Default, Dest); Dest = Dest.TrimEnd(new char[] { Path.DirectorySeparatorChar, Path.AltDirectorySeparatorChar }); if (InternalUtils.SafeDirectoryExists(Dest)) { InternalUtils.SafeDeleteDirectory(Dest, bQuiet); if (InternalUtils.SafeDirectoryExists(Dest, true)) { return false; } } if (!InternalUtils.SafeCreateDirectory(Dest, bQuiet)) { return false; } foreach (var SourceSubDirectory in Directory.GetDirectories(Source)) { string DestPath = Dest + GetPathSeparatorChar(PathSeparator.Default) + GetLastDirectoryName(SourceSubDirectory + GetPathSeparatorChar(PathSeparator.Default)); if (!CopyDirectory_NoExceptions(SourceSubDirectory, DestPath, bQuiet)) { return false; } } foreach (var SourceFile in Directory.GetFiles(Source)) { int FilenameStart = SourceFile.LastIndexOf(GetPathSeparatorChar(PathSeparator.Default)); string DestPath = Dest + SourceFile.Substring(FilenameStart); if (!CopyFile_NoExceptions(SourceFile, DestPath, bQuiet)) { return false; } } return true; } /// /// Returns directory name without filename. /// The difference between this and Path.GetDirectoryName is that this /// function will not throw away the last name if it doesn't have an extension, for example: /// D:\Project\Data\Asset -> D:\Project\Data\Asset /// D:\Project\Data\Asset.ussset -> D:\Project\Data /// /// /// public static string GetDirectoryName(string FilePath) { var LastSeparatorIndex = Math.Max(FilePath.LastIndexOf('/'), FilePath.LastIndexOf('\\')); var ExtensionIndex = FilePath.LastIndexOf('.'); if (ExtensionIndex > LastSeparatorIndex || LastSeparatorIndex == (FilePath.Length - 1)) { return FilePath.Substring(0, LastSeparatorIndex); } else { return FilePath; } } /// /// Returns the last directory name in the path string. /// For example: D:\Temp\Project\File.txt -> Project, Data\Samples -> Samples /// /// /// public static string GetLastDirectoryName(string FilePath) { var LastDir = GetDirectoryName(FilePath); var LastSeparatorIndex = Math.Max(LastDir.LastIndexOf('/'), LastDir.LastIndexOf('\\')); if (LastSeparatorIndex >= 0) { LastDir = LastDir.Substring(LastSeparatorIndex + 1); } return LastDir; } /// /// Removes multi-dot extensions from a filename (i.e. *.automation.csproj) /// /// Filename to remove the extensions from /// Clean filename. public static string GetFilenameWithoutAnyExtensions(string Filename) { do { Filename = Path.GetFileNameWithoutExtension(Filename); } while (Filename.IndexOf('.') >= 0); return Filename; } /// /// Reads a file manifest and returns it /// /// ManifestName /// public static BuildManifest ReadManifest(FileReference ManifestFile) { // Create a new default instance of the type BuildManifest Instance = new UnrealBuildTool.BuildManifest(); XmlReader XmlStream = null; try { // Use the default reader settings if none are passed in XmlReaderSettings ReaderSettings = new XmlReaderSettings(); ReaderSettings.CloseInput = true; ReaderSettings.IgnoreComments = true; // Get the xml data stream to read from XmlStream = XmlReader.Create( ManifestFile.FullName, ReaderSettings ); // Creates an instance of the XmlSerializer class so we can read the settings object XmlSerializer ObjectReader = new XmlSerializer( typeof( UnrealBuildTool.BuildManifest ) ); // Create an object from the xml data Instance = ( BuildManifest )ObjectReader.Deserialize( XmlStream ); } catch( Exception Ex ) { Debug.WriteLine( Ex.Message ); } finally { if( XmlStream != null ) { // Done with the file so close it XmlStream.Close(); } } return Instance; } private static void CloneDirectoryRecursiveWorker(string SourcePathBase, string TargetPathBase, List ClonedFiles, bool bIncremental = false) { bool bDirectoryCreated = InternalUtils.SafeCreateDirectory(TargetPathBase); if (!bIncremental && !bDirectoryCreated) { throw new AutomationException("Failed to create directory {0} for copy", TargetPathBase); } else if (bIncremental && !CommandUtils.DirectoryExists_NoExceptions(TargetPathBase)) { throw new AutomationException("Target directory {0} does not exist", TargetPathBase); } DirectoryInfo SourceDirectory = new DirectoryInfo(SourcePathBase); DirectoryInfo[] SourceSubdirectories = SourceDirectory.GetDirectories(); // Copy the files FileInfo[] SourceFiles = SourceDirectory.GetFiles(); foreach (FileInfo SourceFI in SourceFiles) { string TargetFilename = CommandUtils.CombinePaths(TargetPathBase, SourceFI.Name); if (!bIncremental || !CommandUtils.FileExists(TargetFilename)) { SourceFI.CopyTo(TargetFilename); if (ClonedFiles != null) { ClonedFiles.Add(TargetFilename); } } } // Recurse into subfolders foreach (DirectoryInfo SourceSubdir in SourceSubdirectories) { string NewSourcePath = CommandUtils.CombinePaths(SourcePathBase, SourceSubdir.Name); string NewTargetPath = CommandUtils.CombinePaths(TargetPathBase, SourceSubdir.Name); CloneDirectoryRecursiveWorker(NewSourcePath, NewTargetPath, ClonedFiles, bIncremental); } } /// /// Clones a directory. /// Warning: Will delete all of the existing files in TargetPath /// This is recursive, copying subfolders too. /// /// Source directory. /// Target directory. /// List of cloned files. public static void CloneDirectory(string SourcePath, string TargetPath, List ClonedFiles = null) { DeleteDirectory_NoExceptions(TargetPath); CloneDirectoryRecursiveWorker(SourcePath, TargetPath, ClonedFiles); } /// /// Clones a directory, skipping any files which already exist in the destination. /// This is recursive, copying subfolders too. /// /// Source directory. /// Target directory. /// List of cloned files. public static void CloneDirectoryIncremental(string SourcePath, string TargetPath, List ClonedFiles = null) { CloneDirectoryRecursiveWorker(SourcePath, TargetPath, ClonedFiles, bIncremental: true); } #endregion #region Threaded Copy /// /// Copies files using multiple threads /// /// /// /// public static void ThreadedCopyFiles(string SourceDirectory, string DestDirectory, int MaxThreads = 64) { CreateDirectory(DestDirectory); var SourceFiles = Directory.EnumerateFiles(SourceDirectory, "*", SearchOption.AllDirectories).ToList(); var DestFiles = SourceFiles.Select(SourceFile => CommandUtils.MakeRerootedFilePath(SourceFile, SourceDirectory, DestDirectory)).ToList(); ThreadedCopyFiles(SourceFiles, DestFiles, MaxThreads); } public static void ThreadedCopyFiles(DirectoryReference SourceDirectory, DirectoryReference DestDirectory, int MaxThreads = 64) { ThreadedCopyFiles(SourceDirectory.FullName, DestDirectory.FullName, MaxThreads); } /// /// Copies files using multiple threads /// /// /// /// public static void ThreadedCopyFiles(List Source, List Dest, int MaxThreads = 64, bool bQuiet = false) { if(!bQuiet) { LogInformation("Copying {0} file(s) using max {1} thread(s)", Source.Count, MaxThreads); } if (Source.Count != Dest.Count) { throw new AutomationException("Source count ({0}) does not match Dest count ({1})", Source.Count, Dest.Count); } Parallel.ForEach(Source.Zip(Dest, (Src, Dst) => new { SourceFile = Src, DestFile = Dst }), new ParallelOptions { MaxDegreeOfParallelism = MaxThreads }, (Pair) => { CommandUtils.CopyFile(Pair.SourceFile, Pair.DestFile, true); }); } /// /// Copies a set of files from one folder to another /// /// Source directory /// Target directory /// Paths relative to the source directory to copy /// Maximum number of threads to create /// List of filenames copied to the target directory public static List ThreadedCopyFiles(string SourceDir, string TargetDir, List RelativePaths, int MaxThreads = 64) { var SourceFileNames = RelativePaths.Select(RelativePath => CommandUtils.CombinePaths(SourceDir, RelativePath)).ToList(); var TargetFileNames = RelativePaths.Select(RelativePath => CommandUtils.CombinePaths(TargetDir, RelativePath)).ToList(); CommandUtils.ThreadedCopyFiles(SourceFileNames, TargetFileNames, MaxThreads); return TargetFileNames; } /// /// Copies a set of files from one folder to another /// /// Source directory /// Target directory /// Filter which selects files from the source directory to copy /// Whether to ignore symlinks during the copy /// Maximum number of threads to create /// List of filenames copied to the target directory public static List ThreadedCopyFiles(string SourceDir, string TargetDir, FileFilter Filter, bool bIgnoreSymlinks, int MaxThreads = 64) { // Filter all the relative paths LogInformation("Applying filter to {0}...", SourceDir); DirectoryReference SourceDirRef = new DirectoryReference(SourceDir); var RelativePaths = Filter.ApplyToDirectory(SourceDirRef, bIgnoreSymlinks).Select(x => x.MakeRelativeTo(SourceDirRef)).ToList(); return ThreadedCopyFiles(SourceDir, TargetDir, RelativePaths); } /// /// Moves files in parallel /// /// Pairs of source and target files public static void ParallelMoveFiles(IEnumerable> SourceAndTargetPairs) { try { Parallel.ForEach(SourceAndTargetPairs, x => MoveFile(x.Key, x.Value)); } catch (AggregateException Ex) { throw new AutomationException(Ex, "Failed to thread-copy files."); } } /// /// Move a file from one place to another /// /// Source and target file public static void MoveFile(FileReference SourceFile, FileReference TargetFile) { // Create the directory for the target file try { Directory.CreateDirectory(TargetFile.Directory.FullName); } catch(Exception Ex) { throw new AutomationException(Ex, "Unable to create directory {0} while moving {1} to {2}", TargetFile.Directory, SourceFile, TargetFile); } // Move the file try { File.Move(SourceFile.FullName, TargetFile.FullName); } catch(Exception Ex) { throw new AutomationException(Ex, "Unable to move {0} to {1}", SourceFile, TargetFile); } } #endregion #region Environment variables /// /// Gets environment variable value. /// /// Name of the environment variable /// Environment variable value as string. public static string GetEnvVar(string Name) { return InternalUtils.GetEnvironmentVariable(Name, ""); } /// /// Gets environment variable value. /// /// Name of the environment variable /// Default value of the environment variable if the variable is not set. /// Environment variable value as string. public static string GetEnvVar(string Name, string DefaultValue) { return InternalUtils.GetEnvironmentVariable(Name, DefaultValue); } /// /// Sets environment variable. /// /// Variable name. /// Variable value. /// True if the value has been set, false otherwise. public static void SetEnvVar(string Name, object Value) { try { LogLog("SetEnvVar {0}={1}", Name, Value); Environment.SetEnvironmentVariable(Name, Value.ToString()); } catch (Exception Ex) { throw new AutomationException(Ex, "Failed to set environment variable {0} to {1}", Name, Value); } } /// /// Sets the environment variable if it hasn't been already. /// /// Environment variable name /// New value public static void ConditionallySetEnvVar(string VarName, string Value) { if (String.IsNullOrEmpty(CommandUtils.GetEnvVar(VarName))) { Environment.SetEnvironmentVariable(VarName, Value); } } #endregion #region CommandLine /// /// Converts a list of arguments to a string where each argument is separated with a space character. /// /// Arguments /// Single string containing all arguments separated with a space. public static string FormatCommandLine(IEnumerable Arguments) { StringBuilder Result = new StringBuilder(); foreach(string Argument in Arguments) { if(Result.Length > 0) { Result.Append(" "); } Result.Append(FormatArgumentForCommandLine(Argument)); } return Result.ToString(); } /// /// Format a single argument for passing on the command line, inserting quotes as necessary. /// /// The argument to quote /// The argument, with quotes if necessary public static string FormatArgumentForCommandLine(string Argument) { // Check if the argument contains a space. If not, we can just pass it directly. int SpaceIdx = Argument.IndexOf(' '); if(SpaceIdx == -1) { return Argument; } // If it does have a space, and it's formatted as an option (ie. -Something=), try to insert quotes after the equals character int EqualsIdx = Argument.IndexOf('='); if(Argument.StartsWith("-") && EqualsIdx != -1 && EqualsIdx < SpaceIdx) { return String.Format("{0}=\"{1}\"", Argument.Substring(0, EqualsIdx), Argument.Substring(EqualsIdx + 1)); } else { return String.Format("\"{0}\"", Argument); } } /// /// Parses the argument list for a parameter and returns whether it is defined or not. /// /// Argument list. /// Param to check for. /// True if param was found, false otherwise. public static bool ParseParam(string[] ArgList, string Param) { string ValueParam = Param; if (!ValueParam.EndsWith("=")) { ValueParam += "="; } foreach (string ArgStr in ArgList) { if (ArgStr.Equals(Param, StringComparison.InvariantCultureIgnoreCase) || ArgStr.StartsWith(ValueParam, StringComparison.InvariantCultureIgnoreCase)) { return true; } } return false; } /// /// Parses the argument list for a parameter and reads its value. /// Ex. ParseParamValue(Args, "map=") /// /// Argument list. /// Param to read its value. /// Returns the value or Default if the parameter was not found. public static string ParseParamValue(object[] ArgList, string Param, string Default = null) { if (!Param.EndsWith("=")) { Param += "="; } foreach (object Arg in ArgList) { string ArgStr = Arg.ToString(); if (ArgStr.StartsWith(Param, StringComparison.InvariantCultureIgnoreCase)) { return ArgStr.Substring(Param.Length); } } return Default; } /// /// Parses the argument list for any number of parameters. /// /// Argument list. /// Param to read its value. /// Returns an array of values for this parameter (or an empty array if one was not found. public static string[] ParseParamValues(object[] ArgList, string Param) { string ParamEquals = Param; if (!ParamEquals.EndsWith("=")) { ParamEquals += "="; } List Values = new List(); foreach (object Arg in ArgList) { string ArgStr = Arg.ToString(); if (ArgStr.StartsWith(ParamEquals, StringComparison.InvariantCultureIgnoreCase)) { Values.Add(ArgStr.Substring(ParamEquals.Length)); } } return Values.ToArray(); } /// /// Makes sure path can be used as a command line param (adds quotes if it contains spaces) /// /// Path to convert /// public static string MakePathSafeToUseWithCommandLine(string InPath) { return UnrealBuildTool.Utils.MakePathSafeToUseWithCommandLine(InPath); } #endregion #region Other public static string EscapePath(string InPath) { return InPath.Replace(":", "").Replace("/", "+").Replace("\\", "+").Replace(" ", "+"); } /// /// Checks if collection is either null or empty. /// /// Collection to check. /// True if the collection is either nur or empty. public static bool IsNullOrEmpty(ICollection Collection) { return Collection == null || Collection.Count == 0; } #endregion #region Properties /// /// Checks if this command is running on a build machine. /// public static bool IsBuildMachine { get { return Automation.IsBuildMachine; } } /// /// Path to the root directory /// public static readonly DirectoryReference RootDirectory = new DirectoryReference(Path.Combine(Path.GetDirectoryName(Assembly.GetExecutingAssembly().GetOriginalLocation()), "..", "..", "..")); /// /// Path to the engine directory /// public static readonly DirectoryReference EngineDirectory = DirectoryReference.Combine(RootDirectory, "Engine"); /// /// Telemetry data for the current run. Add -WriteTelemetry= to the command line to export to disk. /// public static TelemetryData Telemetry = new TelemetryData(); #endregion /// /// Cached location of the build root storage because the logic to compute it is a little non-trivial. /// private static string CachedRootBuildStorageDirectory; /// /// "P:\Builds" or "/Volumes/Builds". Root Folder for all build storage. /// /// "P:\Builds" or "/Volumes/Builds" unless overridden by -UseLocalBuildStorage from the commandline, where is uses Engine\Saved\LocalBuilds\. public static string RootBuildStorageDirectory() { if (string.IsNullOrEmpty(CachedRootBuildStorageDirectory)) { if (GlobalCommandLine.UseLocalBuildStorage) { CachedRootBuildStorageDirectory = CombinePaths(CmdEnv.LocalRoot, "Engine", "Saved", "LocalBuilds"); // Must create the directory because much of the system assumes it is already there. CreateDirectory(CombinePaths(CachedRootBuildStorageDirectory, "UE4")); } else { CachedRootBuildStorageDirectory = Utils.IsRunningOnMono ? "/Volumes/Builds" : CombinePaths("P:", "Builds"); } } return CachedRootBuildStorageDirectory; } public static bool DirectoryExistsAndIsWritable_NoExceptions(string Dir) { if (!DirectoryExists_NoExceptions(Dir)) { LogLog("Directory {0} does not exist", Dir); return false; } try { string Filename = CombinePaths(Dir, Guid.NewGuid().ToString() + ".Temp.txt"); string NativeFilename = ConvertSeparators(PathSeparator.Default, Filename); using(StreamWriter Writer = new StreamWriter(NativeFilename)) { Writer.Write("Test"); } if(File.Exists(NativeFilename)) { DeleteFile_NoExceptions(Filename, true); LogLog("Directory {0} is writable", Dir); return true; } } catch(Exception) { } LogLog("Directory {0} is not writable", Dir); return false; } public static void CleanFormalBuilds(string ParentDir, string SearchPattern, int MaximumDaysToKeepTempStorage = 4) { if (!IsBuildMachine || !ParentDir.StartsWith(RootBuildStorageDirectory())) { return; } try { DirectoryInfo DirInfo = new DirectoryInfo(ParentDir); LogInformation("Looking for directories to delete in {0}", ParentDir); foreach (DirectoryInfo ThisDirInfo in DirInfo.EnumerateDirectories(SearchPattern)) { double AgeDays = (DateTime.UtcNow - ThisDirInfo.CreationTimeUtc).TotalDays; if (AgeDays > MaximumDaysToKeepTempStorage) { LogInformation("Deleting formal build directory {0}, because it is {1} days old (maximum {2}).", ThisDirInfo.FullName, (int)AgeDays, MaximumDaysToKeepTempStorage); DeleteDirectory_NoExceptions(true, ThisDirInfo.FullName); } else { LogVerbose("Not deleting formal build directory {0}, because it is {1} days old (maximum {2}).", ThisDirInfo.FullName, (int)AgeDays, MaximumDaysToKeepTempStorage); } } } catch (Exception Ex) { LogWarning("Unable to clean formal builds from directory: {0}", ParentDir); LogWarning(" Exception was {0}", LogUtils.FormatException(Ex)); } } /// /// Returns the generic name for a given platform (eg. "Windows" for Win32/Win64) /// /// Specific platform public static string GetGenericPlatformName(UnrealBuildTool.UnrealTargetPlatform Platform) { if(Platform == UnrealTargetPlatform.Win32 || Platform == UnrealTargetPlatform.Win64) { return "Windows"; } else { return Enum.GetName(typeof(UnrealBuildTool.UnrealTargetPlatform), Platform); } } /// /// Creates a zip file containing the given input files /// /// Filename for the zip /// Filter which selects files to be included in the zip /// Base directory to store relative paths in the zip file to public static void ZipFiles(FileReference ZipFileName, DirectoryReference BaseDirectory, FileFilter Filter) { List Files = Filter.ApplyToDirectory(BaseDirectory, true); ZipFiles(ZipFileName, BaseDirectory, Files); } /// /// Creates a zip file containing the given input files /// /// Filename for the zip /// Base directory to store relative paths in the zip file to /// Files to include in the archive public static void ZipFiles(FileReference ZipFile, DirectoryReference BaseDirectory, IEnumerable Files) { // Ionic.Zip.Zip64Option.Always option produces broken archives on Mono, so we use system zip tool instead if (Utils.IsRunningOnMono) { CommandUtils.CreateDirectory(ZipFile.Directory); CommandUtils.PushDir(BaseDirectory.FullName); string FilesList = ""; foreach(FileReference File in Files) { FilesList += " \"" + File.MakeRelativeTo(BaseDirectory) + "\""; if (FilesList.Length > 32000) { CommandUtils.RunAndLog(CommandUtils.CmdEnv, "zip", "-g -q \"" + ZipFile.FullName + "\"" + FilesList); FilesList = ""; } } if (FilesList.Length > 0) { CommandUtils.RunAndLog(CommandUtils.CmdEnv, "zip", "-g -q \"" + ZipFile.FullName + "\"" + FilesList); } CommandUtils.PopDir(); } else { using(Ionic.Zip.ZipFile Zip = new Ionic.Zip.ZipFile(Encoding.UTF8)) { Zip.UseZip64WhenSaving = Ionic.Zip.Zip64Option.Always; foreach(FileReference File in Files) { Zip.AddFile(File.FullName, Path.GetDirectoryName(File.MakeRelativeTo(BaseDirectory))); } CommandUtils.CreateDirectory(ZipFile.Directory); Zip.Save(ZipFile.FullName); } } } /// /// Extracts the contents of a zip file /// /// Name of the zip file /// Output directory /// List of files written public static IEnumerable UnzipFiles(string ZipFileName, string BaseDirectory) { List OutputFileNames = new List(); if (Utils.IsRunningOnMono) { CommandUtils.CreateDirectory(BaseDirectory); // Use system unzip tool as there have been instances of Ionic not being able to open zips created with Mac zip tool string Output = CommandUtils.RunAndLog("unzip", "\"" + ZipFileName + "\" -d \"" + BaseDirectory + "\"", Options: ERunOptions.Default | ERunOptions.SpewIsVerbose); // Split log output into lines string[] Lines = Output.Split(new char[] { '\n', '\r' }); foreach (string LogLine in Lines) { CommandUtils.LogInformation(LogLine); // Split each line into two by whitespace string[] SplitLine = LogLine.Split(new char[] { ' ', '\t' }, 2, StringSplitOptions.RemoveEmptyEntries); if (SplitLine.Length == 2) { // Second part of line should be a path string FilePath = SplitLine[1].Trim(); CommandUtils.LogInformation(FilePath); if (File.Exists(FilePath) && !OutputFileNames.Contains(FilePath) && FilePath != ZipFileName) { if (CommandUtils.IsProbablyAMacOrIOSExe(FilePath)) { FixUnixFilePermissions(FilePath); } OutputFileNames.Add(FilePath); } } } if (OutputFileNames.Count == 0) { CommandUtils.LogWarning("Unable to parse unzipped files from {0}", ZipFileName); } } else { // manually extract the files. There was a problem with the Ionic.Zip library that required this on non-PC at one point, // but that problem is now fixed. Leaving this code as is as we need to return the list of created files anyway. using (Ionic.Zip.ZipFile Zip = new Ionic.Zip.ZipFile(ZipFileName)) { foreach (Ionic.Zip.ZipEntry Entry in Zip.Entries.Where(x => !x.IsDirectory)) { string OutputFileName = Path.Combine(BaseDirectory, Entry.FileName); Directory.CreateDirectory(Path.GetDirectoryName(OutputFileName)); using (FileStream OutputStream = new FileStream(OutputFileName, FileMode.Create, FileAccess.Write)) { Entry.Extract(OutputStream); } OutputFileNames.Add(OutputFileName); } } } return OutputFileNames; } /// /// Resolve an arbitrary file specification against a directory. May contain any number of p4 wildcard operators (?, *, ...). /// /// Base directory for relative paths /// Pattern to match /// List of patterns to be excluded. May be null. /// Sequence of file references matching the given pattern public static IEnumerable ResolveFilespec(DirectoryReference DefaultDir, string Pattern, IEnumerable ExcludePatterns) { List Files = new List(); // Check if it contains any wildcards. If not, we can just add the pattern directly without searching. int WildcardIdx = FileFilter.FindWildcardIndex(Pattern); if(WildcardIdx == -1) { // Construct a filter which removes all the excluded filetypes FileFilter Filter = new FileFilter(FileFilterType.Include); if(ExcludePatterns != null) { Filter.AddRules(ExcludePatterns, FileFilterType.Exclude); } // Match it against the given file FileReference File = FileReference.Combine(DefaultDir, Pattern); if(Filter.Matches(File.FullName)) { Files.Add(File); } } else { // Find the base directory for the search. We construct this in a very deliberate way including the directory separator itself, so matches // against the OS root directory will resolve correctly both on Mac (where / is the filesystem root) and Windows (where / refers to the current drive). int LastDirectoryIdx = Pattern.LastIndexOfAny(new char[]{ Path.DirectorySeparatorChar, Path.AltDirectorySeparatorChar }, WildcardIdx); DirectoryReference BaseDir = DirectoryReference.Combine(DefaultDir, Pattern.Substring(0, LastDirectoryIdx + 1)); // Construct the absolute include pattern to match against, re-inserting the resolved base directory to construct a canonical path. string IncludePattern = BaseDir.FullName.TrimEnd(new char[]{ Path.DirectorySeparatorChar, Path.AltDirectorySeparatorChar }) + "/" + Pattern.Substring(LastDirectoryIdx + 1); // Construct a filter and apply it to the directory if(DirectoryReference.Exists(BaseDir)) { FileFilter Filter = new FileFilter(); Filter.AddRule(IncludePattern, FileFilterType.Include); if(ExcludePatterns != null) { Filter.AddRules(ExcludePatterns, FileFilterType.Exclude); } Files.AddRange(Filter.ApplyToDirectory(BaseDir, BaseDir.FullName, true)); } } return Files; } static public Dictionary GetBuildVersionPathMap(string[] BuildFolders) { Dictionary BuildVersionPaths = new Dictionary(); foreach (string buildFolder in BuildFolders) { string XboxoneReleaseVersion = Path.GetFileName(buildFolder); // The name of all recent archived builds either start with "EA" or only contain version string VersionPrefix = "EA"; if (XboxoneReleaseVersion.StartsWith(VersionPrefix)) { XboxoneReleaseVersion.Substring(VersionPrefix.Length); // Length of "EA" } Version ReleaseVersion; if (Version.TryParse(XboxoneReleaseVersion, out ReleaseVersion)) { BuildVersionPaths.Add(ReleaseVersion, buildFolder); } } return BuildVersionPaths; } static public string GetPreviousXboxOneReleaseArchiveDir(string XboxOneReleasesArchiveDir) { var BuildFolders = Directory.GetDirectories(XboxOneReleasesArchiveDir); if (BuildFolders.Length > 0) { Dictionary BuildVersionPathMap = GetBuildVersionPathMap(BuildFolders); if (BuildVersionPathMap.Count > 0) { return BuildVersionPathMap.Where(archiveDir => DirectoryExists(CombinePaths(archiveDir.Value, "Paks"))).OrderByDescending(versionPathPair => versionPathPair.Key).First().Value; } else { throw new AutomationException(String.Format("No valid builds were found in %s", XboxOneReleasesArchiveDir)); } } else { throw new AutomationException(String.Format("No builds were found in %s", XboxOneReleasesArchiveDir)); } } public static string FormatSizeString(long Size) { string[] Units = { "bytes", "KB", "MB", "GB", "TB", "PB", "EB", "ZB", "YB" }; int UnitIndex = 0; double AbsSize = Math.Abs(Size); while (AbsSize >= 1024) { AbsSize /= 1024; ++UnitIndex; } return String.Format("{0} {1}", AbsSize.ToString("N2"), Units[UnitIndex]); } public static void TakeLock(DirectoryReference LockDirectory, TimeSpan Timeout, System.Action Callback) { string LockFilePath = Path.Combine(LockDirectory.FullName, ".lock"); FileStream Stream = null; DateTime StartTime = DateTime.Now; DateTime Deadline = StartTime.Add(Timeout); try { DirectoryReference.CreateDirectory(LockDirectory); for (int Iterations = 0; ; ++Iterations) { // Attempt to create the lock file. Ignore any IO exceptions. Stream will be null if this fails. try { Stream = new FileStream(LockFilePath, FileMode.Create, FileAccess.Write, FileShare.Read, 4096, FileOptions.DeleteOnClose); } catch (IOException) { } if (Stream != null) { // If we have a stream, we've taken the lock. try { // Write the machine name to the file. Stream.Write(Encoding.UTF8.GetBytes(Environment.MachineName)); Stream.Flush(); break; } catch { throw new AutomationException("Failed to write to the lock file '{0}'.", LockFilePath); } } // We've failed to take the lock. Throw an exception if the timeout has elapsed. // Otherwise print a log message and retry. var CurrentTime = DateTime.Now; if (CurrentTime >= Deadline) { throw new AutomationException("Couldn't create lock file '{0}' after {1} seconds.", LockFilePath, CurrentTime.Subtract(StartTime).TotalSeconds); } if (Iterations == 0) { LogInformation("Waiting for lock file '{0}' to be removed...", LockFilePath); } else if ((Iterations % 30) == 0) { LogInformation("Still waiting for lock file '{0}' after {1} seconds.", LockFilePath, CurrentTime.Subtract(StartTime).TotalSeconds); } // Wait for a while before retrying. Thread.Sleep(1000); } // Invoke the user callback now that we own the lock. Callback(); } finally { // Always dispose the lock file stream if we took the lock. // The file will delete on close. if (Stream != null) { Stream.Dispose(); Stream = null; } } } public static void OptionallyTakeLock(bool Condition, DirectoryReference LockDirectory, TimeSpan Timeout, System.Action Callback) { if (Condition) { TakeLock(LockDirectory, Timeout, Callback); } else { // No lock required, invoke the callback directly. Callback(); } } } /// /// Valid units for telemetry data /// public enum TelemetryUnits { Count, Milliseconds, Seconds, Minutes, Bytes, Megabytes, } /// /// Sample for telemetry data /// public class TelemetrySample { /// /// Name of this sample /// public string Name; /// /// The value for this sample /// public double Value; /// /// Units for this sample /// public TelemetryUnits Units; } /// /// Stores a set of key/value telemetry samples which can be read and written to a JSON file /// public class TelemetryData { /// /// The current file version /// const int CurrentVersion = 1; /// /// Maps from a sample name to its value /// public List Samples = new List(); /// /// Adds a telemetry sample /// /// Name of the sample /// Value of the sample /// Units for the sample value public void Add(string Name, double Value, TelemetryUnits Units) { Samples.RemoveAll(x => x.Name == Name); Samples.Add(new TelemetrySample() { Name = Name, Value = Value, Units = Units }); } /// /// Add samples from another telemetry block into this one /// /// Prefix for the telemetry data /// The other telemetry data public void Merge(string Prefix, TelemetryData Other) { foreach(TelemetrySample Sample in Other.Samples) { Add(Sample.Name, Sample.Value, Sample.Units); } } /// /// Tries to read the telemetry data from the given file /// /// The file to read from /// On success, the read telemetry data /// True if a telemetry object was read public static bool TryRead(FileReference FileName, out TelemetryData Telemetry) { // Try to read the raw json object JsonObject RawObject; if (!JsonObject.TryRead(FileName, out RawObject)) { Telemetry = null; return false; } // Check the version is valid int Version; if(!RawObject.TryGetIntegerField("Version", out Version) || Version != CurrentVersion) { Telemetry = null; return false; } // Read all the samples JsonObject[] RawSamples; if (!RawObject.TryGetObjectArrayField("Samples", out RawSamples)) { Telemetry = null; return false; } // Parse out all the samples Telemetry = new TelemetryData(); foreach (JsonObject RawSample in RawSamples) { Telemetry.Add(RawSample.GetStringField("Name"), RawSample.GetDoubleField("Value"), RawSample.GetEnumField("Units")); } return true; } /// /// Writes out the telemetry data to a file /// /// public void Write(string FileName) { using (JsonWriter Writer = new JsonWriter(FileName)) { Writer.WriteObjectStart(); Writer.WriteValue("Version", CurrentVersion); Writer.WriteArrayStart("Samples"); foreach(TelemetrySample Sample in Samples) { Writer.WriteObjectStart(); Writer.WriteValue("Name", Sample.Name); Writer.WriteValue("Value", Sample.Value); Writer.WriteValue("Units", Sample.Units.ToString()); Writer.WriteObjectEnd(); } Writer.WriteArrayEnd(); Writer.WriteObjectEnd(); } } } /// /// Timer class used for telemetry reporting. /// public class TelemetryStopwatch : IDisposable { string Name; DateTime StartTime; bool bFinished; public TelemetryStopwatch(string Format, params object[] Args) { Name = String.Format(Format, Args); StartTime = DateTime.Now; } public void Cancel() { bFinished = true; } /// /// Flushes the time to if we are the build machine and that environment variable is specified. /// Call Finish manually with an alternate name to use that one instead. Useful for dynamically generated names that you can't specify at construction. /// /// Used in place of the Name specified during construction. public void Finish(string AlternateName = null) { if(!bFinished) { if (!String.IsNullOrEmpty(AlternateName)) { Name = AlternateName; } var OutputStr = String.Format("UAT,{0},{1},{2}" + Environment.NewLine, Name, StartTime, DateTime.Now); CommandUtils.LogVerbose(OutputStr); if (CommandUtils.IsBuildMachine && !String.IsNullOrEmpty(CommandUtils.CmdEnv.CSVFile) && CommandUtils.CmdEnv.CSVFile != "nul") { try { File.AppendAllText(CommandUtils.CmdEnv.CSVFile, OutputStr); } catch (Exception Ex) { CommandUtils.LogWarning("Could not append to csv file ({0}) : {1}", CommandUtils.CmdEnv.CSVFile, Ex.ToString()); } } } bFinished = true; } public void Dispose() { Finish(); } } /// /// Stopwatch that uses DateTime.UtcNow for timing. Not hi-res, but also not subject to short time limitations of System.Diagnostics.Stopwatch. /// public class DateTimeStopwatch { public static DateTimeStopwatch Start() { return new DateTimeStopwatch(); } /// /// Hide public ctor. /// private DateTimeStopwatch() { } readonly DateTime StartTime = DateTime.UtcNow; public TimeSpan ElapsedTime { get { return DateTime.UtcNow - StartTime; } } } /// /// Use with "using" syntax to push and pop directories in a convenient, exception-safe way /// public class PushedDirectory : IDisposable { public PushedDirectory(string DirectoryName) { CommandUtils.PushDir(DirectoryName); } public void Dispose() { CommandUtils.PopDir(); GC.SuppressFinalize(this); } } /// /// Use with "using" syntax to temporarily set and environment variable in a convenient, exception-safe way /// public class ScopedEnvVar : IDisposable { private string StoredEnvVar = null; public ScopedEnvVar(string EnvVar, string Value) { StoredEnvVar = EnvVar; CommandUtils.SetEnvVar(StoredEnvVar, Value); } public void Dispose() { CommandUtils.SetEnvVar(StoredEnvVar, ""); GC.SuppressFinalize(this); } } /// /// Helper class to associate a file and its contents /// public class EMSFileInfo { public string FileName { get; set; } public byte[] Bytes { get; set; } } /// /// Wrapper class for the enumerate files JSON response from MCP /// [DataContract] public sealed class EnumerationResponse { [DataMember(Name = "doNotCache", IsRequired = true)] public Boolean DoNotCache { get; set; } [DataMember(Name = "uniqueFilename", IsRequired = true)] public string UniqueFilename { get; set; } [DataMember(Name = "filename", IsRequired = true)] public string Filename { get; set; } [DataMember(Name = "hash", IsRequired = true)] public string Hash { get; set; } [DataMember(Name = "length", IsRequired = true)] public long Length { get; set; } [DataMember(Name = "uploaded", IsRequired = true)] public string Uploaded { get; set; } } /// /// Code signing /// [Help("NoSign", "Skips signing of code/content files.")] public class CodeSign { /// /// If so, what is the signing identity to search for? /// public static string SigningIdentity = "Epic Games"; /// /// Should we use the machine store? /// public static bool bUseMachineStoreInsteadOfUserStore = false; /// /// How long to keep re-trying code signing for /// public static TimeSpan CodeSignTimeOut = new TimeSpan(0, 3, 0); // Keep trying to sign one file for up to 3 minutes /// /// Finds the path to SignTool.exe, or throws an exception. /// /// Path to signtool.exe public static string GetSignToolPath() { string[] PossibleSignToolNames = { "C:/Program Files (x86)/Windows Kits/8.1/bin/x86/SignTool.exe", "C:/Program Files (x86)/Windows Kits/10/bin/x86/SignTool.exe" }; foreach(string PossibleSignToolName in PossibleSignToolNames) { if(File.Exists(PossibleSignToolName)) { return PossibleSignToolName; } } throw new AutomationException("SignTool not found at '{0}' (are you missing the Windows SDK?)", String.Join("' or '", PossibleSignToolNames)); } /// /// Code signs the specified file /// public static void SignSingleExecutableIfEXEOrDLL(string Filename, bool bIgnoreExtension = false) { if (UnrealBuildTool.Utils.IsRunningOnMono) { CommandUtils.LogLog(String.Format("Can't sign '{0}', we are running under mono.", Filename)); return; } if (!CommandUtils.FileExists(Filename)) { throw new AutomationException("Can't sign '{0}', file does not exist.", Filename); } // Make sure the file isn't read-only FileInfo TargetFileInfo = new FileInfo(Filename); // Executable extensions List Extensions = new List(); Extensions.Add(".dll"); Extensions.Add(".exe"); bool IsExecutable = bIgnoreExtension; foreach (var Ext in Extensions) { if (TargetFileInfo.FullName.EndsWith(Ext, StringComparison.InvariantCultureIgnoreCase)) { IsExecutable = true; break; } } if (!IsExecutable) { CommandUtils.LogLog(String.Format("Won't sign '{0}', not an executable.", TargetFileInfo.FullName)); return; } string SignToolName = GetSignToolPath(); TargetFileInfo.IsReadOnly = false; // Code sign the executable string[] TimestampServer = { "http://timestamp.verisign.com/scripts/timestamp.dll", "http://timestamp.globalsign.com/scripts/timstamp.dll", "http://timestamp.comodoca.com/authenticode", "http://www.startssl.com/timestamp" }; int TimestampServerIndex = 0; string SpecificStoreArg = bUseMachineStoreInsteadOfUserStore ? " /sm" : ""; DateTime StartTime = DateTime.Now; int NumTrials = 0; for (; ; ) { //@TODO: Verbosity choosing // /v will spew lots of info // /q does nothing on success and minimal output on failure string CodeSignArgs = String.Format("sign{0} /a /n \"{1}\" /t {2} /d \"{3}\" /v \"{4}\"", SpecificStoreArg, SigningIdentity, TimestampServer[TimestampServerIndex], TargetFileInfo.Name, TargetFileInfo.FullName); IProcessResult Result = CommandUtils.Run(SignToolName, CodeSignArgs, null, CommandUtils.ERunOptions.AllowSpew); ++NumTrials; if (Result.ExitCode != 1) { if (Result.ExitCode == 2) { CommandUtils.LogError(String.Format("Signtool returned a warning.")); } // Success! break; } else { // try another timestamp server on the next iteration TimestampServerIndex++; if (TimestampServerIndex >= TimestampServer.Count()) { // loop back to the first timestamp server TimestampServerIndex = 0; } // Keep retrying until we run out of time TimeSpan RunTime = DateTime.Now - StartTime; if (RunTime > CodeSignTimeOut) { throw new AutomationException("Failed to sign executable '{0}' {1} times over a period of {2}", TargetFileInfo.FullName, NumTrials, RunTime); } } } } /// /// Code signs the specified file or folder /// public static void SignMacFileOrFolder(string InPath, bool bIgnoreExtension = false) { bool bExists = CommandUtils.FileExists(InPath) || CommandUtils.DirectoryExists(InPath); if (!bExists) { throw new AutomationException("Can't sign '{0}', file or folder does not exist.", InPath); } // Executable extensions List Extensions = new List(); Extensions.Add(".dylib"); Extensions.Add(".app"); Extensions.Add(".framework"); bool IsExecutable = bIgnoreExtension || (Path.GetExtension(InPath) == "" && !InPath.EndsWith("PkgInfo")); foreach (var Ext in Extensions) { if (InPath.EndsWith(Ext, StringComparison.InvariantCultureIgnoreCase)) { IsExecutable = true; break; } } if (!IsExecutable) { CommandUtils.LogLog(String.Format("Won't sign '{0}', not an executable.", InPath)); return; } // Use the old codesigning tool after the upgrade due to segmentation fault on Sierra string SignToolName = "/usr/local/bin/codesign_old"; // unless it doesn't exist, then use the Sierra one. if(!File.Exists(SignToolName)) { SignToolName = "/usr/bin/codesign"; } string CodeSignArgs = String.Format("-f --deep -s \"{0}\" -v \"{1}\" --no-strict", "Developer ID Application", InPath); DateTime StartTime = DateTime.Now; int NumTrials = 0; for (; ; ) { IProcessResult Result = CommandUtils.Run(SignToolName, CodeSignArgs, null, CommandUtils.ERunOptions.AllowSpew); int ExitCode = Result.ExitCode; ++NumTrials; if (ExitCode == 0) { // Success! break; } else { // Keep retrying until we run out of time TimeSpan RunTime = DateTime.Now - StartTime; if (RunTime > CodeSignTimeOut) { throw new AutomationException("Failed to sign '{0}' {1} times over a period of {2}", InPath, NumTrials, RunTime); } } } } /// /// Codesigns multiple files, but skips anything that's not an EXE or DLL file /// Will automatically skip signing if -NoSign is specified in the command line. /// /// List of files to sign public static void SignMultipleIfEXEOrDLL(BuildCommand Command, IEnumerable Files) { if (!Command.ParseParam("NoSign")) { CommandUtils.LogInformation("Signing up to {0} files...", Files.Count()); UnrealBuildTool.UnrealTargetPlatform TargetPlatform = UnrealBuildTool.BuildHostPlatform.Current.Platform; if (TargetPlatform == UnrealBuildTool.UnrealTargetPlatform.Mac) { foreach (var File in Files) { SignMacFileOrFolder(File); } } else { List FilesToSign = new List(); foreach (string File in Files) { if (!(Path.GetDirectoryName(File).Replace("\\", "/")).Contains("Binaries/XboxOne")) { FilesToSign.Add(new FileReference(File)); } } SignMultipleFilesIfEXEOrDLL(FilesToSign); } } else { CommandUtils.LogLog("Skipping signing {0} files due to -nosign.", Files.Count()); } } public static void SignListFilesIfEXEOrDLL(string FilesToSign) { string SignToolName = GetSignToolPath(); // nothing to sign if (String.IsNullOrEmpty(FilesToSign)) { return; } // Code sign the executable string[] TimestampServer = { "http://timestamp.verisign.com/scripts/timestamp.dll", "http://timestamp.globalsign.com/scripts/timstamp.dll", "http://timestamp.comodoca.com/authenticode", "http://www.startssl.com/timestamp" }; string SpecificStoreArg = bUseMachineStoreInsteadOfUserStore ? " /sm" : ""; Stopwatch Stopwatch = Stopwatch.StartNew(); int NumTrials = 0; for (; ; ) { //@TODO: Verbosity choosing // /v will spew lots of info // /q does nothing on success and minimal output on failure string CodeSignArgs = String.Format("sign{0} /a /n \"{1}\" /t {2} /debug {3}", SpecificStoreArg, SigningIdentity, TimestampServer[NumTrials % TimestampServer.Length], FilesToSign); IProcessResult Result = CommandUtils.Run(SignToolName, CodeSignArgs, null, CommandUtils.ERunOptions.AllowSpew); ++NumTrials; if (Result.ExitCode != 1) { if (Result.ExitCode == 2) { CommandUtils.LogError(String.Format("Signtool returned a warning.")); } // Success! break; } else { // Keep retrying until we run out of time TimeSpan RunTime = Stopwatch.Elapsed; if (RunTime > CodeSignTimeOut && NumTrials >= TimestampServer.Length) { throw new AutomationException("Failed to sign executables {0} times over a period of {1}", NumTrials, RunTime); } } } } public static void SignMultipleFilesIfEXEOrDLL(List Files, bool bIgnoreExtension = false) { if (UnrealBuildTool.Utils.IsRunningOnMono) { CommandUtils.LogLog(String.Format("Can't sign we are running under mono.")); return; } List FinalFiles = new List(); foreach (string Filename in Files.Select(x => x.FullName)) { FileInfo TargetFileInfo = new FileInfo(Filename); // Executable extensions List Extensions = new List(); Extensions.Add(".dll"); Extensions.Add(".exe"); Extensions.Add(".msi"); Extensions.Add(".dle"); bool IsExecutable = bIgnoreExtension; foreach (var Ext in Extensions) { if (TargetFileInfo.FullName.EndsWith(Ext, StringComparison.InvariantCultureIgnoreCase)) { // force file writable TargetFileInfo.IsReadOnly = false; IsExecutable = true; break; } } if (IsExecutable && CommandUtils.FileExists(Filename)) { FinalFiles.Add(Filename); } } StringBuilder FilesToSignBuilder = new StringBuilder(); List FinalListSignStrings = new List(); foreach(string File in FinalFiles) { FilesToSignBuilder.Append("\"" + File + "\" "); if(FilesToSignBuilder.Length > 1900) { string AddFilesToFinalList = FilesToSignBuilder.ToString(); FinalListSignStrings.Add(AddFilesToFinalList); FilesToSignBuilder.Clear(); } } FinalListSignStrings.Add(FilesToSignBuilder.ToString()); foreach(string FilesToSign in FinalListSignStrings) { SignListFilesIfEXEOrDLL(FilesToSign); } } } }