Fix plugin update/uninstall process on MacOS

- Unload bundle executable when updating or uninstalling a plugin
- Use `std::filesystem` for copy operations

Author: anjaldoshi

Source/Processors/PluginManager/PluginManager.cpp

@@ -36,15 +36,16 @@
 
 
 static inline void closeHandle(decltype(LoadedLibInfo::handle) handle) {
-    if (handle) {
+	if (handle) {
 #ifdef _WIN32
-        FreeLibrary(handle);
+		reeLibrary(handle);
 #elif defined(__APPLE__)
-        CFRelease(handle);
+		CF::CFBundleUnloadExecutable(handle);
+		CF::CFRelease(handle);
 #else
-        dlclose(handle);
+		dlclose(handle);
 #endif
-    }
+	}
 }
 
 
@@ -228,30 +229,34 @@ void PluginManager::loadPlugins(const File &pluginPath) {
  */
 
 int PluginManager::loadPlugin(const String& pluginLoc) {
-	/*
-	Load in the selected processor. This takes the
-	dynamic object (.so) and copies it into RAM
-	Dynamic linker requires a C-style string, so we
-	we have to convert first.
-	*/
-	const char* processorLocCString = static_cast<const char*>(pluginLoc.toUTF8());
 
 #ifdef _WIN32
 	HINSTANCE handle;
 	const wchar_t* processorLocLPCWSTR = pluginLoc.toWideCharPointer();
 	handle = LoadLibraryW(processorLocLPCWSTR);
 #elif defined(__APPLE__)
-    CF::CFURLRef bundleURL = CF::CFURLCreateFromFileSystemRepresentation(CF::kCFAllocatorDefault,
-                                                                 reinterpret_cast<const CF::UInt8 *>(processorLocCString),
-                                                                 strlen(processorLocCString),
-                                                                 true);
-    assert(bundleURL);
-    CF::CFBundleRef handle = CF::CFBundleCreate(CF::kCFAllocatorDefault, bundleURL);
-    CFRelease(bundleURL);
+	CF::CFStringRef processorLocCFString = pluginLoc.toCFString();
+	CF::CFURLRef bundleURL = CF::CFURLCreateWithFileSystemPath(CF::kCFAllocatorDefault, 
+															   processorLocCFString,
+															   CF::kCFURLPOSIXPathStyle,
+															   true);
+															   
+	assert(bundleURL);
+	CF::CFBundleRef handle = CF::CFBundleCreate(CF::kCFAllocatorDefault, bundleURL);
+	CF::CFRelease(bundleURL);
+	CF::CFRelease(processorLocCFString);
 #else
 	// Clear errors
 	dlerror();
 
+	/*
+	Load in the selected processor. This takes the
+	dynamic object (.so) and copies it into RAM
+	Dynamic linker requires a C-style string, so we
+	we have to convert first.
+	*/
+	const char* processorLocCString = static_cast<const char*>(pluginLoc.toUTF8());
+
 	/*
 	Changing this to resolve all variables immediately upon loading.
 	This will provide for quicker testing of the custom
@@ -596,7 +601,7 @@ bool PluginManager::removePlugin(String libName)
 		{
 			case Plugin::PROCESSOR:
 			{
-				LOGD("Removing processor plugin");
+				LOGD("Removing processor plugin: ", pInfo.processor.name);
 				for(int j = 0; j < processorPlugins.size(); j++)
 				{
 					if(processorPlugins[j].name == pInfo.processor.name)
@@ -612,7 +617,7 @@ bool PluginManager::removePlugin(String libName)
 			}
 			case Plugin::RECORD_ENGINE:
 			{
-				LOGD("Removing record engine plugin");
+				LOGD("Removing record engine plugin: ", pInfo.recordEngine.name);
 				for(int j = 0; j < recordEnginePlugins.size(); j++)
 				{
 					if(recordEnginePlugins[j].name == pInfo.recordEngine.name)
@@ -628,7 +633,7 @@ bool PluginManager::removePlugin(String libName)
 			}
 			case Plugin::DATA_THREAD:
 			{
-				LOGD("Removing data thread plugin");
+				LOGD("Removing data thread plugin: ", pInfo.dataThread.name);
 				for(int j = 0; j < dataThreadPlugins.size(); j++)
 				{
 					if(dataThreadPlugins[j].name == pInfo.dataThread.name)
@@ -644,7 +649,7 @@ bool PluginManager::removePlugin(String libName)
 			}
 			case Plugin::FILE_SOURCE:
 			{
-				LOGD("Removing file source plugin");
+				LOGD("Removing file source plugin: ", pInfo.fileSource.name);
 				for(int j = 0; j < fileSourcePlugins.size(); j++)
 				{
 					if(fileSourcePlugins[j].name == pInfo.fileSource.name)
@@ -660,7 +665,7 @@ bool PluginManager::removePlugin(String libName)
 			}
 			default:
 			{
-				LOGE("Inavlid plugin");
+				LOGE("Invalid plugin");
 				break;
 			}
 		}

Source/UI/PluginInstaller.cpp

@@ -35,6 +35,7 @@
 #include <Windows.h>
 #endif
 
+namespace fs = std::filesystem;
 
 //-----------------------------------------------------------------------
 static inline File getPluginsDirectory() {
@@ -996,9 +997,17 @@ void PluginInfoComponent::buttonClicked(Button* button)
 		if(!uninstallPlugin(pInfo.pluginName))
 		{
 			LOGE("Failed to uninstall ", pInfo.displayName);
+			AlertWindow::showMessageBoxAsync(AlertWindow::WarningIcon, 
+										"[Plugin Installer] " + pInfo.displayName, 
+										"Failed to uninstall " + pInfo.displayName);
 		}
 		else
+		{
 			LOGC(pInfo.displayName, " uninstalled successfully!");
+			AlertWindow::showMessageBoxAsync(AlertWindow::InfoIcon, 
+										"[Plugin Installer] " + pInfo.displayName, 
+										pInfo.displayName + " uninstalled successfully");
+		}
 	}
 	else if (button == &documentationButton)
 	{
@@ -1049,7 +1058,7 @@ void PluginInfoComponent::run()
 	{
 		AlertWindow::showMessageBoxAsync(AlertWindow::WarningIcon, 
 									"[Plugin Installer] ERROR", 
-									"Unable to current installed version of " + pInfo.displayName + "... Plugin update failed.");
+									"Unable to remove current installed version of " + pInfo.displayName + "... Plugin update failed.");
 
 		LOGE("Unable to remove current installed version of " + pInfo.displayName + "... Plugin update failed.");
 		return;
@@ -1386,7 +1395,7 @@ bool PluginInfoComponent::uninstallPlugin(const String& plugin)
 
 	//delete plugin file
 	File pluginFile = getPluginsDirectory().getChildFile(dllName);
-	if(!pluginFile.deleteFile())
+	if(!pluginFile.deleteRecursively())
 	{
 		LOGE("Unable to delete plugin file ", pluginFile.getFullPathName(), " ... Please remove it manually!!");
 		return false;
@@ -1502,47 +1511,77 @@ int PluginInfoComponent::downloadPlugin(const String& plugin, const String& vers
 		}
 	}
 
-	// Uncompress plugin zip file in temp directory
-	String pluginDllPath;
-
+	// Create temp directory to uncompress the plugin
 	File tempDir = File::getSpecialLocation(File::tempDirectory).getChildFile("open-ephys");
 	tempDir.createDirectory();
 
-	pluginZip.uncompressTo(tempDir);
+	// Delete any existing files in temp directory
+	if (tempDir.getChildFile("plugins").exists())
+		tempDir.getChildFile("plugins").deleteRecursively();
 
-	if(!isDependency)
+	if (tempDir.getChildFile("shared").exists())
+		tempDir.getChildFile("shared").deleteRecursively();
+
+	// Uncompress the plugin zip file to temp directory
+	juce::Result res = pluginZip.uncompressTo(tempDir);
+
+	if (res.failed())
 	{
-		// copy plugin DLL from temp directory to actual location
-		bool copySuccess = tempDir.getChildFile("plugins").getChildFile(dllName)
-							.copyFileTo(getPluginsDirectory().getChildFile(dllName));
+		LOGE("Failed to uncompress plugin zip file: ", res.getErrorMessage());
+		tempDir.deleteRecursively();
+		pluginFile.deleteFile();
+		return 2;
+	}
+
+	String pluginDllPath;
 
-		File dllFile = getPluginsDirectory().getChildFile(dllName);
-		pluginDllPath = dllFile.getFullPathName();
+	// copy plugin DLL from temp directory to actual location
+	if(!isDependency)
+	{
+		fs::path tempPluginPath = tempDir.getChildFile("plugins").getFullPathName().toStdString();
+		fs::path destPluginPath = getPluginsDirectory().getFullPathName().toStdString();
 
-		if(!copySuccess && !dllFile.exists())
+		// Copy only if plugin file exists
+		if(fs::exists(tempPluginPath))
+		{	
+			const auto copyOptions = fs::copy_options::overwrite_existing
+									| fs::copy_options::recursive;
+			try {
+				fs::copy(tempPluginPath, destPluginPath, copyOptions);
+			} catch(fs::filesystem_error& e) {
+				LOGE("Could not copy plugin files: \"", e.what(), "\"");
+				tempDir.deleteRecursively();
+				pluginFile.deleteFile();
+				return 2;
+			}
+		}
+		else
 		{
-			LOGE("Unable to copy necessary plugin files!");
+			LOGE("Plugin file not found in temp directory!!");
+			tempDir.deleteRecursively();
 			pluginFile.deleteFile();
 			return 2;
 		}
+
+		pluginDllPath = getPluginsDirectory().getChildFile(dllName).getFullPathName();
 	}
 
 	/* Copy shared files 
 	*  Uses C++17's filesystem::copy functionality to allow copying symlinks
 	*/
-	std::filesystem::path tempSharedPath = tempDir.getChildFile("shared").getFullPathName().toStdString();
-	std::filesystem::path destSharedPath = getSharedDirectory().getFullPathName().toStdString();
+	fs::path tempSharedPath = tempDir.getChildFile("shared").getFullPathName().toStdString();
+	fs::path destSharedPath = getSharedDirectory().getFullPathName().toStdString();
 
 	// Copy only if shared files exist
-	if(std::filesystem::exists(tempSharedPath))
+	if(fs::exists(tempSharedPath))
 	{
-		const auto copyOptions = std::filesystem::copy_options::overwrite_existing
-								| std::filesystem::copy_options::recursive
-								| std::filesystem::copy_options::copy_symlinks
+		const auto copyOptions = fs::copy_options::overwrite_existing
+								| fs::copy_options::recursive
+								| fs::copy_options::copy_symlinks
 								;
 		try {
-			std::filesystem::copy(tempSharedPath, destSharedPath, copyOptions);
-		} catch(std::filesystem::filesystem_error& e) {
+			fs::copy(tempSharedPath, destSharedPath, copyOptions);
+		} catch(fs::filesystem_error& e) {
 			LOGE("Could not copy shared files: \"", e.what(), "\"");
 		}
 	}