Merge remote-tracking branch 'upstream/development' into nvsickle/OutlinerDuplicateEntryFixes

This commit is contained in:
nvsickle
2021-10-01 15:48:20 -07:00
215 changed files with 3058 additions and 3400 deletions
@@ -12,95 +12,84 @@
#include <AzCore/EBus/EBus.h>
#include <AzCore/std/string/string.h>
#include <AzCore/Math/Uuid.h>
#include <future>
namespace AzToolsFramework
{
// use bind if you need additional context.
// Parameters:
// bool - If the archive command was successful or not.
typedef AZStd::function<void(bool)> ArchiveResponseCallback;
// bool - If the archive command was successful or not.
// AZStd::string - The console output from the command.
typedef AZStd::function<void(bool, AZStd::string)> ArchiveResponseOutputCallback;
//! ArchiveCommands
//! This bus handles messages relating to archive commands
//! archive commands are ASYNCHRONOUS
//! archive formats officially supported are .zip
//! do not block the main thread waiting for a response, it is not okay
//! you will not get a message delivered unless you tick the tickbus anyway!
class ArchiveCommands
: public AZ::EBusTraits
{
public:
using Bus = AZ::EBus<ArchiveCommands>;
// EBus Traits
static const AZ::EBusHandlerPolicy HandlerPolicy = AZ::EBusHandlerPolicy::Single;
static const AZ::EBusAddressPolicy AddressPolicy = AZ::EBusAddressPolicy::Single;
typedef AZStd::recursive_mutex MutexType;
static const bool LocklessDispatch = true;
virtual ~ArchiveCommands() {}
//! Start an async task to extract an archive to the target directory
//! taskHandles are used to cancel a task at some point in the future and are provided by the caller per task.
//! Multiple tasks can be associated with the same handle
virtual void ExtractArchive(const AZStd::string& archivePath, const AZStd::string& destinationPath, AZ::Uuid taskHandle, const ArchiveResponseCallback& respCallback) = 0;
virtual void ExtractArchiveOutput(const AZStd::string& archivePath, const AZStd::string& destinationPath, AZ::Uuid taskHandle, const ArchiveResponseOutputCallback& respCallback) = 0;
// Maintaining backwards API compatibility - ExtractArchiveBlocking below passes in extractWithRoot as an option
virtual void ExtractArchiveWithoutRoot(const AZStd::string& archivePath, const AZStd::string& destinationPath, AZ::Uuid taskHandle, const ArchiveResponseOutputCallback& respCallback) = 0;
virtual ~ArchiveCommands() = default;
//! Start a sync task to extract an archive to the target directory
//! If you do not want to extract the root folder then set extractWithRootDirectory to false.
virtual bool ExtractArchiveBlocking(const AZStd::string& archivePath, const AZStd::string& destinationPath, bool extractWithRootDirectory) = 0;
//! Create an archive of the target directory (all files and subdirectories)
//! @param archivePath The path of the archive to create
//! @dirToArchive The directory to be added to the archive
//! @return Future (bool) which can obtain the success value of the operation
[[nodiscard]] virtual std::future<bool> CreateArchive(
const AZStd::string& archivePath,
const AZStd::string& dirToArchive) = 0;
//! Extract a single file asynchronously from the archive to the destination.
//! Uses cwd if destinationPath empty. overWrite = true for overwrite existing files, false for skipExisting
//! taskHandles are used to cancel a task at some point in the future and are provided by the caller per task.
//! Multiple tasks can be associated with the same handle
virtual void ExtractFile(const AZStd::string& archivePath, const AZStd::string& fileInArchive, const AZStd::string& destinationPath, bool overWrite, AZ::Uuid taskHandle, const ArchiveResponseOutputCallback& respCallback) = 0;
//! Extract an archive to the target directory
//! @param archivePath The path of the archive to extract
//! @param destinationPath The directory where files will be extracted to
//! @return Future (bool) which can obtain the success value of the operation
[[nodiscard]] virtual std::future<bool> ExtractArchive(
const AZStd::string& archivePath,
const AZStd::string& destinationPath) = 0;
//! Extract a single file from the archive to the destination and block until finished.
//! Uses cwd if destinationPath empty. overWrite = true for overwrite existing files, false for skipExisting
virtual bool ExtractFileBlocking(const AZStd::string& archivePath, const AZStd::string& fileInArchive, const AZStd::string& destinationPath, bool overWrite) = 0;
//! Extract a single file from the archive to the destination
//! Destination path should not be empty
//! @param archivePath The path of the archive to extract from
//! @param fileInArchive A path to a file, relative to root of archive
//! @param destinationPath The directory where file will be extracted to
//! @return Future (bool) which can obtain the success value of the operation
[[nodiscard]] virtual std::future<bool> ExtractFile(
const AZStd::string& archivePath,
const AZStd::string& fileInArchive,
const AZStd::string& destinationPath) = 0;
//! Start an async task to create an archive of the target directory (recursively)
//! taskHandles are used to cancel a task at some point in the future and are provided by the caller per task.
//! Multiple tasks can be associated with the same handle.
virtual void CreateArchive(const AZStd::string& archivePath, const AZStd::string& dirToArchive, AZ::Uuid taskHandle, const ArchiveResponseOutputCallback& respCallback) = 0;
//! Retrieve the list of files contained in an archive (all files and subdirectories)
//! @param archivePath The path of the archive to list
//! @param outFileEntries An out parameter that will contain the file paths found
//! @return True if successful, false otherwise
virtual bool ListFilesInArchive(const AZStd::string& archivePath, AZStd::vector<AZStd::string>& outFileEntries) = 0;
//! Start a sync task to create an archive of the target directory (recursively)
virtual bool CreateArchiveBlocking(const AZStd::string& archivePath, const AZStd::string& dirToArchive) = 0;
//! Start an async task to retrieve the list of files and their relative paths within an archive (recursively)
//! taskHandles are used to cancel a task at some point in the future and are provided by the caller per task.
//! Multiple tasks can be associated with the same handle.
virtual void ListFilesInArchive(const AZStd::string& archivePath, AZStd::vector<AZStd::string>& fileEntries, AZ::Uuid taskHandle, const ArchiveResponseOutputCallback& respCallback) = 0;
//! Add a file to an archive
//! The archive might not exist yet
//! The file path relative to the working directory will be replicated in the archive
//! @param archivePath The path of the archive to add to
//! @param workingDirectory A directory that will be the starting path of the file to be added
//! @param fileToAdd A path to the file relative to the working directory
//! @return Future (bool) which can obtain the success value of the operation
[[nodiscard]] virtual std::future<bool> AddFileToArchive(
const AZStd::string& archivePath,
const AZStd::string& workingDirectory,
const AZStd::string& fileToAdd) = 0;
//! Start a sync task to retrieve the list of files and their relative paths within an archive (recursively)
virtual bool ListFilesInArchiveBlocking(const AZStd::string& archivePath, AZStd::vector<AZStd::string>& fileEntries) = 0;
//! Start an async task to add a file to a preexisting archive.
//! fileToAdd must be a relative path to the file from the working directory. The path to the file from the root of the archive will be the same as the relative path to the file on disk.
//! taskHandles are used to cancel a task at some point in the future and are provided by the caller per task.
//! Multiple tasks can be associated with the same handle.
virtual void AddFileToArchive(const AZStd::string& archivePath, const AZStd::string& workingDirectory, const AZStd::string& fileToAdd, AZ::Uuid taskHandle, const ArchiveResponseOutputCallback& respCallback) = 0;
//! Start a sync task to add a file to a preexisting archive.
//! fileToAdd must be a relative path to the file from the working directory. The path to the file from the root of the archive will be the same as the relative path to the file on disk.
virtual bool AddFileToArchiveBlocking(const AZStd::string& archivePath, const AZStd::string& workingDirectory, const AZStd::string& fileToAdd) = 0;
//! Start an async task to add files to a archive.
//! File paths inside the list file must either be a relative path from the working directory or an absolute path.
virtual void AddFilesToArchive(const AZStd::string& archivePath, const AZStd::string& workingDirectory, const AZStd::string& listFilePath, AZ::Uuid taskHandle, const ArchiveResponseOutputCallback& respCallback) = 0;
//! Start a sync task to add files to an archive.
//! File paths inside the list file must either be a relative path from the working directory or an absolute path.
virtual bool AddFilesToArchiveBlocking(const AZStd::string& archivePath, const AZStd::string& workingDirectory, const AZStd::string& listFilePath) = 0;
//! Cancels tasks associtated with the given handle. Blocks until all tasks are cancelled.
virtual void CancelTasks(AZ::Uuid taskHandle) = 0;
//! Add files to an archive provided from a file listing
//! The archive might not exist yet
//! File paths in the file list should be relative to root of the archive
//! @param archivePath The path of the archive to add to
//! @param workingDirectory A directory that will be the starting path of the list of files to add
//! @param listFilePath Full path to a text file that contains the list of files to add
//! @return Future (bool) which can obtain the success value of the operation
[[nodiscard]] virtual std::future<bool> AddFilesToArchive(
const AZStd::string& archivePath,
const AZStd::string& workingDirectory,
const AZStd::string& listFilePath) = 0;
};
using ArchiveCommandsBus = AZ::EBus<ArchiveCommands>;
}; // namespace AzToolsFramework
@@ -12,118 +12,98 @@
#include <AzCore/Component/ComponentApplicationBus.h>
#include <AzCore/Serialization/EditContext.h>
#include <AzFramework/StringFunc/StringFunc.h>
#include <AzFramework/Archive/INestedArchive.h>
#include <AzFramework/Archive/ZipDirStructures.h>
#include <AzFramework/Process/ProcessCommunicator.h>
#include <AzFramework/Process/ProcessWatcher.h>
#include <AzFramework/FileFunc/FileFunc.h>
namespace AzToolsFramework
{
// Forward declare platform specific functions
namespace Platform
constexpr const char s_traceName[] = "ArchiveComponent";
constexpr AZ::u32 s_compressionMethod = AZ::IO::INestedArchive::METHOD_DEFLATE;
constexpr AZ::s32 s_compressionLevel = AZ::IO::INestedArchive::LEVEL_NORMAL;
constexpr CompressionCodec::Codec s_compressionCodec = CompressionCodec::Codec::ZLIB;
namespace ArchiveUtils
{
AZStd::string GetZipExePath();
AZStd::string GetUnzipExePath();
AZStd::string GetCreateArchiveCommand(const AZStd::string& archivePath, const AZStd::string& dirToArchive);
AZStd::string GetExtractArchiveCommand(const AZStd::string& archivePath, const AZStd::string& destinationPath, bool includeRoot);
AZStd::string GetAddFileToArchiveCommand(const AZStd::string& archivePath, const AZStd::string& file);
AZStd::string GetAddFilesToArchiveCommand(const AZStd::string& archivePath, const AZStd::string& listFilePath);
AZStd::string GetExtractFileCommand(const AZStd::string& archivePath, const AZStd::string& fileInArchive, const AZStd::string& destinationPath, bool overWrite);
AZStd::string GetListFilesInArchiveCommand(const AZStd::string& archivePath);
void ParseConsoleOutputFromListFilesInArchive(const AZStd::string& consoleOutput, AZStd::vector<AZStd::string>& fileEntries);
}
const char s_traceName[] = "ArchiveComponent";
const unsigned int g_sleepDuration = 1;
// Echoes all results of stdout and stderr to console and never blocks
class ConsoleEchoCommunicator
{
public:
ConsoleEchoCommunicator(AzFramework::ProcessCommunicator* communicator)
: m_communicator(communicator)
// Read a file's contents into a provided buffer.
// Does not add a zero byte at the end of the buffer.
// returns true if read was successful, false otherwise.
bool ReadFile(const AZ::IO::Path& filePath, AZ::IO::OpenMode openMode, AZStd::vector<char>& outBuffer)
{
}
~ConsoleEchoCommunicator()
{
}
// Call this periodically to drain the buffers
void Pump()
{
if (m_communicator->IsValid())
auto fileIO = AZ::IO::FileIOBase::GetDirectInstance();
if (!fileIO)
{
AZ::u32 readBufferSize = 0;
AZStd::string readBuffer;
// Don't call readOutput unless there is output or else it will block...
readBufferSize = m_communicator->PeekOutput();
if (readBufferSize)
{
readBuffer.resize_no_construct(readBufferSize + 1);
readBuffer[readBufferSize] = '\0';
m_communicator->ReadOutput(readBuffer.data(), readBufferSize);
EchoBuffer(readBuffer);
}
readBufferSize = m_communicator->PeekError();
if (readBufferSize)
{
readBuffer.resize_no_construct(readBufferSize + 1);
readBuffer[readBufferSize] = '\0';
m_communicator->ReadError(readBuffer.data(), readBufferSize);
EchoBuffer(readBuffer);
}
return false;
}
}
private:
void EchoBuffer(const AZStd::string& buffer)
{
size_t startIndex = 0;
size_t endIndex = 0;
const size_t bufferSize = buffer.size();
for (size_t i = 0; i < bufferSize; ++i)
bool success = false;
AZ::IO::HandleType fileHandle = AZ::IO::InvalidHandle;
if (fileIO->Open(filePath.c_str(), openMode, fileHandle))
{
if (buffer[i] == '\n' || buffer[i] == '\0')
AZ::u64 fileSize = 0;
if (fileIO->Size(fileHandle, fileSize) && fileSize != 0)
{
endIndex = i;
bool isEmptyMessage = (endIndex - startIndex == 1) && (buffer[startIndex] == '\r');
if (!isEmptyMessage)
outBuffer.resize_no_construct(fileSize);
AZ::u64 bytesRead = 0;
if (fileIO->Read(fileHandle, outBuffer.data(), fileSize, true, &bytesRead))
{
AZ_Printf(s_traceName, "%s", buffer.substr(startIndex, endIndex - startIndex).c_str());
success = (fileSize == bytesRead);
}
startIndex = endIndex + 1;
}
fileIO->Close(fileHandle);
}
return success;
}
// Reads a text file that contains a list of file paths.
// Tokenize the file by lines.
// Calls the lineVisitor function for each line of the file.
void ProcessFileList(const AZ::IO::Path& filePath, AZStd::function<void(AZStd::string_view line)> lineVisitor)
{
AZStd::vector<char> fileBuffer;
if (ReadFile(filePath, AZ::IO::OpenMode::ModeText | AZ::IO::OpenMode::ModeRead, fileBuffer))
{
AZ::StringFunc::TokenizeVisitor(AZStd::string_view{ fileBuffer.data(), fileBuffer.size() }, lineVisitor, "\n");
}
}
AzFramework::ProcessCommunicator* m_communicator = nullptr;
};
} // namespace ArchiveUtils
void ArchiveComponent::Activate()
{
m_zipExePath = Platform::GetZipExePath();
m_unzipExePath = Platform::GetUnzipExePath();
m_fileIO = AZ::IO::FileIOBase::GetDirectInstance();
if (m_fileIO == nullptr)
{
AZ_Error(s_traceName, false, "Failed to create a LocalFileIO instance!");
}
ArchiveCommands::Bus::Handler::BusConnect();
m_archive = AZ::Interface<AZ::IO::IArchive>::Get();
if (m_archive == nullptr)
{
AZ_Error(s_traceName, false, "Failed to get IArchive interface!");
}
ArchiveCommandsBus::Handler::BusConnect();
}
void ArchiveComponent::Deactivate()
{
ArchiveCommands::Bus::Handler::BusDisconnect();
ArchiveCommandsBus::Handler::BusDisconnect();
AZStd::unique_lock<AZStd::mutex> lock(m_threadControlMutex);
for (auto pair : m_threadInfoMap)
m_fileIO = nullptr;
m_archive = nullptr;
for (AZStd::thread& t : m_threads)
{
ThreadInfo& info = pair.second;
info.shouldStop = true;
m_cv.wait(lock, [&info]() {
return info.threads.size() == 0;
});
t.join();
}
m_threadInfoMap.clear();
m_threads = {};
}
void ArchiveComponent::Reflect(AZ::ReflectContext * context)
@@ -132,7 +112,7 @@ namespace AzToolsFramework
{
serializeContext->Class<ArchiveComponent, AZ::Component>()
->Version(2)
->Attribute(AZ::Edit::Attributes::SystemComponentTags, AZStd::vector<AZ::Crc32>({ AZ_CRC("AssetBuilder", 0xc739c7d7) }))
->Attribute(AZ::Edit::Attributes::SystemComponentTags, AZStd::vector<AZ::Crc32>({ AZ_CRC_CE("AssetBuilder") }))
;
if (AZ::EditContext* editContext = serializeContext->GetEditContext())
@@ -141,320 +121,480 @@ namespace AzToolsFramework
"Archive", "Handles creation and extraction of zip archives.")
->ClassElement(AZ::Edit::ClassElements::EditorData, "")
->Attribute(AZ::Edit::Attributes::Category, "Editor")
->Attribute(AZ::Edit::Attributes::AppearsInAddComponentMenu, AZ_CRC("System", 0xc94d118b))
->Attribute(AZ::Edit::Attributes::AppearsInAddComponentMenu, AZ_CRC_CE("System"))
;
}
}
}
void ArchiveComponent::CreateArchive(const AZStd::string& archivePath, const AZStd::string& dirToArchive, AZ::Uuid taskHandle, const ArchiveResponseOutputCallback& respCallback)
std::future<bool> ArchiveComponent::CreateArchive(
const AZStd::string& archivePath,
const AZStd::string& dirToArchive)
{
AZStd::string commandLineArgs = AZStd::string::format(R"(a -tzip -mx=1 "%s" -r "%s\*")", archivePath.c_str(), dirToArchive.c_str());
LaunchZipExe(m_zipExePath, commandLineArgs, respCallback, taskHandle);
}
bool ArchiveComponent::CreateArchiveBlocking(const AZStd::string& archivePath, const AZStd::string& dirToArchive)
{
bool success = false;
auto createArchiveCallback = [&success](bool result, AZStd::string consoleOutput) {
success = result;
};
AZStd::string commandLineArgs = Platform::GetCreateArchiveCommand(archivePath, dirToArchive);
if (commandLineArgs.empty())
if (!CheckParamsForCreate(archivePath, dirToArchive))
{
// The platform-specific implementation has already thrown its own error, no need to throw another one
return false;
std::promise<bool> p;
p.set_value(false);
return p.get_future();
}
LaunchZipExe(m_zipExePath, commandLineArgs, createArchiveCallback, AZ::Uuid::CreateNull(), dirToArchive, false);
return success;
}
void ArchiveComponent::ExtractArchive(const AZStd::string& archivePath, const AZStd::string& destinationPath, AZ::Uuid taskHandle, const ArchiveResponseCallback& respCallback)
{
ArchiveResponseOutputCallback responseHandler = [respCallback](bool result, AZStd::string /*outputStr*/) { respCallback(result); };
ExtractArchiveOutput(archivePath, destinationPath, taskHandle, responseHandler);
}
void ArchiveComponent::ExtractArchiveOutput(const AZStd::string& archivePath, const AZStd::string& destinationPath, AZ::Uuid taskHandle, const ArchiveResponseOutputCallback& respCallback)
{
AZStd::string commandLineArgs = Platform::GetExtractArchiveCommand(archivePath, destinationPath, true);
if (commandLineArgs.empty())
auto FnCreateArchive = [this, archivePath, dirToArchive](std::promise<bool>&& p) -> void
{
// The platform-specific implementation has already thrown its own error, no need to throw another one
return;
}
LaunchZipExe(m_unzipExePath, commandLineArgs, respCallback, taskHandle);
}
void ArchiveComponent::ExtractArchiveWithoutRoot(const AZStd::string& archivePath, const AZStd::string& destinationPath, AZ::Uuid taskHandle, const ArchiveResponseOutputCallback& respCallback)
{
AZStd::string commandLineArgs = Platform::GetExtractArchiveCommand(archivePath, destinationPath, false);
if (commandLineArgs.empty())
{
// The platform-specific implementation has already thrown its own error, no need to throw another one
return;
}
LaunchZipExe(m_unzipExePath, commandLineArgs, respCallback, taskHandle);
}
void ArchiveComponent::ExtractFile(const AZStd::string& archivePath, const AZStd::string& fileInArchive, const AZStd::string& destinationPath, bool overWrite, AZ::Uuid taskHandle, const ArchiveResponseOutputCallback& respCallback)
{
AZStd::string commandLineArgs = AzToolsFramework::Platform::GetExtractFileCommand(archivePath, fileInArchive, destinationPath, overWrite);
if (commandLineArgs.empty())
{
// The platform-specific implementation has already thrown its own error, no need to throw another one
return;
}
LaunchZipExe(m_unzipExePath, commandLineArgs, respCallback, taskHandle);
}
bool ArchiveComponent::ExtractFileBlocking(const AZStd::string& archivePath, const AZStd::string& fileInArchive, const AZStd::string& destinationPath, bool overWrite)
{
AZStd::string commandLineArgs = AzToolsFramework::Platform::GetExtractFileCommand(archivePath, fileInArchive, destinationPath, overWrite);
if (commandLineArgs.empty())
{
// The platform-specific implementation has already thrown its own error, no need to throw another one
return false;
}
bool success = false;
auto createArchiveCallback = [&success](bool result, AZStd::string consoleOutput) {
success = result;
};
LaunchZipExe(m_unzipExePath, commandLineArgs, createArchiveCallback);
return success;
}
void ArchiveComponent::ListFilesInArchive(const AZStd::string& archivePath, AZStd::vector<AZStd::string>& fileEntries, AZ::Uuid taskHandle, const ArchiveResponseOutputCallback& respCallback)
{
AZStd::string commandLineArgs = Platform::GetListFilesInArchiveCommand(archivePath);
auto parseOutput = [respCallback, &fileEntries](bool exitCode, AZStd::string consoleOutput)
{
Platform::ParseConsoleOutputFromListFilesInArchive(consoleOutput, fileEntries);
AZ::TickBus::QueueFunction(respCallback, exitCode, AZStd::move(consoleOutput));
};
LaunchZipExe(m_unzipExePath, commandLineArgs, parseOutput, taskHandle, "", true);
}
bool ArchiveComponent::ListFilesInArchiveBlocking(const AZStd::string& archivePath, AZStd::vector<AZStd::string>& fileEntries)
{
AZStd::string listOutput;
AZStd::string commandLineArgs = Platform::GetListFilesInArchiveCommand(archivePath.c_str());
bool success = false;
auto parseOutput = [&success, &fileEntries](bool result, AZStd::string consoleOutput)
{
Platform::ParseConsoleOutputFromListFilesInArchive(consoleOutput, fileEntries);
success = result;
};
LaunchZipExe(m_unzipExePath, commandLineArgs, parseOutput, AZ::Uuid::CreateNull(), "", true);
return success;
}
void ArchiveComponent::AddFileToArchive(const AZStd::string& archivePath, const AZStd::string& workingDirectory, const AZStd::string& fileToAdd, AZ::Uuid taskHandle, const ArchiveResponseOutputCallback& respCallback)
{
AZStd::string commandLineArgs = Platform::GetAddFileToArchiveCommand(archivePath, fileToAdd);
if (commandLineArgs.empty())
{
// The platform-specific implementation has already thrown its own error, no need to throw another one
return;
}
LaunchZipExe(m_zipExePath, commandLineArgs, respCallback, taskHandle, workingDirectory);
}
bool ArchiveComponent::AddFileToArchiveBlocking(const AZStd::string& archivePath, const AZStd::string& workingDirectory, const AZStd::string& fileToAdd)
{
AZStd::string commandLineArgs = Platform::GetAddFileToArchiveCommand(archivePath, fileToAdd);
if (commandLineArgs.empty())
{
// The platform-specific implementation has already thrown its own error, no need to throw another one
return false;
}
bool success = false;
auto addFileToArchiveCallback = [&success](bool result, AZStd::string consoleOutput) {
success = result;
};
LaunchZipExe(m_zipExePath, commandLineArgs, addFileToArchiveCallback, AZ::Uuid::CreateNull(), workingDirectory);
return success;
}
bool ArchiveComponent::AddFilesToArchiveBlocking(const AZStd::string& archivePath, const AZStd::string& workingDirectory, const AZStd::string& listFilePath)
{
bool success = false;
auto addFileToArchiveCallback = [&success](bool result, AZStd::string consoleOutput) {
success = result;
};
AZStd::string commandLineArgs = Platform::GetAddFilesToArchiveCommand(archivePath.c_str(), listFilePath.c_str());
if (commandLineArgs.empty())
{
// The platform-specific implementation has already thrown its own error, no need to throw another one
return false;
}
LaunchZipExe(m_zipExePath, commandLineArgs, addFileToArchiveCallback, AZ::Uuid::CreateNull(), workingDirectory);
return success;
}
void ArchiveComponent::AddFilesToArchive(const AZStd::string& archivePath, const AZStd::string& workingDirectory, const AZStd::string& listFilePath, AZ::Uuid taskHandle, const ArchiveResponseOutputCallback& respCallback)
{
AZStd::string commandLineArgs = Platform::GetAddFilesToArchiveCommand(archivePath, listFilePath);
if (commandLineArgs.empty())
{
// The platform-specific implementation has already thrown its own error, no need to throw another one
return;
}
LaunchZipExe(m_zipExePath, commandLineArgs, respCallback, taskHandle, workingDirectory);
}
bool ArchiveComponent::ExtractArchiveBlocking(const AZStd::string& archivePath, const AZStd::string& destinationPath, bool extractWithRootDirectory)
{
AZStd::string commandLineArgs = Platform::GetExtractArchiveCommand(archivePath, destinationPath, extractWithRootDirectory);
if (commandLineArgs.empty())
{
// The platform-specific implementation has already thrown its own error, no need to throw another one
return false;
}
bool success = false;
auto extractArchiveCallback = [&success](bool result, AZStd::string consoleOutput) {
success = result;
};
LaunchZipExe(m_unzipExePath, commandLineArgs, extractArchiveCallback);
return success;
}
void ArchiveComponent::CancelTasks(AZ::Uuid taskHandle)
{
AZStd::unique_lock<AZStd::mutex> lock(m_threadControlMutex);
auto it = m_threadInfoMap.find(taskHandle);
if (it == m_threadInfoMap.end())
{
return;
}
ThreadInfo& info = it->second;
info.shouldStop = true;
m_cv.wait(lock, [&info]() {
return info.threads.size() == 0;
});
m_threadInfoMap.erase(it);
}
void ArchiveComponent::LaunchZipExe(const AZStd::string& exePath, const AZStd::string& commandLineArgs, const ArchiveResponseOutputCallback& respCallback, AZ::Uuid taskHandle, const AZStd::string& workingDir, bool captureOutput)
{
auto sevenZJob = [=]()
{
if (!taskHandle.IsNull())
auto archive = m_archive->OpenArchive(archivePath, {}, AZ::IO::INestedArchive::FLAGS_CREATE_NEW);
if (!archive)
{
AZStd::unique_lock<AZStd::mutex> lock(m_threadControlMutex);
m_threadInfoMap[taskHandle].threads.insert(AZStd::this_thread::get_id());
m_cv.notify_all();
AZ_Error(s_traceName, false, "Failed to create archive file '%s'", archivePath.c_str());
p.set_value(false);
return;
}
AzFramework::ProcessLauncher::ProcessLaunchInfo info;
info.m_commandlineParameters = exePath + " " + commandLineArgs;
info.m_showWindow = false;
if (!workingDir.empty())
auto foundFiles = AzFramework::FileFunc::FindFilesInPath(dirToArchive, "*", true);
if (!foundFiles.IsSuccess())
{
info.m_workingDirectory = workingDir;
AZ_Error(s_traceName, false, "Failed to find file listing under directory '%d'", dirToArchive.c_str());
p.set_value(false);
return;
}
AZStd::unique_ptr<AzFramework::ProcessWatcher> watcher(AzFramework::ProcessWatcher::LaunchProcess(info, AzFramework::ProcessCommunicationType::COMMUNICATOR_TYPE_STDINOUT));
AZStd::string consoleOutput;
AZ::u32 exitCode = static_cast<AZ::u32>(SevenZipExitCode::UserStoppedProcess);
if (watcher)
bool success = true;
AZStd::vector<char> fileBuffer;
const AZ::IO::Path workingPath{ dirToArchive };
for (const auto& fileName : foundFiles.GetValue())
{
// callback requires output captured from 7z
if (captureOutput)
bool thisSuccess = false;
AZ::IO::PathView relativePath = AZ::IO::PathView{ fileName }.LexicallyRelative(workingPath);
AZ::IO::Path fullPath = (workingPath / relativePath);
if (ArchiveUtils::ReadFile(fullPath, AZ::IO::OpenMode::ModeRead, fileBuffer))
{
AZStd::string consoleBuffer;
while (watcher->IsProcessRunning(&exitCode))
{
if (!taskHandle.IsNull())
{
AZStd::unique_lock<AZStd::mutex> lock(m_threadControlMutex);
if (m_threadInfoMap[taskHandle].shouldStop)
{
watcher->TerminateProcess(static_cast<AZ::u32>(SevenZipExitCode::UserStoppedProcess));
}
}
watcher->WaitForProcessToExit(g_sleepDuration, &exitCode);
AZ::u32 outputSize = watcher->GetCommunicator()->PeekOutput();
if (outputSize)
{
consoleBuffer.resize(outputSize);
watcher->GetCommunicator()->ReadOutput(consoleBuffer.data(), outputSize);
consoleOutput += consoleBuffer;
}
}
int result = archive->UpdateFile(
relativePath.Native(), fileBuffer.data(), fileBuffer.size(), s_compressionMethod,
s_compressionLevel, s_compressionCodec);
thisSuccess = (result == AZ::IO::ZipDir::ZD_ERROR_SUCCESS);
AZ_Error(
s_traceName, thisSuccess, "Error %d encountered while adding '%s' to archive '%.*s'", result, fileName.c_str(),
AZ_STRING_ARG(archive->GetFullPath().Native()));
}
else
{
ConsoleEchoCommunicator echoCommunicator(watcher->GetCommunicator());
while (watcher->IsProcessRunning(&exitCode))
{
if (!taskHandle.IsNull())
{
AZStd::unique_lock<AZStd::mutex> lock(m_threadControlMutex);
if (m_threadInfoMap[taskHandle].shouldStop)
{
watcher->TerminateProcess(static_cast<AZ::u32>(SevenZipExitCode::UserStoppedProcess));
}
}
watcher->WaitForProcessToExit(g_sleepDuration, &exitCode);
echoCommunicator.Pump();
}
AZ_Error(
s_traceName, false, "Error encountered while reading '%s' to add to archive '%.*s'", fileName.c_str(),
AZ_STRING_ARG(archive->GetFullPath().Native()));
}
success = (success && thisSuccess);
}
if (taskHandle.IsNull())
archive.reset();
p.set_value(success);
};
// Async task...
std::promise<bool> p;
std::future<bool> f = p.get_future();
AZStd::thread_desc threadDesc;
threadDesc.m_name = "Archive Task (Create)";
m_threads.emplace_back(threadDesc, FnCreateArchive, AZStd::move(p));
return f;
}
std::future<bool> ArchiveComponent::ExtractArchive(
const AZStd::string& archivePath,
const AZStd::string& destinationPath)
{
if (!CheckParamsForExtract(archivePath, destinationPath))
{
std::promise<bool> p;
p.set_value(false);
return p.get_future();
}
auto FnExtractArchive = [this, archivePath, destinationPath](std::promise<bool>&& p) -> void
{
auto archive = m_archive->OpenArchive(archivePath, {}, AZ::IO::INestedArchive::FLAGS_READ_ONLY);
if (!archive)
{
respCallback(exitCode == static_cast<AZ::u32>(SevenZipExitCode::NoError), AZStd::move(consoleOutput));
AZ_Error(s_traceName, false, "Failed to open archive file '%s'", archivePath.c_str());
p.set_value(false);
return;
}
AZStd::vector<AZ::IO::Path> filesInArchive;
if (int result = archive->ListAllFiles(filesInArchive); result != AZ::IO::ZipDir::ZD_ERROR_SUCCESS)
{
AZ_Error(s_traceName, false, "Failed to get list of files in archive '%s'", archivePath.c_str());
p.set_value(false);
return;
}
AZStd::vector<AZ::u8> fileBuffer;
AZ::IO::Path destination{ destinationPath };
AZ::u64 fileSize = 0;
AZ::u64 numFilesWritten = 0;
AZ::u64 bytesWritten = 0;
AZ::IO::INestedArchive::Handle srcHandle{};
AZ::IO::HandleType dstHandle = AZ::IO::InvalidHandle;
constexpr AZ::IO::OpenMode openMode =
(AZ::IO::OpenMode::ModeCreatePath | AZ::IO::OpenMode::ModeWrite | AZ::IO::OpenMode::ModeUpdate);
for (const auto& filePath : filesInArchive)
{
srcHandle = archive->FindFile(filePath.Native());
AZ_Assert(srcHandle != nullptr, "File '%s' does not exist inside archive '%s'", filePath.c_str(), archivePath.c_str());
fileSize = (srcHandle != nullptr) ? archive->GetFileSize(srcHandle) : 0;
fileBuffer.resize_no_construct(fileSize);
if (auto result = archive->ReadFile(srcHandle, fileBuffer.data()); result != AZ::IO::ZipDir::ZD_ERROR_SUCCESS)
{
AZ_Error(
s_traceName, false, "Failed to read file '%s' in archive '%s' with error %d", filePath.c_str(), archivePath.c_str(),
result);
continue;
}
AZ::IO::Path destinationFile = destination / filePath;
if (!m_fileIO->Open(destinationFile.c_str(), openMode, dstHandle))
{
AZ_Error(s_traceName, false, "Failed to open '%s' for writing", destinationFile.c_str());
continue;
}
if (!m_fileIO->Write(dstHandle, fileBuffer.data(), fileSize, &bytesWritten))
{
AZ_Error(s_traceName, false, "Failed to write destination file '%s'", destinationFile.c_str());
}
else if (bytesWritten == fileSize)
{
++numFilesWritten;
}
m_fileIO->Close(dstHandle);
}
p.set_value(numFilesWritten == filesInArchive.size());
};
// Async task...
std::promise<bool> p;
std::future<bool> f = p.get_future();
AZStd::thread_desc threadDesc;
threadDesc.m_name = "Archive Task (Extract)";
m_threads.emplace_back(threadDesc, FnExtractArchive, AZStd::move(p));
return f;
}
std::future<bool> ArchiveComponent::ExtractFile(
const AZStd::string& archivePath,
const AZStd::string& fileInArchive,
const AZStd::string& destinationPath)
{
if (!CheckParamsForExtract(archivePath, destinationPath))
{
std::promise<bool> p;
p.set_value(false);
return p.get_future();
}
auto FnExtractFile = [this, archivePath, fileInArchive, destinationPath](std::promise<bool>&& p) -> void
{
auto archive = m_archive->OpenArchive(archivePath, {}, AZ::IO::INestedArchive::FLAGS_READ_ONLY);
if (!archive)
{
AZ_Error(s_traceName, false, "Failed to open archive file '%s'", archivePath.c_str());
p.set_value(false);
return;
}
AZ::IO::INestedArchive::Handle fileHandle = archive->FindFile(fileInArchive);
if (!fileHandle)
{
AZ_Error(s_traceName, false, "File '%s' does not exist inside archive '%s'", fileInArchive.c_str(), archivePath.c_str());
p.set_value(false);
return;
}
AZ::u64 fileSize = archive->GetFileSize(fileHandle);
AZStd::vector<AZ::u8> fileBuffer;
fileBuffer.resize_no_construct(fileSize);
if (auto result = archive->ReadFile(fileHandle, fileBuffer.data()); result != AZ::IO::ZipDir::ZD_ERROR_SUCCESS)
{
AZ_Error(
s_traceName, false, "Failed to read file '%s' in archive '%s' with error %d", fileInArchive.c_str(),
archivePath.c_str(), result);
p.set_value(false);
return;
}
AZ::IO::HandleType destFileHandle = AZ::IO::InvalidHandle;
AZ::IO::Path destinationFile{ destinationPath };
destinationFile /= fileInArchive;
AZ::IO::OpenMode openMode = (AZ::IO::OpenMode::ModeCreatePath | AZ::IO::OpenMode::ModeWrite | AZ::IO::OpenMode::ModeUpdate);
if (!m_fileIO->Open(destinationFile.c_str(), openMode, destFileHandle))
{
AZ_Error(s_traceName, false, "Failed to open destination file '%s' for writing", destinationFile.c_str());
p.set_value(false);
return;
}
AZ::u64 bytesWritten = 0;
if (!m_fileIO->Write(destFileHandle, fileBuffer.data(), fileSize, &bytesWritten))
{
AZ_Error(s_traceName, false, "Failed to write destination file '%s'", destinationFile.c_str());
}
m_fileIO->Close(destFileHandle);
p.set_value(bytesWritten == fileSize);
};
// Async task...
std::promise<bool> p;
std::future<bool> f = p.get_future();
AZStd::thread_desc threadDesc;
threadDesc.m_name = "Archive Task (Extract Single)";
m_threads.emplace_back(threadDesc, FnExtractFile, AZStd::move(p));
return f;
}
bool ArchiveComponent::ListFilesInArchive(const AZStd::string& archivePath, AZStd::vector<AZStd::string>& outFileEntries)
{
if (!m_fileIO || !m_archive)
{
return false;
}
if (!m_fileIO->Exists(archivePath.c_str()))
{
AZ_Error(s_traceName, false, "Archive '%s' does not exist!", archivePath.c_str());
return false;
}
auto archive = m_archive->OpenArchive(archivePath, {}, AZ::IO::INestedArchive::FLAGS_READ_ONLY);
if (!archive)
{
AZ_Error(s_traceName, false, "Failed to open archive file '%s'", archivePath.c_str());
return false;
}
AZStd::vector<AZ::IO::Path> fileEntries;
int result = archive->ListAllFiles(fileEntries);
outFileEntries.clear();
for (const auto& path : fileEntries)
{
outFileEntries.emplace_back(path.String());
}
return (result == AZ::IO::ZipDir::ZD_ERROR_SUCCESS);
}
std::future<bool> ArchiveComponent::AddFileToArchive(
const AZStd::string& archivePath,
const AZStd::string& workingDirectory,
const AZStd::string& fileToAdd)
{
if (!CheckParamsForAdd(workingDirectory, fileToAdd))
{
std::promise<bool> p;
p.set_value(false);
return p.get_future();
}
auto FnAddFileToArchive = [this, archivePath, workingDirectory, fileToAdd](std::promise<bool>&& p) -> void
{
auto archive = m_archive->OpenArchive(archivePath);
if (!archive)
{
AZ_Error(s_traceName, false, "Failed to open archive file '%s'", archivePath.c_str());
p.set_value(false);
return;
}
AZ::IO::Path workingPath{ workingDirectory };
AZ::IO::Path fullPath = workingPath / fileToAdd;
AZ::IO::PathView relativePath = AZ::IO::PathView{ fullPath }.LexicallyRelative(workingPath);
AZStd::vector<char> fileBuffer;
bool success = false;
if (ArchiveUtils::ReadFile(fullPath, AZ::IO::OpenMode::ModeRead, fileBuffer))
{
int result = archive->UpdateFile(
relativePath.Native(), fileBuffer.data(), fileBuffer.size(), s_compressionMethod,
s_compressionLevel, s_compressionCodec);
success = (result == AZ::IO::ZipDir::ZD_ERROR_SUCCESS);
AZ_Error(
s_traceName, success, "Error %d encountered while adding '%s' to archive '%.*s'", result, fileToAdd.c_str(),
AZ_STRING_ARG(archive->GetFullPath().Native()));
}
else
{
AZ::TickBus::QueueFunction(respCallback, (exitCode == static_cast<AZ::u32>(SevenZipExitCode::NoError)), AZStd::move(consoleOutput));
AZ_Error(
s_traceName, false, "Error encountered while reading '%s' to add to archive '%.*s'", fileToAdd.c_str(),
AZ_STRING_ARG(archive->GetFullPath().Native()));
}
if (!taskHandle.IsNull())
{
AZStd::unique_lock<AZStd::mutex> lock(m_threadControlMutex);
ThreadInfo& tInfo = m_threadInfoMap[taskHandle];
tInfo.threads.erase(AZStd::this_thread::get_id());
m_cv.notify_all();
}
archive.reset();
p.set_value(success);
};
if (!taskHandle.IsNull())
{
AZStd::thread processThread(sevenZJob);
AZStd::unique_lock<AZStd::mutex> lock(m_threadControlMutex);
ThreadInfo& info = m_threadInfoMap[taskHandle];
m_cv.wait(lock, [&info, &processThread]() {
return info.threads.find(processThread.get_id()) != info.threads.end();
});
processThread.detach();
}
else
{
sevenZJob();
}
// Async task...
std::promise<bool> p;
std::future<bool> f = p.get_future();
AZStd::thread_desc threadDesc;
threadDesc.m_name = "Archive Task (Add Single)";
m_threads.emplace_back(threadDesc, FnAddFileToArchive, AZStd::move(p));
return f;
}
std::future<bool> ArchiveComponent::AddFilesToArchive(
const AZStd::string& archivePath,
const AZStd::string& workingDirectory,
const AZStd::string& listFilePath)
{
if (!CheckParamsForAdd(workingDirectory, listFilePath))
{
std::promise<bool> p;
p.set_value(false);
return p.get_future();
}
auto FnAddFilesToArchive = [this, archivePath, workingDirectory, listFilePath](std::promise<bool>&& p) -> void
{
auto archive = m_archive->OpenArchive(archivePath);
if (!archive)
{
AZ_Error(s_traceName, false, "Failed to open archive file '%s'", archivePath.c_str());
p.set_value(false);
return;
}
bool success = true; // starts true and turns false when any error is encountered.
AZ::IO::Path basePath{ workingDirectory };
auto PerLineCallback = [&success, &basePath, &archive](AZStd::string_view filePathLine) -> void
{
AZStd::vector<char> fileBuffer;
AZ::IO::Path fullPath = (basePath / filePathLine);
if (ArchiveUtils::ReadFile(fullPath, AZ::IO::OpenMode::ModeRead, fileBuffer))
{
int result = archive->UpdateFile(
filePathLine, fileBuffer.data(), fileBuffer.size(), s_compressionMethod,
s_compressionLevel, s_compressionCodec);
bool thisSuccess = (result == AZ::IO::ZipDir::ZD_ERROR_SUCCESS);
success = (success && thisSuccess);
AZ_Error(
s_traceName, thisSuccess, "Error %d encountered while adding '%.*s' to archive '%.*s'", result,
AZ_STRING_ARG(filePathLine), AZ_STRING_ARG(archive->GetFullPath().Native()));
}
else
{
AZ_Error(
s_traceName, false, "Error encountered while reading '%.*s' to add to archive '%.*s'", AZ_STRING_ARG(filePathLine),
AZ_STRING_ARG(archive->GetFullPath().Native()));
}
};
ArchiveUtils::ProcessFileList(listFilePath, PerLineCallback);
archive.reset();
p.set_value(success);
};
// Async task...
std::promise<bool> p;
std::future<bool> f = p.get_future();
AZStd::thread_desc threadDesc;
threadDesc.m_name = "Archive Task (Add)";
m_threads.emplace_back(threadDesc, FnAddFilesToArchive, AZStd::move(p));
return f;
}
bool ArchiveComponent::CheckParamsForAdd(const AZStd::string& directory, const AZStd::string& file)
{
if (!m_fileIO || !m_archive)
{
return false;
}
if (!m_fileIO->IsDirectory(directory.c_str()))
{
AZ_Error(
s_traceName, false, "Working directory '%s' is not a directory or doesn't exist!", directory.c_str());
return false;
}
if (!file.empty())
{
auto filePath = AZ::IO::Path{ directory } / file;
if (!m_fileIO->Exists(filePath.c_str()) || m_fileIO->IsDirectory(filePath.c_str()))
{
AZ_Error(s_traceName, false, "File list '%s' is a directory or doesn't exist!", filePath.c_str());
return false;
}
}
return true;
}
bool ArchiveComponent::CheckParamsForExtract(const AZStd::string& archive, const AZStd::string& directory)
{
if (!m_fileIO || !m_archive)
{
return false;
}
if (!m_fileIO->Exists(archive.c_str()))
{
AZ_Error(s_traceName, false, "Archive '%s' does not exist!", archive.c_str());
return false;
}
if (!m_fileIO->Exists(directory.c_str()))
{
if (!m_fileIO->CreatePath(directory.c_str()))
{
AZ_Error(s_traceName, false, "Failed to create destination directory '%s'", directory.c_str());
return false;
}
}
return true;
}
bool ArchiveComponent::CheckParamsForCreate(const AZStd::string& archive, const AZStd::string& directory)
{
if (!m_fileIO || !m_archive)
{
return false;
}
if (m_fileIO->Exists(archive.c_str()))
{
AZ_Error(s_traceName, false, "Archive file '%s' already exists, cannot create a new archive there!");
return false;
}
if (!m_fileIO->IsDirectory(directory.c_str()))
{
AZ_Error(s_traceName, false, "Directory '%s' is not a directory or doesn't exist!", directory.c_str());
return false;
}
return true;
}
} // namespace AzToolsFramework
@@ -10,80 +10,76 @@
#include <AzCore/base.h>
#include <AzCore/Component/Component.h>
#include <AzCore/IO/FileIO.h>
#include <AzCore/std/parallel/thread.h>
#include <AzCore/std/parallel/conditional_variable.h>
#include <AzCore/std/containers/set.h>
#include <AzCore/std/containers/unordered_set.h>
#include <AzFramework/Archive/IArchive.h>
#include <AzToolsFramework/Archive/ArchiveAPI.h>
namespace AzToolsFramework
{
enum class SevenZipExitCode : AZ::u32
{
NoError = 0,
Warning = 1,
FatalError = 2,
CommandLineError = 7,
NotEnoughMemory = 8,
UserStoppedProcess = 255
};
// the ArchiveComponent's job is to execute zip commands.
// it parses the status of zip commands and returns results.
// the ArchiveComponent's job is to create and manipulate zip archives.
class ArchiveComponent
: public AZ::Component
, private ArchiveCommands::Bus::Handler
, private ArchiveCommandsBus::Handler
{
public:
AZ_COMPONENT(ArchiveComponent, "{A19EEA33-3736-447F-ACF7-DAA4B6A179AA}")
AZ_COMPONENT(ArchiveComponent, "{A19EEA33-3736-447F-ACF7-DAA4B6A179AA}");
ArchiveComponent() = default;
~ArchiveComponent() override = default;
ArchiveComponent(const ArchiveComponent&) = delete;
ArchiveComponent& operator=(const ArchiveComponent&) = delete;
//////////////////////////////////////////////////////////////////////////
// AZ::Component overrides
void Activate() override;
void Deactivate() override;
//////////////////////////////////////////////////////////////////////////
private:
protected:
static void Reflect(AZ::ReflectContext* context);
//////////////////////////////////////////////////////////////////////////
// ArchiveCommands::Bus::Handler overrides
void CreateArchive(const AZStd::string& archivePath, const AZStd::string& dirToArchive, AZ::Uuid taskHandle, const ArchiveResponseOutputCallback& respCallback) override;
bool CreateArchiveBlocking(const AZStd::string& archivePath, const AZStd::string& dirToArchive) override;
bool ExtractArchiveBlocking(const AZStd::string& archivePath, const AZStd::string& destinationPath, bool extractWithRootDirectory) override;
void ExtractArchive(const AZStd::string& archivePath, const AZStd::string& destinationPath, AZ::Uuid taskHandle, const ArchiveResponseCallback& respCallback) override;
void ExtractArchiveOutput(const AZStd::string& archivePath, const AZStd::string& destinationPath, AZ::Uuid taskHandle, const ArchiveResponseOutputCallback& respCallback) override;
void ExtractArchiveWithoutRoot(const AZStd::string& archivePath, const AZStd::string& destinationPath, AZ::Uuid taskHandle, const ArchiveResponseOutputCallback& respCallback) override;
void ExtractFile(const AZStd::string& archivePath, const AZStd::string& fileInArchive, const AZStd::string& destinationPath, bool overWrite, AZ::Uuid taskHandle, const ArchiveResponseOutputCallback& respCallback) override;
bool ExtractFileBlocking(const AZStd::string& archivePath, const AZStd::string& fileInArchive, const AZStd::string& destinationPath, bool overWrite) override;
void ListFilesInArchive(const AZStd::string& archivePath, AZStd::vector<AZStd::string>& fileEntries, AZ::Uuid taskHandle, const ArchiveResponseOutputCallback& respCallback) override;
bool ListFilesInArchiveBlocking(const AZStd::string& archivePath, AZStd::vector<AZStd::string>& fileEntries) override;
void AddFileToArchive(const AZStd::string& archivePath, const AZStd::string& workingDirectory, const AZStd::string& fileToAdd, AZ::Uuid taskHandle, const ArchiveResponseOutputCallback& respCallback) override;
bool AddFileToArchiveBlocking(const AZStd::string& archivePath, const AZStd::string& workingDirectory, const AZStd::string& fileToAdd) override;
bool AddFilesToArchiveBlocking(const AZStd::string& archivePath, const AZStd::string& workingDirectory, const AZStd::string& listFilePath) override;
void AddFilesToArchive(const AZStd::string& archivePath, const AZStd::string& workingDirectory, const AZStd::string& listFilePath, AZ::Uuid taskHandle, const ArchiveResponseOutputCallback& respCallback) override;
void CancelTasks(AZ::Uuid taskHandle) override;
// ArchiveCommandsBus::Handler overrides
[[nodiscard]] std::future<bool> CreateArchive(
const AZStd::string& archivePath,
const AZStd::string& dirToArchive) override;
[[nodiscard]] std::future<bool> ExtractArchive(
const AZStd::string& archivePath,
const AZStd::string& destinationPath) override;
[[nodiscard]] std::future<bool> ExtractFile(
const AZStd::string& archivePath,
const AZStd::string& fileInArchive,
const AZStd::string& destinationPath) override;
bool ListFilesInArchive(const AZStd::string& archivePath, AZStd::vector<AZStd::string>& outFileEntries) override;
[[nodiscard]] std::future<bool> AddFileToArchive(
const AZStd::string& archivePath,
const AZStd::string& workingDirectory,
const AZStd::string& fileToAdd) override;
[[nodiscard]] std::future<bool> AddFilesToArchive(
const AZStd::string& archivePath,
const AZStd::string& workingDirectory,
const AZStd::string& listFilePath) override;
//////////////////////////////////////////////////////////////////////////
// Launches the input zip exe as a background child process in a detached background thread, if the task handle is not null
// otherwise launches input zip exe in the calling thread.
void LaunchZipExe(const AZStd::string& exePath, const AZStd::string& commandLineArgs, const ArchiveResponseOutputCallback& respCallback, AZ::Uuid taskHandle = AZ::Uuid::CreateNull(), const AZStd::string& workingDir = "", bool captureOutput = false);
AZStd::string m_zipExePath;
AZStd::string m_unzipExePath;
private:
AZ::IO::FileIOBase* m_fileIO = nullptr;
AZ::IO::IArchive* m_archive = nullptr;
AZStd::vector<AZStd::thread> m_threads;
// Struct for tracking background threads/tasks
struct ThreadInfo
{
bool shouldStop = false;
AZStd::set<AZStd::thread::id> threads;
};
AZStd::mutex m_threadControlMutex; // Guards m_threadInfoMap
AZStd::condition_variable m_cv;
AZStd::unordered_map<AZ::Uuid, ThreadInfo> m_threadInfoMap;
bool CheckParamsForAdd(const AZStd::string& directory, const AZStd::string& file);
bool CheckParamsForExtract(const AZStd::string& archive, const AZStd::string& directory);
bool CheckParamsForCreate(const AZStd::string& archive, const AZStd::string& directory);
};
} // namespace AzToolsFramework
@@ -16,91 +16,62 @@ namespace AzToolsFramework
void NullArchiveComponent::Activate()
{
ArchiveCommands::Bus::Handler::BusConnect();
ArchiveCommandsBus::Handler::BusConnect();
}
void NullArchiveComponent::Deactivate()
{
ArchiveCommands::Bus::Handler::BusDisconnect();
ArchiveCommandsBus::Handler::BusDisconnect();
}
bool NullArchiveComponent::ExtractArchiveBlocking(const AZStd::string& /*archivePath*/, const AZStd::string& /*destinationPath*/, bool /*extractWithRootDirectory*/)
std::future<bool> DefaultFuture()
{
std::promise<bool> p;
p.set_value(false);
return p.get_future();
}
std::future<bool> NullArchiveComponent::CreateArchive(
const AZStd::string& /*archivePath*/,
const AZStd::string& /*dirToArchive*/)
{
return DefaultFuture();
}
std::future<bool> NullArchiveComponent::ExtractArchive(
const AZStd::string& /*archivePath*/,
const AZStd::string& /*destinationPath*/)
{
return DefaultFuture();
}
std::future<bool> NullArchiveComponent::ExtractFile(
const AZStd::string& /*archivePath*/,
const AZStd::string& /*fileInArchive*/,
const AZStd::string& /*destinationPath*/)
{
return DefaultFuture();
}
bool NullArchiveComponent::ListFilesInArchive(const AZStd::string& /*archivePath*/, AZStd::vector<AZStd::string>& /*outFileEntries*/)
{
return false;
}
void NullArchiveComponent::ExtractArchive(const AZStd::string& /*archivePath*/, const AZStd::string& /*destinationPath*/, AZ::Uuid /*taskHandle*/, const ArchiveResponseCallback& respCallback)
std::future<bool> NullArchiveComponent::AddFileToArchive(
const AZStd::string& /*archivePath*/,
const AZStd::string& /*fileToAdd*/,
const AZStd::string& /*pathInArchive*/)
{
AZ::TickBus::QueueFunction(respCallback, false);
return DefaultFuture();
}
void NullArchiveComponent::ExtractArchiveOutput(const AZStd::string& /*archivePath*/, const AZStd::string& /*destinationPath*/, AZ::Uuid /*taskHandle*/, const ArchiveResponseOutputCallback& respCallback)
{
AZ::TickBus::QueueFunction(respCallback, false, AZStd::string());
}
void NullArchiveComponent::ExtractArchiveWithoutRoot(const AZStd::string& /*archivePath*/, const AZStd::string& /*destinationPath*/, AZ::Uuid /*taskHandle*/, const ArchiveResponseOutputCallback& respCallback)
{
AZ::TickBus::QueueFunction(respCallback, false, AZStd::string());
}
void NullArchiveComponent::ExtractFile(const AZStd::string& /*archivePath*/, const AZStd::string& /*fileInArchive*/, const AZStd::string& /*destinationPath*/, bool /*overWrite*/, AZ::Uuid /*taskHandle*/, const ArchiveResponseOutputCallback& respCallback)
{
// Always report we failed to extract
AZ::TickBus::QueueFunction(respCallback, false, AZStd::string());
}
bool NullArchiveComponent::ExtractFileBlocking(const AZStd::string& /*archivePath*/, const AZStd::string& /*fileInArchive*/, const AZStd::string& /*destinationPath*/, bool /*overWrite*/)
{
return false;
}
void NullArchiveComponent::ListFilesInArchive(const AZStd::string& /*archivePath*/, AZStd::vector<AZStd::string>& /*consoleOutput*/, AZ::Uuid /*taskHandle*/, const ArchiveResponseOutputCallback& respCallback)
{
// Always report we failed to extract
AZ::TickBus::QueueFunction(respCallback, false, AZStd::string());
}
bool NullArchiveComponent::ListFilesInArchiveBlocking(const AZStd::string& /*archivePath*/, AZStd::vector<AZStd::string>& /*consoleOutput*/)
{
return false;
}
void NullArchiveComponent::AddFileToArchive(const AZStd::string& /*archivePath*/, const AZStd::string& /*fileToAdd*/, const AZStd::string& /*pathInArchive*/, AZ::Uuid /*taskHandle*/, const ArchiveResponseOutputCallback& respCallback)
{
// Always report we failed to extract
AZ::TickBus::QueueFunction(respCallback, false, AZStd::string());
}
bool NullArchiveComponent::AddFileToArchiveBlocking(const AZStd::string& /*archivePath*/, const AZStd::string& /*fileToAdd*/, const AZStd::string& /*pathInArchive*/)
{
return false;
}
bool NullArchiveComponent::AddFilesToArchiveBlocking(const AZStd::string& /*archivePath*/, const AZStd::string& /*workingDirectory*/, const AZStd::string& /*listFilePath*/)
{
return false;
}
void NullArchiveComponent::AddFilesToArchive(const AZStd::string& /*archivePath*/, const AZStd::string& /*workingDirectory*/, const AZStd::string& /*listFilePath*/, AZ::Uuid /*taskHandle*/, const ArchiveResponseOutputCallback& respCallback)
{
// Always report we failed to extract
AZ::TickBus::QueueFunction(respCallback, false, AZStd::string());
}
void NullArchiveComponent::CreateArchive(const AZStd::string& /*archivePath*/, const AZStd::string& /*dirToArchive*/, AZ::Uuid /*taskHandle*/, const ArchiveResponseOutputCallback& respCallback)
{
// Always report we failed to extract
AZ::TickBus::QueueFunction(respCallback, false, AZStd::string());
}
bool NullArchiveComponent::CreateArchiveBlocking(const AZStd::string& /*archivePath*/, const AZStd::string& /*dirToArchive*/)
{
return false;
}
void NullArchiveComponent::CancelTasks(AZ::Uuid /*taskHandle*/)
std::future<bool> NullArchiveComponent::AddFilesToArchive(
const AZStd::string& /*archivePath*/,
const AZStd::string& /*workingDirectory*/,
const AZStd::string& /*listFilePath*/)
{
return DefaultFuture();
}
void NullArchiveComponent::Reflect(AZ::ReflectContext* context)
@@ -15,7 +15,7 @@ namespace AzToolsFramework
{
class NullArchiveComponent
: public AZ::Component
, private ArchiveCommands::Bus::Handler
, private ArchiveCommandsBus::Handler
{
public:
AZ_COMPONENT(NullArchiveComponent, "{D665B6B1-5FF4-4203-B19F-BBDB82587129}")
@@ -32,23 +32,31 @@ namespace AzToolsFramework
static void Reflect(AZ::ReflectContext* context);
//////////////////////////////////////////////////////////////////////////
// ArchiveCommands::Bus::Handler overrides
// ArchiveCommands::Bus::Handler overrides
void CreateArchive(const AZStd::string& archivePath, const AZStd::string& dirToArchive, AZ::Uuid taskHandle, const ArchiveResponseOutputCallback& respCallback) override;
bool CreateArchiveBlocking(const AZStd::string& archivePath, const AZStd::string& dirToArchive) override;
bool ExtractArchiveBlocking(const AZStd::string& archivePath, const AZStd::string& destinationPath, bool extractWithRootDirectory) override;
void ExtractArchive(const AZStd::string& archivePath, const AZStd::string& destinationPath, AZ::Uuid taskHandle, const ArchiveResponseCallback& respCallback) override;
void ExtractArchiveOutput(const AZStd::string& archivePath, const AZStd::string& destinationPath, AZ::Uuid taskHandle, const ArchiveResponseOutputCallback& respCallback) override;
void ExtractArchiveWithoutRoot(const AZStd::string& archivePath, const AZStd::string& destinationPath, AZ::Uuid taskHandle, const ArchiveResponseOutputCallback& respCallback) override;
void ExtractFile(const AZStd::string& archivePath, const AZStd::string& fileInArchive, const AZStd::string& destinationPath, bool overWrite, AZ::Uuid taskHandle, const ArchiveResponseOutputCallback& respCallback) override;
bool ExtractFileBlocking(const AZStd::string& archivePath, const AZStd::string& fileInArchive, const AZStd::string& destinationPath, bool overWrite) override;
void ListFilesInArchive(const AZStd::string& archivePath, AZStd::vector<AZStd::string>& consoleOutput, AZ::Uuid taskHandle, const ArchiveResponseOutputCallback& respCallback) override;
bool ListFilesInArchiveBlocking(const AZStd::string& archivePath, AZStd::vector<AZStd::string>& consoleOutput) override;
void AddFileToArchive(const AZStd::string& archivePath, const AZStd::string& fileToAdd, const AZStd::string& pathInArchive, AZ::Uuid taskHandle, const ArchiveResponseOutputCallback& respCallback) override;
bool AddFileToArchiveBlocking(const AZStd::string& archivePath, const AZStd::string& fileToAdd, const AZStd::string& pathInArchive) override;
bool AddFilesToArchiveBlocking(const AZStd::string& archivePath, const AZStd::string& workingDirectory, const AZStd::string& listFilePath) override;
void AddFilesToArchive(const AZStd::string& archivePath, const AZStd::string& workingDirectory, const AZStd::string& listFilePath, AZ::Uuid taskHandle, const ArchiveResponseOutputCallback& respCallback) override;
void CancelTasks(AZ::Uuid taskHandle) override;
// ArchiveCommandsBus::Handler overrides
[[nodiscard]] std::future<bool> CreateArchive(
const AZStd::string& archivePath,
const AZStd::string& dirToArchive) override;
[[nodiscard]] std::future<bool> ExtractArchive(
const AZStd::string& archivePath,
const AZStd::string& destinationPath) override;
[[nodiscard]] std::future<bool> ExtractFile(
const AZStd::string& archivePath,
const AZStd::string& fileInArchive,
const AZStd::string& destinationPath) override;
bool ListFilesInArchive(const AZStd::string& archivePath, AZStd::vector<AZStd::string>& outFileEntries) override;
[[nodiscard]] std::future<bool> AddFileToArchive(
const AZStd::string& archivePath,
const AZStd::string& workingDirectory,
const AZStd::string& fileToAdd) override;
[[nodiscard]] std::future<bool> AddFilesToArchive(
const AZStd::string& archivePath,
const AZStd::string& workingDirectory,
const AZStd::string& listFilePath) override;
//////////////////////////////////////////////////////////////////////////
};
} // namespace AzToolsFramework
@@ -20,7 +20,7 @@ AZ_PUSH_DISABLE_WARNING(4251, "-Wunknown-warning-option")
AZ_POP_DISABLE_WARNING
AZ_CVAR(
bool, ed_useNewAssetBrowserTableView, true, nullptr, AZ::ConsoleFunctorFlags::Null,
bool, ed_useNewAssetBrowserTableView, false, nullptr, AZ::ConsoleFunctorFlags::Null,
"Use the new AssetBrowser TableView for searching assets.");
namespace AzToolsFramework
{
@@ -290,7 +290,7 @@ namespace AzToolsFramework
absoluteIconPath = AZ::IO::FixedMaxPath(AZ::Utils::GetEnginePath()) / TreeIconPathOneChild;
break;
}
bool pixmapLoadedSuccess = pixmap.load(absoluteIconPath.c_str());
[[maybe_unused]] bool pixmapLoadedSuccess = pixmap.load(absoluteIconPath.c_str());
AZ_Assert(pixmapLoadedSuccess, "Error loading Branch Icons in SearchEntryDelegate");
m_branchIcons[static_cast<EntryBranchType>(branchType)] = pixmap;
@@ -32,12 +32,10 @@ namespace AzToolsFramework
const int NumOfBytesInMB = 1024 * 1024;
const int ManifestFileSizeBufferInBytes = 10 * 1024; // 10 KB
const float AssetCatalogFileSizeBufferPercentage = 1.0f;
using ArchiveCommandsBus = AzToolsFramework::ArchiveCommands::Bus;
using AssetCatalogRequestBus = AZ::Data::AssetCatalogRequestBus;
const char AssetBundleComponent::DeltaCatalogName[] = "DeltaCatalog.xml";
constexpr int SleepTimeMS = 250;
constexpr int InjectFileRetryCount = 4;
@@ -136,7 +134,7 @@ namespace AzToolsFramework
AZ_TracePrintf(logWindowName, "Gathering file entries in source pak file \"%s\".\n", sourcePak.c_str());
bool result = false;
AZStd::vector<AZStd::string> fileEntries;
ArchiveCommandsBus::BroadcastResult(result, &AzToolsFramework::ArchiveCommands::ListFilesInArchiveBlocking, normalizedSourcePakPath, fileEntries);
ArchiveCommandsBus::BroadcastResult(result, &AzToolsFramework::ArchiveCommandsBus::Events::ListFilesInArchive, normalizedSourcePakPath, fileEntries);
// This ebus currently always returns false as the result, as it is believed that the 7z process is
// being terminated by the user instead of ending gracefully. Check against an empty fileList instead
// as a result.
@@ -606,15 +604,17 @@ namespace AzToolsFramework
{
AZ_TracePrintf(logWindowName, "Injecting file (%s) into bundle (%s).\n", filePath.c_str(), archiveFilePath.c_str());
bool fileAddedToArchive = false;
std::future<bool> fileAdded;
int retryCount = InjectFileRetryCount;
while (!fileAddedToArchive && retryCount)
{
ArchiveCommandsBus::BroadcastResult(fileAddedToArchive, &AzToolsFramework::ArchiveCommands::AddFileToArchiveBlocking, archiveFilePath, workingDirectory, filePath);
ArchiveCommandsBus::BroadcastResult(fileAdded, &AzToolsFramework::ArchiveCommandsBus::Events::AddFileToArchive, archiveFilePath, workingDirectory, filePath);
--retryCount;
fileAddedToArchive = fileAdded.get();
if (!fileAddedToArchive && retryCount)
{
AZ_Error(logWindowName, false, "Failed to insert file (%s) into bundle (%s). Retrying.", filePath.c_str(), archiveFilePath.c_str());
AZStd::this_thread::sleep_for(AZStd::chrono::milliseconds(SleepTimeMS));
}
}
@@ -627,7 +627,11 @@ namespace AzToolsFramework
bool AssetBundleComponent::InjectFile(const AZStd::string& filePath, const AZStd::string& sourcePak)
{
return InjectFile(filePath, sourcePak, "");
// When no working directory is specified, assume that the file being injected goes into the root of the archive.
// The filePath should be an absolute path, making the workingDirectory be the path leading up to the file.
AZ::IO::PathView fullFilePath{ filePath, AZ::IO::PosixPathSeparator };
AZ::IO::Path workingDir{ fullFilePath.ParentPath() };
return InjectFile(filePath, sourcePak, workingDir.c_str());
}
bool AssetBundleComponent::InjectFiles(const AZStd::vector<AZStd::string>& fileEntries, const AZStd::string& sourcePak, const char* workingDirectory)
@@ -668,8 +672,9 @@ namespace AzToolsFramework
}
}
bool filesAddedToArchive = false;
AzToolsFramework::ArchiveCommandsBus::BroadcastResult(filesAddedToArchive, &AzToolsFramework::ArchiveCommands::AddFilesToArchiveBlocking, sourcePak, workingDirectory, listFilePath);
std::future<bool> filesAdded;
AzToolsFramework::ArchiveCommandsBus::BroadcastResult(filesAdded, &AzToolsFramework::ArchiveCommands::AddFilesToArchive, sourcePak, workingDirectory, listFilePath);
bool filesAddedToArchive = filesAdded.get();
if (!filesAddedToArchive)
{
AZ_Error(logWindowName, false, "Failed to insert files into bundle (%s).\n", sourcePak.c_str());
@@ -688,7 +693,6 @@ namespace AzToolsFramework
{
// open the manifest and deserialize it
bool manifestExtracted = false;
const bool overwriteExisting = true;
TemporaryDir tempDir(sourcePak);
if (!tempDir.m_result)
@@ -698,7 +702,10 @@ namespace AzToolsFramework
AZStd::string manifestFilePath;
AzFramework::StringFunc::Path::ConstructFull(tempDir.m_tempFolderPath.c_str(), AzFramework::AssetBundleManifest::s_manifestFileName, manifestFilePath, true);
ArchiveCommandsBus::BroadcastResult(manifestExtracted, &ArchiveCommandsBus::Events::ExtractFileBlocking, sourcePak, AzFramework::AssetBundleManifest::s_manifestFileName, tempDir.m_tempFolderPath, overwriteExisting);
std::future<bool> extractResult;
ArchiveCommandsBus::BroadcastResult(extractResult, &ArchiveCommandsBus::Events::ExtractFile, sourcePak, AzFramework::AssetBundleManifest::s_manifestFileName, tempDir.m_tempFolderPath);
manifestExtracted = extractResult.get();
if (!manifestExtracted)
{
AZ_Error(logWindowName, false, "Failed to extract existing manifest from archive \"%s\".", sourcePak.c_str());
@@ -57,7 +57,7 @@ namespace AzToolsFramework
//! Returns true if the file at filePath was successfully injected into the bundle at sourcePak
static bool InjectFile(const AZStd::string& filePath, const AZStd::string& sourcePak, const char* workingDirectory);
//! Inject the files with relative filePaths which espect to the working directory into the bundle at sourcePak
//! Inject the files with relative filePaths with respect to the working directory into the bundle at sourcePak
//! Returns true if the file at filePath was successfully injected into the bundle at sourcePak
static bool InjectFiles(const AZStd::vector<AZStd::string>& fileEntries, const AZStd::string& sourcePak, const char* workingDirectory);
@@ -18,8 +18,9 @@
#include <AzToolsFramework/API/ToolsApplicationAPI.h>
#include <AzToolsFramework/Entity/PrefabEditorEntityOwnershipService.h>
#include <AzToolsFramework/Prefab/EditorPrefabComponent.h>
#include <AzToolsFramework/Prefab/Instance/InstanceEntityMapperInterface.h>
#include <AzToolsFramework/Prefab/Instance/Instance.h>
#include <AzToolsFramework/Prefab/Instance/InstanceEntityIdMapper.h>
#include <AzToolsFramework/Prefab/Instance/InstanceEntityMapperInterface.h>
#include <AzToolsFramework/Prefab/PrefabDomUtils.h>
#include <AzToolsFramework/Prefab/PrefabLoader.h>
#include <AzToolsFramework/Prefab/PrefabSystemComponentInterface.h>
@@ -317,17 +318,18 @@ namespace AzToolsFramework
const AZStd::vector<AZ::Entity*>& entities, AZStd::vector<AZStd::unique_ptr<Prefab::Instance>>&& nestedPrefabInstances,
AZ::IO::PathView filePath, Prefab::InstanceOptionalReference instanceToParentUnder)
{
AZStd::unique_ptr<Prefab::Instance> createdPrefabInstance =
m_prefabSystemComponent->CreatePrefab(entities, AZStd::move(nestedPrefabInstances), filePath, nullptr, false);
if (!instanceToParentUnder)
{
instanceToParentUnder = *m_rootInstance;
}
AZStd::unique_ptr<Prefab::Instance> createdPrefabInstance = m_prefabSystemComponent->CreatePrefab(
entities, AZStd::move(nestedPrefabInstances), filePath, nullptr, instanceToParentUnder, false);
if (createdPrefabInstance)
{
if (!instanceToParentUnder)
{
instanceToParentUnder = *m_rootInstance;
}
Prefab::Instance& addedInstance = instanceToParentUnder->get().AddInstance(AZStd::move(createdPrefabInstance));
Prefab::Instance& addedInstance = instanceToParentUnder->get().AddInstance(
AZStd::move(createdPrefabInstance));
AZ::Entity* containerEntity = addedInstance.m_containerEntity.get();
containerEntity->AddComponent(aznew Prefab::EditorPrefabComponent());
HandleEntitiesAdded({containerEntity});
@@ -341,16 +343,18 @@ namespace AzToolsFramework
Prefab::InstanceOptionalReference PrefabEditorEntityOwnershipService::InstantiatePrefab(
AZ::IO::PathView filePath, Prefab::InstanceOptionalReference instanceToParentUnder)
{
AZStd::unique_ptr<Prefab::Instance> createdPrefabInstance = m_prefabSystemComponent->InstantiatePrefab(filePath);
if (createdPrefabInstance)
if (!instanceToParentUnder)
{
if (!instanceToParentUnder)
{
instanceToParentUnder = *m_rootInstance;
}
instanceToParentUnder = *m_rootInstance;
}
Prefab::Instance& addedInstance = instanceToParentUnder->get().AddInstance(AZStd::move(createdPrefabInstance));
AZStd::unique_ptr<Prefab::Instance> instantiatedPrefabInstance =
m_prefabSystemComponent->InstantiatePrefab(filePath, instanceToParentUnder);
if (instantiatedPrefabInstance)
{
Prefab::Instance& addedInstance = instanceToParentUnder->get().AddInstance(
AZStd::move(instantiatedPrefabInstance));
HandleEntitiesAdded({addedInstance.m_containerEntity.get()});
return addedInstance;
}
@@ -11,6 +11,7 @@
#include <AzToolsFramework/API/ViewportEditorModeTrackerInterface.h>
#include <AzToolsFramework/FocusMode/FocusModeNotificationBus.h>
#include <AzToolsFramework/FocusMode/FocusModeSystemComponent.h>
#include <AzToolsFramework/API/ViewportEditorModeTrackerInterface.h>
namespace AzToolsFramework
{
@@ -73,7 +74,18 @@ namespace AzToolsFramework
m_focusRoot = entityId;
FocusModeNotificationBus::Broadcast(&FocusModeNotifications::OnEditorFocusChanged, m_focusRoot);
// TODO - If m_focusRoot != AZ::EntityId(), activate focus mode via ViewportEditorModeTrackerInterface; else, deactivate focus mode
if (auto tracker = AZ::Interface<ViewportEditorModeTrackerInterface>::Get();
tracker != nullptr)
{
if (!m_focusRoot.IsValid() && entityId.IsValid())
{
tracker->ActivateMode({ /* DefaultViewportId */ }, ViewportEditorMode::Focus);
}
else if (m_focusRoot.IsValid() && !entityId.IsValid())
{
tracker->DeactivateMode({ /* DefaultViewportId */ }, ViewportEditorMode::Focus);
}
}
}
void FocusModeSystemComponent::ClearFocusRoot([[maybe_unused]] AzFramework::EntityContextId entityContextId)
@@ -15,6 +15,7 @@
#include <AzToolsFramework/Entity/EditorEntityHelpers.h>
#include <AzToolsFramework/Prefab/Instance/Instance.h>
#include <AzToolsFramework/Prefab/PrefabDomUtils.h>
#include <AzToolsFramework/Prefab/Instance/InstanceEntityIdMapper.h>
#include <AzToolsFramework/Prefab/Instance/InstanceEntityMapperInterface.h>
#include <AzToolsFramework/Prefab/Instance/TemplateInstanceMapperInterface.h>
@@ -28,24 +29,52 @@ namespace AzToolsFramework
}
Instance::Instance(AZStd::unique_ptr<AZ::Entity> containerEntity)
: Instance(AZStd::move(containerEntity), AZStd::nullopt, GenerateInstanceAlias())
{
m_instanceEntityMapper = AZ::Interface<InstanceEntityMapperInterface>::Get();
}
Instance::Instance(InstanceOptionalReference parent)
: Instance(nullptr, parent, GenerateInstanceAlias())
{
}
Instance::Instance(InstanceAlias alias)
: Instance(nullptr, AZStd::nullopt, AZStd::move(alias))
{
}
Instance::Instance(AZStd::unique_ptr<AZ::Entity> containerEntity, InstanceOptionalReference parent)
: Instance(AZStd::move(containerEntity), parent, GenerateInstanceAlias())
{
}
Instance::Instance(AZStd::unique_ptr<AZ::Entity> containerEntity, InstanceOptionalReference parent, InstanceAlias alias)
: m_parent(parent.has_value() ? &parent->get() : nullptr)
, m_alias(AZStd::move(alias))
, m_containerEntity(containerEntity ? AZStd::move(containerEntity) : AZStd::make_unique<AZ::Entity>())
, m_instanceEntityMapper(AZ::Interface<InstanceEntityMapperInterface>::Get())
, m_templateInstanceMapper(AZ::Interface<TemplateInstanceMapperInterface>::Get())
{
AZ_Assert(m_instanceEntityMapper,
"Instance Entity Mapper Interface could not be found. "
"It is a requirement for the Prefab Instance class. "
"Check that it is being correctly initialized.");
m_templateInstanceMapper = AZ::Interface<TemplateInstanceMapperInterface>::Get();
AZ_Assert(m_templateInstanceMapper,
"Template Instance Mapper Interface could not be found. "
"It is a requirement for the Prefab Instance class. "
"Check that it is being correctly initialized.");
m_alias = GenerateInstanceAlias();
m_containerEntity = containerEntity ? AZStd::move(containerEntity)
: AZStd::make_unique<AZ::Entity>();
if (parent)
{
AliasPath absoluteInstancePath = m_parent->GetAbsoluteInstanceAliasPath();
absoluteInstancePath.Append(m_alias);
absoluteInstancePath.Append(PrefabDomUtils::ContainerEntityName);
AZ::EntityId newContainerEntityId = InstanceEntityIdMapper::GenerateEntityIdForAliasPath(absoluteInstancePath);
m_containerEntity->SetId(newContainerEntityId);
}
RegisterEntity(m_containerEntity->GetId(), PrefabDomUtils::ContainerEntityName);
}
@@ -69,12 +98,12 @@ namespace AzToolsFramework
}
}
const TemplateId& Instance::GetTemplateId() const
TemplateId Instance::GetTemplateId() const
{
return m_templateId;
}
void Instance::SetTemplateId(const TemplateId& templateId)
void Instance::SetTemplateId(TemplateId templateId)
{
// If we aren't changing the template Id, there's no need to unregister / re-register
if (templateId == m_templateId)
@@ -295,20 +324,21 @@ namespace AzToolsFramework
}
Instance& Instance::AddInstance(AZStd::unique_ptr<Instance> instance)
{
InstanceAlias newInstanceAlias = GenerateInstanceAlias();
return AddInstance(AZStd::move(instance), newInstanceAlias);
}
Instance& Instance::AddInstance(AZStd::unique_ptr<Instance> instance, InstanceAlias newInstanceAlias)
{
AZ_Assert(instance.get(), "instance argument is nullptr");
if (instance->GetInstanceAlias().empty())
{
instance->m_alias = GenerateInstanceAlias();
}
AZ_Assert(
m_nestedInstances.find(newInstanceAlias) == m_nestedInstances.end(),
m_nestedInstances.find(instance->GetInstanceAlias()) == m_nestedInstances.end(),
"InstanceAlias' unique id collision, this should never happen.");
instance->m_parent = this;
instance->m_alias = newInstanceAlias;
return *(m_nestedInstances[newInstanceAlias] = std::move(instance));
auto& alias = instance->GetInstanceAlias();
return *(m_nestedInstances[alias] = AZStd::move(instance));
}
void Instance::DetachNestedInstances(const AZStd::function<void(AZStd::unique_ptr<Instance>)>& callback)
@@ -65,6 +65,9 @@ namespace AzToolsFramework
Instance();
explicit Instance(AZStd::unique_ptr<AZ::Entity> containerEntity);
explicit Instance(InstanceOptionalReference parent);
explicit Instance(AZStd::unique_ptr<AZ::Entity> containerEntity, InstanceOptionalReference parent);
explicit Instance(InstanceAlias alias);
virtual ~Instance();
Instance(const Instance& rhs) = delete;
@@ -72,8 +75,8 @@ namespace AzToolsFramework
static void Reflect(AZ::ReflectContext* context);
const TemplateId& GetTemplateId() const;
void SetTemplateId(const TemplateId& templateId);
TemplateId GetTemplateId() const;
void SetTemplateId(TemplateId templateId);
const AZ::IO::Path& GetTemplateSourcePath() const;
void SetTemplateSourcePath(AZ::IO::PathView sourcePath);
@@ -97,7 +100,6 @@ namespace AzToolsFramework
void Reset();
Instance& AddInstance(AZStd::unique_ptr<Instance> instance);
Instance& AddInstance(AZStd::unique_ptr<Instance> instance, InstanceAlias instanceAlias);
AZStd::unique_ptr<Instance> DetachNestedInstance(const InstanceAlias& instanceAlias);
void DetachNestedInstances(const AZStd::function<void(AZStd::unique_ptr<Instance>)>& callback);
@@ -184,6 +186,8 @@ namespace AzToolsFramework
private:
static constexpr const char s_aliasPathSeparator = '/';
Instance(AZStd::unique_ptr<AZ::Entity> containerEntity, InstanceOptionalReference parent, InstanceAlias alias);
void ClearEntities();
void RemoveEntities(const AZStd::function<bool(const AZStd::unique_ptr<AZ::Entity>&)>& filter);
@@ -46,10 +46,11 @@ namespace AzToolsFramework
//! Updates the template links (updating instances) for the given template and triggers propagation on its instances.
//! @param providedPatch The patch to apply to the template.
//! @param templateId The id of the template to update.
//! @param immediate An optional flag whether to apply the patch immediately (needed for Undo/Redos) or wait until next system tick.
//! @param instanceToExclude An optional reference to an instance of the template being updated that should not be refreshes as part of propagation.
//! Defaults to nullopt, which means that all instances will be refreshed.
//! @return True if the template was patched correctly, false if the operation failed.
virtual bool PatchTemplate(PrefabDomValue& providedPatch, TemplateId templateId, InstanceOptionalReference instanceToExclude = AZStd::nullopt) = 0;
virtual bool PatchTemplate(PrefabDomValue& providedPatch, TemplateId templateId, bool immediate = false, InstanceOptionalReference instanceToExclude = AZStd::nullopt) = 0;
virtual void ApplyPatchesToInstance(const AZ::EntityId& entityId, PrefabDom& patches, const Instance& instanceToAddPatches) = 0;
@@ -156,7 +156,7 @@ namespace AzToolsFramework
}
}
bool InstanceToTemplatePropagator::PatchTemplate(PrefabDomValue& providedPatch, TemplateId templateId, InstanceOptionalReference instanceToExclude)
bool InstanceToTemplatePropagator::PatchTemplate(PrefabDomValue& providedPatch, TemplateId templateId, bool immediate, InstanceOptionalReference instanceToExclude)
{
PrefabDom& templateDomReference = m_prefabSystemComponentInterface->FindTemplateDom(templateId);
@@ -178,7 +178,7 @@ namespace AzToolsFramework
(result.GetOutcome() != AZ::JsonSerializationResult::Outcomes::PartialSkip),
"Some of the patches were not successfully applied.");
m_prefabSystemComponentInterface->SetTemplateDirtyFlag(templateId, true);
m_prefabSystemComponentInterface->PropagateTemplateChanges(templateId, instanceToExclude);
m_prefabSystemComponentInterface->PropagateTemplateChanges(templateId, immediate, instanceToExclude);
return true;
}
}
@@ -33,7 +33,7 @@ namespace AzToolsFramework
InstanceOptionalReference GetTopMostInstanceInHierarchy(AZ::EntityId entityId) override;
bool PatchTemplate(PrefabDomValue& providedPatch, TemplateId templateId, InstanceOptionalReference instanceToExclude = AZStd::nullopt) override;
bool PatchTemplate(PrefabDomValue& providedPatch, TemplateId templateId, bool immediate = false, InstanceOptionalReference instanceToExclude = AZStd::nullopt) override;
void ApplyPatchesToInstance(const AZ::EntityId& entityId, PrefabDom& patches, const Instance& instanceToAddPatches) override;
@@ -52,7 +52,7 @@ namespace AzToolsFramework
AZ::Interface<InstanceUpdateExecutorInterface>::Unregister(this);
}
void InstanceUpdateExecutor::AddTemplateInstancesToQueue(TemplateId instanceTemplateId, InstanceOptionalReference instanceToExclude)
void InstanceUpdateExecutor::AddTemplateInstancesToQueue(TemplateId instanceTemplateId, bool immediate, InstanceOptionalReference instanceToExclude)
{
auto findInstancesResult =
m_templateInstanceMapperInterface->FindInstancesOwnedByTemplate(instanceTemplateId);
@@ -79,6 +79,11 @@ namespace AzToolsFramework
m_instancesUpdateQueue.emplace_back(instance);
}
}
if (immediate)
{
UpdateTemplateInstancesInQueue();
}
}
void InstanceUpdateExecutor::RemoveTemplateInstanceFromQueue(const Instance* instance)
@@ -31,7 +31,7 @@ namespace AzToolsFramework
explicit InstanceUpdateExecutor(int instanceCountToUpdateInBatch = 0);
void AddTemplateInstancesToQueue(TemplateId instanceTemplateId, InstanceOptionalReference instanceToExclude = AZStd::nullopt) override;
void AddTemplateInstancesToQueue(TemplateId instanceTemplateId, bool immediate = false, InstanceOptionalReference instanceToExclude = AZStd::nullopt) override;
bool UpdateTemplateInstancesInQueue() override;
virtual void RemoveTemplateInstanceFromQueue(const Instance* instance) override;
@@ -23,7 +23,7 @@ namespace AzToolsFramework
virtual ~InstanceUpdateExecutorInterface() = default;
// Add all Instances of Template with given Id into a queue for updating them later.
virtual void AddTemplateInstancesToQueue(TemplateId instanceTemplateId, InstanceOptionalReference instanceToExclude = AZStd::nullopt) = 0;
virtual void AddTemplateInstancesToQueue(TemplateId instanceTemplateId, bool immediate = false, InstanceOptionalReference instanceToExclude = AZStd::nullopt) = 0;
// Update Instances in the waiting queue.
virtual bool UpdateTemplateInstancesInQueue() = 0;
@@ -27,7 +27,7 @@ namespace AzToolsFramework
}
bool TemplateInstanceMapper::RegisterTemplate(const TemplateId& templateId)
bool TemplateInstanceMapper::RegisterTemplate(TemplateId templateId)
{
const bool result = m_templateIdToInstancesMap.emplace(templateId, InstanceSet()).second;
AZ_Assert(result,
@@ -39,7 +39,7 @@ namespace AzToolsFramework
return result;
}
bool TemplateInstanceMapper::UnregisterTemplate(const TemplateId& templateId)
bool TemplateInstanceMapper::UnregisterTemplate(TemplateId templateId)
{
const bool result = m_templateIdToInstancesMap.erase(templateId) != 0;
AZ_Assert(result,
@@ -53,7 +53,7 @@ namespace AzToolsFramework
bool TemplateInstanceMapper::RegisterInstanceToTemplate(Instance& instance)
{
const TemplateId& templateId = instance.GetTemplateId();
TemplateId templateId = instance.GetTemplateId();
if (templateId == InvalidTemplateId)
{
return false;
@@ -79,7 +79,7 @@ namespace AzToolsFramework
found->second.erase(&instance) != 0;
}
InstanceSetConstReference TemplateInstanceMapper::FindInstancesOwnedByTemplate(const TemplateId& templateId) const
InstanceSetConstReference TemplateInstanceMapper::FindInstancesOwnedByTemplate(TemplateId templateId) const
{
auto found = m_templateIdToInstancesMap.find(templateId);
@@ -26,10 +26,10 @@ namespace AzToolsFramework
TemplateInstanceMapper();
~TemplateInstanceMapper() override;
InstanceSetConstReference FindInstancesOwnedByTemplate(const TemplateId& templateId) const override;
InstanceSetConstReference FindInstancesOwnedByTemplate(TemplateId templateId) const override;
bool RegisterTemplate(const TemplateId& templateId);
bool UnregisterTemplate(const TemplateId& templateId);
bool RegisterTemplate(TemplateId templateId);
bool UnregisterTemplate(TemplateId templateId);
protected:
bool RegisterInstanceToTemplate(Instance& instance) override;
@@ -24,7 +24,7 @@ namespace AzToolsFramework
AZ_RTTI(TemplateInstanceMapperInterface, "{5DCCCDAA-3441-4266-9670-B349386E0129}");
virtual ~TemplateInstanceMapperInterface() = default;
virtual InstanceSetConstReference FindInstancesOwnedByTemplate(const TemplateId& templateId) const = 0;
virtual InstanceSetConstReference FindInstancesOwnedByTemplate(TemplateId templateId) const = 0;
protected:
// Only the Instance class is allowed to register and unregister Instances.
@@ -122,12 +122,12 @@ namespace AzToolsFramework
!m_instanceName.empty();
}
const TemplateId& Link::GetSourceTemplateId() const
TemplateId Link::GetSourceTemplateId() const
{
return m_sourceTemplateId;
}
const TemplateId& Link::GetTargetTemplateId() const
TemplateId Link::GetTargetTemplateId() const
{
return m_targetTemplateId;
}
@@ -48,8 +48,8 @@ namespace AzToolsFramework
bool IsValid() const;
const TemplateId& GetSourceTemplateId() const;
const TemplateId& GetTargetTemplateId() const;
TemplateId GetSourceTemplateId() const;
TemplateId GetTargetTemplateId() const;
LinkId GetId() const;
@@ -1041,7 +1041,7 @@ namespace AzToolsFramework
PrefabUndoInstance* command = aznew PrefabUndoInstance("Entity/Instance duplication");
command->SetParent(undoBatch.GetUndoBatch());
command->Capture(instanceDomBefore, instanceDomAfter, commonOwningInstance->get().GetTemplateId());
command->Redo();
command->RedoBatched();
DuplicateNestedInstancesInInstance(commonOwningInstance->get(),
instances, instanceDomAfter, duplicatedEntityAndInstanceIds, newInstanceAliasToOldInstanceMap);
@@ -92,7 +92,17 @@ namespace AzToolsFramework
AZStd::unique_ptr<Instance> PrefabSystemComponent::CreatePrefab(
const AZStd::vector<AZ::Entity*>& entities, AZStd::vector<AZStd::unique_ptr<Instance>>&& instancesToConsume,
AZ::IO::PathView filePath, AZStd::unique_ptr<AZ::Entity> containerEntity, bool shouldCreateLinks)
AZ::IO::PathView filePath, AZStd::unique_ptr<AZ::Entity> containerEntity, InstanceOptionalReference parent,
bool shouldCreateLinks)
{
AZStd::unique_ptr<Instance> newInstance = AZStd::make_unique<Instance>(AZStd::move(containerEntity), parent);
CreatePrefab(entities, AZStd::move(instancesToConsume), filePath, newInstance, shouldCreateLinks);
return newInstance;
}
void PrefabSystemComponent::CreatePrefab(
const AZStd::vector<AZ::Entity*>& entities, AZStd::vector<AZStd::unique_ptr<Instance>>&& instancesToConsume,
AZ::IO::PathView filePath, AZStd::unique_ptr<Instance>& newInstance, bool shouldCreateLinks)
{
AZ::IO::Path relativeFilePath = m_prefabLoader.GenerateRelativePath(filePath);
if (GetTemplateIdFromFilePath(relativeFilePath) != InvalidTemplateId)
@@ -101,11 +111,9 @@ namespace AzToolsFramework
"Filepath %s has already been registered with the Prefab System Component",
relativeFilePath.c_str());
return nullptr;
return;
}
AZStd::unique_ptr<Instance> newInstance = AZStd::make_unique<Instance>(AZStd::move(containerEntity));
for (AZ::Entity* entity : entities)
{
AZ_Assert(entity, "Prefab - Null entity passed in during Create Prefab");
@@ -136,13 +144,11 @@ namespace AzToolsFramework
{
newInstance->SetTemplateId(newTemplateId);
}
return newInstance;
}
void PrefabSystemComponent::PropagateTemplateChanges(TemplateId templateId, InstanceOptionalReference instanceToExclude)
void PrefabSystemComponent::PropagateTemplateChanges(TemplateId templateId, bool immediate, InstanceOptionalReference instanceToExclude)
{
UpdatePrefabInstances(templateId, instanceToExclude);
UpdatePrefabInstances(templateId, immediate, instanceToExclude);
auto templateIdToLinkIdsIterator = m_templateToLinkIdsMap.find(templateId);
if (templateIdToLinkIdsIterator != m_templateToLinkIdsMap.end())
@@ -171,9 +177,9 @@ namespace AzToolsFramework
}
}
void PrefabSystemComponent::UpdatePrefabInstances(const TemplateId& templateId, InstanceOptionalReference instanceToExclude)
void PrefabSystemComponent::UpdatePrefabInstances(TemplateId templateId, bool immediate, InstanceOptionalReference instanceToExclude)
{
m_instanceUpdateExecutor.AddTemplateInstancesToQueue(templateId, instanceToExclude);
m_instanceUpdateExecutor.AddTemplateInstancesToQueue(templateId, immediate, instanceToExclude);
}
void PrefabSystemComponent::UpdateLinkedInstances(AZStd::queue<LinkIds>& linkIdsQueue)
@@ -256,7 +262,8 @@ namespace AzToolsFramework
}
}
AZStd::unique_ptr<Instance> PrefabSystemComponent::InstantiatePrefab(AZ::IO::PathView filePath)
AZStd::unique_ptr<Instance> PrefabSystemComponent::InstantiatePrefab(
AZ::IO::PathView filePath, InstanceOptionalReference parent)
{
// Retrieve the template id for the source prefab filepath
Prefab::TemplateId templateId = GetTemplateIdFromFilePath(filePath);
@@ -276,10 +283,11 @@ namespace AzToolsFramework
return nullptr;
}
return InstantiatePrefab(templateId);
return InstantiatePrefab(templateId, parent);
}
AZStd::unique_ptr<Instance> PrefabSystemComponent::InstantiatePrefab(const TemplateId& templateId)
AZStd::unique_ptr<Instance> PrefabSystemComponent::InstantiatePrefab(
TemplateId templateId, InstanceOptionalReference parent)
{
TemplateReference instantiatingTemplate = FindTemplate(templateId);
@@ -292,7 +300,7 @@ namespace AzToolsFramework
return nullptr;
}
auto newInstance = AZStd::make_unique<Instance>();
auto newInstance = AZStd::make_unique<Instance>(parent);
Instance::EntityList newEntities;
if (!PrefabDomUtils::LoadInstanceFromPrefabDom(*newInstance, newEntities, instantiatingTemplate->get().GetPrefabDom()))
{
@@ -354,7 +362,7 @@ namespace AzToolsFramework
return newTemplateId;
}
TemplateReference PrefabSystemComponent::FindTemplate(const TemplateId& id)
TemplateReference PrefabSystemComponent::FindTemplate(TemplateId id)
{
auto found = m_templateIdMap.find(id);
if (found != m_templateIdMap.end())
@@ -466,7 +474,7 @@ namespace AzToolsFramework
templateToChange.SetFilePath(filePath);
}
void PrefabSystemComponent::RemoveTemplate(const TemplateId& templateId)
void PrefabSystemComponent::RemoveTemplate(TemplateId templateId)
{
auto findTemplateResult = FindTemplate(templateId);
if (!findTemplateResult.has_value())
@@ -553,8 +561,8 @@ namespace AzToolsFramework
}
LinkId PrefabSystemComponent::AddLink(
const TemplateId& sourceTemplateId,
const TemplateId& targetTemplateId,
TemplateId sourceTemplateId,
TemplateId targetTemplateId,
PrefabDomValue::MemberIterator& instanceIterator,
InstanceOptionalReference instance)
{
@@ -571,10 +579,13 @@ namespace AzToolsFramework
Template& targetTemplate = targetTemplateReference->get();
#if defined(AZ_ENABLE_TRACING)
Template& sourceTemplate = sourceTemplateReference->get();
AZStd::string_view instanceName(instanceIterator->name.GetString(), instanceIterator->name.GetStringLength());
const AZStd::string& targetTemplateFilePath = targetTemplate.GetFilePath().Native();
const AZStd::string& sourceTemplateFilePath = sourceTemplate.GetFilePath().Native();
#endif
LinkId newLinkId = CreateUniqueLinkId();
Link newLink(newLinkId);
@@ -616,8 +627,8 @@ namespace AzToolsFramework
}
LinkId PrefabSystemComponent::CreateLink(
const TemplateId& linkTargetId,
const TemplateId& linkSourceId,
TemplateId linkTargetId,
TemplateId linkSourceId,
const InstanceAlias& instanceAlias,
const PrefabDomConstReference linkPatches,
const LinkId& linkId)
@@ -774,7 +785,7 @@ namespace AzToolsFramework
}
}
bool PrefabSystemComponent::IsTemplateDirty(const TemplateId& templateId)
bool PrefabSystemComponent::IsTemplateDirty(TemplateId templateId)
{
auto templateRef = FindTemplate(templateId);
@@ -786,7 +797,7 @@ namespace AzToolsFramework
return false;
}
void PrefabSystemComponent::SetTemplateDirtyFlag(const TemplateId& templateId, bool dirty)
void PrefabSystemComponent::SetTemplateDirtyFlag(TemplateId templateId, bool dirty)
{
auto templateRef = FindTemplate(templateId);
@@ -903,8 +914,10 @@ namespace AzToolsFramework
return false;
}
#if defined(AZ_ENABLE_TRACING)
Template& sourceTemplate = sourceTemplateReference->get();
Template& targetTemplate = targetTemplateReference->get();
#endif
AZStd::string_view instanceName(instanceIterator->name.GetString(), instanceIterator->name.GetStringLength());
@@ -940,7 +953,7 @@ namespace AzToolsFramework
return true;
}
bool PrefabSystemComponent::GenerateLinksForNewTemplate(const TemplateId& newTemplateId, Instance& instance)
bool PrefabSystemComponent::GenerateLinksForNewTemplate(TemplateId newTemplateId, Instance& instance)
{
TemplateReference newTemplateReference = FindTemplate(newTemplateId);
if (!newTemplateReference.has_value())
@@ -980,7 +993,7 @@ namespace AzToolsFramework
}
const PrefabDomValue& source = instanceSourceReference->get();
const TemplateId& nestedTemplateId = GetTemplateIdFromFilePath(source.GetString());
TemplateId nestedTemplateId = GetTemplateIdFromFilePath(source.GetString());
if (nestedTemplateId == InvalidTemplateId)
{
AZ_Error("Prefab", false,
@@ -84,7 +84,7 @@ namespace AzToolsFramework
* @param id A unique id of a Template.
* @return Reference of Template if the Template exists.
*/
TemplateReference FindTemplate(const TemplateId& id) override;
TemplateReference FindTemplate(TemplateId id) override;
/**
* Find Link with given Link id from Prefab System Component.
@@ -112,7 +112,7 @@ namespace AzToolsFramework
* Remove the Template associated with the given id from Prefab System Component.
* @param templateId A unique id of a Template.
*/
void RemoveTemplate(const TemplateId& templateId) override;
void RemoveTemplate(TemplateId templateId) override;
/**
* Remove all Templates from the Prefab System Component.
@@ -121,17 +121,21 @@ namespace AzToolsFramework
/**
* Generates a new Prefab Instance based on the Template whose source is stored in filepath.
* @param filePath the path to the prefab source file containing the template being instantiated.
* @param filePath The path to the prefab source file containing the template being instantiated.
* @param parent Reference of the target instance the instantiated instance will be placed under.
* @return A unique_ptr to the newly instantiated instance. Null if operation failed.
*/
AZStd::unique_ptr<Instance> InstantiatePrefab(AZ::IO::PathView filePath) override;
AZStd::unique_ptr<Instance> InstantiatePrefab(
AZ::IO::PathView filePath, InstanceOptionalReference parent = AZStd::nullopt) override;
/**
* Generates a new Prefab Instance based on the Template referenced by templateId
* @param templateId the id of the template being instantiated.
* Generates a new Prefab Instance based on the Template referenced by templateId.
* @param templateId The id of the template being instantiated.
* @param parent Reference of the target instance the instantiated instance will be placed under.
* @return A unique_ptr to the newly instantiated instance. Null if operation failed.
*/
AZStd::unique_ptr<Instance> InstantiatePrefab(const TemplateId& templateId) override;
AZStd::unique_ptr<Instance> InstantiatePrefab(
TemplateId templateId, InstanceOptionalReference parent = AZStd::nullopt) override;
/**
* Add a new Link into Prefab System Component and create a unique id for it.
@@ -142,8 +146,8 @@ namespace AzToolsFramework
* @return A unique id for the new Link.
*/
LinkId AddLink(
const TemplateId& sourceTemplateId,
const TemplateId& targetTemplateId,
TemplateId sourceTemplateId,
TemplateId targetTemplateId,
PrefabDomValue::MemberIterator& instanceIterator,
InstanceOptionalReference instance) override;
@@ -157,8 +161,8 @@ namespace AzToolsFramework
* @return A unique id for the new Link.
*/
LinkId CreateLink(
const TemplateId& linkTargetId,
const TemplateId& linkSourceId,
TemplateId linkTargetId,
TemplateId linkSourceId,
const InstanceAlias& instanceAlias,
const PrefabDomConstReference linkPatches,
const LinkId& linkId = InvalidLinkId) override;
@@ -181,14 +185,14 @@ namespace AzToolsFramework
* @param templateId The id of the template to query.
* @return The value of the dirty flag on the template.
*/
bool IsTemplateDirty(const TemplateId& templateId) override;
bool IsTemplateDirty(TemplateId templateId) override;
/**
* Sets the dirty flag of the template to the value provided.
* @param templateId The id of the template to flag.
* @param dirty The new value of the dirty flag.
*/
void SetTemplateDirtyFlag(const TemplateId& templateId, bool dirty) override;
void SetTemplateDirtyFlag(TemplateId templateId, bool dirty) override;
bool AreDirtyTemplatesPresent(TemplateId rootTemplateId) override;
@@ -200,20 +204,21 @@ namespace AzToolsFramework
/**
* Builds a new Prefab Template out of entities and instances and returns the first instance comprised of
* these entities and instances
* @param entities A vector of entities that will be used in the new instance. May be empty
* these entities and instances.
* @param entities A vector of entities that will be used in the new instance. May be empty.
* @param instances A vector of Prefab Instances that will be nested in the new instance, will be consumed and moved.
* May be empty
* @param filePath the path to associate the template of the new instance to.
* May be empty.
* @param filePath The path to associate the template of the new instance to.
* @param containerEntity The container entity for the prefab to be created. It will be created if a nullptr is provided.
* @param parent Reference of an instance the created instance will be placed under, if given.
* @param shouldCreateLinks The flag indicating if links should be created between the templates of the instance
* and its nested instances.
* @return A pointer to the newly created instance. nullptr on failure
* @return A pointer to the newly created instance. nullptr on failure.
*/
AZStd::unique_ptr<Instance> CreatePrefab(
const AZStd::vector<AZ::Entity*>& entities, AZStd::vector<AZStd::unique_ptr<Instance>>&& instancesToConsume,
AZ::IO::PathView filePath, AZStd::unique_ptr<AZ::Entity> containerEntity = nullptr,
bool ShouldCreateLinks = true) override;
InstanceOptionalReference parent = AZStd::nullopt, bool shouldCreateLinks = true) override;
PrefabDom& FindTemplateDom(TemplateId templateId) override;
@@ -225,18 +230,36 @@ namespace AzToolsFramework
*/
void UpdatePrefabTemplate(TemplateId templateId, const PrefabDom& updatedDom) override;
void PropagateTemplateChanges(TemplateId templateId, InstanceOptionalReference instanceToExclude = AZStd::nullopt) override;
void PropagateTemplateChanges(TemplateId templateId, bool immediate = false, InstanceOptionalReference instanceToExclude = AZStd::nullopt) override;
/**
* Updates all Instances owned by a Template.
*
* @param templateId The id of the Template owning Instances to update.
* @param immediate An optional flag whether to apply the patch immediately (needed for Undo/Redos) or wait until next system tick.
* @param instanceToExclude An optional reference to an instance of the template being updated that should not be refreshes as part of propagation.
* Defaults to nullopt, which means that all instances will be refreshed.
*/
void UpdatePrefabInstances(const TemplateId& templateId, InstanceOptionalReference instanceToExclude = AZStd::nullopt);
void UpdatePrefabInstances(TemplateId templateId, bool immediate = false, InstanceOptionalReference instanceToExclude = AZStd::nullopt);
private:
AZ_DISABLE_COPY_MOVE(PrefabSystemComponent);
/**
* Builds a new Prefab Template out of entities and instances and returns the first instance comprised of
* these entities and instances.
* @param entities A vector of entities that will be used in the new instance. May be empty.
* @param instances A vector of Prefab Instances that will be nested in the new instance, will be consumed and moved.
* May be empty.
* @param filePath The path to associate the template of the new instance to.
* @param instance Reference of a pointer to the newly created instance which needs initiation.
* @param shouldCreateLinks The flag indicating if links should be created between the templates of the instance
* and its nested instances.
*/
void CreatePrefab(const AZStd::vector<AZ::Entity*>& entities,
AZStd::vector<AZStd::unique_ptr<Instance>>&& instancesToConsume, AZ::IO::PathView filePath,
AZStd::unique_ptr<Instance>& instance, bool shouldCreateLinks);
/**
* Updates all the linked Instances corresponding to the linkIds in the provided queue.
* Queue gets populated with more linkId lists as linked instances are updated. Updating stops when the queue is empty.
@@ -310,7 +333,7 @@ namespace AzToolsFramework
* @param instance The instance that the template was created from. This needs to be editable for inserting linkId into it.
* @return bool on whether the operation succeeded
*/
bool GenerateLinksForNewTemplate(const TemplateId& newTemplateId, Instance& instance);
bool GenerateLinksForNewTemplate(TemplateId newTemplateId, Instance& instance);
/**
* Create a unique Template id for newly created Template.
@@ -29,28 +29,28 @@ namespace AzToolsFramework
public:
AZ_RTTI(PrefabSystemComponentInterface, "{8E95A029-67F9-4F74-895F-DDBFE29516A0}");
virtual TemplateReference FindTemplate(const TemplateId& id) = 0;
virtual TemplateReference FindTemplate(TemplateId id) = 0;
virtual LinkReference FindLink(const LinkId& id) = 0;
virtual TemplateId AddTemplate(const AZ::IO::Path& filePath, PrefabDom prefabDom) = 0;
virtual void UpdateTemplateFilePath(TemplateId templateId, const AZ::IO::PathView& filePath) = 0;
virtual void RemoveTemplate(const TemplateId& templateId) = 0;
virtual void RemoveTemplate(TemplateId templateId) = 0;
virtual void RemoveAllTemplates() = 0;
virtual LinkId AddLink(const TemplateId& sourceTemplateId, const TemplateId& targetTemplateId,
virtual LinkId AddLink(TemplateId sourceTemplateId, TemplateId targetTemplateId,
PrefabDomValue::MemberIterator& instanceIterator, InstanceOptionalReference instance) = 0;
//creates a new Link
virtual LinkId CreateLink(
const TemplateId& linkTargetId, const TemplateId& linkSourceId, const InstanceAlias& instanceAlias,
TemplateId linkTargetId, TemplateId linkSourceId, const InstanceAlias& instanceAlias,
const PrefabDomConstReference linkPatches, const LinkId& linkId = InvalidLinkId) = 0;
virtual void RemoveLink(const LinkId& linkId) = 0;
virtual TemplateId GetTemplateIdFromFilePath(AZ::IO::PathView filePath) const = 0;
virtual bool IsTemplateDirty(const TemplateId& templateId) = 0;
virtual void SetTemplateDirtyFlag(const TemplateId& templateId, bool dirty) = 0;
virtual bool IsTemplateDirty(TemplateId templateId) = 0;
virtual void SetTemplateDirtyFlag(TemplateId templateId, bool dirty) = 0;
//! Recursive function to check if the template is dirty or if any dirty templates are presents in the links of the template.
//! @param rootTemplateId The id of the template provided as the beginning template to check the outgoing links.
@@ -67,13 +67,16 @@ namespace AzToolsFramework
virtual PrefabDom& FindTemplateDom(TemplateId templateId) = 0;
virtual void UpdatePrefabTemplate(TemplateId templateId, const PrefabDom& updatedDom) = 0;
virtual void PropagateTemplateChanges(TemplateId templateId, InstanceOptionalReference instanceToExclude = AZStd::nullopt) = 0;
virtual void PropagateTemplateChanges(TemplateId templateId, bool immediate = false, InstanceOptionalReference instanceToExclude = AZStd::nullopt) = 0;
virtual AZStd::unique_ptr<Instance> InstantiatePrefab(AZ::IO::PathView filePath) = 0;
virtual AZStd::unique_ptr<Instance> InstantiatePrefab(const TemplateId& templateId) = 0;
virtual AZStd::unique_ptr<Instance> InstantiatePrefab(
AZ::IO::PathView filePath, InstanceOptionalReference parent = AZStd::nullopt) = 0;
virtual AZStd::unique_ptr<Instance> InstantiatePrefab(
TemplateId templateId, InstanceOptionalReference parent = AZStd::nullopt) = 0;
virtual AZStd::unique_ptr<Instance> CreatePrefab(const AZStd::vector<AZ::Entity*>& entities,
AZStd::vector<AZStd::unique_ptr<Instance>>&& instancesToConsume, AZ::IO::PathView filePath,
AZStd::unique_ptr<AZ::Entity> containerEntity = nullptr, bool ShouldCreateLinks = true) = 0;
AZStd::unique_ptr<AZ::Entity> containerEntity = nullptr, InstanceOptionalReference parent = AZStd::nullopt,
bool shouldCreateLinks = true) = 0;
};
@@ -33,7 +33,7 @@ namespace AzToolsFramework
void PrefabUndoInstance::Capture(
const PrefabDom& initialState,
const PrefabDom& endState,
const TemplateId& templateId)
TemplateId templateId)
{
m_templateId = templateId;
@@ -43,10 +43,15 @@ namespace AzToolsFramework
void PrefabUndoInstance::Undo()
{
m_instanceToTemplateInterface->PatchTemplate(m_undoPatch, m_templateId);
m_instanceToTemplateInterface->PatchTemplate(m_undoPatch, m_templateId, true);
}
void PrefabUndoInstance::Redo()
{
m_instanceToTemplateInterface->PatchTemplate(m_redoPatch, m_templateId, true);
}
void PrefabUndoInstance::RedoBatched()
{
m_instanceToTemplateInterface->PatchTemplate(m_redoPatch, m_templateId);
}
@@ -91,7 +96,7 @@ namespace AzToolsFramework
void PrefabUndoEntityUpdate::Undo()
{
[[maybe_unused]] bool isPatchApplicationSuccessful =
m_instanceToTemplateInterface->PatchTemplate(m_undoPatch, m_templateId);
m_instanceToTemplateInterface->PatchTemplate(m_undoPatch, m_templateId, true);
AZ_Error(
"Prefab", isPatchApplicationSuccessful,
@@ -102,7 +107,7 @@ namespace AzToolsFramework
void PrefabUndoEntityUpdate::Redo()
{
[[maybe_unused]] bool isPatchApplicationSuccessful =
m_instanceToTemplateInterface->PatchTemplate(m_redoPatch, m_templateId);
m_instanceToTemplateInterface->PatchTemplate(m_redoPatch, m_templateId, true);
AZ_Error(
"Prefab", isPatchApplicationSuccessful,
@@ -113,7 +118,7 @@ namespace AzToolsFramework
void PrefabUndoEntityUpdate::Redo(InstanceOptionalReference instanceToExclude)
{
[[maybe_unused]] bool isPatchApplicationSuccessful =
m_instanceToTemplateInterface->PatchTemplate(m_redoPatch, m_templateId, instanceToExclude);
m_instanceToTemplateInterface->PatchTemplate(m_redoPatch, m_templateId, false, instanceToExclude);
AZ_Error(
"Prefab", isPatchApplicationSuccessful,
@@ -136,8 +141,8 @@ namespace AzToolsFramework
}
void PrefabUndoInstanceLink::Capture(
const TemplateId& targetId,
const TemplateId& sourceId,
TemplateId targetId,
TemplateId sourceId,
const InstanceAlias& instanceAlias,
PrefabDom linkPatches,
const LinkId linkId)
@@ -329,7 +334,7 @@ namespace AzToolsFramework
//propagate the link changes
link->get().UpdateTarget();
m_prefabSystemComponentInterface->PropagateTemplateChanges(link->get().GetTargetTemplateId(), instanceToExclude);
m_prefabSystemComponentInterface->PropagateTemplateChanges(link->get().GetTargetTemplateId(), false, instanceToExclude);
//mark as dirty
m_prefabSystemComponentInterface->SetTemplateDirtyFlag(link->get().GetTargetTemplateId(), true);
@@ -49,10 +49,11 @@ namespace AzToolsFramework
void Capture(
const PrefabDom& initialState,
const PrefabDom& endState,
const TemplateId& templateId);
TemplateId templateId);
void Undo() override;
void Redo() override;
void RedoBatched();
};
//! handles entity updates, such as when the values on an entity change
@@ -95,8 +96,8 @@ namespace AzToolsFramework
//capture for add/remove
void Capture(
const TemplateId& targetId,
const TemplateId& sourceId,
TemplateId targetId,
TemplateId sourceId,
const InstanceAlias& instanceAlias,
PrefabDom linkPatches = PrefabDom(),
const LinkId linkId = InvalidLinkId);
@@ -26,7 +26,7 @@ namespace AzToolsFramework
PrefabUndoInstance* state = aznew Prefab::PrefabUndoInstance(undoMessage);
state->Capture(instanceDomBeforeUpdate, instanceDomAfterUpdate, instance.GetTemplateId());
state->SetParent(undoBatch);
state->Redo();
state->RedoBatched();
}
LinkId CreateLink(
@@ -1160,7 +1160,7 @@ namespace AzToolsFramework
AZStd::string unsavedPrefabFileName = unsavedPrefabFileLabel->property("FilePath").toString().toUtf8().data();
AzToolsFramework::Prefab::TemplateId unsavedPrefabTemplateId =
s_prefabSystemComponentInterface->GetTemplateIdFromFilePath(unsavedPrefabFileName.data());
bool isTemplateSavedSuccessfully = s_prefabLoaderInterface->SaveTemplate(unsavedPrefabTemplateId);
[[maybe_unused]] bool isTemplateSavedSuccessfully = s_prefabLoaderInterface->SaveTemplate(unsavedPrefabTemplateId);
AZ_Error("Prefab", isTemplateSavedSuccessfully, "Prefab '%s' could not be saved successfully.", unsavedPrefabFileName.c_str());
}
}
@@ -1,230 +0,0 @@
/*
* Copyright (c) Contributors to the Open 3D Engine Project.
* For complete copyright and license terms please see the LICENSE at the root of this distribution.
*
* SPDX-License-Identifier: Apache-2.0 OR MIT
*
*/
#include <AzCore/std/string/string.h>
#include <AzCore/Outcome/Outcome.h>
#include <AzFramework/StringFunc/StringFunc.h>
#include <AzFramework/IO/LocalFileIO.h>
namespace AzToolsFramework
{
namespace Platform
{
[[maybe_unused]] static const char ErrorChannel[] = "ArchiveComponent_Linux";
static const char ZipExePath[] = R"(/usr/bin/zip)";
static const char UnzipExePath[] = R"(/usr/bin/unzip)";
static const char CreateArchiveCmd[] = "-r \"%s\" . -i *";
static const char ExtractArchiveCmd[] = R"(-o "%s" -d "%s")";
static const char AddFileCmd[] = R"("%s" "%s")";
static const char ExtractFileCmd[] = R"(%s "%s" %s)";
static const char ExtractFileDestination[] = R"(%s "%s" "%s" -d "%s")";
static const char ExtractOverwrite[] = "-o";
static const char ExtractSkipExisting[] = "-n";
static const char ListFilesInArchiveCmd[] = "-l %s";
AZStd::string GetZipExePath()
{
return ZipExePath;
}
AZStd::string GetUnzipExePath()
{
return UnzipExePath;
}
AZ::Outcome<AZStd::string, AZStd::string> MakePath(const AZStd::string& path)
{
// Create the folder if it does not already exist
if (!AZ::IO::FileIOBase::GetInstance()->Exists(path.c_str()))
{
auto result = AZ::IO::FileIOBase::GetInstance()->CreatePath(path.c_str());
if (!result)
{
return AZ::Failure(AZStd::string::format("Path creation failed. Input path: %s \n", path.c_str()));
}
}
return AZ::Success(path);
}
AZ::Outcome<AZStd::string, AZStd::string> MakeCreateArchivePath(const AZStd::string& archivePath)
{
// Remove the file name from the input path
// /some/folder/path/archive.zip -> /some/folder/path/
AZStd::string strippedArchivePath = archivePath;
AzFramework::StringFunc::Path::StripFullName(strippedArchivePath);
if (strippedArchivePath.empty())
{
return AZ::Failure(AZStd::string::format("Stripped path name is empty. Cancelling path creation. Input path: %s\n", archivePath.c_str()));
}
return MakePath(strippedArchivePath);
}
AZ::Outcome<AZStd::string, AZStd::string> MakeExtractArchivePath(const AZStd::string& archivePath, const AZStd::string& destinationPath, bool includeRoot)
{
if(!includeRoot)
{
// Create the folder for the input destination path with no modifications
// /path/to/destination/
return MakePath(destinationPath);
}
// Get the name of the input archive. This will be the name of the root folder for the archive extraction
// /some/folder/path/archive.zip -> archive
AZStd::string zipFileName;
bool result = AzFramework::StringFunc::Path::GetFileName(archivePath.c_str(), zipFileName);
if(!result)
{
return AZ::Failure(AZStd::string::format("Failed to get name of zip file from the archive path. Cancelling path creation. \n Input Archive Path: %s \n", archivePath.c_str()));
}
// Append the root folder name to the end of the destination path
// /path/to/destination/ + archive -> /path/to/destination/archive
AZStd::string destinationPathWithRoot;
result = AzFramework::StringFunc::Path::Join(destinationPath.c_str(), zipFileName.c_str(), destinationPathWithRoot);
if(!result)
{
return AZ::Failure(AZStd::string::format("Failed to append zip file name to the destination path. Cancelling path creation. \n Destination Path: %s \n Zip file name: %s \n", destinationPath.c_str(), zipFileName.c_str()));
}
// Append a separator so that it is formatted like a folder
// /path/to/destination/archive -> /path/to/destination/archive/
AzFramework::StringFunc::Path::AppendSeparator(destinationPathWithRoot);
return MakePath(destinationPathWithRoot);
}
AZStd::string GetCreateArchiveCommand(const AZStd::string& archivePath, const AZStd::string& dirToArchive)
{
auto pathCreationResult = MakeCreateArchivePath(archivePath);
if (!pathCreationResult)
{
AZ_Error(ErrorChannel, false, "%s", pathCreationResult.GetError().c_str());
return "";
}
AZ_UNUSED(dirToArchive);
return AZStd::string::format(CreateArchiveCmd, archivePath.c_str());
}
AZStd::string GetExtractArchiveCommand(const AZStd::string& archivePath, const AZStd::string& destinationPath, bool includeRoot)
{
auto pathCreationResult = MakeExtractArchivePath(archivePath, destinationPath, includeRoot);
if (!pathCreationResult)
{
AZ_Error(ErrorChannel, false, "%s", pathCreationResult.GetError().c_str());
return "";
}
return AZStd::string::format(ExtractArchiveCmd, archivePath.c_str(), pathCreationResult.GetValue().c_str());
}
AZStd::string GetAddFilesToArchiveCommand(const AZStd::string& /*archivePath*/, const AZStd::string& /*listFilePath*/)
{
// Adding files into a archive using a list file is not currently supported
return {};
}
bool IsAddFilesToArchiveCommandSupported()
{
// Adding files into a archive using a list file is not currently supported
return false;
}
AZStd::string GetAddFileToArchiveCommand(const AZStd::string& archivePath, const AZStd::string& file)
{
if (!MakeCreateArchivePath(archivePath).IsSuccess())
{
AZ_Error(ErrorChannel, false, "Unable to make path for ( %s ).\n", archivePath.c_str());
return {};
}
return AZStd::string::format(AddFileCmd, archivePath.c_str(), file.c_str());
}
AZStd::string GetExtractFileCommand(const AZStd::string& archivePath, const AZStd::string& fileInArchive, const AZStd::string& destinationPath, bool overWrite)
{
AZStd::string commandLineArgs;
if (destinationPath.empty())
{
// Extract file in archive from archive path to the current directory, overwriting a file of the same name that exists there.
commandLineArgs = AZStd::string::format(ExtractFileCmd, overWrite ? ExtractOverwrite : ExtractSkipExisting, archivePath.c_str(), fileInArchive.c_str());
}
else
{
if (!MakePath(destinationPath).IsSuccess())
{
AZ_Error(ErrorChannel, false, "Unable to make path ( %s ).\n", destinationPath.c_str());
return {};
}
// Extract file in archive from archive path to destinationPath, overwriting a file of the same name that exists there.
commandLineArgs = AZStd::string::format(ExtractFileDestination, overWrite ? ExtractOverwrite : ExtractSkipExisting, archivePath.c_str(), fileInArchive.c_str(), destinationPath.c_str());
}
return commandLineArgs;
}
AZStd::string GetListFilesInArchiveCommand(const AZStd::string& archivePath)
{
AZStd::string commandLineArgs = AZStd::string::format(ListFilesInArchiveCmd, archivePath.c_str());
return commandLineArgs;
}
/*
Sample Console Output of the unzip list command
Archive: /var/folders/1q/12nyzqc913qgm532y2c98mnm6w4_qv/T/ArchiveTests-ra8oMy/TestArchive.pak
Length Date Time Name
--------- ---------- ----- ----
0 10-14-2019 15:22 testfolder/
1 10-14-2019 15:22 testfolder/folderfile.txt
1 10-14-2019 15:22 basicfile.txt
1 10-14-2019 15:22 basicfile2.txt
0 10-14-2019 15:22 testfolder2/
1 10-14-2019 15:22 testfolder2/sharedfolderfile2.txt
1 10-14-2019 15:22 testfolder2/sharedfolderfile.txt
0 10-14-2019 15:22 testfolder3/
0 10-14-2019 15:22 testfolder3/testfolder4/
1 10-14-2019 15:22 testfolder3/testfolder4/depthfile.bat
--------- -------
6 10 files
*/
void ParseConsoleOutputFromListFilesInArchive(const AZStd::string& consoleOutput, AZStd::vector<AZStd::string>& fileEntries)
{
AZStd::vector<AZStd::string> fileEntryData;
AzFramework::StringFunc::Tokenize(consoleOutput.c_str(), fileEntryData, "\n");
int startingLineIdx = 3; // first line that might contain the file name
for (size_t lineIdx = startingLineIdx; lineIdx < fileEntryData.size(); ++lineIdx)
{
AZStd::string& line = fileEntryData[lineIdx];
AZStd::vector<AZStd::string> lineEntryData;
AzFramework::StringFunc::Tokenize(line.c_str(), lineEntryData, " ");
AZStd::string& fileName = lineEntryData.back();
if(fileName.back() == AZ_CORRECT_FILESYSTEM_SEPARATOR)
{
// if the filename ends with a separator
// than it indicates that this is a directory
continue;
}
if(fileName.compare("-------") == 0)
{
return;
}
fileEntries.emplace_back(fileName);
}
}
} // namespace Platform
} // namespace AzToolsFramework
@@ -7,5 +7,4 @@
#
set(FILES
AzToolsFramework/Archive/ArchiveComponent_Linux.cpp
)
@@ -1,263 +0,0 @@
/*
* Copyright (c) Contributors to the Open 3D Engine Project.
* For complete copyright and license terms please see the LICENSE at the root of this distribution.
*
* SPDX-License-Identifier: Apache-2.0 OR MIT
*
*/
#include <AzCore/std/string/string.h>
#include <AzCore/Outcome/Outcome.h>
#include <AzFramework/StringFunc/StringFunc.h>
#include <AzFramework/IO/LocalFileIO.h>
namespace AzToolsFramework
{
namespace Platform
{
const char ErrorChannel[] = "ArchiveComponent_OSX";
const char ZipExePath[] = R"(/usr/bin/zip)";
const char UnzipExePath[] = R"(/usr/bin/unzip)";
// v Requires investigation, the correct cmd should be R"(-r "%s" "%s/")" but tests fail
const char CreateArchiveCmd[] = R"(-r "%s" .)";
const char ExtractArchiveCmd[] = R"(-o "%s" -d "%s")";
const char AddFileCmd[] = R"("%s" "%s" -X)";
const char AddFilesCmd[] = R"("%s" -X %s)";
const char ExtractFileCmd[] = R"(%s "%s" %s)";
const char ExtractFileDestination[] = R"(%s "%s" "%s" -d "%s")";
const char ExtractOverwrite[] = "-o";
const char ExtractSkipExisting[] = "-n";
const char ListFilesInArchiveCmd[] = "-l %s";
AZStd::string GetZipExePath()
{
return ZipExePath;
}
AZStd::string GetUnzipExePath()
{
return UnzipExePath;
}
AZ::Outcome<AZStd::string, AZStd::string> MakePath(const AZStd::string& path)
{
// Create the folder if it does not already exist
if (!AZ::IO::FileIOBase::GetInstance()->Exists(path.c_str()))
{
auto result = AZ::IO::FileIOBase::GetInstance()->CreatePath(path.c_str());
if (!result)
{
return AZ::Failure(AZStd::string::format("Path creation failed. Input path: %s \n", path.c_str()));
}
}
return AZ::Success(path);
}
AZ::Outcome<AZStd::string, AZStd::string> MakeCreateArchivePath(const AZStd::string& archivePath)
{
// Remove the file name from the input path
// /some/folder/path/archive.zip -> /some/folder/path/
AZStd::string strippedArchivePath = archivePath;
AzFramework::StringFunc::Path::StripFullName(strippedArchivePath);
if (strippedArchivePath.empty())
{
return AZ::Failure(AZStd::string::format("Stripped path name is empty. Cancelling path creation. Input path: %s\n", archivePath.c_str()));
}
return MakePath(strippedArchivePath);
}
AZ::Outcome<AZStd::string, AZStd::string> MakeExtractArchivePath(const AZStd::string& archivePath, const AZStd::string& destinationPath, bool includeRoot)
{
if(!includeRoot)
{
// Create the folder for the input destination path with no modifications
// /path/to/destination/
return MakePath(destinationPath);
}
// Get the name of the input archive. This will be the name of the root folder for the archive extraction
// /some/folder/path/archive.zip -> archive
AZStd::string zipFileName;
bool result = AzFramework::StringFunc::Path::GetFileName(archivePath.c_str(), zipFileName);
if(!result)
{
return AZ::Failure(AZStd::string::format("Failed to get name of zip file from the archive path. Cancelling path creation. \n Input Archive Path: %s \n", archivePath.c_str()));
}
// Append the root folder name to the end of the destination path
// /path/to/destination/ + archive -> /path/to/destination/archive
AZStd::string destinationPathWithRoot;
result = AzFramework::StringFunc::Path::Join(destinationPath.c_str(), zipFileName.c_str(), destinationPathWithRoot);
if(!result)
{
return AZ::Failure(AZStd::string::format("Failed to append zip file name to the destination path. Cancelling path creation. \n Destination Path: %s \n Zip file name: %s \n", destinationPath.c_str(), zipFileName.c_str()));
}
// Append a separator so that it is formatted like a folder
// /path/to/destination/archive -> /path/to/destination/archive/
AzFramework::StringFunc::Path::AppendSeparator(destinationPathWithRoot);
return MakePath(destinationPathWithRoot);
}
AZStd::string GetCreateArchiveCommand(const AZStd::string& archivePath, const AZStd::string& dirToArchive)
{
auto pathCreationResult = MakeCreateArchivePath(archivePath);
if (!pathCreationResult.IsSuccess())
{
AZ_Error(ErrorChannel, false, pathCreationResult.GetError().c_str());
return "";
}
// LY-116692. Requires proper investigation, the correct format should be:
// AZStd::string::format(CreateArchiveCmd, archivePath.c_str(), dirToArchive.c_str());
// but unit test ArchiveTest.ListFilesInArchiveBlocking_FilesAtThreeDepths_FilesFound fails
AZ_UNUSED(dirToArchive);
return AZStd::string::format(CreateArchiveCmd, archivePath.c_str());
}
AZStd::string GetExtractArchiveCommand(const AZStd::string& archivePath, const AZStd::string& destinationPath, bool includeRoot)
{
auto pathCreationResult = MakeExtractArchivePath(archivePath, destinationPath, includeRoot);
if (!pathCreationResult)
{
AZ_Error(ErrorChannel, false, pathCreationResult.GetError().c_str());
return "";
}
return AZStd::string::format(ExtractArchiveCmd, archivePath.c_str(), pathCreationResult.GetValue().c_str());
}
AZStd::string GetAddFilesToArchiveCommand(const AZStd::string& archivePath, const AZStd::string& listFilePath)
{
auto pathCreationResult = MakeCreateArchivePath(archivePath);
if (!pathCreationResult)
{
AZ_Error(ErrorChannel, false, pathCreationResult.GetError().c_str());
return "";
}
AZStd::string fileListStr;
{
AZ::IO::FileIOStream fileStream(listFilePath.c_str(), AZ::IO::OpenMode::ModeRead | AZ::IO::OpenMode::ModeText);
if (fileStream.IsOpen())
{
AZ::IO::SizeType length = fileStream.GetLength();
AZStd::vector<char> charBuffer;
charBuffer.resize_no_construct(length + 1);
fileStream.Read(length, charBuffer.data());
charBuffer.back() = 0;
fileListStr.append("\"");
fileListStr.insert(1, charBuffer.data());
AzFramework::StringFunc::Replace(fileListStr, "\n", "\" \"");
fileListStr.append("\"");
}
else
{
AZ_Error(ErrorChannel, false, "Unable to read list file ( %s ) \n", listFilePath.c_str());
return "";
}
}
return AZStd::string::format(AddFilesCmd, archivePath.c_str(), fileListStr.c_str());
}
AZStd::string GetAddFileToArchiveCommand(const AZStd::string& archivePath, const AZStd::string& file)
{
auto pathCreationResult = MakeCreateArchivePath(archivePath);
if (!pathCreationResult)
{
AZ_Error(ErrorChannel, false, pathCreationResult.GetError().c_str());
return "";
}
return AZStd::string::format(AddFileCmd, archivePath.c_str(), file.c_str());
}
AZStd::string GetExtractFileCommand(const AZStd::string& archivePath, const AZStd::string& fileInArchive, const AZStd::string& destinationPath, bool overWrite)
{
AZStd::string commandLineArgs;
if (destinationPath.empty())
{
// Extract file in archive from archive path to the current directory, overwriting a file of the same name that exists there.
commandLineArgs = AZStd::string::format(ExtractFileCmd, overWrite ? ExtractOverwrite : ExtractSkipExisting, archivePath.c_str(), fileInArchive.c_str());
}
else
{
if (!MakePath(destinationPath).IsSuccess())
{
AZ_Error(ErrorChannel, false, "Unable to make path ( %s ).\n", destinationPath.c_str());
return "";
}
// Extract file in archive from archive path to destinationPath, overwriting a file of the same name that exists there.
commandLineArgs = AZStd::string::format(ExtractFileDestination, overWrite ? ExtractOverwrite : ExtractSkipExisting, archivePath.c_str(), fileInArchive.c_str(), destinationPath.c_str());
}
return commandLineArgs;
}
AZStd::string GetListFilesInArchiveCommand(const AZStd::string& archivePath)
{
AZStd::string commandLineArgs = AZStd::string::format(ListFilesInArchiveCmd, archivePath.c_str());
return commandLineArgs;
}
/*
Sample Console Output of the unzip list command
Archive: /var/folders/1q/12nyzqc913qgm532y2c98mnm6w4_qv/T/ArchiveTests-ra8oMy/TestArchive.pak
Length Date Time Name
--------- ---------- ----- ----
0 10-14-2019 15:22 testfolder/
1 10-14-2019 15:22 testfolder/folderfile.txt
1 10-14-2019 15:22 basicfile.txt
1 10-14-2019 15:22 basicfile2.txt
0 10-14-2019 15:22 testfolder2/
1 10-14-2019 15:22 testfolder2/sharedfolderfile2.txt
1 10-14-2019 15:22 testfolder2/sharedfolderfile.txt
0 10-14-2019 15:22 testfolder3/
0 10-14-2019 15:22 testfolder3/testfolder4/
1 10-14-2019 15:22 testfolder3/testfolder4/depthfile.bat
--------- -------
6 10 files
*/
void ParseConsoleOutputFromListFilesInArchive(const AZStd::string& consoleOutput, AZStd::vector<AZStd::string>& fileEntries)
{
AZStd::vector<AZStd::string> fileEntryData;
AzFramework::StringFunc::Tokenize(consoleOutput.c_str(), fileEntryData, "\n");
int startingLineIdx = 3; // first line that might contain the file name
for (size_t lineIdx = startingLineIdx; lineIdx < fileEntryData.size(); ++lineIdx)
{
AZStd::string& line = fileEntryData[lineIdx];
AZStd::vector<AZStd::string> lineEntryData;
AzFramework::StringFunc::Tokenize(line.c_str(), lineEntryData, " ");
AZStd::string& fileName = lineEntryData.back();
if(fileName.back() == AZ_CORRECT_FILESYSTEM_SEPARATOR)
{
// if the filename ends with a separator
// than it indicates that this is a directory
continue;
}
if(fileName.compare("-------") == 0)
{
return;
}
fileEntries.emplace_back(fileName);
}
}
} // namespace Platform
} // namespace AzToolsFramework
@@ -7,5 +7,4 @@
#
set(FILES
AzToolsFramework/Archive/ArchiveComponent_Mac.cpp
)
@@ -1,167 +0,0 @@
/*
* Copyright (c) Contributors to the Open 3D Engine Project.
* For complete copyright and license terms please see the LICENSE at the root of this distribution.
*
* SPDX-License-Identifier: Apache-2.0 OR MIT
*
*/
#include <AzCore/std/string/string.h>
#include <AzCore/Component/ComponentApplicationBus.h>
#include <AzFramework/StringFunc/StringFunc.h>
#include <AzToolsFramework/Archive/ArchiveComponent.h>
namespace AzToolsFramework
{
namespace Platform
{
const char CreateArchiveCmd[] = R"(a -tzip -mx=1 "%s" -r "%s\*")";
// -aos is for skipping extract on existing files
const char ExtractArchiveCmd[] = R"(x -mmt=off "%s" -o"%s\*" -aos)";
const char ExtractArchiveWithoutRootCmd[] = R"(x -mmt=off "%s" -o"%s" -aos)";
const char AddFilesCmd[] = R"(a -tzip "%s" @"%s")";
const char AddFileCmd[] = R"(a -tzip "%s" "%s")";
const char ExtractFileCmd[] = R"(e -mmt=off "%s" "%s" %s)";
const char ExtractFileDestination[] = R"(e -mmt=off "%s" -o"%s" "%s" %s)";
const char ExtractOverwrite[] = "-aoa";
const char ExtractSkipExisting[] = "-aos";
const char ListFilesInArchiveCmd[] = R"(l -r -slt "%s")";
AZStd::string Get7zExePath()
{
const char* rootPath = nullptr;
AZ::ComponentApplicationBus::BroadcastResult(rootPath, &AZ::ComponentApplicationRequests::GetEngineRoot);
AZStd::string exePath;
AzFramework::StringFunc::Path::ConstructFull(rootPath, "Tools", "7za", ".exe", exePath);
return exePath;
}
AZStd::string GetZipExePath()
{
return Get7zExePath();
}
AZStd::string GetUnzipExePath()
{
return Get7zExePath();
}
AZStd::string GetCreateArchiveCommand(const AZStd::string& archivePath, const AZStd::string& dirToArchive)
{
return AZStd::string::format(CreateArchiveCmd, archivePath.c_str(), dirToArchive.c_str());
}
AZStd::string GetExtractArchiveCommand(const AZStd::string& archivePath, const AZStd::string& destinationPath, bool includeRoot)
{
if (includeRoot)
{
// Extract archive path to destinationPath\<archiveFileName> and skipping extracting of existing files
return AZStd::string::format(ExtractArchiveCmd, archivePath.c_str(), destinationPath.c_str());
}
else
{
// Extract archive path to destinationPath and skipping extracting of existing files
return AZStd::string::format(ExtractArchiveWithoutRootCmd, archivePath.c_str(), destinationPath.c_str());
}
}
AZStd::string GetAddFilesToArchiveCommand(const AZStd::string& archivePath, const AZStd::string& listFilePath)
{
return AZStd::string::format(AddFilesCmd, archivePath.c_str(), listFilePath.c_str());
}
AZStd::string GetAddFileToArchiveCommand(const AZStd::string& archivePath, const AZStd::string& file)
{
return AZStd::string::format(AddFileCmd, archivePath.c_str(), file.c_str());
}
AZStd::string GetExtractFileCommand(const AZStd::string& archivePath, const AZStd::string& fileInArchive, const AZStd::string& destinationPath, bool overWrite)
{
AZStd::string commandLineArgs;
if (destinationPath.empty())
{
// Extract file in archive from archive path to the current directory, overwriting a file of the same name that exists there.
commandLineArgs = AZStd::string::format(ExtractFileCmd, archivePath.c_str(), fileInArchive.c_str(), overWrite ? ExtractOverwrite : ExtractSkipExisting);
}
else
{
// Extract file in archive from archive path to destinationPath, overwriting a file of the same name that exists there.
commandLineArgs = AZStd::string::format(ExtractFileDestination, archivePath.c_str(), destinationPath.c_str(), fileInArchive.c_str(), overWrite ? ExtractOverwrite : ExtractSkipExisting);
}
return commandLineArgs;
}
AZStd::string GetListFilesInArchiveCommand(const AZStd::string& archivePath)
{
AZStd::string commandLineArgs = AZStd::string::format(ListFilesInArchiveCmd, archivePath.c_str());
return commandLineArgs;
}
/*
File output for our list archive commands takes the following two patterns for files vs directories:
Path = basicfile2.txt
Folder = -
Size = 1
Packed Size = 1
Modified = 2019-03-26 18:31:10
Created = 2019-03-26 18:31:10
Accessed = 2019-03-26 18:31:10
Attributes = A
Encrypted = -
Comment =
CRC = 32D70693
Method = Store
Characteristics = NTFS
Host OS = FAT
Version = 10
Volume Index = 0
Offset = 44
Path = testfolder
Folder = +
Size = 0
Packed Size = 0
Modified = 2019-03-26 18:31:10
Created = 2019-03-26 18:31:10
Accessed = 2019-03-26 18:31:10
Attributes = D
Encrypted = -
Comment =
CRC =
Method = Store
Characteristics = NTFS
Host OS = FAT
Version = 20
Volume Index = 0
Offset = 89
*/
void ParseConsoleOutputFromListFilesInArchive(const AZStd::string& consoleOutput, AZStd::vector<AZStd::string>& fileEntries)
{
AZStd::vector<AZStd::string> fileEntryData;
AzFramework::StringFunc::Tokenize(consoleOutput.c_str(), fileEntryData, "\r\n");
for (size_t slotNum = 0; slotNum < fileEntryData.size(); ++slotNum)
{
AZStd::string& line = fileEntryData[slotNum];
if (AzFramework::StringFunc::StartsWith(line, "Path = "))
{
if ((slotNum + 1) < fileEntryData.size())
{
// We're checking one past each entry we find for the Folder entry and skipping anything marked as a folder
// See sample output above
if (AzFramework::StringFunc::StartsWith(fileEntryData[slotNum + 1], "Folder = -"))
{
AzFramework::StringFunc::Replace(line, "Path = ", "", false, true);
fileEntries.emplace_back(AZStd::move(line));
slotNum++;
}
}
}
}
}
} // namespace Platform
} // namespace AzToolsFramework
@@ -7,5 +7,4 @@
#
set(FILES
AzToolsFramework/Archive/ArchiveComponent_Windows.cpp
)
@@ -31,7 +31,6 @@ namespace UnitTest
{
namespace
{
bool CreateDummyFile(const QString& fullPathToFile, const QString& tempStr = {})
{
QFileInfo fi(fullPathToFile);
@@ -50,7 +49,7 @@ namespace UnitTest
return true;
}
class ArchiveTest :
class ArchiveComponentTest :
public ::testing::Test
{
@@ -73,7 +72,12 @@ namespace UnitTest
return "Archive";
}
void CreateArchiveFolder( QString archiveFolderName, QStringList fileList )
QString GetExtractFolderName()
{
return "Extracted";
}
void CreateArchiveFolder(QString archiveFolderName, QStringList fileList)
{
QDir tempPath = QDir(m_tempDir.GetDirectory()).filePath(archiveFolderName);
@@ -84,6 +88,14 @@ namespace UnitTest
}
}
QString CreateArchiveListTextFile()
{
QString listFilePath = QDir(m_tempDir.GetDirectory()).absoluteFilePath("FileList.txt");
QString textContent = CreateArchiveFileList().join("\n");
EXPECT_TRUE(CreateDummyFile(listFilePath, textContent));
return listFilePath;
}
void CreateArchiveFolder()
{
CreateArchiveFolder(GetArchiveFolderName(), CreateArchiveFileList());
@@ -99,16 +111,24 @@ namespace UnitTest
return QDir(m_tempDir.GetDirectory()).filePath(GetArchiveFolderName());
}
QString GetExtractFolder()
{
return QDir(m_tempDir.GetDirectory()).filePath(GetExtractFolderName());
}
bool CreateArchive()
{
bool createResult{ false };
AzToolsFramework::ArchiveCommandsBus::BroadcastResult(createResult, &AzToolsFramework::ArchiveCommandsBus::Events::CreateArchiveBlocking, GetArchivePath().toStdString().c_str(), GetArchiveFolder().toStdString().c_str());
return createResult;
std::future<bool> createResult;
AzToolsFramework::ArchiveCommandsBus::BroadcastResult(createResult,
&AzToolsFramework::ArchiveCommandsBus::Events::CreateArchive,
GetArchivePath().toUtf8().constData(), GetArchiveFolder().toUtf8().constData());
bool result = createResult.get();
return result;
}
void SetUp() override
{
m_app.reset(aznew ToolsTestApplication("ArchiveTest"));
m_app.reset(aznew ToolsTestApplication("ArchiveComponentTest"));
m_app->Start(AzFramework::Application::Descriptor());
// Without this, the user settings component would attempt to save on finalize/shutdown. Since the file is
// shared across the whole engine, if multiple tests are run in parallel, the saving could cause a crash
@@ -132,76 +152,138 @@ namespace UnitTest
};
#if AZ_TRAIT_DISABLE_FAILED_ARCHIVE_TESTS
TEST_F(ArchiveTest, DISABLED_CreateArchiveBlocking_FilesAtThreeDepths_ArchiveCreated)
TEST_F(ArchiveComponentTest, DISABLED_CreateArchive_FilesAtThreeDepths_ArchiveCreated)
#else
TEST_F(ArchiveTest, CreateArchiveBlocking_FilesAtThreeDepths_ArchiveCreated)
TEST_F(ArchiveComponentTest, CreateArchive_FilesAtThreeDepths_ArchiveCreated)
#endif // AZ_TRAIT_DISABLE_FAILED_ARCHIVE_TESTS
{
EXPECT_TRUE(m_tempDir.IsValid());
CreateArchiveFolder();
AZ_TEST_START_TRACE_SUPPRESSION;
bool createResult = CreateArchive();
AZ_TEST_STOP_TRACE_SUPPRESSION_NO_COUNT;
EXPECT_EQ(createResult, true);
EXPECT_TRUE(createResult);
}
#if AZ_TRAIT_DISABLE_FAILED_ARCHIVE_TESTS
TEST_F(ArchiveTest, DISABLED_ListFilesInArchiveBlocking_FilesAtThreeDepths_FilesFound)
TEST_F(ArchiveComponentTest, DISABLED_ListFilesInArchive_FilesAtThreeDepths_FilesFound)
#else
TEST_F(ArchiveTest, ListFilesInArchiveBlocking_FilesAtThreeDepths_FilesFound)
TEST_F(ArchiveComponentTest, ListFilesInArchive_FilesAtThreeDepths_FilesFound)
#endif // AZ_TRAIT_DISABLE_FAILED_ARCHIVE_TESTS
{
EXPECT_TRUE(m_tempDir.IsValid());
CreateArchiveFolder();
AZ_TEST_START_TRACE_SUPPRESSION;
EXPECT_EQ(CreateArchive(), true);
AZStd::vector<AZStd::string> fileList;
bool listResult{ false };
AzToolsFramework::ArchiveCommandsBus::BroadcastResult(listResult, &AzToolsFramework::ArchiveCommandsBus::Events::ListFilesInArchiveBlocking, GetArchivePath().toStdString().c_str(), fileList);
AzToolsFramework::ArchiveCommandsBus::BroadcastResult(listResult,
&AzToolsFramework::ArchiveCommandsBus::Events::ListFilesInArchive,
GetArchivePath().toUtf8().constData(), fileList);
AZ_TEST_STOP_TRACE_SUPPRESSION_NO_COUNT;
EXPECT_TRUE(listResult);
EXPECT_EQ(fileList.size(), 6);
}
#if AZ_TRAIT_DISABLE_FAILED_ARCHIVE_TESTS
TEST_F(ArchiveTest, DISABLED_CreateDeltaCatalog_AssetsNotRegistered_Failure)
TEST_F(ArchiveComponentTest, DISABLED_CreateDeltaCatalog_AssetsNotRegistered_Failure)
#else
TEST_F(ArchiveTest, CreateDeltaCatalog_AssetsNotRegistered_Failure)
TEST_F(ArchiveComponentTest, CreateDeltaCatalog_AssetsNotRegistered_Failure)
#endif // AZ_TRAIT_DISABLE_FAILED_ARCHIVE_TESTS
{
QStringList fileList = CreateArchiveFileList();
CreateArchiveFolder(GetArchiveFolderName(), fileList);
AZ_TEST_START_TRACE_SUPPRESSION;
bool createResult = CreateArchive();
AZ_TEST_STOP_TRACE_SUPPRESSION_NO_COUNT;
EXPECT_EQ(createResult, true);
bool catalogCreated{ true };
AZ::Test::AssertAbsorber assertAbsorber;
AzToolsFramework::AssetBundleCommandsBus::BroadcastResult(catalogCreated, &AzToolsFramework::AssetBundleCommandsBus::Events::CreateDeltaCatalog, GetArchivePath().toStdString().c_str(), true);
AzToolsFramework::AssetBundleCommandsBus::BroadcastResult(catalogCreated,
&AzToolsFramework::AssetBundleCommandsBus::Events::CreateDeltaCatalog, GetArchivePath().toUtf8().constData(), true);
EXPECT_EQ(catalogCreated, false);
}
#if AZ_TRAIT_DISABLE_FAILED_ARCHIVE_TESTS
TEST_F(ArchiveTest, DISABLED_CreateDeltaCatalog_ArchiveWithoutCatalogAssetsRegistered_Success)
TEST_F(ArchiveComponentTest, DISABLED_AddFilesToArchive_FromListFile_Success)
#else
TEST_F(ArchiveTest, CreateDeltaCatalog_ArchiveWithoutCatalogAssetsRegistered_Success)
TEST_F(ArchiveComponentTest, AddFilesToArchive_FromListFile_Success)
#endif // AZ_TRAIT_DISABLE_FAILED_ARCHIVE_TESTS
{
QString listFile = CreateArchiveListTextFile();
CreateArchiveFolder(GetArchiveFolderName(), CreateArchiveFileList());
AZ_TEST_START_TRACE_SUPPRESSION;
std::future<bool> addResult;
AzToolsFramework::ArchiveCommandsBus::BroadcastResult(
addResult, &AzToolsFramework::ArchiveCommandsBus::Events::AddFilesToArchive, GetArchivePath().toUtf8().constData(),
GetArchiveFolder().toUtf8().constData(), listFile.toUtf8().constData());
bool result = addResult.get();
AZ_TEST_STOP_TRACE_SUPPRESSION_NO_COUNT;
EXPECT_TRUE(result);
}
#if AZ_TRAIT_DISABLE_FAILED_ARCHIVE_TESTS
TEST_F(ArchiveComponentTest, DISABLED_ExtractArchive_AllFiles_Success)
#else
TEST_F(ArchiveComponentTest, ExtractArchive_AllFiles_Success)
#endif // AZ_TRAIT_DISABLE_FAILED_ARCHIVE_TESTS
{
CreateArchiveFolder();
AZ_TEST_START_TRACE_SUPPRESSION;
bool createResult = CreateArchive();
AZ_TEST_STOP_TRACE_SUPPRESSION_NO_COUNT;
EXPECT_TRUE(createResult);
AZ_TEST_START_TRACE_SUPPRESSION;
std::future<bool> extractResult;
AzToolsFramework::ArchiveCommandsBus::BroadcastResult(
extractResult, &AzToolsFramework::ArchiveCommandsBus::Events::ExtractArchive, GetArchivePath().toUtf8().constData(),
GetExtractFolder().toUtf8().constData());
bool result = extractResult.get();
AZ_TEST_STOP_TRACE_SUPPRESSION_NO_COUNT;
EXPECT_TRUE(result);
QStringList archiveFiles = CreateArchiveFileList();
for (const auto& file : archiveFiles)
{
QString fullFilePath = QDir(GetExtractFolder()).absoluteFilePath(file);
QFileInfo fi(fullFilePath);
EXPECT_TRUE(fi.exists());
}
}
#if AZ_TRAIT_DISABLE_FAILED_ARCHIVE_TESTS
TEST_F(ArchiveComponentTest, DISABLED_CreateDeltaCatalog_ArchiveWithoutCatalogAssetsRegistered_Success)
#else
TEST_F(ArchiveComponentTest, CreateDeltaCatalog_ArchiveWithoutCatalogAssetsRegistered_Success)
#endif // AZ_TRAIT_DISABLE_FAILED_ARCHIVE_TESTS
{
QStringList fileList = CreateArchiveFileList();
CreateArchiveFolder(GetArchiveFolderName(), fileList);
AZ_TEST_START_TRACE_SUPPRESSION;
bool createResult = CreateArchive();
AZ_TEST_STOP_TRACE_SUPPRESSION_NO_COUNT;
EXPECT_EQ(createResult, true);
for (const auto& thisPath : fileList)
{
AZ::Data::AssetInfo newInfo;
newInfo.m_relativePath = thisPath.toStdString().c_str();
newInfo.m_relativePath = thisPath.toUtf8().constData();
newInfo.m_assetType = AZ::Uuid::CreateRandom();
newInfo.m_sizeBytes = 100; // Arbitrary
AZ::Data::AssetId generatedID(AZ::Uuid::CreateRandom());
@@ -212,7 +294,7 @@ namespace UnitTest
bool catalogCreated{ false };
AZ_TEST_START_TRACE_SUPPRESSION;
AzToolsFramework::AssetBundleCommandsBus::BroadcastResult(catalogCreated, &AzToolsFramework::AssetBundleCommandsBus::Events::CreateDeltaCatalog, GetArchivePath().toStdString().c_str(), true);
AzToolsFramework::AssetBundleCommandsBus::BroadcastResult(catalogCreated, &AzToolsFramework::AssetBundleCommandsBus::Events::CreateDeltaCatalog, GetArchivePath().toUtf8().constData(), true);
AZ_TEST_STOP_TRACE_SUPPRESSION_NO_COUNT; // produces different counts in different platforms
EXPECT_EQ(catalogCreated, true);
}
@@ -72,7 +72,7 @@ namespace Benchmark
AZStd::unique_ptr<Instance> instance = m_prefabSystemComponent->CreatePrefab(
entities
, {}
, m_pathString);
, m_pathString);
state.PauseTiming();
@@ -165,7 +165,7 @@ namespace Benchmark
{
nestedInstanceRoot = m_prefabSystemComponent->CreatePrefab(
{},
MakeInstanceList( AZStd::move(nestedInstanceRoot) ),
MakeInstanceList(AZStd::move(nestedInstanceRoot)),
m_paths[instanceCounter]);
}
@@ -36,7 +36,7 @@ namespace Benchmark
AZStd::unique_ptr<Instance> enclosingInstance = m_prefabSystemComponent->CreatePrefab(
{},
MakeInstanceList( AZStd::move(nestedInstance) ),
MakeInstanceList(AZStd::move(nestedInstance)),
enclosingTemplatePath);
TemplateId templateToInstantiateId = enclosingInstance->GetTemplateId();
@@ -99,7 +99,7 @@ namespace Benchmark
{
currentInstanceRoot = m_prefabSystemComponent->CreatePrefab(
{},
MakeInstanceList( AZStd::move(currentInstanceRoot) ),
MakeInstanceList(AZStd::move(currentInstanceRoot)),
m_paths[currentDepth - 1]);
}
@@ -151,7 +151,7 @@ namespace Benchmark
{
currentInstanceRoot = m_prefabSystemComponent->CreatePrefab(
{},
MakeInstanceList( AZStd::move(currentInstanceRoot) ),
MakeInstanceList(AZStd::move(currentInstanceRoot)),
m_paths[currentDepth]);
}
@@ -214,7 +214,7 @@ namespace Benchmark
currentInstanceRoot = m_prefabSystemComponent->CreatePrefab(
{},
MakeInstanceList( AZStd::move(currentInstanceRoot), AZStd::move(extraNestedInstance) ),
MakeInstanceList(AZStd::move(currentInstanceRoot), AZStd::move(extraNestedInstance)),
m_paths[currentDepth]);
}
@@ -54,7 +54,7 @@ namespace UnitTest
// Create a street prefab that nests the car and sportscar instances created above. The container entity will be created as part of the process.
AZStd::unique_ptr<AzToolsFramework::Prefab::Instance> streetInstance =
m_prefabSystemComponent->CreatePrefab({}, MakeInstanceList( AZStd::move(carInstance), AZStd::move(sportsCarInstance) ), "test/street");
m_prefabSystemComponent->CreatePrefab({}, MakeInstanceList(AZStd::move(carInstance), AZStd::move(sportsCarInstance)), "test/street");
ASSERT_TRUE(streetInstance);
m_instanceMap[StreetEntityName] = streetInstance.get();
@@ -320,7 +320,7 @@ namespace UnitTest
Instance& addedInstance = *addedInstancePtr;
//create a first instance where the instance will be removed
AZStd::unique_ptr<Instance> firstInstance = m_prefabSystemComponent->CreatePrefab({}, MakeInstanceList( AZStd::move(addedInstancePtr) ), "test/path");
AZStd::unique_ptr<Instance> firstInstance = m_prefabSystemComponent->CreatePrefab({}, MakeInstanceList(AZStd::move(addedInstancePtr)), "test/path");
ASSERT_TRUE(firstInstance);
//get added instance alias
@@ -44,11 +44,11 @@ namespace UnitTest
ASSERT_TRUE(firstInstance);
AZStd::unique_ptr<AzToolsFramework::Prefab::Instance> secondInstance = m_prefabSystemComponent->CreatePrefab({},
MakeInstanceList( AZStd::move(firstInstance) ), "test/path2");
MakeInstanceList(AZStd::move(firstInstance)), "test/path2");
ASSERT_TRUE(secondInstance);
AZStd::unique_ptr<AzToolsFramework::Prefab::Instance> thirdInstance = m_prefabSystemComponent->CreatePrefab({},
MakeInstanceList( AZStd::move(secondInstance) ), "test/path3");
MakeInstanceList(AZStd::move(secondInstance)), "test/path3");
ASSERT_TRUE(thirdInstance);
//Instantiate it
@@ -21,8 +21,8 @@ namespace UnitTest
using namespace AzToolsFramework::Prefab;
LinkData CreateLinkData(
const InstanceData& instanceData,
const TemplateId& sourceTemplateId,
const TemplateId& targetTemplateId)
TemplateId sourceTemplateId,
TemplateId targetTemplateId)
{
LinkData newLinkData;
newLinkData.m_instanceData = instanceData;
@@ -17,8 +17,8 @@ namespace UnitTest
{
LinkData CreateLinkData(
const InstanceData& instanceData,
const AzToolsFramework::Prefab::TemplateId& sourceTemplateId,
const AzToolsFramework::Prefab::TemplateId& targetTemplateId);
AzToolsFramework::Prefab::TemplateId sourceTemplateId,
AzToolsFramework::Prefab::TemplateId targetTemplateId);
InstanceData CreateInstanceDataWithNoPatches(
const AZStd::string& name,
@@ -56,7 +56,7 @@ namespace UnitTest
}
void ValidateInstances(
const TemplateId& templateId,
TemplateId templateId,
const PrefabDomValue& expectedContent,
const PrefabDomPath& contentPath,
bool isContentAnInstance,
@@ -204,7 +204,7 @@ namespace UnitTest
}
void ValidateEntitiesOfInstances(
const AzToolsFramework::Prefab::TemplateId& templateId,
AzToolsFramework::Prefab::TemplateId templateId,
const AzToolsFramework::Prefab::PrefabDom& expectedPrefabDom,
const AZStd::vector<EntityAlias>& entityAliases)
{
@@ -219,7 +219,7 @@ namespace UnitTest
}
void ValidateNestedInstancesOfInstances(
const AzToolsFramework::Prefab::TemplateId& templateId,
AzToolsFramework::Prefab::TemplateId templateId,
const AzToolsFramework::Prefab::PrefabDom& expectedPrefabDom,
const AZStd::vector<InstanceAlias>& nestedInstanceAliases)
{
@@ -118,7 +118,7 @@ namespace UnitTest
const PrefabDomValue& patches);
void ValidateInstances(
const TemplateId& templateId,
TemplateId templateId,
const PrefabDomValue& expectedContent,
const PrefabDomPath& contentPath,
bool isContentAnInstance = false,
@@ -147,12 +147,12 @@ namespace UnitTest
void ComparePrefabDomValues(PrefabDomValueConstReference valueA, PrefabDomValueConstReference valueB);
void ValidateEntitiesOfInstances(
const AzToolsFramework::Prefab::TemplateId& templateId,
AzToolsFramework::Prefab::TemplateId templateId,
const AzToolsFramework::Prefab::PrefabDom& expectedPrefabDom,
const AZStd::vector<EntityAlias>& entityAliases);
void ValidateNestedInstancesOfInstances(
const AzToolsFramework::Prefab::TemplateId& templateId,
AzToolsFramework::Prefab::TemplateId templateId,
const AzToolsFramework::Prefab::PrefabDom& expectedPrefabDom,
const AZStd::vector<InstanceAlias>& nestedInstanceAliases);
@@ -18,14 +18,14 @@ namespace UnitTest
{
//create two prefabs for test
//create prefab 1
firstInstance = AZStd::move(m_prefabSystemComponent->CreatePrefab({ }, {}, "test/path0"));
firstInstance = AZStd::move(m_prefabSystemComponent->CreatePrefab({}, {}, "test/path0"));
ASSERT_TRUE(firstInstance);
//get template id
ownerId = firstInstance->GetTemplateId();
//create prefab 2
secondInstance = AZStd::move(m_prefabSystemComponent->CreatePrefab({ }, {}, "test/path1"));
secondInstance = AZStd::move(m_prefabSystemComponent->CreatePrefab({}, {}, "test/path1"));
ASSERT_TRUE(secondInstance);
//get template id
@@ -120,7 +120,7 @@ namespace UnitTest
// Create an enclosing Template with 0 entities and 1 nested Instance.
AZStd::unique_ptr<Instance> nestedInstance1 = m_prefabSystemComponent->InstantiatePrefab(newNestedTemplateId);
AZStd::unique_ptr<Instance> newEnclosingInstance = m_prefabSystemComponent->CreatePrefab({}, MakeInstanceList( AZStd::move(nestedInstance1) ), PrefabMockFilePath);
AZStd::unique_ptr<Instance> newEnclosingInstance = m_prefabSystemComponent->CreatePrefab({}, MakeInstanceList(AZStd::move(nestedInstance1)), PrefabMockFilePath);
TemplateId newEnclosingTemplateId = newEnclosingInstance->GetTemplateId();
EXPECT_TRUE(newEnclosingTemplateId != InvalidTemplateId);
PrefabDom& newEnclosingTemplateDom = m_prefabSystemComponent->FindTemplateDom(newEnclosingTemplateId);
@@ -284,7 +284,7 @@ namespace UnitTest
AZStd::unique_ptr<Instance> nestedInstance2 = m_prefabSystemComponent->InstantiatePrefab(newNestedTemplateId);
AZStd::unique_ptr<Instance> newEnclosingInstance = m_prefabSystemComponent->CreatePrefab(
{},
MakeInstanceList( AZStd::move(nestedInstance1), AZStd::move(nestedInstance2) ),
MakeInstanceList(AZStd::move(nestedInstance1), AZStd::move(nestedInstance2)),
PrefabMockFilePath);
TemplateId newEnclosingTemplateId = newEnclosingInstance->GetTemplateId();
EXPECT_TRUE(newEnclosingTemplateId != InvalidTemplateId);
@@ -41,7 +41,7 @@ namespace UnitTest
AZStd::unique_ptr<Instance> wheel1UnderAxle = m_prefabSystemComponent->InstantiatePrefab(wheelTemplateId);
AZStd::unique_ptr<Instance> wheel2UnderAxle = m_prefabSystemComponent->InstantiatePrefab(wheelTemplateId);
AZStd::unique_ptr<Instance> axleInstance = m_prefabSystemComponent->CreatePrefab({},
MakeInstanceList( AZStd::move(wheel1UnderAxle), AZStd::move(wheel2UnderAxle) ), AxlePrefabMockFilePath);
MakeInstanceList(AZStd::move(wheel1UnderAxle), AZStd::move(wheel2UnderAxle)), AxlePrefabMockFilePath);
const TemplateId axleTemplateId = axleInstance->GetTemplateId();
const AZStd::vector<InstanceAlias> wheelInstanceAliasesUnderAxle = axleInstance->GetNestedInstanceAliases(wheelTemplateId);
PrefabDom& axleTemplateDom = m_prefabSystemComponent->FindTemplateDom(axleTemplateId);
@@ -51,7 +51,7 @@ namespace UnitTest
AZStd::unique_ptr<Instance> axle2UnderCar = m_prefabSystemComponent->InstantiatePrefab(axleTemplateId);
AZStd::unique_ptr<Instance> spareWheelUnderCar = m_prefabSystemComponent->InstantiatePrefab(wheelTemplateId);
AZStd::unique_ptr<Instance> carInstance = m_prefabSystemComponent->CreatePrefab({},
MakeInstanceList( AZStd::move(axle1UnderCar), AZStd::move(axle2UnderCar), AZStd::move(spareWheelUnderCar) ), CarPrefabMockFilePath);
MakeInstanceList(AZStd::move(axle1UnderCar), AZStd::move(axle2UnderCar), AZStd::move(spareWheelUnderCar)), CarPrefabMockFilePath);
const TemplateId carTemplateId = carInstance->GetTemplateId();
const AZStd::vector<InstanceAlias> axleInstanceAliasesUnderCar = carInstance->GetNestedInstanceAliases(axleTemplateId);
const AZStd::vector<InstanceAlias> wheelInstanceAliasesUnderCar = carInstance->GetNestedInstanceAliases(wheelTemplateId);
@@ -93,7 +93,7 @@ namespace UnitTest
// Create an axle with 0 entities and 1 wheel instance.
AZStd::unique_ptr<Instance> wheel1UnderAxle = m_prefabSystemComponent->InstantiatePrefab(wheelTemplateId);
AZStd::unique_ptr<Instance> axleInstance = m_prefabSystemComponent->CreatePrefab({},
MakeInstanceList( AZStd::move(wheel1UnderAxle) ), AxlePrefabMockFilePath);
MakeInstanceList(AZStd::move(wheel1UnderAxle)), AxlePrefabMockFilePath);
const TemplateId axleTemplateId = axleInstance->GetTemplateId();
PrefabDom& axleTemplateDom = m_prefabSystemComponent->FindTemplateDom(axleTemplateId);
AZStd::vector<InstanceAlias> wheelInstanceAliasesUnderAxle = axleInstance->GetNestedInstanceAliases(wheelTemplateId);
@@ -105,7 +105,7 @@ namespace UnitTest
AZStd::unique_ptr<Instance> axle1UnderCar = m_prefabSystemComponent->InstantiatePrefab(axleTemplateId);
AZStd::unique_ptr<Instance> axle2UnderCar = m_prefabSystemComponent->InstantiatePrefab(axleTemplateId);
AZStd::unique_ptr<Instance> carInstance = m_prefabSystemComponent->CreatePrefab({},
MakeInstanceList( AZStd::move(axle1UnderCar), AZStd::move(axle2UnderCar) ), CarPrefabMockFilePath);
MakeInstanceList(AZStd::move(axle1UnderCar), AZStd::move(axle2UnderCar)), CarPrefabMockFilePath);
const TemplateId carTemplateId = carInstance->GetTemplateId();
const AZStd::vector<InstanceAlias> axleInstanceAliasesUnderCar = carInstance->GetNestedInstanceAliases(axleTemplateId);
PrefabDom& carTemplateDom = m_prefabSystemComponent->FindTemplateDom(carTemplateId);
@@ -151,7 +151,7 @@ namespace UnitTest
// Create an axle with 0 entities and 1 wheel instance.
AZStd::unique_ptr<Instance> wheel1UnderAxle = m_prefabSystemComponent->InstantiatePrefab(wheelTemplateId);
AZStd::unique_ptr<Instance> axleInstance = m_prefabSystemComponent->CreatePrefab({},
MakeInstanceList( AZStd::move(wheel1UnderAxle) ), AxlePrefabMockFilePath);
MakeInstanceList(AZStd::move(wheel1UnderAxle)), AxlePrefabMockFilePath);
const TemplateId axleTemplateId = axleInstance->GetTemplateId();
PrefabDom& axleTemplateDom = m_prefabSystemComponent->FindTemplateDom(axleTemplateId);
const AZStd::vector<InstanceAlias> wheelInstanceAliasesUnderAxle = axleInstance->GetNestedInstanceAliases(wheelTemplateId);
@@ -159,7 +159,7 @@ namespace UnitTest
// Create a car with 0 entities and 1 axle instance.
AZStd::unique_ptr<Instance> axleUnderCar = m_prefabSystemComponent->InstantiatePrefab(axleTemplateId);
AZStd::unique_ptr<Instance> carInstance = m_prefabSystemComponent->CreatePrefab({},
MakeInstanceList( AZStd::move(axleUnderCar) ), CarPrefabMockFilePath);
MakeInstanceList(AZStd::move(axleUnderCar)), CarPrefabMockFilePath);
const TemplateId carTemplateId = carInstance->GetTemplateId();
const AZStd::vector<InstanceAlias> axleInstanceAliasesUnderCar = carInstance->GetNestedInstanceAliases(axleTemplateId);
PrefabDom& carTemplateDom = m_prefabSystemComponent->FindTemplateDom(carTemplateId);
@@ -205,7 +205,7 @@ namespace UnitTest
// Create an axle with 0 entities and 1 wheel instance.
AZStd::unique_ptr<Instance> wheel1UnderAxle = m_prefabSystemComponent->InstantiatePrefab(wheelTemplateId);
AZStd::unique_ptr<Instance> axleInstance = m_prefabSystemComponent->CreatePrefab({},
MakeInstanceList( AZStd::move(wheel1UnderAxle) ), AxlePrefabMockFilePath);
MakeInstanceList(AZStd::move(wheel1UnderAxle)), AxlePrefabMockFilePath);
const TemplateId axleTemplateId = axleInstance->GetTemplateId();
PrefabDom& axleTemplateDom = m_prefabSystemComponent->FindTemplateDom(axleTemplateId);
const AZStd::vector<InstanceAlias> wheelInstanceAliasesUnderAxle = axleInstance->GetNestedInstanceAliases(wheelTemplateId);
@@ -213,7 +213,7 @@ namespace UnitTest
// Create a car with 0 entities and 1 axle instance.
AZStd::unique_ptr<Instance> axleUnderCar = m_prefabSystemComponent->InstantiatePrefab(axleTemplateId);
AZStd::unique_ptr<Instance> carInstance = m_prefabSystemComponent->CreatePrefab({},
MakeInstanceList( AZStd::move(axleUnderCar) ), CarPrefabMockFilePath);
MakeInstanceList(AZStd::move(axleUnderCar)), CarPrefabMockFilePath);
const TemplateId carTemplateId = carInstance->GetTemplateId();
const AZStd::vector<InstanceAlias> axleInstanceAliasesUnderCar = carInstance->GetNestedInstanceAliases(axleTemplateId);
PrefabDom& carTemplateDom = m_prefabSystemComponent->FindTemplateDom(carTemplateId);
@@ -253,7 +253,7 @@ namespace UnitTest
AZStd::unique_ptr<Instance> wheel1UnderAxle = m_prefabSystemComponent->InstantiatePrefab(wheelTemplateId);
AZStd::unique_ptr<Instance> wheel2UnderAxle = m_prefabSystemComponent->InstantiatePrefab(wheelTemplateId);
AZStd::unique_ptr<Instance> axleInstance = m_prefabSystemComponent->CreatePrefab({},
MakeInstanceList( AZStd::move(wheel1UnderAxle), AZStd::move(wheel2UnderAxle) ),
MakeInstanceList(AZStd::move(wheel1UnderAxle), AZStd::move(wheel2UnderAxle) ),
AxlePrefabMockFilePath);
const TemplateId axleTemplateId = axleInstance->GetTemplateId();
PrefabDom& axleTemplateDom = m_prefabSystemComponent->FindTemplateDom(axleTemplateId);
@@ -265,7 +265,7 @@ namespace UnitTest
// Create a car with 0 entities and 1 axle instance.
AZStd::unique_ptr<Instance> axle1UnderCar = m_prefabSystemComponent->InstantiatePrefab(axleTemplateId);
AZStd::unique_ptr<Instance> carInstance = m_prefabSystemComponent->CreatePrefab({},
MakeInstanceList( AZStd::move(axle1UnderCar) ), CarPrefabMockFilePath);
MakeInstanceList(AZStd::move(axle1UnderCar)), CarPrefabMockFilePath);
const TemplateId carTemplateId = carInstance->GetTemplateId();
const AZStd::vector<InstanceAlias> axleInstanceAliasesUnderCar = carInstance->GetNestedInstanceAliases(axleTemplateId);
PrefabDom& carTemplateDom = m_prefabSystemComponent->FindTemplateDom(carTemplateId);
@@ -320,7 +320,7 @@ namespace UnitTest
// Create an axle with 0 entities and 1 wheel instance.
AZStd::unique_ptr<Instance> wheel1UnderAxle = m_prefabSystemComponent->InstantiatePrefab(wheelTemplateId);
AZStd::unique_ptr<Instance> axleInstance = m_prefabSystemComponent->CreatePrefab({},
MakeInstanceList( AZStd::move(wheel1UnderAxle) ), AxlePrefabMockFilePath);
MakeInstanceList(AZStd::move(wheel1UnderAxle)), AxlePrefabMockFilePath);
const TemplateId axleTemplateId = axleInstance->GetTemplateId();
PrefabDom& axleTemplateDom = m_prefabSystemComponent->FindTemplateDom(axleTemplateId);
const AZStd::vector<InstanceAlias> wheelInstanceAliasesUnderAxle = axleInstance->GetNestedInstanceAliases(wheelTemplateId);
@@ -328,7 +328,7 @@ namespace UnitTest
// Create a car with 0 entities and 1 axle instance.
AZStd::unique_ptr<Instance> axleUnderCar = m_prefabSystemComponent->InstantiatePrefab(axleTemplateId);
AZStd::unique_ptr<Instance> carInstance = m_prefabSystemComponent->CreatePrefab({},
MakeInstanceList( AZStd::move(axleUnderCar) ), CarPrefabMockFilePath);
MakeInstanceList(AZStd::move(axleUnderCar)), CarPrefabMockFilePath);
const TemplateId carTemplateId = carInstance->GetTemplateId();
const AZStd::vector<InstanceAlias> axleInstanceAliasesUnderCar = carInstance->GetNestedInstanceAliases(axleTemplateId);
PrefabDom& carTemplateDom = m_prefabSystemComponent->FindTemplateDom(carTemplateId);
@@ -381,7 +381,7 @@ namespace UnitTest
// Create an axle with 0 entities and 1 wheel instance.
AZStd::unique_ptr<Instance> wheel1UnderAxle = m_prefabSystemComponent->InstantiatePrefab(wheelTemplateId);
AZStd::unique_ptr<Instance> axleInstance = m_prefabSystemComponent->CreatePrefab({},
MakeInstanceList( AZStd::move(wheel1UnderAxle) ), AxlePrefabMockFilePath);
MakeInstanceList(AZStd::move(wheel1UnderAxle)), AxlePrefabMockFilePath);
const TemplateId axleTemplateId = axleInstance->GetTemplateId();
PrefabDom& axleTemplateDom = m_prefabSystemComponent->FindTemplateDom(axleTemplateId);
const AZStd::vector<InstanceAlias> wheelInstanceAliasesUnderAxle = axleInstance->GetNestedInstanceAliases(wheelTemplateId);
@@ -389,7 +389,7 @@ namespace UnitTest
// Create a car with 0 entities and 1 axle instance.
AZStd::unique_ptr<Instance> axleUnderCar = m_prefabSystemComponent->InstantiatePrefab(axleTemplateId);
AZStd::unique_ptr<Instance> carInstance = m_prefabSystemComponent->CreatePrefab({},
MakeInstanceList( AZStd::move(axleUnderCar) ), CarPrefabMockFilePath);
MakeInstanceList(AZStd::move(axleUnderCar)), CarPrefabMockFilePath);
const TemplateId carTemplateId = carInstance->GetTemplateId();
const AZStd::vector<InstanceAlias> axleInstanceAliasesUnderCar = carInstance->GetNestedInstanceAliases(axleTemplateId);
PrefabDom& carTemplateDom = m_prefabSystemComponent->FindTemplateDom(carTemplateId);
@@ -68,7 +68,7 @@ namespace UnitTest
// Create a car with 0 entities and 1 axle instance.
AZStd::unique_ptr<Instance> axleUnderCar = m_prefabSystemComponent->InstantiatePrefab(axleTemplateId);
AZStd::unique_ptr<Instance> carInstance = m_prefabSystemComponent->CreatePrefab({},
MakeInstanceList( AZStd::move(axleUnderCar) ), CarPrefabMockFilePath);
MakeInstanceList(AZStd::move(axleUnderCar)), CarPrefabMockFilePath);
const TemplateId carTemplateId = carInstance->GetTemplateId();
const AZStd::vector<InstanceAlias> axleInstanceAliasesUnderCar = carInstance->GetNestedInstanceAliases(axleTemplateId);
PrefabDom& carTemplateDom = m_prefabSystemComponent->FindTemplateDom(carTemplateId);