Update the FileIO Aliases (#4186)

* Update the FileIOAlias naming to make the cache, project root and engine root paths more clear The alias of `@root@`, `@assets@`, and `@projectplatformcache@` has been collapsed to `@projectproductassets@` The alias of `@devroot@` and `@engroot@` has been collapsed to `@engroot@` The alias of `@devassets@` and `@projectroot@` has been collapsed to `@projectroot@` Signed-off-by: lumberyard-employee-dm <56135373+lumberyard-employee-dm@users.noreply.github.com> * Updated use of devassets and devroot properties in python Those properties now use projectroot and engroot Signed-off-by: lumberyard-employee-dm <56135373+lumberyard-employee-dm@users.noreply.github.com> * Updating the alias @engroot@ alias path comment in each platform specific LocalFileIO_*.cpp file Signed-off-by: lumberyard-employee-dm <56135373+lumberyard-employee-dm@users.noreply.github.com> * Removed hardcoded size of 9 for the product asset alias. The ResolvePath function now just appends the @projectproductassets@ alias with the input path Signed-off-by: lumberyard-employee-dm <56135373+lumberyard-employee-dm@users.noreply.github.com> * Remove duplicate @projectproductassets@ check in ProcessFileTreeRequest Signed-off-by: lumberyard-employee-dm <56135373+lumberyard-employee-dm@users.noreply.github.com> * Fix for typos in Hydra python test Signed-off-by: lumberyard-employee-dm <56135373+lumberyard-employee-dm@users.noreply.github.com> * Updated LocalFileIO::Copy call on Windows to use the Unicode aware CopyFileW API Signed-off-by: lumberyard-employee-dm <56135373+lumberyard-employee-dm@users.noreply.github.com> * Updated the AWSMetreicsGemAllocatorFixture to properly suppress asset cache write errors for Test file creation. Signed-off-by: lumberyard-employee-dm <56135373+lumberyard-employee-dm@users.noreply.github.com> * Removed unneeded call to set the @projectproductasstes@ alias at the bottom of the AssetSeedManagerTest SetUp Signed-off-by: lumberyard-employee-dm <56135373+lumberyard-employee-dm@users.noreply.github.com> * Added a deprecated alias map to the FileIO System When a deprecated alias is accessed, the FileIO System logs an AZ_Error and indicates the alias that should be used Signed-off-by: lumberyard-employee-dm <56135373+lumberyard-employee-dm@users.noreply.github.com> * Updated python test scripts to use the projectroot binding Retrieving the AutomatedTesting project path based on "<devroot>/AutomatedTesting" has been removed. Signed-off-by: lumberyard-employee-dm <56135373+lumberyard-employee-dm@users.noreply.github.com> * Updated references to devroot and devgame within the codebase The GetAbsoluteDevGameFolderPath functions has been replaced with direct call to AZ::Utils::GetProjectPath The GetAbsoluteDevRootFolderPath functions has been replaced with direct calls to AZ::Utils::GetEnginePath Signed-off-by: lumberyard-employee-dm <56135373+lumberyard-employee-dm@users.noreply.github.com> * Updated <engroot>/AutomatedTesting references to projectroot Signed-off-by: lumberyard-employee-dm <56135373+lumberyard-employee-dm@users.noreply.github.com> * Replaced references that assumes the project path is <engroot>/AutomatedTesting with <projectroot> in the AutomatedTesting python test Signed-off-by: lumberyard-employee-dm <56135373+lumberyard-employee-dm@users.noreply.github.com> * Correct casing in emfxworkspace file Signed-off-by: lumberyard-employee-dm <56135373+lumberyard-employee-dm@users.noreply.github.com> * Removed newly added AppendPathParts function Removed the Path constructors which accepts a PathIterable instance The PathIterable isn't safe to return to a user of the Path class as it might be referencing temporary paths supplied via PathView arguments Signed-off-by: lumberyard-employee-dm <56135373+lumberyard-employee-dm@users.noreply.github.com> * Fixed unused parameter warning Signed-off-by: lumberyard-employee-dm <56135373+lumberyard-employee-dm@users.noreply.github.com> * Undid change to the LexicallyProximate function to set the path result to the base path. It needs to return the *this path if the pathResult is empty Signed-off-by: lumberyard-employee-dm <56135373+lumberyard-employee-dm@users.noreply.github.com> * Moved the LocalFileIO ConvertToAbsolutePath implementations to AZ::Utils Fixed the ConvertToAbsolutePath implementation for Unix platforms to use a buffer that is size PATH_MAX(4096 on all our supported Unix platforms). Because the buffer before was AZ::IO::MaxPathLength which as a size of 1024, this was resulting in the Unix `realpath` function smashing the stack when it converts a path to an absolute path that is longer than 1024 characters Signed-off-by: lumberyard-employee-dm <56135373+lumberyard-employee-dm@users.noreply.github.com> * Updated the EditorCore.Tests to attach the AZ Environment to the EditorCore shared library that is statically loaded on launch. Signed-off-by: lumberyard-employee-dm <56135373+lumberyard-employee-dm@users.noreply.github.com> * Fixed for DeprecatedAlaisesKeyVisitor Visit function causing the non string_view overloads being hidden causing a hidden base class function warning Signed-off-by: lumberyard-employee-dm <56135373+lumberyard-employee-dm@users.noreply.github.com> * Changed the AWSMetricsGemMock to use a temporary for writing test assets Signed-off-by: lumberyard-employee-dm <56135373+lumberyard-employee-dm@users.noreply.github.com> * Updated the LocalFileIO::ResolvePath function to use HasRootPath to determine if a path starts with a root path such as "D:", "D:/" or "/" IsAbsolute was not the corect check as the path of "D:" is a relative path. To be absolute according to the Windows the path must have a root directory. i.e "D:/" or "D:\" Signed-off-by: lumberyard-employee-dm <56135373+lumberyard-employee-dm@users.noreply.github.com> * Removed absolute path comment from LocalFile_UnixLike.cpp and LocalFile_Android.cpp FindFiles implementations Updated the ConvertToAlias to supply an AZ::IO::FixedMaxPath Signed-off-by: lumberyard-employee-dm <56135373+lumberyard-employee-dm@users.noreply.github.com> * Replaced usage of the @projectproductassets@ alias with @engroot@ when referring to the LmbrCentral source folder in the CopyDependencyBuilderTest and the SeedBuilderTests Signed-off-by: lumberyard-employee-dm <56135373+lumberyard-employee-dm@users.noreply.github.com> * Updated the ScriptCanvas Upgrade Tool to output backed up files to the Project User Path instead of the engine root Signed-off-by: lumberyard-employee-dm <56135373+lumberyard-employee-dm@users.noreply.github.com> * Fixed whitespacing issues in Application.cpp Signed-off-by: lumberyard-employee-dm <56135373+lumberyard-employee-dm@users.noreply.github.com> * Remove unnecessary creation of a FixedMaxPath in the UpgradeTool.cpp Signed-off-by: lumberyard-employee-dm <56135373+lumberyard-employee-dm@users.noreply.github.com> * Modified testSeedFolder variable in the SeedBuilderTests to use the @engroot@ alias instead of @projectproductassets@/.. alias when referring to the LmbrCentral Gem source path Signed-off-by: lumberyard-employee-dm <56135373+lumberyard-employee-dm@users.noreply.github.com> * Updated references to the Project Asset Cache in the PythonTests. Those tests no longer use the logic `azlmbr.paths.projectroot / "Cache" / "pc"` to retrieve a path to the cache root but instead the `azlmbr.paths.projectproductassets` constant Signed-off-by: lumberyard-employee-dm <56135373+lumberyard-employee-dm@users.noreply.github.com> * Fixed the FileIO Deprecated Alias test on Windows Signed-off-by: lumberyard-employee-dm <56135373+lumberyard-employee-dm@users.noreply.github.com> * Removing @projectsourceassets@ alias, as it is only used once. Updated the PhysX EditorSystemComponent.cpp to query the ProjectPath form the SettingsRegistry. Signed-off-by: lumberyard-employee-dm <56135373+lumberyard-employee-dm@users.noreply.github.com> * Replaced @projectproductassets@ alias with @products@ Signed-off-by: lumberyard-employee-dm <56135373+lumberyard-employee-dm@users.noreply.github.com> * Rollback changes to the PhysX EditorSystemComponent.cpp The changes to use the ProjectPath from the SettingsRegistry has been implemented in PR #4497 Signed-off-by: lumberyard-employee-dm <56135373+lumberyard-employee-dm@users.noreply.github.com>
2021-10-05 15:12:53 -05:00
parent 643bd84739
commit f648cb1fd8
209 changed files with 1365 additions and 1678 deletions
@@ -13,7 +13,9 @@

 #include <AzCore/Component/ComponentApplicationBus.h>
 #include <AzCore/Component/TickBus.h>
+#include <AzCore/IO/Path/Path.h>
 #include <AzCore/IO/SystemFile.h>
+#include <AzCore/Settings/SettingsRegistryMergeUtils.h>
 #include <AzCore/UserSettings/UserSettingsProvider.h>

 #include <AzFramework/Asset/AssetSystemBus.h>
@@ -169,10 +171,11 @@ namespace ScriptCanvasEditor
            QDateTime theTime = QDateTime::currentDateTime();
            QString subFolder = theTime.toString("yyyy-MM-dd [HH.mm.ss]");

-            m_backupPath = AZStd::string::format("@devroot@/ScriptCanvas_BACKUP/%s", subFolder.toUtf8().data());
-            char backupPathCStr[AZ_MAX_PATH_LEN] = { 0 };
-            AZ::IO::FileIOBase::GetInstance()->ResolvePath(m_backupPath.c_str(), backupPathCStr, AZ_MAX_PATH_LEN);
-            m_backupPath = backupPathCStr;
+            auto settingsRegistry = AZ::SettingsRegistry::Get();
+            m_backupPath.clear();
+            settingsRegistry->Get(m_backupPath.Native(), AZ::SettingsRegistryMergeUtils::FilePathKey_ProjectUserPath);
+
+            m_backupPath = m_backupPath / "ScriptCanvas_BACKUP" / subFolder.toUtf8().data();

            if (!AZ::IO::FileIOBase::GetInstance()->Exists(m_backupPath.c_str()))
            {
@@ -489,56 +492,25 @@ namespace ScriptCanvasEditor

    void UpgradeTool::BackupAsset(const AZ::Data::AssetInfo& assetInfo)
    {
-
-        AZStd::string devRoot = "@devroot@";
-        AZStd::string devAssets = "@devassets@";
-
-        char devRootCStr[AZ_MAX_PATH_LEN] = { 0 };
-        AZ::IO::FileIOBase::GetInstance()->ResolvePath(devRoot.c_str(), devRootCStr, AZ_MAX_PATH_LEN);
-
-        char devAssetsCStr[AZ_MAX_PATH_LEN] = { 0 };
-        AZ::IO::FileIOBase::GetInstance()->ResolvePath(devAssets.c_str(), devAssetsCStr, AZ_MAX_PATH_LEN);
-
-        AZStd::string relativePath = devAssetsCStr;
-        AzFramework::StringFunc::Replace(relativePath, devRootCStr, "");
-        if (relativePath.starts_with("/"))
-        {
-            relativePath = relativePath.substr(1, relativePath.size() - 1);
-        }
-
-        AZStd::string sourceFilePath;
+        AZ::IO::FixedMaxPath sourceFilePath;

        // Using this to get the watch folder
        AZStd::string watchFolder;
-        AZ::Data::AssetInfo assetInfo2;
+        AZ::Data::AssetInfo sourceFileAssetInfo;
        bool sourceInfoFound{};
-        AzToolsFramework::AssetSystemRequestBus::BroadcastResult(sourceInfoFound, &AzToolsFramework::AssetSystemRequestBus::Events::GetSourceInfoBySourcePath, assetInfo.m_relativePath.c_str(), assetInfo2, watchFolder);
+        AzToolsFramework::AssetSystemRequestBus::BroadcastResult(sourceInfoFound,
+            &AzToolsFramework::AssetSystemRequestBus::Events::GetSourceInfoBySourcePath,
+             assetInfo.m_relativePath.c_str(), sourceFileAssetInfo, watchFolder);
        if (sourceInfoFound)
        {
-            AZStd::string assetPath;
-            AzFramework::StringFunc::Path::Join(watchFolder.c_str(), assetInfo.m_relativePath.c_str(), assetPath);
-
-            sourceFilePath = assetPath;
+            sourceFilePath = AZ::IO::FixedMaxPath(AZStd::string_view(watchFolder)) / sourceFileAssetInfo.m_relativePath;
        }

-        devRoot = devRootCStr;
-        AzFramework::StringFunc::Path::Normalize(devRoot);
-
-        relativePath = sourceFilePath;
-        AzFramework::StringFunc::Replace(relativePath, devRoot.c_str(), "");
-        if (relativePath.starts_with("/"))
-        {
-            relativePath = relativePath.substr(1, relativePath.size() - 1);
-        }
-
-        AZStd::string targetFilePath;
-        AzFramework::StringFunc::Path::Join(m_backupPath.c_str(), relativePath.c_str(), targetFilePath);
+        const auto targetFilePath = m_backupPath / sourceFileAssetInfo.m_relativePath;

        if (AZ::IO::FileIOBase::GetInstance()->Copy(sourceFilePath.c_str(), targetFilePath.c_str()) != AZ::IO::ResultCode::Error)
        {
-            AZStd::string filename;
-            AzFramework::StringFunc::Path::GetFileName(sourceFilePath.c_str(), filename);
-            AZ_TracePrintf("Script Canvas", "Backup: %s -> %s\n", filename.c_str(), targetFilePath.c_str());
+            AZ_TracePrintf("Script Canvas", "Backup: %s -> %s\n", sourceFilePath.c_str(), targetFilePath.c_str());
        }
        else
        {
@@ -583,7 +555,7 @@ namespace ScriptCanvasEditor

    void UpgradeTool::SaveLog()
    {
-        AZStd::string outputFileName = AZStd::string::format("@devroot@/ScriptCanvasUpgradeReport.html");
+        AZStd::string outputFileName = AZStd::string::format("@log@/ScriptCanvasUpgradeReport.html");

        char resolvedBuffer[AZ_MAX_PATH_LEN] = { 0 };
        AZ::IO::FileIOBase::GetInstance()->ResolvePath(outputFileName.c_str(), resolvedBuffer, AZ_MAX_PATH_LEN);
@@ -27,6 +27,7 @@ AZ_POP_DISABLE_WARNING
 #include <ISystem.h>
 #include <IConsole.h>
 #include <AzCore/Debug/TraceMessageBus.h>
+#include <AzCore/IO/Path/Path.h>
 #endif

 class QPushButton;
@@ -135,7 +136,7 @@ namespace ScriptCanvasEditor

        AZ::Entity* m_scriptCanvasEntity = nullptr;

-        AZStd::string m_backupPath;
+        AZ::IO::Path m_backupPath;

        void FinalizeUpgrade();
        void DisconnectBuses();
@@ -19,6 +19,7 @@
 #include <AzCore/Component/TickBus.h>
 #include <AzCore/IO/FileIOEventBus.h>
 #include <AzCore/IO/SystemFile.h>
+#include <AzCore/Settings/SettingsRegistryMergeUtils.h>
 #include <AzCore/UserSettings/UserSettingsProvider.h>
 #include <AzFramework/Asset/AssetSystemBus.h>
 #include <AzFramework/IO/FileOperations.h>
@@ -301,51 +302,37 @@ namespace ScriptCanvasEditor
            return "";
        }

+        auto fileIoBase = AZ::IO::FileIOBase::GetInstance();
+        auto settingsRegistry = AZ::SettingsRegistry::Get();
+
        QDateTime theTime = QDateTime::currentDateTime();
        QString subFolder = theTime.toString("yyyy-MM-dd [HH.mm.ss]");

-        AZStd::string backupPath = AZStd::string::format("@devroot@/ScriptCanvas_BACKUP/%s", subFolder.toUtf8().data());
-        char backupPathCStr[AZ_MAX_PATH_LEN] = { 0 };
-        AZ::IO::FileIOBase::GetInstance()->ResolvePath(backupPath.c_str(), backupPathCStr, AZ_MAX_PATH_LEN);
-        backupPath = backupPathCStr;
+        AZ::IO::FixedMaxPath projectUserPath;
+        settingsRegistry->Get(projectUserPath.Native(), AZ::SettingsRegistryMergeUtils::FilePathKey_ProjectUserPath);

-        if (!AZ::IO::FileIOBase::GetInstance()->Exists(backupPath.c_str()))
+        AZ::IO::FixedMaxPath backupPath = projectUserPath / "ScriptCanvas_BACKUP" / subFolder.toUtf8().data();
+
+        if (!fileIoBase->Exists(backupPath.c_str()))
        {
-            if (AZ::IO::FileIOBase::GetInstance()->CreatePath(backupPath.c_str()) != AZ::IO::ResultCode::Success)
+            if (fileIoBase->CreatePath(backupPath.c_str()) != AZ::IO::ResultCode::Success)
            {
                AZ_Error(ScriptCanvas::k_VersionExplorerWindow.data(), false, "Failed to create backup folder %s", backupPath.c_str());
                return "Failed to create backup folder";
            }
        }

-        AZStd::string devRoot = "@devroot@";
-        AZStd::string devAssets = "@devassets@";
-
-        char devRootCStr[AZ_MAX_PATH_LEN] = { 0 };
-        AZ::IO::FileIOBase::GetInstance()->ResolvePath(devRoot.c_str(), devRootCStr, AZ_MAX_PATH_LEN);
-
-        char devAssetsCStr[AZ_MAX_PATH_LEN] = { 0 };
-        AZ::IO::FileIOBase::GetInstance()->ResolvePath(devAssets.c_str(), devAssetsCStr, AZ_MAX_PATH_LEN);
-
-        AZStd::string relativePath = devAssetsCStr;
-        AzFramework::StringFunc::Replace(relativePath, devRootCStr, "");
-        if (relativePath.starts_with("/"))
-        {
-            relativePath = relativePath.substr(1, relativePath.size() - 1);
-        }
-
-        AZStd::string sourceFilePath;
-
        AZStd::string watchFolder;
        AZ::Data::AssetInfo assetInfo;
+
+        AZ::IO::FixedMaxPath sourceFilePath;
        bool sourceInfoFound{};
-        AzToolsFramework::AssetSystemRequestBus::BroadcastResult(sourceInfoFound, &AzToolsFramework::AssetSystemRequestBus::Events::GetSourceInfoBySourcePath, asset.GetHint().c_str(), assetInfo, watchFolder);
+        AzToolsFramework::AssetSystemRequestBus::BroadcastResult(sourceInfoFound,
+            &AzToolsFramework::AssetSystemRequestBus::Events::GetSourceInfoBySourcePath,
+             asset.GetHint().c_str(), assetInfo, watchFolder);
        if (sourceInfoFound)
        {
-            AZStd::string assetPath;
-            AzFramework::StringFunc::Path::Join(watchFolder.c_str(), assetInfo.m_relativePath.c_str(), assetPath);
-
-            sourceFilePath = assetPath;
+            sourceFilePath = AZ::IO::FixedMaxPath(AZStd::string_view(watchFolder)) / assetInfo.m_relativePath;
        }
        else
        {
@@ -353,23 +340,9 @@ namespace ScriptCanvasEditor
            return "Failed to find source file";
        }

-        devRoot = devRootCStr;
-        AzFramework::StringFunc::Path::Normalize(devRoot);
+        const AZ::IO::FixedMaxPath targetFilePath = backupPath / assetInfo.m_relativePath;

-        relativePath = sourceFilePath;
-        AzFramework::StringFunc::Replace(relativePath, devRoot.c_str(), "");
-        if (relativePath.starts_with("/"))
-        {
-            relativePath = relativePath.substr(1, relativePath.size() - 1);
-        }
-
-        AzFramework::StringFunc::Path::Normalize(relativePath);
-        AzFramework::StringFunc::Path::Normalize(backupPath);
-
-        AZStd::string targetFilePath = backupPath;
-        targetFilePath += relativePath;
-
-        if (AZ::IO::FileIOBase::GetInstance()->Copy(sourceFilePath.c_str(), targetFilePath.c_str()) != AZ::IO::ResultCode::Success)
+        if (fileIoBase->Copy(sourceFilePath.c_str(), targetFilePath.c_str()) != AZ::IO::ResultCode::Success)
        {
            AZ_Warning(ScriptCanvas::k_VersionExplorerWindow.data(), false, "VersionExplorer::BackupGraph: Error creating backup: %s  ---> %s\n", sourceFilePath.c_str(), targetFilePath.c_str());
            return "Failed to copy source file to backup location";
@@ -602,7 +575,7 @@ namespace ScriptCanvasEditor
                });
                streamer->QueueRequest(flushRequest);
            }
-        }        
+        }
    }

    void VersionExplorer::GraphUpgradeComplete
@@ -816,7 +789,7 @@ namespace ScriptCanvasEditor
        }

        char resolvedBuffer[AZ_MAX_PATH_LEN] = { 0 };
-        AZStd::string path = AZStd::string::format("@devroot@/%s", asset.GetHint().c_str());
+        AZStd::string path = AZStd::string::format("@engroot@/%s", asset.GetHint().c_str());
        AZ::IO::FileIOBase::GetInstance()->ResolvePath(path.c_str(), resolvedBuffer, AZ_MAX_PATH_LEN);
        AZ::StringFunc::Path::GetFullPath(resolvedBuffer, path);
        AZ::StringFunc::Path::Normalize(path);
@@ -873,7 +846,7 @@ namespace ScriptCanvasEditor

                m_state = ProcessState::Upgrade;
                AZ::SystemTickBus::Handler::BusConnect();
-            }          
+            }
        }
    }

@@ -883,7 +856,7 @@ namespace ScriptCanvasEditor
        m_inProgress = false;
        m_ui->progressBar->setValue(aznumeric_cast<int>(m_currentAssetRowIndex));
        m_ui->scanButton->setEnabled(true);
-        
+
        m_inspectingAsset = m_assetsToInspect.erase(m_inspectingAsset);
        FlushLogs();