[SharedCache] Allow project databases to be stored in a separate folder

However the primary file will need to be selected each time you open, for that to be resolved we need to use project file UUID's or the cache entry UUID's themselves to traverse all project files

Author: emesare

view/sharedcache/core/SharedCacheView.cpp

@@ -811,6 +811,19 @@ bool SharedCacheView::InitController()
 	}
 	std::string primaryFileDir = std::filesystem::path(*primaryFilePath).parent_path().string();
 
+	// Get the primary project file from the current files project.
+	// This is required to allow selecting a primary file in a different directory. Otherwise, we search the current database directory.
+	Ref<ProjectFile> primaryProjectFile = nullptr;
+	auto currentProjectFile = GetFile()->GetProjectFile();
+	if (currentProjectFile)
+		primaryProjectFile = currentProjectFile->GetProject()->GetFileByPathOnDisk(*primaryFilePath);
+
+	if (!IsSameFolderForFile(primaryProjectFile, currentProjectFile))
+	{
+		// TODO: Remove this restriction using stored cache UUID's and a fast project file search.
+		m_logger->LogWarn("Because the primary file is in a different project folder you will need to select it on every open, consider moving the database file into the same folder.");
+	}
+
 	// OK, we have the primary shared cache file, now let's add the entries.
 	auto sharedCacheBuilder = SharedCacheBuilder(this);
 	sharedCacheBuilder.SetPrimaryFileName(m_primaryFileName);
@@ -827,8 +840,8 @@ bool SharedCacheView::InitController()
 		// After this we should have all the mappings available as well.
 		auto startTime = std::chrono::high_resolution_clock::now();
 		sharedCacheBuilder.AddDirectory(primaryFileDir);
-		if (auto projectFile = GetFile()->GetProjectFile())
-			sharedCacheBuilder.AddProjectFolder(projectFile->GetFolder());
+		if (primaryProjectFile)
+			sharedCacheBuilder.AddProjectFolder(primaryProjectFile->GetFolder());
 		auto totalEntries = sharedCacheBuilder.GetCache().GetEntries().size();
 		auto endTime = std::chrono::high_resolution_clock::now();
 		std::chrono::duration<double> elapsed = endTime - startTime;

view/sharedcache/core/Utility.cpp

@@ -137,6 +137,15 @@ std::string BaseFileName(const std::string& path)
 	return path;
 }
 
+bool IsSameFolderForFile(Ref<ProjectFile> a, Ref<ProjectFile> b)
+{
+	if (!a && !b)
+		return true;
+	if (a && b)
+		return IsSameFolder(a->GetFolder(), b->GetFolder());
+	return false;
+}
+
 bool IsSameFolder(Ref<ProjectFolder> a, Ref<ProjectFolder> b)
 {
 	if (!a && !b)

view/sharedcache/core/Utility.h

@@ -40,6 +40,7 @@ void ApplySymbol(BinaryNinja::Ref<BinaryNinja::BinaryView> view, BinaryNinja::Re
 // /blah/foo/bar/libObjCThing.dylib -> libObjCThing.dylib
 std::string BaseFileName(const std::string& path);
 
+bool IsSameFolderForFile(BinaryNinja::Ref<BinaryNinja::ProjectFile> a, BinaryNinja::Ref<BinaryNinja::ProjectFile> b);
 bool IsSameFolder(BinaryNinja::Ref<BinaryNinja::ProjectFolder> a, BinaryNinja::Ref<BinaryNinja::ProjectFolder> b);
 
 // Represents a range of addresses [start, end).