12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141 |
- /*
- * 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 "ApplicationManagerBase.h"
- #include <AzCore/Settings/SettingsRegistryMergeUtils.h>
- #include <AzCore/std/smart_ptr/make_shared.h>
- #include <AzCore/std/sort.h>
- #include <native/assetprocessor.h>
- #include <native/utilities/BuilderConfigurationManager.h>
- #include <native/resourcecompiler/rccontroller.h>
- #include <native/AssetManager/assetScanner.h>
- #include <native/AssetManager/FileStateCache.h>
- #include <native/AssetManager/ControlRequestHandler.h>
- #include <native/connection/connectionManager.h>
- #include <native/utilities/ByteArrayStream.h>
- #include <native/AssetManager/AssetRequestHandler.h>
- #include <native/FileProcessor/FileProcessor.h>
- #include <native/FileWatcher/FileWatcher.h>
- #include <native/utilities/ApplicationServer.h>
- #include <native/utilities/AssetServerHandler.h>
- #include <native/InternalBuilders/SettingsRegistryBuilder.h>
- #include <AzToolsFramework/Application/Ticker.h>
- #include <AzToolsFramework/ToolsFileUtils/ToolsFileUtils.h>
- #include <AssetBuilder/AssetBuilderStatic.h>
- #include <iostream>
- #include <QCoreApplication>
- #include <QElapsedTimer>
- //! CreateJobs will wait up to 2 minutes before timing out
- //! This shouldn't need to be so high but very large slices can take a while to process currently
- //! This should be reduced down to something more reasonable after slice jobs are sped up
- static const int s_MaximumCreateJobsTimeSeconds = 60 * 2;
- //! ProcessJobs will wait up to 1 hour before timing out
- static const int s_MaximumProcessJobsTimeSeconds = 60 * 60;
- //! Reserve extra disk space when doing disk space checks to leave a little room for logging, database operations, etc
- static const qint64 s_ReservedDiskSpaceInBytes = 256 * 1024;
- //! Maximum number of temp folders allowed
- static const int s_MaximumTempFolders = 10000;
- ApplicationManagerBase::ApplicationManagerBase(int* argc, char*** argv, QObject* parent)
- : ApplicationManagerBase(argc, argv, parent, {})
- {
- }
- ApplicationManagerBase::ApplicationManagerBase(int* argc, char*** argv, AZ::ComponentApplicationSettings componentAppSettings)
- : ApplicationManagerBase(argc, argv, nullptr, AZStd::move(componentAppSettings))
- {
- }
- ApplicationManagerBase::ApplicationManagerBase(int* argc, char*** argv, QObject* parent, AZ::ComponentApplicationSettings componentAppSettings)
- : ApplicationManager(argc, argv, parent, AZStd::move(componentAppSettings))
- {
- qRegisterMetaType<AZ::u32>("AZ::u32");
- qRegisterMetaType<AZ::u32>("AZ::s64");
- qRegisterMetaType<AZ::Uuid>("AZ::Uuid");
- }
- ApplicationManagerBase::~ApplicationManagerBase()
- {
- AzToolsFramework::SourceControlNotificationBus::Handler::BusDisconnect();
- AZ::Debug::TraceMessageBus::Handler::BusDisconnect();
- AssetProcessor::AssetBuilderRegistrationBus::Handler::BusDisconnect();
- AssetBuilderSDK::AssetBuilderBus::Handler::BusDisconnect();
- AssetProcessor::AssetBuilderInfoBus::Handler::BusDisconnect();
- if (m_settingsRegistryBuilder)
- {
- m_settingsRegistryBuilder->Uninitialize();
- }
- if (m_internalBuilder)
- {
- m_internalBuilder->UnInitialize();
- }
- for (AssetProcessor::ExternalModuleAssetBuilderInfo* externalAssetBuilderInfo : this->m_externalAssetBuilders)
- {
- externalAssetBuilderInfo->UnInitialize();
- delete externalAssetBuilderInfo;
- }
- Destroy();
- }
- AssetProcessor::RCController* ApplicationManagerBase::GetRCController() const
- {
- return m_rcController;
- }
- int ApplicationManagerBase::ProcessedAssetCount() const
- {
- return m_processedAssetCount;
- }
- int ApplicationManagerBase::FailedAssetsCount() const
- {
- return static_cast<int>(m_failedAssets.size());
- }
- void ApplicationManagerBase::ResetProcessedAssetCount()
- {
- m_processedAssetCount = 0;
- }
- void ApplicationManagerBase::ResetFailedAssetCount()
- {
- m_failedAssets = AZStd::set<AZStd::string>{};
- }
- AssetProcessor::AssetScanner* ApplicationManagerBase::GetAssetScanner() const
- {
- return m_assetScanner;
- }
- AssetProcessor::AssetProcessorManager* ApplicationManagerBase::GetAssetProcessorManager() const
- {
- return m_assetProcessorManager;
- }
- AssetProcessor::PlatformConfiguration* ApplicationManagerBase::GetPlatformConfiguration() const
- {
- return m_platformConfiguration;
- }
- ConnectionManager* ApplicationManagerBase::GetConnectionManager() const
- {
- return m_connectionManager;
- }
- ApplicationServer* ApplicationManagerBase::GetApplicationServer() const
- {
- return m_applicationServer;
- }
- void ApplicationManagerBase::InitAssetProcessorManager(AZStd::vector<ApplicationManagerBase::APCommandLineSwitch>& commandLineInfo)
- {
- AssetProcessor::ThreadController<AssetProcessor::AssetProcessorManager>* assetProcessorHelper = new AssetProcessor::ThreadController<AssetProcessor::AssetProcessorManager>();
- addRunningThread(assetProcessorHelper);
- m_assetProcessorManager = assetProcessorHelper->initialize([this, &assetProcessorHelper]()
- {
- return new AssetProcessor::AssetProcessorManager(m_platformConfiguration, assetProcessorHelper);
- });
- QObject::connect(this, &ApplicationManagerBase::OnBuildersRegistered, m_assetProcessorManager, &AssetProcessor::AssetProcessorManager::OnBuildersRegistered, Qt::QueuedConnection);
- connect(this, &ApplicationManagerBase::SourceControlReady, [this]()
- {
- m_sourceControlReady = true;
- });
- const AzFramework::CommandLine* commandLine = nullptr;
- AzFramework::ApplicationRequests::Bus::BroadcastResult(commandLine, &AzFramework::ApplicationRequests::GetCommandLine);
- const APCommandLineSwitch Command_waitOnLaunch(commandLineInfo, "waitOnLaunch", "Briefly pauses Asset Processor during initializiation. Useful if you want to attach a debugger.");
- const APCommandLineSwitch Command_zeroAnalysisMode(commandLineInfo, "zeroAnalysisMode", "Enables using file modification time when examining source assets for processing.");
- const APCommandLineSwitch Command_enableQueryLogging(commandLineInfo, "enableQueryLogging", "Enables logging database queries.");
- const APCommandLineSwitch Command_dependencyScanPattern(commandLineInfo, "dependencyScanPattern", "Scans assets that match the given pattern for missing product dependencies.");
- const APCommandLineSwitch Command_dsp(commandLineInfo, "dsp", Command_dependencyScanPattern.m_helpText);
- const APCommandLineSwitch Command_fileDependencyScanPattern(commandLineInfo, "fileDependencyScanPattern", "Used with dependencyScanPattern to farther filter the scan.");
- const APCommandLineSwitch Command_fdsp(commandLineInfo, "fdsp", Command_fileDependencyScanPattern.m_helpText);
- const APCommandLineSwitch Command_additionalScanFolders(commandLineInfo, "additionalScanFolders", "Used with dependencyScanPattern to farther filter the scan.");
- const APCommandLineSwitch Command_dependencyScanMaxIteration(commandLineInfo, "dependencyScanMaxIteration", "Used to limit the number of recursive searches per line when running dependencyScanPattern.");
- const APCommandLineSwitch Command_warningLevel(commandLineInfo, "warningLevel", "Configure the error and warning reporting level for AssetProcessor. Pass in 1 for fatal errors, 2 for fatal errors and warnings.");
- const APCommandLineSwitch Command_acceptInput(commandLineInfo, "acceptInput", "Enable external control messaging via the ControlRequestHandler, used with automated tests.");
- const APCommandLineSwitch Command_debugOutput(commandLineInfo, "debugOutput", "When enabled, builders that support it will output debug information as product assets. Used primarily with scene files.");
- const APCommandLineSwitch Command_truncatefingerprint(commandLineInfo, "truncatefingerprint", "Truncates the fingerprint used for processed assets. Useful if you plan to compress product assets to share on another machine because some compression formats like zip will truncate file mod timestamps.");
- const APCommandLineSwitch Command_reprocessFileList(commandLineInfo, "reprocessFileList", "Reprocesses files in the passed in newline separated text file.");
- if (commandLine->HasSwitch(Command_waitOnLaunch.m_switch))
- {
- // Useful for attaching the debugger, this forces a short pause.
- AZStd::this_thread::sleep_for(AZStd::chrono::seconds(20));
- }
- if (commandLine->HasSwitch(Command_zeroAnalysisMode.m_switch))
- {
- m_assetProcessorManager->SetEnableModtimeSkippingFeature(true);
- }
- if (commandLine->HasSwitch(Command_enableQueryLogging.m_switch))
- {
- m_assetProcessorManager->SetQueryLogging(true);
- }
- if (commandLine->HasSwitch(Command_dependencyScanPattern.m_switch))
- {
- m_dependencyScanPattern = commandLine->GetSwitchValue(Command_dependencyScanPattern.m_switch, 0).c_str();
- }
- else if (commandLine->HasSwitch(Command_dsp.m_switch))
- {
- m_dependencyScanPattern = commandLine->GetSwitchValue(Command_dsp.m_switch, 0).c_str();
- }
- if (commandLine->HasSwitch(Command_reprocessFileList.m_switch))
- {
- m_reprocessFileList = commandLine->GetSwitchValue(Command_reprocessFileList.m_switch, 0).c_str();
- }
- m_fileDependencyScanPattern = "*";
- if (commandLine->HasSwitch(Command_fileDependencyScanPattern.m_switch))
- {
- m_fileDependencyScanPattern = commandLine->GetSwitchValue(Command_fileDependencyScanPattern.m_switch, 0).c_str();
- }
- else if (commandLine->HasSwitch(Command_fdsp.m_switch))
- {
- m_fileDependencyScanPattern = commandLine->GetSwitchValue(Command_fdsp.m_switch, 0).c_str();
- }
- if (commandLine->HasSwitch(Command_additionalScanFolders.m_switch))
- {
- for (size_t idx = 0; idx < commandLine->GetNumSwitchValues(Command_additionalScanFolders.m_switch); idx++)
- {
- AZStd::string value = commandLine->GetSwitchValue(Command_additionalScanFolders.m_switch, idx);
- m_dependencyAddtionalScanFolders.emplace_back(AZStd::move(value));
- }
- }
- if (commandLine->HasSwitch(Command_dependencyScanMaxIteration.m_switch))
- {
- AZStd::string maxIterationAsString = commandLine->GetSwitchValue(Command_dependencyScanMaxIteration.m_switch, 0);
- m_dependencyScanMaxIteration = AZStd::stoi(maxIterationAsString);
- }
- if (commandLine->HasSwitch(Command_warningLevel.m_switch))
- {
- using namespace AssetProcessor;
- const AZStd::string& levelString = commandLine->GetSwitchValue(Command_warningLevel.m_switch, 0);
- WarningLevel warningLevel = WarningLevel::Default;
- switch(AZStd::stoi(levelString))
- {
- case 1:
- warningLevel = WarningLevel::FatalErrors;
- break;
- case 2:
- warningLevel = WarningLevel::FatalErrorsAndWarnings;
- break;
- }
- AssetProcessor::JobDiagnosticRequestBus::Broadcast(&AssetProcessor::JobDiagnosticRequestBus::Events::SetWarningLevel, warningLevel);
- }
- if (commandLine->HasSwitch(Command_acceptInput.m_switch))
- {
- InitControlRequestHandler();
- }
- if (commandLine->HasSwitch(Command_debugOutput.m_switch))
- {
- m_assetProcessorManager->SetBuilderDebugFlag(true);
- }
- if (commandLine->HasSwitch(Command_truncatefingerprint.m_switch))
- {
- // Zip archive format uses 2 second precision truncated
- const int ArchivePrecision = 2000;
- int precision = ArchivePrecision;
- if (commandLine->GetNumSwitchValues(Command_truncatefingerprint.m_switch) > 0)
- {
- precision = AZStd::stoi(commandLine->GetSwitchValue(Command_truncatefingerprint.m_switch, 0));
- if(precision < 1)
- {
- precision = 1;
- }
- }
- AssetUtilities::SetTruncateFingerprintTimestamp(precision);
- }
- }
- void ApplicationManagerBase::HandleCommandLineHelp(AZStd::vector<ApplicationManagerBase::APCommandLineSwitch>& commandLineInfo)
- {
- const AzFramework::CommandLine* commandLine = nullptr;
- AzFramework::ApplicationRequests::Bus::BroadcastResult(commandLine, &AzFramework::ApplicationRequests::GetCommandLine);
- if (!commandLine)
- {
- AZ_TracePrintf(
- "AssetProcessor",
- "Asset Processor Command Line information not available, help cannot be printed. This is an application initialization problem "
- "and should be resolved in code.\n");
- return;
- }
- const APCommandLineSwitch Command_help(commandLineInfo, "help", "Displays this message.");
- const APCommandLineSwitch Command_h(commandLineInfo, "h", Command_help.m_helpText);
- // The regset command line flag is checked elsewhere, but handled here to make the help text complete.
- const APCommandLineSwitch Command_regset(commandLineInfo, "regset", "Set the given registry key to the given value.");
- if (commandLine->HasSwitch(Command_help.m_switch) || commandLine->HasSwitch(Command_h.m_switch))
- {
- // Other O3DE tools have a more full featured system for registering command flags
- // that includes help output, but right now the AssetProcessor just checks strings
- // via HasSwitch. This means this help output has to be updated manually.
- AZ_TracePrintf("AssetProcessor", "Asset Processor Command Line Flags:\n");
- for ([[maybe_unused]] const auto& command : commandLineInfo)
- {
- AZ_TracePrintf("AssetProcessor", "\t%s : %s\n", command.m_switch, command.m_helpText);
- }
- }
- }
- void ApplicationManagerBase::Rescan()
- {
- m_assetProcessorManager->SetEnableModtimeSkippingFeature(false);
- GetAssetScanner()->StartScan();
- }
- void ApplicationManagerBase::FastScan()
- {
- m_assetProcessorManager->SetEnableModtimeSkippingFeature(true);
- GetAssetScanner()->StartScan();
- }
- void ApplicationManagerBase::InitAssetCatalog()
- {
- using namespace AssetProcessor;
- if (m_assetCatalog)
- {
- return;
- }
- ThreadController<AssetCatalog>* assetCatalogHelper = new ThreadController<AssetCatalog>();
- addRunningThread(assetCatalogHelper);
- m_assetCatalog = assetCatalogHelper->initialize([this, &assetCatalogHelper]()
- {
- AssetProcessor::AssetCatalog* catalog = new AssetCatalog(assetCatalogHelper, m_platformConfiguration);
- // Using a direct connection so we know the catalog has been updated before continuing on with code might depend on the asset being in the catalog
- connect(m_assetProcessorManager, &AssetProcessorManager::AssetMessage, catalog, &AssetCatalog::OnAssetMessage, Qt::DirectConnection);
- connect(m_assetProcessorManager, &AssetProcessorManager::SourceQueued, catalog, &AssetCatalog::OnSourceQueued);
- connect(m_assetProcessorManager, &AssetProcessorManager::SourceFinished, catalog, &AssetCatalog::OnSourceFinished);
- connect(m_assetProcessorManager, &AssetProcessorManager::PathDependencyResolved, catalog, &AssetCatalog::OnDependencyResolved);
- connect(
- catalog,
- &AssetCatalog::SendAssetMessage,
- this,
- [](auto message)
- {
- AssetProcessor::ConnectionBus::Broadcast(&AssetProcessor::ConnectionBus::Events::SendPerPlatform, 0, message, QString::fromUtf8(message.m_platform.c_str()));
- },
- Qt::QueuedConnection);
- connect(m_connectionManager, &ConnectionManager::ConnectionReady, catalog, &AssetCatalog::OnConnect, Qt::QueuedConnection);
- connect(catalog, &AssetCatalog::CatalogLoaded, m_assetProcessorManager, &AssetProcessorManager::OnCatalogReady);
- return catalog;
- });
- ConnectAssetCatalog();
- // schedule the asset catalog to build its registry in its own thread:
- QMetaObject::invokeMethod(m_assetCatalog, "BuildRegistry", Qt::QueuedConnection);
- }
- void ApplicationManagerBase::ConnectAssetCatalog()
- {
- using namespace AssetProcessor;
- auto router = AZ::Interface<IRequestRouter>::Get();
- if (router)
- {
- router->RegisterQueuedCallbackHandler(GetAssetCatalog(), &AssetCatalog::HandleSaveAssetCatalogRequest);
- router->RegisterQueuedCallbackHandler(GetAssetCatalog(), &AssetCatalog::HandleGetUnresolvedDependencyCountsRequest);
- }
- }
- void ApplicationManagerBase::InitRCController()
- {
- m_rcController = new AssetProcessor::RCController(m_platformConfiguration->GetMinJobs(), m_platformConfiguration->GetMaxJobs());
- QObject::connect(m_assetProcessorManager, &AssetProcessor::AssetProcessorManager::AssetToProcess, m_rcController, &AssetProcessor::RCController::JobSubmitted);
- QObject::connect(m_rcController, &AssetProcessor::RCController::FileCompiled, m_assetProcessorManager, &AssetProcessor::AssetProcessorManager::AssetProcessed, Qt::UniqueConnection);
- QObject::connect(m_rcController, &AssetProcessor::RCController::FileFailed, m_assetProcessorManager, &AssetProcessor::AssetProcessorManager::AssetFailed);
- QObject::connect(m_rcController, &AssetProcessor::RCController::FileCancelled, m_assetProcessorManager, &AssetProcessor::AssetProcessorManager::AssetCancelled);
- QObject::connect(m_assetProcessorManager, &AssetProcessor::AssetProcessorManager::EscalateJobs, m_rcController, &AssetProcessor::RCController::EscalateJobs);
- QObject::connect(m_assetProcessorManager, &AssetProcessor::AssetProcessorManager::SourceDeleted, m_rcController, &AssetProcessor::RCController::RemoveJobsBySource);
- QObject::connect(m_assetProcessorManager, &AssetProcessor::AssetProcessorManager::JobComplete, m_rcController, &AssetProcessor::RCController::OnJobComplete);
- QObject::connect(m_assetProcessorManager, &AssetProcessor::AssetProcessorManager::AddedToCatalog, m_rcController, &AssetProcessor::RCController::OnAddedToCatalog);
- }
- void ApplicationManagerBase::DestroyRCController()
- {
- if (m_rcController)
- {
- delete m_rcController;
- m_rcController = nullptr;
- }
- }
- void ApplicationManagerBase::InitAssetScanner()
- {
- using namespace AssetProcessor;
- m_assetScanner = new AssetScanner(m_platformConfiguration);
- // // wait until file cache is ready before attempting to build the catalog.
- QObject::connect(
- m_assetProcessorManager,
- &AssetProcessorManager::FileCacheIsReady,
- m_assetProcessorManager,
- [this]()
- {
- InitAssetCatalog();
- });
- QObject::connect(m_assetScanner, &AssetScanner::AssetScanningStatusChanged, m_assetProcessorManager, &AssetProcessorManager::OnAssetScannerStatusChange);
- QObject::connect(m_assetScanner, &AssetScanner::FilesFound, m_assetProcessorManager, &AssetProcessorManager::RecordFilesFromScanner);
- QObject::connect(m_assetScanner, &AssetScanner::FoldersFound, m_assetProcessorManager, &AssetProcessorManager::RecordFoldersFromScanner);
- QObject::connect(m_assetScanner, &AssetScanner::ExcludedFound, m_assetProcessorManager, &AssetProcessorManager::RecordExcludesFromScanner);
- QObject::connect(m_assetScanner, &AssetScanner::FilesFound, [this](QSet<AssetFileInfo> files) { m_fileStateCache->AddInfoSet(files); });
- QObject::connect(m_assetScanner, &AssetScanner::FoldersFound, [this](QSet<AssetFileInfo> files) { m_fileStateCache->AddInfoSet(files); });
- QObject::connect(m_assetScanner, &AssetScanner::ExcludedFound, [this](QSet<AssetFileInfo> files) { m_fileStateCache->AddInfoSet(files); });
- // file table
- QObject::connect(m_assetScanner, &AssetScanner::AssetScanningStatusChanged, m_fileProcessor.get(), &FileProcessor::OnAssetScannerStatusChange);
- QObject::connect(m_assetScanner, &AssetScanner::FilesFound, m_fileProcessor.get(), &FileProcessor::AssessFilesFromScanner);
- QObject::connect(m_assetScanner, &AssetScanner::FoldersFound, m_fileProcessor.get(), &FileProcessor::AssessFoldersFromScanner);
- }
- void ApplicationManagerBase::DestroyAssetScanner()
- {
- if (m_assetScanner)
- {
- delete m_assetScanner;
- m_assetScanner = nullptr;
- }
- }
- bool ApplicationManagerBase::InitPlatformConfiguration()
- {
- m_platformConfiguration = new AssetProcessor::PlatformConfiguration();
- QDir assetRoot;
- AssetUtilities::ComputeAssetRoot(assetRoot);
- return m_platformConfiguration->InitializeFromConfigFiles(GetSystemRoot().absolutePath(), assetRoot.absolutePath(), GetProjectPath());
- }
- bool ApplicationManagerBase::InitBuilderConfiguration()
- {
- m_builderConfig = AZStd::make_unique<AssetProcessor::BuilderConfigurationManager>();
- QString configFile = QDir(GetProjectPath()).absoluteFilePath(AssetProcessor::BuilderConfigFile);
- if (!QFile::exists(configFile))
- {
- AZ_TracePrintf("AssetProcessor", "No builder configuration file found at %s - skipping\n", configFile.toUtf8().data());
- return false;
- }
- if (!m_builderConfig->LoadConfiguration(configFile.toStdString().c_str()))
- {
- AZ_Error("AssetProcessor", false, "Failed to Initialize from %s - check the log files in the logs/ subfolder for more information.", configFile.toUtf8().data());
- return false;
- }
- return true;
- }
- void ApplicationManagerBase::DestroyPlatformConfiguration()
- {
- if (m_platformConfiguration)
- {
- delete m_platformConfiguration;
- m_platformConfiguration = nullptr;
- }
- }
- void ApplicationManagerBase::InitFileMonitor(AZStd::unique_ptr<FileWatcherBase> fileWatcher)
- {
- m_fileWatcher = AZStd::move(fileWatcher);
- using AssetProcessor::IntermediateAssetsFolderName;
- using AssetProcessor::AssetProcessorManager;
- using AssetProcessor::ScanFolderInfo;
- using AssetProcessor::ExcludedFolderCacheInterface;
- using AssetProcessor::FileProcessor;
- QString projectPath = GetProjectPath();
- QDir cacheRoot;
- AssetUtilities::ComputeProjectCacheRoot(cacheRoot);
- m_fileWatcher->InstallDefaultExclusionRules(cacheRoot.absolutePath(), projectPath);
- if (!cacheRoot.isEmpty())
- {
- // note that in projects, if we watch the project root, the cache folder is a subfolder of that folder anyway,
- // so AddFolderWatch below for the cache does nothing. In the case where the project might watch only a specific
- // subfolder, then this matters.
- m_fileWatcher->AddFolderWatch(cacheRoot.absolutePath(), true);
- }
- for (int folderIdx = 0; folderIdx < m_platformConfiguration->GetScanFolderCount(); ++folderIdx)
- {
- const ScanFolderInfo& info = m_platformConfiguration->GetScanFolderAt(folderIdx);
- m_fileWatcher->AddFolderWatch(info.ScanPath(), info.RecurseSubFolders());
- }
- const auto OnFileAdded = [this](QString path)
- {
- m_fileStateCache->AddFile(path);
- };
- const auto OnFileModified = [this](QString path)
- {
- m_fileStateCache->UpdateFile(path);
- m_uuidManager->FileChanged(path.toUtf8().constData());
- };
- const auto OnFileRemoved = [this](QString path)
- {
- m_fileStateCache->RemoveFile(path);
- m_uuidManager->FileRemoved(path.toUtf8().constData());
- };
- connect(m_fileWatcher.get(), &FileWatcher::fileAdded, OnFileAdded);
- connect(m_fileWatcher.get(), &FileWatcher::fileModified, OnFileModified);
- connect(m_fileWatcher.get(), &FileWatcher::fileRemoved, OnFileRemoved);
- auto excludedFolderCacheInterfacePtr = AZ::Interface<ExcludedFolderCacheInterface>::Get();
- if (!excludedFolderCacheInterfacePtr)
- {
- AZ_Error("AssetProcessor", false, "ExcludedFolderCacheInterface not found.");
- }
- else
- {
- const auto OnFileAddedForExcludeFolderCache = [excludedFolderCacheInterfacePtr](QString path)
- {
- excludedFolderCacheInterfacePtr->FileAdded(path);
- };
- connect(m_fileWatcher.get(), &FileWatcher::fileAdded, OnFileAddedForExcludeFolderCache);
- }
- if (m_fileProcessor.get())
- {
- connect(m_fileWatcher.get(), &FileWatcher::fileAdded, m_fileProcessor.get(), &FileProcessor::AssessAddedFile, Qt::QueuedConnection);
- connect(m_fileWatcher.get(), &FileWatcher::fileRemoved, m_fileProcessor.get(), &FileProcessor::AssessDeletedFile, Qt::QueuedConnection);
- }
- connect(m_fileWatcher.get(), &FileWatcher::fileAdded, m_assetProcessorManager, &AssetProcessorManager::AssessAddedFile, Qt::QueuedConnection);
- connect(m_fileWatcher.get(), &FileWatcher::fileModified, m_assetProcessorManager, &AssetProcessorManager::AssessModifiedFile, Qt::QueuedConnection);
- connect(m_fileWatcher.get(), &FileWatcher::fileRemoved, m_assetProcessorManager, &AssetProcessorManager::AssessDeletedFile, Qt::QueuedConnection);
- }
- void ApplicationManagerBase::DestroyFileMonitor()
- {
- if(m_fileWatcher)
- {
- m_fileWatcher->ClearFolderWatches();
- m_fileWatcher = nullptr;
- }
- }
- void ApplicationManagerBase::DestroyApplicationServer()
- {
- if (m_applicationServer)
- {
- delete m_applicationServer;
- m_applicationServer = nullptr;
- }
- }
- void ApplicationManagerBase::DestroyControlRequestHandler()
- {
- if (m_controlRequestHandler)
- {
- delete m_controlRequestHandler;
- m_controlRequestHandler = nullptr;
- }
- }
- void ApplicationManagerBase::InitControlRequestHandler()
- {
- m_controlRequestHandler = new ControlRequestHandler(this);
- }
- void ApplicationManagerBase::InitConnectionManager()
- {
- using namespace AzFramework::AssetSystem;
- using namespace AzToolsFramework::AssetSystem;
- m_connectionManager = new ConnectionManager();
- //Application manager related stuff
- // The AssetCatalog has to be rebuilt on connection, so we force the incoming connection messages to be serialized as they connect to the ApplicationManagerBase
- [[maybe_unused]] bool result = QObject::connect(m_applicationServer, &ApplicationServer::newIncomingConnection, m_connectionManager, &ConnectionManager::NewConnection, Qt::QueuedConnection);
- AZ_Assert(result, "Failed to connect to ApplicationServer signal");
- //RcController related stuff
- result = QObject::connect(GetRCController(), &AssetProcessor::RCController::JobStatusChanged, GetAssetProcessorManager(), &AssetProcessor::AssetProcessorManager::OnJobStatusChanged);
- AZ_Assert(result, "Failed to connect to RCController signal");
- result = QObject::connect(GetRCController(), &AssetProcessor::RCController::JobStarted, this,
- [](QString inputFile, QString platform)
- {
- QString msg = QCoreApplication::translate("O3DE Asset Processor", "Processing %1 (%2)...\n", "%1 is the name of the file, and %2 is the platform to process it for").arg(inputFile, platform);
- AZ_Printf(AssetProcessor::ConsoleChannel, "%s", msg.toUtf8().constData());
- AssetNotificationMessage message(inputFile.toUtf8().constData(), AssetNotificationMessage::JobStarted, AZ::Data::s_invalidAssetType, platform.toUtf8().constData());
- AssetProcessor::ConnectionBus::Broadcast(&AssetProcessor::ConnectionBus::Events::SendPerPlatform, 0, message, platform);
- }
- );
- AZ_Assert(result, "Failed to connect to RCController signal");
- result = QObject::connect(
- GetRCController(),
- &AssetProcessor::RCController::FileCompiled,
- this,
- [](AssetProcessor::JobEntry entry, AssetBuilderSDK::ProcessJobResponse /*response*/)
- {
- AssetNotificationMessage message(
- entry.m_sourceAssetReference.RelativePath().c_str(),
- AssetNotificationMessage::JobCompleted,
- AZ::Data::s_invalidAssetType,
- entry.m_platformInfo.m_identifier.c_str());
- AssetProcessor::ConnectionBus::Broadcast(
- &AssetProcessor::ConnectionBus::Events::SendPerPlatform,
- 0,
- message,
- QString::fromUtf8(entry.m_platformInfo.m_identifier.c_str()));
- });
- AZ_Assert(result, "Failed to connect to RCController signal");
- result = QObject::connect(
- GetRCController(),
- &AssetProcessor::RCController::FileFailed,
- this,
- [](AssetProcessor::JobEntry entry)
- {
- AssetNotificationMessage message(
- entry.m_sourceAssetReference.RelativePath().c_str(),
- AssetNotificationMessage::JobFailed,
- AZ::Data::s_invalidAssetType,
- entry.m_platformInfo.m_identifier.c_str());
- AssetProcessor::ConnectionBus::Broadcast(
- &AssetProcessor::ConnectionBus::Events::SendPerPlatform,
- 0,
- message,
- QString::fromUtf8(entry.m_platformInfo.m_identifier.c_str()));
- });
- AZ_Assert(result, "Failed to connect to RCController signal");
- result = QObject::connect(GetRCController(), &AssetProcessor::RCController::JobsInQueuePerPlatform, this,
- [](QString platform, int count)
- {
- AssetNotificationMessage message(QByteArray::number(count).constData(), AssetNotificationMessage::JobCount, AZ::Data::s_invalidAssetType, platform.toUtf8().constData());
- AssetProcessor::ConnectionBus::Broadcast(&AssetProcessor::ConnectionBus::Events::SendPerPlatform, 0, message, platform);
- }
- );
- AZ_Assert(result, "Failed to connect to RCController signal");
- m_connectionManager->RegisterService(RequestPing::MessageType,
- AZStd::bind([](unsigned int connId, unsigned int /*type*/, unsigned int serial, QByteArray /*payload*/)
- {
- ResponsePing responsePing;
- AssetProcessor::ConnectionBus::Event(connId, &AssetProcessor::ConnectionBus::Events::SendResponse, serial, responsePing);
- }, AZStd::placeholders::_1, AZStd::placeholders::_2, AZStd::placeholders::_3, AZStd::placeholders::_4)
- );
- m_connectionManager->RegisterService(
- AssetBuilder::BuilderRegistrationRequest::MessageType,
- [this](unsigned int /*connId*/, unsigned int /*type*/, unsigned int /*serial*/, QByteArray payload, QString)
- {
- AssetBuilder::BuilderRegistrationRequest registrationRequest;
- if (m_builderRegistrationComplete)
- {
- return;
- }
- m_builderRegistrationComplete = true;
- if (AssetProcessor::UnpackMessage(payload, registrationRequest))
- {
- for (const auto& builder : registrationRequest.m_builders)
- {
- AssetBuilderSDK::AssetBuilderDesc desc;
- desc.m_name = builder.m_name;
- desc.m_patterns = builder.m_patterns;
- desc.m_version = builder.m_version;
- desc.m_analysisFingerprint = builder.m_analysisFingerprint;
- desc.m_flags = builder.m_flags;
- desc.m_busId = builder.m_busId;
- desc.m_flagsByJobKey = builder.m_flagsByJobKey;
- desc.m_productsToKeepOnFailure = builder.m_productsToKeepOnFailure;
- // Builders registered this way are always external builders
- desc.m_builderType = AssetBuilderSDK::AssetBuilderDesc::AssetBuilderType::External;
- RegisterBuilderInformation(desc);
- }
- QTimer::singleShot(
- 0, this,
- [this]()
- {
- if (!PostActivate())
- {
- QuitRequested();
- }
- });
- }
- });
- //You can get Asset Processor Current State
- using AzFramework::AssetSystem::RequestAssetProcessorStatus;
- auto GetState = [this](unsigned int connId, unsigned int, unsigned int serial, QByteArray payload, QString)
- {
- RequestAssetProcessorStatus requestAssetProcessorMessage;
- if (AssetProcessor::UnpackMessage(payload, requestAssetProcessorMessage))
- {
- bool status = false;
- //check whether the scan is complete,the asset processor manager initial processing is complete and
- //the number of copy jobs are zero
- int numberOfPendingJobs = GetRCController()->NumberOfPendingCriticalJobsPerPlatform(requestAssetProcessorMessage.m_platform.c_str());
- status = (GetAssetScanner()->status() == AssetProcessor::AssetScanningStatus::Completed)
- && m_assetProcessorManagerIsReady
- && (!numberOfPendingJobs);
- ResponseAssetProcessorStatus responseAssetProcessorMessage;
- responseAssetProcessorMessage.m_isAssetProcessorReady = status;
- responseAssetProcessorMessage.m_numberOfPendingJobs = numberOfPendingJobs + m_remainingAPMJobs;
- if (responseAssetProcessorMessage.m_numberOfPendingJobs && m_highestConnId < connId)
- {
- // We will just emit this status message once per connId
- Q_EMIT ConnectionStatusMsg(QString(" Critical assets need to be processed for %1 platform. Editor/Game will launch once they are processed.").arg(requestAssetProcessorMessage.m_platform.c_str()));
- m_highestConnId = connId;
- }
- AssetProcessor::ConnectionBus::Event(
- connId, &AssetProcessor::ConnectionBus::Events::SendResponse, serial, responseAssetProcessorMessage);
- }
- };
- // connect the network messages to the Request handler:
- m_connectionManager->RegisterService(RequestAssetProcessorStatus::MessageType, GetState);
- // ability to see if an asset platform is enabled or not
- using AzToolsFramework::AssetSystem::AssetProcessorPlatformStatusRequest;
- m_connectionManager->RegisterService(AssetProcessorPlatformStatusRequest::MessageType,
- [](unsigned int connId, unsigned int, unsigned int serial, QByteArray payload, QString)
- {
- AssetProcessorPlatformStatusResponse responseMessage;
- AssetProcessorPlatformStatusRequest requestMessage;
- if (AssetProcessor::UnpackMessage(payload, requestMessage))
- {
- AzToolsFramework::AssetSystemRequestBus::BroadcastResult(responseMessage.m_isPlatformEnabled,
- &AzToolsFramework::AssetSystemRequestBus::Events::IsAssetPlatformEnabled, requestMessage.m_platform.c_str());
- }
- AssetProcessor::ConnectionBus::Event(connId,
- &AssetProcessor::ConnectionBus::Events::SendResponse, serial, responseMessage);
- });
- // check the total number of assets remaining for a specified platform
- using AzToolsFramework::AssetSystem::AssetProcessorPendingPlatformAssetsRequest;
- m_connectionManager->RegisterService(AssetProcessorPendingPlatformAssetsRequest::MessageType,
- [this](unsigned int connId, unsigned int, unsigned int serial, QByteArray payload, QString)
- {
- AssetProcessorPendingPlatformAssetsResponse responseMessage;
- AssetProcessorPendingPlatformAssetsRequest requestMessage;
- if (AssetProcessor::UnpackMessage(payload, requestMessage))
- {
- const char* platformIdentifier = requestMessage.m_platform.c_str();
- responseMessage.m_numberOfPendingJobs =
- GetRCController()->NumberOfPendingJobsPerPlatform(platformIdentifier);
- }
- AssetProcessor::ConnectionBus::Event(connId,
- &AssetProcessor::ConnectionBus::Events::SendResponse, serial, responseMessage);
- });
- }
- void ApplicationManagerBase::DestroyConnectionManager()
- {
- if (m_connectionManager)
- {
- delete m_connectionManager;
- m_connectionManager = nullptr;
- }
- }
- void ApplicationManagerBase::InitAssetRequestHandler(AssetProcessor::AssetRequestHandler* assetRequestHandler)
- {
- using namespace AzFramework::AssetSystem;
- using namespace AzToolsFramework::AssetSystem;
- using namespace AzFramework::AssetSystem;
- using namespace AssetProcessor;
- m_assetRequestHandler = assetRequestHandler;
- auto router = AZ::Interface<IRequestRouter>::Get();
- if (router)
- {
- router->RegisterQueuedCallbackHandler(GetAssetProcessorManager(), &AssetProcessorManager::ProcessFingerprintClearRequest);
- router->RegisterQueuedCallbackHandler(GetAssetProcessorManager(), &AssetProcessorManager::ProcessGetAssetJobsInfoRequest);
- router->RegisterQueuedCallbackHandler(GetAssetProcessorManager(), &AssetProcessorManager::ProcessGetAssetJobLogRequest);
- router->RegisterQueuedCallbackHandler(GetAssetProcessorManager(), &AssetProcessorManager::ProcessGetAbsoluteAssetDatabaseLocationRequest);
- }
- // connect the "Does asset exist?" loop to each other:
- QObject::connect(m_assetRequestHandler, &AssetRequestHandler::RequestAssetExists, GetAssetProcessorManager(), &AssetProcessorManager::OnRequestAssetExists);
- QObject::connect(GetAssetProcessorManager(), &AssetProcessorManager::SendAssetExistsResponse, m_assetRequestHandler, &AssetRequestHandler::OnRequestAssetExistsResponse);
- QObject::connect(GetAssetProcessorManager(), &AssetProcessorManager::FenceFileDetected, m_assetRequestHandler, &AssetRequestHandler::OnFenceFileDetected);
- // connect the Asset Request Handler to RC:
- QObject::connect(m_assetRequestHandler, &AssetRequestHandler::RequestCompileGroup, GetRCController(), &RCController::OnRequestCompileGroup);
- QObject::connect(m_assetRequestHandler, &AssetRequestHandler::RequestEscalateAssetBySearchTerm, GetRCController(), &RCController::OnEscalateJobsBySearchTerm);
- QObject::connect(m_assetRequestHandler, &AssetRequestHandler::RequestEscalateAssetByUuid, GetRCController(), &RCController::OnEscalateJobsBySourceUUID);
- QObject::connect(GetRCController(), &RCController::CompileGroupCreated, m_assetRequestHandler, &AssetRequestHandler::OnCompileGroupCreated);
- QObject::connect(GetRCController(), &RCController::CompileGroupFinished, m_assetRequestHandler, &AssetRequestHandler::OnCompileGroupFinished);
- QObject::connect(GetAssetProcessorManager(), &AssetProcessor::AssetProcessorManager::NumRemainingJobsChanged, this, [this](int newNum, QString extraInfo)
- {
- if (!m_assetProcessorManagerIsReady)
- {
- if ((m_remainingAPMJobs == newNum) && m_remainingAPMJobs)
- {
- return;
- }
- m_remainingAPMJobs = newNum;
- if (!m_remainingAPMJobs)
- {
- m_assetProcessorManagerIsReady = true;
- }
- }
- AssetProcessor::AssetProcessorStatusEntry entry(AssetProcessor::AssetProcessorStatus::Analyzing_Jobs, newNum, extraInfo);
- Q_EMIT AssetProcessorStatusChanged(entry);
- });
- }
- void ApplicationManagerBase::InitFileStateCache()
- {
- const AzFramework::CommandLine* commandLine = nullptr;
- AzFramework::ApplicationRequests::Bus::BroadcastResult(commandLine, &AzFramework::ApplicationRequests::GetCommandLine);
- if (commandLine->HasSwitch("disableFileCache"))
- {
- m_fileStateCache = AZStd::make_unique<AssetProcessor::FileStatePassthrough>();
- return;
- }
- m_fileStateCache = AZStd::make_unique<AssetProcessor::FileStateCache>();
- }
- void ApplicationManagerBase::InitUuidManager()
- {
- m_uuidManager = AZStd::make_unique<AssetProcessor::UuidManager>();
- AssetProcessor::UuidSettings uuidSettings;
- AZ::SettingsRegistryInterface* settingsRegistry = AZ::SettingsRegistry::Get();
- if (settingsRegistry)
- {
- if (settingsRegistry->GetObject(uuidSettings, "/O3DE/AssetProcessor/Settings/Metadata"))
- {
- m_uuidManager->EnableGenerationForTypes(uuidSettings.m_enabledTypes);
- m_assetProcessorManager->SetMetaCreationDelay(uuidSettings.m_metaCreationDelayMs);
- }
- }
- }
- ApplicationManager::BeforeRunStatus ApplicationManagerBase::BeforeRun()
- {
- ApplicationManager::BeforeRunStatus status = ApplicationManager::BeforeRun();
- if (status != ApplicationManager::BeforeRunStatus::Status_Success)
- {
- return status;
- }
- //Register all QMetatypes here
- qRegisterMetaType<AzFramework::AssetSystem::AssetStatus>("AzFramework::AssetSystem::AssetStatus");
- qRegisterMetaType<AzFramework::AssetSystem::AssetStatus>("AssetStatus");
- qRegisterMetaType<AssetProcessor::AssetScanningStatus>("AssetScanningStatus");
- qRegisterMetaType<AssetProcessor::NetworkRequestID>("NetworkRequestID");
- qRegisterMetaType<AssetProcessor::JobEntry>("JobEntry");
- qRegisterMetaType<AzToolsFramework::AssetSystem::JobInfo>("AzToolsFramework::AssetSystem::JobInfo");
- qRegisterMetaType<AssetBuilderSDK::ProcessJobResponse>("ProcessJobResponse");
- qRegisterMetaType<AzToolsFramework::AssetSystem::JobStatus>("AzToolsFramework::AssetSystem::JobStatus");
- qRegisterMetaType<AzToolsFramework::AssetSystem::JobStatus>("JobStatus");
- qRegisterMetaType<AssetProcessor::JobDetails>("JobDetails");
- qRegisterMetaType<AZ::Data::AssetId>("AZ::Data::AssetId");
- qRegisterMetaType<AZ::Data::AssetInfo>("AZ::Data::AssetInfo");
- qRegisterMetaType<AzToolsFramework::AssetSystem::AssetJobLogRequest>("AzToolsFramework::AssetSystem::AssetJobLogRequest");
- qRegisterMetaType<AzToolsFramework::AssetSystem::AssetJobLogRequest>("AssetJobLogRequest");
- qRegisterMetaType<AzToolsFramework::AssetSystem::AssetJobLogResponse>("AzToolsFramework::AssetSystem::AssetJobLogResponse");
- qRegisterMetaType<AzToolsFramework::AssetSystem::AssetJobLogResponse>("AssetJobLogResponse");
- qRegisterMetaType<AzFramework::AssetSystem::BaseAssetProcessorMessage*>("AzFramework::AssetSystem::BaseAssetProcessorMessage*");
- qRegisterMetaType<AzFramework::AssetSystem::BaseAssetProcessorMessage*>("BaseAssetProcessorMessage*");
- qRegisterMetaType<AssetProcessor::JobIdEscalationList>("AssetProcessor::JobIdEscalationList");
- qRegisterMetaType<AzFramework::AssetSystem::AssetNotificationMessage>("AzFramework::AssetSystem::AssetNotificationMessage");
- qRegisterMetaType<AzFramework::AssetSystem::AssetNotificationMessage>("AssetNotificationMessage");
- qRegisterMetaType<AZStd::string>("AZStd::string");
- qRegisterMetaType<AzToolsFramework::AssetDatabase::ProductDependencyDatabaseEntry>("AzToolsFramework::AssetDatabase::ProductDependencyDatabaseEntry");
- qRegisterMetaType<AssetProcessor::AssetCatalogStatus>("AssetCatalogStatus");
- qRegisterMetaType<AssetProcessor::AssetCatalogStatus>("AssetProcessor::AssetCatalogStatus");
- qRegisterMetaType<QSet<QString> >("QSet<QString>");
- qRegisterMetaType<QSet<AssetProcessor::AssetFileInfo>>("QSet<AssetFileInfo>");
- qRegisterMetaType<AssetProcessor::SourceAssetReference>("SourceAssetReference");
- qRegisterMetaType<AZStd::unordered_set<AZ::Uuid>>("AZStd::unordered_set<AZ::Uuid>");
- AssetBuilderSDK::AssetBuilderBus::Handler::BusConnect();
- AssetProcessor::AssetBuilderRegistrationBus::Handler::BusConnect();
- AssetProcessor::AssetBuilderInfoBus::Handler::BusConnect();
- AZ::Debug::TraceMessageBus::Handler::BusConnect();
- AzToolsFramework::SourceControlNotificationBus::Handler::BusConnect();
- return ApplicationManager::BeforeRunStatus::Status_Success;
- }
- void ApplicationManagerBase::Destroy()
- {
- delete m_ticker;
- m_ticker = nullptr;
- delete m_assetRequestHandler;
- m_assetRequestHandler = nullptr;
- // Destroy file monitor early so that no callbacks fire during shutdown.
- DestroyFileMonitor();
- ShutdownBuilderManager();
- ShutDownFileProcessor();
- DestroyControlRequestHandler();
- DestroyConnectionManager();
- DestroyAssetServerHandler();
- DestroyRCController();
- DestroyAssetScanner();
- ShutDownAssetDatabase();
- DestroyPlatformConfiguration();
- DestroyApplicationServer();
- }
- bool ApplicationManagerBase::Run()
- {
- bool showErrorMessageOnRegistryProblem = false;
- RegistryCheckInstructions registryCheckInstructions = CheckForRegistryProblems(nullptr, showErrorMessageOnRegistryProblem);
- if (registryCheckInstructions != RegistryCheckInstructions::Continue)
- {
- return false;
- }
- if (!Activate())
- {
- return false;
- }
- AZ_Printf(AssetProcessor::ConsoleChannel, "Asset Processor Batch Processing Started.\n");
- AZ_Printf(AssetProcessor::ConsoleChannel, "-----------------------------------------\n");
- QElapsedTimer allAssetsProcessingTimer;
- allAssetsProcessingTimer.start();
- m_duringStartup = false;
- qApp->exec();
- AZ_Printf(AssetProcessor::ConsoleChannel, "-----------------------------------------\n");
- AZ_Printf(AssetProcessor::ConsoleChannel, "Asset Processor Batch Processing complete\n");
- if (!m_failedAssets.empty())
- {
- AZ_Printf(AssetProcessor::ConsoleChannel, "---------------FAILED ASSETS-------------\n");
- for (const auto& failedAsset : m_failedAssets)
- {
- AZ_Printf(AssetProcessor::ConsoleChannel, "%s\n", failedAsset.c_str());
- }
- AZ_Printf(AssetProcessor::ConsoleChannel, "-----------------------------------------\n");
- }
- AZ_Printf(AssetProcessor::ConsoleChannel, "Number of Assets Successfully Processed: %d.\n", ProcessedAssetCount());
- AZ_Printf(AssetProcessor::ConsoleChannel, "Number of Assets Failed to Process: %d.\n", FailedAssetsCount());
- AZ_Printf(AssetProcessor::ConsoleChannel, "Number of Warnings Reported: %d.\n", m_warningCount);
- AZ_Printf(AssetProcessor::ConsoleChannel, "Number of Errors Reported: %d.\n", m_errorCount);
- AZ_Printf(AssetProcessor::ConsoleChannel, "Total Assets Processing Time: %fs\n", allAssetsProcessingTimer.elapsed() / 1000.0f);
- AZ_Printf(AssetProcessor::ConsoleChannel, "Asset Processor Batch Processing Completed.\n");
- RemoveOldTempFolders();
- Destroy();
- return FailedAssetsCount() == 0;
- }
- void ApplicationManagerBase::HandleFileRelocation() const
- {
- static constexpr char Delimiter[] = "--------------------------- RELOCATION REPORT ---------------------------\n";
- static constexpr char MoveCommand[] = "move";
- static constexpr char DeleteCommand[] = "delete";
- static constexpr char ConfirmCommand[] = "confirm";
- static constexpr char LeaveEmptyFoldersCommand[] = "leaveEmptyFolders";
- static constexpr char AllowBrokenDependenciesCommand[] = "allowBrokenDependencies";
- static constexpr char UpdateReferencesCommand[] = "updateReferences";
- static constexpr char ExcludeMetaDataFiles[] = "excludeMetaDataFiles";
- const AzFramework::CommandLine* commandLine = nullptr;
- AzFramework::ApplicationRequests::Bus::BroadcastResult(commandLine, &AzFramework::ApplicationRequests::GetCommandLine);
- const bool allowBrokenDependencies = commandLine->HasSwitch(AllowBrokenDependenciesCommand);
- const bool previewOnly = !commandLine->HasSwitch(ConfirmCommand);
- const bool leaveEmptyFolders = commandLine->HasSwitch(LeaveEmptyFoldersCommand);
- const bool doMove = commandLine->HasSwitch(MoveCommand);
- const bool doDelete = commandLine->HasSwitch(DeleteCommand);
- const bool updateReferences = commandLine->HasSwitch(UpdateReferencesCommand);
- const bool excludeMetaDataFiles = commandLine->HasSwitch(ExcludeMetaDataFiles);
- const int flags = (allowBrokenDependencies ? AssetProcessor::RelocationParameters_AllowDependencyBreakingFlag : 0) |
- (previewOnly ? AssetProcessor::RelocationParameters_PreviewOnlyFlag : 0) |
- (leaveEmptyFolders ? 0 : AssetProcessor::RelocationParameters_RemoveEmptyFoldersFlag) |
- (updateReferences ? AssetProcessor::RelocationParameters_UpdateReferencesFlag : 0) |
- (excludeMetaDataFiles ? AssetProcessor::RelocationParameters_ExcludeMetaDataFilesFlag : 0);
- if(doMove || doDelete)
- {
- int printCounter = 0;
- while(!m_sourceControlReady)
- {
- // We need to wait for source control to be ready before continuing
- if (printCounter % 10 == 0)
- {
- AZ_TracePrintf(AssetProcessor::ConsoleChannel, "Waiting for Source Control connection\n");
- }
- AZStd::this_thread::sleep_for(AZStd::chrono::milliseconds(100));
- AZ::TickBus::ExecuteQueuedEvents();
- ++printCounter;
- }
- }
- if(!doMove && updateReferences)
- {
- AZ_Error(AssetProcessor::ConsoleChannel, false, "Command --%s must be used with command --%s", UpdateReferencesCommand, MoveCommand);
- return;
- }
- // Print some errors to inform users that the move or delete command must be included
- if(!doMove && !doDelete)
- {
- AZ_Error(AssetProcessor::ConsoleChannel, previewOnly, "Command --%s must be used with command --%s or --%s", ConfirmCommand, MoveCommand, DeleteCommand);
- AZ_Error(AssetProcessor::ConsoleChannel, !leaveEmptyFolders, "Command --%s must be used with command --%s or --%s", LeaveEmptyFoldersCommand, MoveCommand, DeleteCommand);
- AZ_Error(AssetProcessor::ConsoleChannel, !allowBrokenDependencies, "Command --%s must be used with command --%s or --%s", AllowBrokenDependenciesCommand, MoveCommand, DeleteCommand);
- return;
- }
- if (doMove)
- {
- if (commandLine->GetNumSwitchValues(MoveCommand) != 2)
- {
- AZ_Error(AssetProcessor::ConsoleChannel, false, "Invalid format for move command. Expected format is %s=<source>,<destination>", MoveCommand);
- return;
- }
- AZ_Printf(AssetProcessor::ConsoleChannel, Delimiter);
- auto source = commandLine->GetSwitchValue(MoveCommand, 0);
- auto destination = commandLine->GetSwitchValue(MoveCommand, 1);
- AZ_Printf(AssetProcessor::ConsoleChannel, "Move Source: %s, Destination: %s\n", source.c_str(), destination.c_str());
- if(!previewOnly)
- {
- AZ_Printf(AssetProcessor::ConsoleChannel, "Performing real file move\n");
- if (leaveEmptyFolders)
- {
- AZ_Printf(AssetProcessor::ConsoleChannel, "Leaving empty folders\n");
- }
- else
- {
- AZ_Printf(AssetProcessor::ConsoleChannel, "Deleting empty folders\n");
- }
- if(updateReferences)
- {
- AZ_Printf(AssetProcessor::ConsoleChannel, "Attempting to perform reference fix-up\n");
- }
- }
- else
- {
- AZ_Printf(AssetProcessor::ConsoleChannel, "SETTING: Preview file move. Run again with --%s to actually make changes\n", ConfirmCommand);
- }
- auto* relocationInterface = AZ::Interface<AssetProcessor::ISourceFileRelocation>::Get();
- if(relocationInterface)
- {
- auto result = relocationInterface->Move(source, destination, flags);
- if (result.IsSuccess())
- {
- AssetProcessor::RelocationSuccess success = result.TakeValue();
- // The report can be too long for the AZ_Printf buffer, so split it into individual lines
- AZStd::string report = relocationInterface->BuildReport(success.m_relocationContainer, success.m_updateTasks, true, updateReferences);
- AZStd::vector<AZStd::string> lines;
- AzFramework::StringFunc::Tokenize(report.c_str(), lines, "\n");
- for (const AZStd::string& line : lines)
- {
- AZ_Printf(AssetProcessor::ConsoleChannel, (line + "\n").c_str());
- }
- if (!previewOnly)
- {
- AZ_Printf(AssetProcessor::ConsoleChannel, "MOVE COMPLETE\n");
- AZ_Printf(AssetProcessor::ConsoleChannel, "TOTAL DEPENDENCIES FOUND: %d\n", success.m_updateTotalCount);
- AZ_Printf(AssetProcessor::ConsoleChannel, "SUCCESSFULLY UPDATED: %d\n", success.m_updateSuccessCount);
- AZ_Printf(AssetProcessor::ConsoleChannel, "FAILED TO UPDATE: %d\n", success.m_updateFailureCount);
- AZ_Printf(AssetProcessor::ConsoleChannel, "TOTAL FILES: %d\n", success.m_moveTotalCount);
- AZ_Printf(AssetProcessor::ConsoleChannel, "SUCCESS COUNT: %d\n", success.m_moveSuccessCount);
- AZ_Printf(AssetProcessor::ConsoleChannel, "FAILURE COUNT: %d\n", success.m_moveFailureCount);
- }
- }
- else
- {
- AssetProcessor::MoveFailure failure = result.TakeError();
- AZ_Printf(AssetProcessor::ConsoleChannel, failure.m_reason.c_str());
- if(failure.m_dependencyFailure)
- {
- AZ_Printf(AssetProcessor::ConsoleChannel, "To ignore and continue anyway, re-run this command with the --%s option OR re-run this command with the --%s option to attempt to fix-up references\n", AllowBrokenDependenciesCommand, UpdateReferencesCommand);
- }
- }
- }
- else
- {
- AZ_Error(AssetProcessor::ConsoleChannel, false, "Unable to retrieve ISourceFileRelocation interface");
- return;
- }
- AZ_Printf(AssetProcessor::ConsoleChannel, Delimiter);
- }
- else if(doDelete)
- {
- if(commandLine->GetNumSwitchValues(DeleteCommand) != 1)
- {
- AZ_Error(AssetProcessor::ConsoleChannel, false, "Invalid format for delete command. Expected format is %s=<source>", DeleteCommand);
- return;
- }
- AZ_Printf(AssetProcessor::ConsoleChannel, Delimiter);
- auto source = commandLine->GetSwitchValue(DeleteCommand, 0);
- AZ_Printf(AssetProcessor::ConsoleChannel, "Delete Source: %s\n", source.c_str());
- if (!previewOnly)
- {
- AZ_Printf(AssetProcessor::ConsoleChannel, "Performing real file delete\n");
- if (leaveEmptyFolders)
- {
- AZ_Printf(AssetProcessor::ConsoleChannel, "Leaving empty folders\n");
- }
- else
- {
- AZ_Printf(AssetProcessor::ConsoleChannel, "Deleting empty folders\n");
- }
- }
- else
- {
- AZ_Printf(AssetProcessor::ConsoleChannel, "SETTING: Preview file delete. Run again with --%s to actually make changes\n", ConfirmCommand);
- }
- auto* relocationInterface = AZ::Interface<AssetProcessor::ISourceFileRelocation>::Get();
- if (relocationInterface)
- {
- auto result = relocationInterface->Delete(source, flags);
- if (result.IsSuccess())
- {
- AssetProcessor::RelocationSuccess success = result.TakeValue();
- // The report can be too long for the AZ_Printf buffer, so split it into individual lines
- AZStd::string report = relocationInterface->BuildReport(success.m_relocationContainer, success.m_updateTasks, false, updateReferences);
- AZStd::vector<AZStd::string> lines;
- AzFramework::StringFunc::Tokenize(report.c_str(), lines, "\n");
- for (const AZStd::string& line : lines)
- {
- AZ_Printf(AssetProcessor::ConsoleChannel, (line + "\n").c_str());
- }
- if (!previewOnly)
- {
- AZ_Printf(AssetProcessor::ConsoleChannel, "DELETE COMPLETE\n");
- AZ_Printf(AssetProcessor::ConsoleChannel, "TOTAL FILES: %d\n", success.m_moveTotalCount);
- AZ_Printf(AssetProcessor::ConsoleChannel, "SUCCESS COUNT: %d\n", success.m_moveSuccessCount);
- AZ_Printf(AssetProcessor::ConsoleChannel, "FAILURE COUNT: %d\n", success.m_moveFailureCount);
- }
- }
- else
- {
- AZ_Printf(AssetProcessor::ConsoleChannel, result.TakeError().c_str());
- }
- }
- else
- {
- AZ_Error(AssetProcessor::ConsoleChannel, false, "Unable to retrieve ISourceFileRelocation interface");
- }
- AZ_Printf(AssetProcessor::ConsoleChannel, Delimiter);
- }
- }
- bool ApplicationManagerBase::CheckFullIdle()
- {
- bool isIdle = m_rcController->IsIdle() && m_AssetProcessorManagerIdleState && m_remainingAssetsToFinalize == 0;
- if (isIdle != m_fullIdle)
- {
- m_fullIdle = isIdle;
- Q_EMIT FullIdle(m_fullIdle);
- }
- return isIdle;
- }
- void ApplicationManagerBase::CheckForIdle()
- {
- if (InitiatedShutdown())
- {
- return;
- }
- bool shouldExit = GetShouldExitOnIdle();
- if (shouldExit && m_connectionsToRemoveOnShutdown.empty())
- {
- // we've already entered this state once. Ignore repeats. this can happen if another sender of events
- // rapidly flicks between idle/not idle and sends many "I'm done!" messages which are all queued up.
- return;
- }
- if (CheckFullIdle())
- {
- if (CheckReprocessFileList())
- {
- return;
- }
- if (shouldExit)
- {
- // If everything else is done, and it was requested to scan for missing product dependencies, perform that scan now.
- TryScanProductDependencies();
- TryHandleFileRelocation();
- // since we are shutting down, we save the registry and then we quit.
- AZ_Printf(AssetProcessor::ConsoleChannel, "No assets remain in the build queue. Saving the catalog, and then shutting down.\n");
- // stop accepting any further idle messages, as we will shut down - don't want this function to repeat!
- for (const QMetaObject::Connection& connection : m_connectionsToRemoveOnShutdown)
- {
- QObject::disconnect(connection);
- }
- m_connectionsToRemoveOnShutdown.clear();
- // Checking the status of the asset catalog here using qt's signal slot mechanism
- // to ensure that we do not have any pending events in the event loop that can make the catalog dirty again
- QObject::connect(m_assetCatalog, &AssetProcessor::AssetCatalog::AsyncAssetCatalogStatusResponse, this, [&](AssetProcessor::AssetCatalogStatus status)
- {
- if (status == AssetProcessor::AssetCatalogStatus::RequiresSaving)
- {
- AssetProcessor::AssetRegistryRequestBus::Broadcast(&AssetProcessor::AssetRegistryRequests::SaveRegistry);
- }
- AssetProcessor::AssetRegistryRequestBus::Broadcast(&AssetProcessor::AssetRegistryRequests::ValidatePreLoadDependency);
- QuitRequested();
- }, Qt::UniqueConnection);
- QMetaObject::invokeMethod(m_assetCatalog, "AsyncAssetCatalogStatusRequest", Qt::QueuedConnection);
- }
- else
- {
- // we save the registry when we become idle, but we stay running.
- AssetProcessor::AssetRegistryRequestBus::Broadcast(&AssetProcessor::AssetRegistryRequests::SaveRegistry);
- AssetProcessor::AssetRegistryRequestBus::Broadcast(&AssetProcessor::AssetRegistryRequests::ValidatePreLoadDependency);
- }
- }
- }
- WId ApplicationManagerBase::GetWindowId() const
- {
- return {};
- }
- void ApplicationManagerBase::InitBuilderManager()
- {
- AZ_Assert(m_connectionManager != nullptr, "ConnectionManager must be started before the builder manager");
- m_builderManager = new AssetProcessor::BuilderManager(m_connectionManager);
- QObject::connect(m_connectionManager, &ConnectionManager::ConnectionDisconnected, this, [this](unsigned int connId)
- {
- m_builderManager->ConnectionLost(connId);
- });
- }
- void ApplicationManagerBase::ShutdownBuilderManager()
- {
- if (m_builderManager)
- {
- delete m_builderManager;
- m_builderManager = nullptr;
- }
- }
- bool ApplicationManagerBase::InitAssetDatabase(bool ignoreFutureAssetDBVersionError)
- {
- AzToolsFramework::AssetDatabase::AssetDatabaseRequests::Bus::Handler::BusConnect();
- // create or upgrade the asset database here, so that it is already good for the rest of the application and the rest
- // of the application does not have to worry about a failure to upgrade or create it.
- AssetProcessor::AssetDatabaseConnection database;
- if (!database.OpenDatabase(ignoreFutureAssetDBVersionError))
- {
- return false;
- }
- database.CloseDatabase();
- return true;
- }
- void ApplicationManagerBase::ShutDownAssetDatabase()
- {
- AzToolsFramework::AssetDatabase::AssetDatabaseRequests::Bus::Handler::BusDisconnect();
- }
- void ApplicationManagerBase::InitFileProcessor()
- {
- AssetProcessor::ThreadController<AssetProcessor::FileProcessor>* fileProcessorHelper = new AssetProcessor::ThreadController<AssetProcessor::FileProcessor>();
- addRunningThread(fileProcessorHelper);
- m_fileProcessor.reset(fileProcessorHelper->initialize([this]()
- {
- return new AssetProcessor::FileProcessor(m_platformConfiguration);
- }));
- }
- void ApplicationManagerBase::ShutDownFileProcessor()
- {
- m_fileProcessor.reset();
- }
- void ApplicationManagerBase::InitAssetServerHandler()
- {
- m_assetServerHandler = new AssetProcessor::AssetServerHandler();
- m_assetServerHandler->HandleRemoteConfiguration();
- }
- void ApplicationManagerBase::DestroyAssetServerHandler()
- {
- delete m_assetServerHandler;
- m_assetServerHandler = nullptr;
- }
- // IMPLEMENTATION OF -------------- AzToolsFramework::AssetDatabase::AssetDatabaseRequests::Bus::Listener
- bool ApplicationManagerBase::GetAssetDatabaseLocation(AZStd::string& location)
- {
- QDir cacheRoot;
- if (!AssetUtilities::ComputeProjectCacheRoot(cacheRoot))
- {
- location = "assetdb.sqlite";
- }
- location = cacheRoot.absoluteFilePath("assetdb.sqlite").toUtf8().data();
- return true;
- }
- // ------------------------------------------------------------
- bool ApplicationManagerBase::CheckReprocessFileList()
- {
- if (m_reprocessFileList.isEmpty() && m_filesToReprocess.isEmpty())
- {
- return false;
- }
- if (!m_reprocessFileList.isEmpty())
- {
- QFile reprocessFile(m_reprocessFileList);
- m_reprocessFileList.clear();
- if (!reprocessFile.open(QIODevice::ReadOnly))
- {
- AZ_Error("AssetProcessor", false, "Unable to open reprocess file list with path %s.", reprocessFile.fileName().toUtf8().data());
- return false;
- }
- while (!reprocessFile.atEnd())
- {
- m_filesToReprocess.append(reprocessFile.readLine());
- }
- reprocessFile.close();
- if (m_filesToReprocess.empty())
- {
- AZ_Error(
- "AssetProcessor", false, "No files listed to reprocess in the file at path %s.", reprocessFile.fileName().toUtf8().data());
- return false;
- }
- }
- // Queue one at a time, and wait for idle.
- // This makes sure the files in the list are processed in the same order.
- // Otherwise, the order can shuffle based on Asset Processor state.
- m_assetProcessorManager->RequestReprocess(m_filesToReprocess.front());
- m_filesToReprocess.pop_front();
- return true;
- }
- bool ApplicationManagerBase::Activate()
- {
- QDir projectCache;
- if (!AssetUtilities::ComputeProjectCacheRoot(projectCache))
- {
- AZ_Error("AssetProcessor", false, "Could not compute project cache root, please configure your project correctly to launch Asset Processor.");
- return false;
- }
- AZ_TracePrintf(AssetProcessor::ConsoleChannel,
- "AssetProcessor will process assets from project root %s.\n", AssetUtilities::ComputeProjectPath().toUtf8().data());
- // Shutdown if the disk has less than 128MB of free space
- if (!CheckSufficientDiskSpace(128 * 1024 * 1024, true))
- {
- // CheckSufficientDiskSpace reports an error if disk space is low.
- return false;
- }
- bool appInited = InitApplicationServer();
- if (!appInited)
- {
- AZ_Error(
- "AssetProcessor", false, "InitApplicationServer failed, something internal to Asset Processor has failed, please report this to support if you encounter this error.");
- return false;
- }
- const AzFramework::CommandLine* commandLine = nullptr;
- AzFramework::ApplicationRequests::Bus::BroadcastResult(commandLine, &AzFramework::ApplicationRequests::GetCommandLine);
- AZStd::vector<APCommandLineSwitch> commandLineInfo;
- const APCommandLineSwitch Command_ignoreFutureDBError(commandLineInfo, "ignoreFutureAssetDatabaseVersionError", "When not set, if the Asset Processor encounters an Asset Database "
- "with a future version, it will emit an error and shut down. When set, instead it will print the error as a log and erase the Asset Database, then it will proceed to initialize. "
- "This is intended for use with automated builds, and shouldn't be used by individuals. If an individual finds they want to use this flag frequently, the team should "
- "examine their workflows to determine why some team members encounter issues with future versioned Asset Databases.");
- if (!InitAssetDatabase(commandLine->HasSwitch(Command_ignoreFutureDBError.m_switch)))
- {
- // AssetDatabaseConnection::OpenDatabase reports any errors it encounters.
- return false;
- }
- if (!ApplicationManager::Activate())
- {
- // ApplicationManager::Activate() reports any errors it encounters.
- return false;
- }
- if (!InitPlatformConfiguration())
- {
- AZ_Error("AssetProcessor", false, "Failed to Initialize from AssetProcessorPlatformConfig.setreg - check the log files in the logs/ subfolder for more information.");
- return false;
- }
- InitBuilderConfiguration();
- PopulateApplicationDependencies();
- InitAssetProcessorManager(commandLineInfo);
- HandleCommandLineHelp(commandLineInfo);
- AssetBuilderSDK::InitializeSerializationContext();
- AssetBuilderSDK::InitializeBehaviorContext();
- AssetBuilder::InitializeSerializationContext();
- InitFileStateCache();
- InitFileProcessor();
- InitUuidManager();
- // now that apm, statecache, processor, and uuid manager are all alive, hook them up to the signal that AP
- // gives when it modifies an intermediate asset. For the file cache, we hook it up directly so that there is
- // no delay between the notification and the invalidation/creation of its cache entry.
- auto notifyFileStateCache = [this](QString changedFile)
- {
- // the file state cache will get this immediately and inline, it needs to treat it with thread safety.
- m_fileStateCache->UpdateFile(changedFile);
- };
- auto notifyUuidManagerAndFileProcessor = [this](QString changedFile)
- {
- // this is not necessarily time sensitive.
- m_uuidManager->FileChanged(changedFile.toUtf8().constData());
- };
- QObject::connect(
- m_assetProcessorManager,
- &AssetProcessor::AssetProcessorManager::IntermediateAssetCreated,
- this,
- notifyFileStateCache,
- Qt::DirectConnection);
- QObject::connect(
- m_assetProcessorManager,
- &AssetProcessor::AssetProcessorManager::IntermediateAssetCreated,
- this,
- notifyUuidManagerAndFileProcessor,
- Qt::QueuedConnection);
- InitFileMonitor(AZStd::make_unique<FileWatcher>());
- InitAssetScanner();
- InitAssetServerHandler();
- InitRCController();
- InitConnectionManager();
- InitAssetRequestHandler(new AssetProcessor::AssetRequestHandler());
- InitBuilderManager();
- InitSourceControl();
- //We must register all objects that need to be notified if we are shutting down before we install the ctrlhandler
- // inserting in the front so that the application server is notified first
- // and we stop listening for new incoming connections during shutdown
- RegisterObjectForQuit(m_applicationServer, true);
- RegisterObjectForQuit(m_fileProcessor.get());
- RegisterObjectForQuit(m_connectionManager);
- RegisterObjectForQuit(m_assetProcessorManager);
- RegisterObjectForQuit(m_rcController);
- m_connectionsToRemoveOnShutdown << QObject::connect(
- m_assetProcessorManager, &AssetProcessor::AssetProcessorManager::AssetProcessorManagerIdleState,
- this, [this](bool state)
- {
- if (state)
- {
- QMetaObject::invokeMethod(m_rcController, "SetDispatchPaused", Qt::QueuedConnection, Q_ARG(bool, false));
- }
- });
- m_connectionsToRemoveOnShutdown << QObject::connect(
- m_assetProcessorManager, &AssetProcessor::AssetProcessorManager::AssetProcessorManagerIdleState,
- this, &ApplicationManagerBase::OnAssetProcessorManagerIdleState);
- m_connectionsToRemoveOnShutdown << QObject::connect(m_assetProcessorManager, &AssetProcessor::AssetProcessorManager::FinishedAnalysis, this, [this](int count)
- {
- m_remainingAssetsToFinalize = count;
- });
- m_connectionsToRemoveOnShutdown << QObject::connect(
- m_rcController, &AssetProcessor::RCController::BecameIdle,
- this, [this]()
- {
- Q_EMIT CheckAssetProcessorManagerIdleState();
- });
- m_connectionsToRemoveOnShutdown << QObject::connect(
- this, &ApplicationManagerBase::CheckAssetProcessorManagerIdleState,
- m_assetProcessorManager, &AssetProcessor::AssetProcessorManager::CheckAssetProcessorIdleState);
- MakeActivationConnections();
- // only after everyones had a chance to init messages, we start listening.
- if (m_applicationServer)
- {
- if (!m_applicationServer->startListening())
- {
- // startListening reports any errors it encounters.
- return false;
- }
- }
- AssetProcessor::AssetProcessorStatusEntry entry(AssetProcessor::AssetProcessorStatus::Initializing_Builders, 0, QString());
- Q_EMIT AssetProcessorStatusChanged(entry);
- // Start up a thread which will request a builder to start to handle the registration of gems/builders
- // Builder info will be sent back to the AP via the network connection, start up will wait for the info before continuing
- // See ApplicationManagerBase::InitConnectionManager BuilderRegistrationRequest for the resume point here
- // Waiting here is not possible because the message comes back as a network message, which requires the main thread to process it
- // Since execution has to continue, this also means the thread object will go out of scope, so it must be detached before exiting.
- AZStd::thread_desc desc;
- desc.m_name = "Builder Component Registration";
- AZStd::thread builderRegistrationThread(
- desc,
- []()
- {
- AssetProcessor::BuilderRef builder;
- AssetProcessor::BuilderManagerBus::BroadcastResult(builder, &AssetProcessor::BuilderManagerBus::Events::GetBuilder, AssetProcessor::BuilderPurpose::Registration);
- if (!builder)
- {
- AZ_Error("ApplicationManagerBase", false, "AssetBuilder process failed to start. Builder registration cannot complete. Shutting down.");
- AssetProcessor::MessageInfoBus::Broadcast(&AssetProcessor::MessageInfoBus::Events::OnBuilderRegistrationFailure);
- }
- });
- builderRegistrationThread.detach();
- // While waiting for builder registration, start scanning
- GetAssetScanner()->StartScan();
- return true;
- }
- bool ApplicationManagerBase::PostActivate()
- {
- m_connectionManager->LoadConnections();
- InitializeInternalBuilders();
- Q_EMIT OnBuildersRegistered();
- // 25 milliseconds is above the 'while loop' thing that QT does on windows (where small time ticks will spin loop instead of sleep)
- m_ticker = new AzToolsFramework::Ticker(nullptr, 25.0f);
- m_ticker->Start();
- connect(m_ticker, &AzToolsFramework::Ticker::Tick, this, []()
- {
- AZ::SystemTickBus::ExecuteQueuedEvents();
- AZ::SystemTickBus::Broadcast(&AZ::SystemTickEvents::OnSystemTick);
- });
- return true;
- }
- void ApplicationManagerBase::Reflect()
- {
- AZ::SerializeContext* context = nullptr;
- AZ::ComponentApplicationBus::BroadcastResult(context, &AZ::ComponentApplicationBus::Events::GetSerializeContext);
- AZ_Assert(context, "SerializeContext is not available");
- ApplicationManager::Reflect();
- AssetProcessor::UuidManager::Reflect(context);
- }
- void ApplicationManagerBase::CreateQtApplication()
- {
- m_qApp = new QCoreApplication(*m_frameworkApp.GetArgC(), *m_frameworkApp.GetArgV());
- }
- bool ApplicationManagerBase::InitializeInternalBuilders()
- {
- m_internalBuilder = AZStd::make_shared<AssetProcessor::InternalRecognizerBasedBuilder>();
- bool result = m_internalBuilder->Initialize(*this->m_platformConfiguration);
- m_settingsRegistryBuilder = AZStd::make_shared<AssetProcessor::SettingsRegistryBuilder>();
- result = m_settingsRegistryBuilder->Initialize() && result;
- return result;
- }
- static void HandleConditionalRetry(const AssetProcessor::BuilderRunJobOutcome& result, int retryCount, AssetProcessor::BuilderRef& builderRef, AssetProcessor::BuilderPurpose purpose)
- {
- // If a lost connection occured or the process was terminated before a response can be read, and there is another retry to get the
- // response from a Builder, then handle the logic to log and sleep before attempting the retry of the job
- if ((result == AssetProcessor::BuilderRunJobOutcome::LostConnection ||
- result == AssetProcessor::BuilderRunJobOutcome::ProcessTerminated ) && (retryCount <= AssetProcessor::RetriesForJobLostConnection))
- {
- const int delay = 1 << (retryCount-1);
- // Check if we need a new builder, and if so, request a new one
- if (!builderRef->IsValid())
- {
- // If the connection was lost and the process handle is no longer valid, then we need to request a new builder to reprocess the job
- AZStd::string oldBuilderId = builderRef->GetUuid().ToString<AZStd::string>();
- builderRef.release();
- AssetProcessor::BuilderManagerBus::BroadcastResult(builderRef, &AssetProcessor::BuilderManagerBusTraits::GetBuilder, purpose);
- if (builderRef)
- {
- AZ_TracePrintf(AssetProcessor::ConsoleChannel, "Lost connection to builder %s. Retrying with a new builder %s (Attempt %d with %d second delay)",
- oldBuilderId.c_str(),
- builderRef->GetUuid().ToString<AZStd::string>().c_str(),
- retryCount+1,
- delay);
- }
- else
- {
- AZ_TracePrintf(AssetProcessor::ConsoleChannel, "Lost connection to builder %s and no further builders are available. Job will not retry.\n",
- oldBuilderId.c_str());
- // if we failed to get a builder ref, it means we're probably
- // shutting down, in which case we do not want to do an exponential
- // backoff delay and need to return immediately.
- return;
- }
- }
- else
- {
- AZ_TracePrintf(AssetProcessor::ConsoleChannel, "Lost connection to builder %s. Retrying (Attempt %d with %d second delay)",
- builderRef->GetUuid().ToString<AZStd::string>().c_str(),
- retryCount+1,
- delay);
- }
- AZStd::this_thread::sleep_for(AZStd::chrono::seconds(delay));
- }
- }
- void ApplicationManagerBase::RegisterBuilderInformation(const AssetBuilderSDK::AssetBuilderDesc& builderDesc)
- {
- if (!builderDesc.IsExternalBuilder())
- {
- // Create Job Function validation
- AZ_Error(
- AssetProcessor::ConsoleChannel, builderDesc.m_createJobFunction,
- "Create Job Function (m_createJobFunction) for %s builder is empty.\n", builderDesc.m_name.c_str());
- // Process Job Function validation
- AZ_Error(
- AssetProcessor::ConsoleChannel, builderDesc.m_processJobFunction,
- "Process Job Function (m_processJobFunction) for %s builder is empty.\n", builderDesc.m_name.c_str());
- }
- // Bus ID validation
- AZ_Error(AssetProcessor::ConsoleChannel,
- !builderDesc.m_busId.IsNull(),
- "Bus ID for %s builder is empty.\n",
- builderDesc.m_name.c_str());
- AssetBuilderSDK::AssetBuilderDesc modifiedBuilderDesc = builderDesc;
- // Allow for overrides defined in a BuilderConfig.ini file to update our code defined default values
- AssetProcessor::BuilderConfigurationRequestBus::Broadcast(&AssetProcessor::BuilderConfigurationRequests::UpdateBuilderDescriptor, builderDesc.m_name, modifiedBuilderDesc);
- if (builderDesc.IsExternalBuilder())
- {
- // We're going to override the createJob function so we can run it externally in AssetBuilder, rather than having it run
- // inside the AP
- modifiedBuilderDesc.m_createJobFunction =
- [this](const AssetBuilderSDK::CreateJobsRequest& request, AssetBuilderSDK::CreateJobsResponse& response)
- {
- AssetProcessor::BuilderRef builderRef;
- AssetProcessor::BuilderManagerBus::BroadcastResult(builderRef, &AssetProcessor::BuilderManagerBusTraits::GetBuilder, AssetProcessor::BuilderPurpose::CreateJobs);
- if (builderRef)
- {
- int retryCount = 0;
- AssetProcessor::BuilderRunJobOutcome result;
- if (this->InitiatedShutdown())
- {
- return; // exit early if you're shutting down!
- }
- do
- {
- retryCount++;
- result = builderRef->RunJob<AssetBuilder::CreateJobsNetRequest, AssetBuilder::CreateJobsNetResponse>(
- request, response, s_MaximumCreateJobsTimeSeconds, "create", "", nullptr);
- HandleConditionalRetry(result, retryCount, builderRef, AssetProcessor::BuilderPurpose::CreateJobs);
- } while ((result == AssetProcessor::BuilderRunJobOutcome::LostConnection ||
- result == AssetProcessor::BuilderRunJobOutcome::ProcessTerminated) &&
- retryCount <= AssetProcessor::RetriesForJobLostConnection);
- }
- else
- {
- AZ_Error("AssetProcessor", false, "Failed to retrieve a valid builder to process job");
- }
- };
- const bool debugOutput = m_assetProcessorManager->GetBuilderDebugFlag();
- // Also override the processJob function to run externally
- modifiedBuilderDesc.m_processJobFunction =
- [this, debugOutput](const AssetBuilderSDK::ProcessJobRequest& request, AssetBuilderSDK::ProcessJobResponse& response)
- {
- AssetBuilderSDK::JobCancelListener jobCancelListener(request.m_jobId);
- AssetProcessor::BuilderRef builderRef;
- AssetProcessor::BuilderManagerBus::BroadcastResult(builderRef, &AssetProcessor::BuilderManagerBusTraits::GetBuilder, AssetProcessor::BuilderPurpose::ProcessJob);
- if (builderRef)
- {
- if (debugOutput)
- {
- AssetProcessor::BuilderManagerBus::Broadcast(
- &AssetProcessor::BuilderManagerBusTraits::AddAssetToBuilderProcessedList, builderRef->GetUuid(),
- request.m_fullPath);
- }
- int retryCount = 0;
- AssetProcessor::BuilderRunJobOutcome result;
- do
- {
- if (jobCancelListener.IsCancelled())
- {
- // do not attempt to continue to retry or spawn
- // new builders during shut down.
- break;
- }
- if (this->InitiatedShutdown())
- {
- return; // exit early if you're shutting down!
- }
- retryCount++;
- result = builderRef->RunJob<AssetBuilder::ProcessJobNetRequest, AssetBuilder::ProcessJobNetResponse>(
- request, response, s_MaximumProcessJobsTimeSeconds, "process", "", &jobCancelListener, request.m_tempDirPath);
- HandleConditionalRetry(result, retryCount, builderRef, AssetProcessor::BuilderPurpose::ProcessJob);
- } while ((result == AssetProcessor::BuilderRunJobOutcome::LostConnection ||
- result == AssetProcessor::BuilderRunJobOutcome::ProcessTerminated) &&
- retryCount <= AssetProcessor::RetriesForJobLostConnection);
- }
- else
- {
- AZ_Error("AssetProcessor", false, "Failed to retrieve a valid builder to process job");
- }
- };
- }
- if (m_builderDescMap.find(modifiedBuilderDesc.m_busId) != m_builderDescMap.end())
- {
- AZ_Warning(AssetProcessor::DebugChannel, false, "Uuid for %s builder is already registered.\n", modifiedBuilderDesc.m_name.c_str());
- return;
- }
- if (m_builderNameToId.find(modifiedBuilderDesc.m_name) != m_builderNameToId.end())
- {
- AZ_Warning(AssetProcessor::DebugChannel, false, "Duplicate builder detected. A builder named '%s' is already registered.\n", modifiedBuilderDesc.m_name.c_str());
- return;
- }
- AZStd::sort(modifiedBuilderDesc.m_patterns.begin(), modifiedBuilderDesc.m_patterns.end(),
- [](const AssetBuilderSDK::AssetBuilderPattern& first, const AssetBuilderSDK::AssetBuilderPattern& second)
- {
- return first.ToString() < second.ToString();
- });
- m_builderDescMap[modifiedBuilderDesc.m_busId] = modifiedBuilderDesc;
- m_builderNameToId[modifiedBuilderDesc.m_name] = modifiedBuilderDesc.m_busId;
- for (const AssetBuilderSDK::AssetBuilderPattern& pattern : modifiedBuilderDesc.m_patterns)
- {
- AssetUtilities::BuilderFilePatternMatcher patternMatcher(pattern, modifiedBuilderDesc.m_busId);
- m_matcherBuilderPatterns.push_back(patternMatcher);
- }
- }
- void ApplicationManagerBase::RegisterComponentDescriptor(AZ::ComponentDescriptor* descriptor)
- {
- ApplicationManager::RegisterComponentDescriptor(descriptor);
- if (m_currentExternalAssetBuilder)
- {
- m_currentExternalAssetBuilder->RegisterComponentDesc(descriptor);
- }
- else
- {
- AZ_Warning(AssetProcessor::DebugChannel, false, "Component description can only be registered during component activation.\n");
- }
- }
- void ApplicationManagerBase::BuilderLog(const AZ::Uuid& builderId, const char* message, ...)
- {
- va_list args;
- va_start(args, message);
- BuilderLogV(builderId, message, args);
- va_end(args);
- }
- void ApplicationManagerBase::BuilderLogV(const AZ::Uuid& builderId, const char* message, va_list list)
- {
- AZStd::string builderName;
- if (m_builderDescMap.find(builderId) != m_builderDescMap.end())
- {
- char messageBuffer[1024];
- azvsnprintf(messageBuffer, 1024, message, list);
- AZ_TracePrintf(AssetProcessor::ConsoleChannel, "Builder name : %s Message : %s.\n", m_builderDescMap[builderId].m_name.c_str(), messageBuffer);
- }
- else
- {
- // asset processor does not know about this builder id
- AZ_TracePrintf(AssetProcessor::ConsoleChannel, "AssetProcessor does not know about the builder id: %s. \n", builderId.ToString<AZStd::string>().c_str());
- }
- }
- bool ApplicationManagerBase::FindBuilderInformation(const AZ::Uuid& builderGuid, AssetBuilderSDK::AssetBuilderDesc& descriptionOut)
- {
- auto iter = m_builderDescMap.find(builderGuid);
- if (iter != m_builderDescMap.end())
- {
- descriptionOut = iter->second;
- return true;
- }
- else
- {
- return false;
- }
- }
- void ApplicationManagerBase::UnRegisterBuilderDescriptor(const AZ::Uuid& builderId)
- {
- if (m_builderDescMap.find(builderId) == m_builderDescMap.end())
- {
- AZ_Warning(AssetProcessor::DebugChannel, false, "Cannot unregister builder descriptor for Uuid %s, not currently registered.\n", builderId.ToString<AZStd::string>().c_str());
- return;
- }
- // Remove from the map
- AssetBuilderSDK::AssetBuilderDesc& descToUnregister = m_builderDescMap[builderId];
- AZStd::string descNameToUnregister = descToUnregister.m_name;
- descToUnregister.m_createJobFunction.clear();
- descToUnregister.m_processJobFunction.clear();
- m_builderDescMap.erase(builderId);
- m_builderNameToId.erase(descNameToUnregister);
- // Remove the matcher build pattern
- for (auto remover = this->m_matcherBuilderPatterns.begin();
- remover != this->m_matcherBuilderPatterns.end();
- remover++)
- {
- if (remover->GetBuilderDescID() == builderId)
- {
- auto deleteIter = remover;
- remover++;
- this->m_matcherBuilderPatterns.erase(deleteIter);
- }
- }
- }
- void ApplicationManagerBase::GetMatchingBuildersInfo(const AZStd::string& assetPath, AssetProcessor::BuilderInfoList& builderInfoList)
- {
- AZStd::set<AZ::Uuid> uniqueBuilderDescIDs;
- for (AssetUtilities::BuilderFilePatternMatcher& matcherPair : m_matcherBuilderPatterns)
- {
- if (uniqueBuilderDescIDs.find(matcherPair.GetBuilderDescID()) != uniqueBuilderDescIDs.end())
- {
- continue;
- }
- if (matcherPair.MatchesPath(assetPath))
- {
- const AssetBuilderSDK::AssetBuilderDesc& builderDesc = m_builderDescMap[matcherPair.GetBuilderDescID()];
- uniqueBuilderDescIDs.insert(matcherPair.GetBuilderDescID());
- builderInfoList.push_back(builderDesc);
- }
- }
- }
- void ApplicationManagerBase::GetAllBuildersInfo(AssetProcessor::BuilderInfoList& builderInfoList)
- {
- for (const auto &builderPair : m_builderDescMap)
- {
- builderInfoList.push_back(builderPair.second);
- }
- }
- bool ApplicationManagerBase::OnError(const char* /*window*/, const char* /*message*/)
- {
- // We don't need to print the message to stdout, the trace system will already do that
- return true;
- }
- bool ApplicationManagerBase::CheckSufficientDiskSpace(qint64 requiredSpace, bool shutdownIfInsufficient)
- {
- QDir cacheDir;
- if (!AssetUtilities::ComputeProjectCacheRoot(cacheDir))
- {
- AZ_Error(
- "AssetProcessor",
- false,
- "Could not compute project cache root, please configure your project correctly to launch Asset Processor.");
- return false;
- }
- QString savePath = cacheDir.absolutePath();
- if (!QDir(savePath).exists())
- {
- // GetFreeDiskSpace will fail if the path does not exist
- QDir dir;
- dir.mkpath(savePath);
- }
- qint64 bytesFree = 0;
- [[maybe_unused]] bool result = AzToolsFramework::ToolsFileUtils::GetFreeDiskSpace(savePath, bytesFree);
- AZ_Assert(result, "Unable to determine the amount of free space on drive containing path (%s).", savePath.toUtf8().constData());
- if (bytesFree < requiredSpace + s_ReservedDiskSpaceInBytes)
- {
- if (shutdownIfInsufficient)
- {
- AZ_Error(AssetProcessor::ConsoleChannel, false, "There is insufficient disk space to continue running. AssetProcessor will now exit");
- QMetaObject::invokeMethod(this, "QuitRequested", Qt::QueuedConnection);
- }
- return false;
- }
- return true;
- }
- void ApplicationManagerBase::RemoveOldTempFolders()
- {
- QDir rootDir;
- if (!AssetUtilities::ComputeAssetRoot(rootDir))
- {
- return;
- }
- QString startFolder;
- if (auto settingsRegistry = AZ::SettingsRegistry::Get(); settingsRegistry != nullptr)
- {
- if (AZ::IO::Path userPath; settingsRegistry->Get(userPath.Native(), AZ::SettingsRegistryMergeUtils::FilePathKey_ProjectUserPath))
- {
- startFolder = QString::fromUtf8(userPath.c_str(), aznumeric_cast<int>(userPath.Native().size()));
- }
- }
- QDir root;
- if (!AssetUtilities::CreateTempRootFolder(startFolder, root))
- {
- return;
- }
- // We will remove old temp folders if either their modified time is older than the cutoff time or
- // if the total number of temp folders have exceeded the maximum number of temp folders.
- QFileInfoList entries = root.entryInfoList(QDir::Dirs | QDir::NoDotAndDotDot, QDir::Time); // sorting by modification time
- int folderCount = 0;
- bool removeFolder = false;
- QDateTime cutoffTime = QDateTime::currentDateTime().addDays(-7);
- for (const QFileInfo& entry : entries)
- {
- if (!entry.fileName().startsWith("JobTemp-"))
- {
- continue;
- }
- // Since we are sorting the folders list from latest to oldest, we will either be in a state where we have to delete all the remaining folders or not
- // because either we have reached the folder limit or reached the cutoff date limit.
- removeFolder = removeFolder || (folderCount++ >= s_MaximumTempFolders) ||
- (entry.lastModified() < cutoffTime);
- if (removeFolder)
- {
- QDir dir(entry.absoluteFilePath());
- dir.removeRecursively();
- }
- }
- }
- void ApplicationManagerBase::ConnectivityStateChanged(const AzToolsFramework::SourceControlState /*newState*/)
- {
- Q_EMIT SourceControlReady();
- }
- void ApplicationManagerBase::OnBuilderRegistrationFailure()
- {
- QMetaObject::invokeMethod(this, "QuitRequested");
- }
- void ApplicationManagerBase::OnAssetProcessorManagerIdleState(bool isIdle)
- {
- // these can come in during shutdown.
- if (InitiatedShutdown())
- {
- return;
- }
- if (isIdle)
- {
- if (!m_AssetProcessorManagerIdleState)
- {
- // We want to again ask the APM for the idle state just incase it goes from idle to non idle in between
- Q_EMIT CheckAssetProcessorManagerIdleState();
- }
- else
- {
- CheckForIdle();
- return;
- }
- }
- if (isIdle != m_AssetProcessorManagerIdleState)
- {
- Q_EMIT AssetProcesserManagerIdleStateChange(isIdle);
- }
- m_AssetProcessorManagerIdleState = isIdle;
- }
- bool ApplicationManagerBase::IsAssetProcessorManagerIdle() const
- {
- return m_AssetProcessorManagerIdleState;
- }
- void ApplicationManagerBase::OnActiveJobsCountChanged(unsigned int count)
- {
- AssetProcessor::AssetProcessorStatusEntry entry(AssetProcessor::AssetProcessorStatus::Processing_Jobs, count);
- Q_EMIT AssetProcessorStatusChanged(entry);
- }
|