implement sidebar integration for GNOME Nautilus

Author: infeo

pom.xml

@@ -40,7 +40,7 @@
 
 		<!-- runtime dependencies -->
 
-		<api.version>1.3.1</api.version>
+		<api.version>1.4.0-sidebar</api.version>
 		<secret-service.version>2.0.1-alpha</secret-service.version>
 		<kdewallet.version>1.4.0</kdewallet.version>
 		<slf4j.version>2.0.13</slf4j.version>

src/main/java/module-info.java

@@ -1,6 +1,8 @@
+import org.cryptomator.integrations.sidebar.SidebarService;
 import org.cryptomator.integrations.keychain.KeychainAccessProvider;
 import org.cryptomator.integrations.revealpath.RevealPathService;
 import org.cryptomator.integrations.tray.TrayMenuController;
+import org.cryptomator.linux.sidebar.NautilusSidebarService;
 import org.cryptomator.linux.keychain.KDEWalletKeychainAccess;
 import org.cryptomator.linux.keychain.SecretServiceKeychainAccess;
 import org.cryptomator.linux.revealpath.DBusSendRevealPathService;
@@ -17,6 +19,7 @@
 	provides KeychainAccessProvider with SecretServiceKeychainAccess, KDEWalletKeychainAccess;
 	provides RevealPathService with DBusSendRevealPathService;
 	provides TrayMenuController with AppindicatorTrayMenuController;
+	provides SidebarService with NautilusSidebarService;
 
 	opens org.cryptomator.linux.tray to org.cryptomator.integrations.api;
 }

src/main/java/org/cryptomator/linux/sidebar/NautilusSidebarService.java

@@ -0,0 +1,75 @@
+package org.cryptomator.linux.sidebar;
+
+import org.cryptomator.integrations.sidebar.SidebarService;
+import org.cryptomator.integrations.sidebar.SidebarServiceException;
+
+import java.io.IOException;
+import java.nio.charset.StandardCharsets;
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.nio.file.StandardCopyOption;
+import java.nio.file.StandardOpenOption;
+import java.util.concurrent.locks.Lock;
+import java.util.concurrent.locks.ReentrantReadWriteLock;
+
+public class NautilusSidebarService implements SidebarService {
+
+	private static final int MAX_FILE_SIZE = 4096;
+	private static final Path BOOKMARKS_FILE = Path.of(System.getProperty("user.home"), ".config/gtk-3.0/bookmarks");
+	private static final Path TMP_FILE = BOOKMARKS_FILE.resolveSibling("bookmarks.cryptomator.tmp");
+	private static final Lock BOOKMARKS_LOCK = new ReentrantReadWriteLock().writeLock();
+
+	@Override
+	public SidebarEntry add(Path target, String displayName) throws SidebarServiceException {
+		String entryLine = "file://" + target.toAbsolutePath() + " " + displayName;
+		try {
+			BOOKMARKS_LOCK.lock();
+			if (Files.size(BOOKMARKS_FILE) > MAX_FILE_SIZE) {
+				throw new IOException("File %s exceeds size of %d bytes".formatted(BOOKMARKS_FILE, MAX_FILE_SIZE));
+			}
+			//by reading all lines, we ensure that each line is terminated with EOL
+			var entries = Files.readAllLines(BOOKMARKS_FILE, StandardCharsets.UTF_8);
+			entries.add(entryLine);
+			Files.write(TMP_FILE, entries, StandardCharsets.UTF_8, StandardOpenOption.WRITE, StandardOpenOption.CREATE, StandardOpenOption.TRUNCATE_EXISTING);
+			Files.move(TMP_FILE, BOOKMARKS_FILE, StandardCopyOption.REPLACE_EXISTING, StandardCopyOption.ATOMIC_MOVE);
+			return new NautilusSidebarEntry(entryLine);
+		} catch (IOException e) {
+			throw new SidebarServiceException("Adding entry to Nautilus bookmarks file failed.", e);
+		} finally {
+			BOOKMARKS_LOCK.unlock();
+		}
+	}
+
+	static class NautilusSidebarEntry implements SidebarEntry {
+
+		private final String line;
+		private volatile boolean isRemoved = false;
+
+		NautilusSidebarEntry(String line) {
+			this.line = line;
+		}
+
+		@Override
+		public void remove() throws SidebarServiceException {
+			try {
+				BOOKMARKS_LOCK.lock();
+				if (isRemoved) {
+					return;
+				}
+				if (Files.size(BOOKMARKS_FILE) > MAX_FILE_SIZE) {
+					throw new IOException("File %s exceeds size of %d bytes".formatted(BOOKMARKS_FILE, MAX_FILE_SIZE));
+				}
+				var entries = Files.readAllLines(BOOKMARKS_FILE);
+				if (entries.remove(line)) {
+					Files.write(TMP_FILE, entries, StandardCharsets.UTF_8, StandardOpenOption.WRITE, StandardOpenOption.CREATE, StandardOpenOption.TRUNCATE_EXISTING);
+					Files.move(TMP_FILE, BOOKMARKS_FILE, StandardCopyOption.REPLACE_EXISTING, StandardCopyOption.ATOMIC_MOVE);
+				}
+				isRemoved = true;
+			} catch (IOException e) {
+				throw new SidebarServiceException("Removing entry from Nautilus bookmarks faile failed", e);
+			} finally {
+				BOOKMARKS_LOCK.unlock();
+			}
+		}
+	}
+}

src/main/resources/META-INF/services/org.cryptomator.integrations.sidebar.SidebarService

@@ -0,0 +1 @@
+org.cryptomator.linux.sidebar.NautilusSidebarService

src/test/java/org/cryptomator/linux/filemanagersidebar/NautilusSidebarServiceIT.java

@@ -0,0 +1,23 @@
+package org.cryptomator.linux.filemanagersidebar;
+
+import org.cryptomator.integrations.sidebar.SidebarServiceException;
+import org.cryptomator.linux.sidebar.NautilusSidebarService;
+import org.junit.jupiter.api.Disabled;
+import org.junit.jupiter.api.DisplayName;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.io.TempDir;
+
+import java.nio.file.Path;
+import java.time.Duration;
+
+public class NautilusSidebarServiceIT {
+
+	@Test
+	@DisplayName("Adds for 20s an entryto the Nautilus sidebar")
+	@Disabled
+	public void testSidebarIntegration(@TempDir Path tmpdir) throws SidebarServiceException, InterruptedException {
+		var entry = new NautilusSidebarService().add(tmpdir, "integrations-linux");
+		Thread.sleep(Duration.ofSeconds(20));
+		entry.remove();
+	}
+}