Merge branch 'release/1.3.0'

infeo · infeo · commit 7a15e92261de · 2023-09-15T12:21:37.000+02:00
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -10,8 +10,8 @@ jobs:
       - uses: actions/checkout@v3
       - uses: actions/setup-java@v3
         with:
-          distribution: 'temurin'
-          java-version: 19
+          distribution: 'zulu'
+          java-version: 20
           cache: 'maven'
       - name: Ensure to use tagged version
         if: startsWith(github.ref, 'refs/tags/')
diff --git a/.github/workflows/codeql-analysis.yml b/.github/workflows/codeql-analysis.yml
@@ -20,8 +20,8 @@ jobs:
         fetch-depth: 2
     - uses: actions/setup-java@v3
       with:
-        distribution: 'temurin'
-        java-version: 19
+        distribution: 'zulu'
+        java-version: 20
         cache: 'maven'
     - name: Initialize CodeQL
       uses: github/codeql-action/init@v2
diff --git a/.github/workflows/publish-central.yml b/.github/workflows/publish-central.yml
@@ -15,8 +15,8 @@ jobs:
           ref: "refs/tags/${{ github.event.inputs.tag }}"
       - uses: actions/setup-java@v3
         with:
-          distribution: 'temurin'
-          java-version: 19
+          distribution: 'zulu'
+          java-version: 20
           cache: 'maven'
           server-id: ossrh # Value of the distributionManagement/repository/id field of the pom.xml
           server-username: MAVEN_USERNAME # env variable for username in deploy
diff --git a/.github/workflows/publish-github.yml b/.github/workflows/publish-github.yml
@@ -10,8 +10,8 @@ jobs:
       - uses: actions/checkout@v3
       - uses: actions/setup-java@v3
         with:
-          distribution: 'temurin'
-          java-version: 19
+          distribution: 'zulu'
+          java-version: 20
           cache: 'maven'
           gpg-private-key: ${{ secrets.RELEASES_GPG_PRIVATE_KEY }} # Value of the GPG private key to import
           gpg-passphrase: MAVEN_GPG_PASSPHRASE # env variable for GPG private key passphrase
diff --git a/.idea/misc.xml b/.idea/misc.xml
diff --git a/README.md b/README.md
@@ -1,2 +1,8 @@
 # integrations-linux
-Linux-specific implemenations of the integrations-api
+Linux-specific implemenations of the [integrations-api](https://github.com/cryptomator/integrations-api).
+
+# Config
+
+This project uses the following JVM properties:
+* `cryptomator.integrationsLinux.trayIconsDir` - specifies the directory from which svg images for the tray icon are loaded
+
diff --git a/pom.xml b/pom.xml
@@ -5,7 +5,7 @@
 	<modelVersion>4.0.0</modelVersion>
 	<groupId>org.cryptomator</groupId>
 	<artifactId>integrations-linux</artifactId>
-	<version>1.2.1</version>
+	<version>1.3.0</version>
 
 	<name>integrations-linux</name>
 	<description>Provides optional Linux services used by Cryptomator</description>
@@ -36,21 +36,23 @@
 
 	<properties>
 		<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
-		<project.jdk.version>19</project.jdk.version>
+		<project.jdk.version>20</project.jdk.version>
 
 		<!-- runtime dependencies -->
 
-		<api.version>1.2.0</api.version>
+		<api.version>1.3.0</api.version>
 		<secret-service.version>1.8.1-jdk17</secret-service.version>
-		<kdewallet.version>1.2.8</kdewallet.version>
-		<guava.version>31.1-jre</guava.version>
+		<kdewallet.version>1.3.2</kdewallet.version>
+		<appindicator.version>1.3.4</appindicator.version>
+		<guava.version>32.0.0-jre</guava.version>
 		<slf4j.version>1.7.36</slf4j.version>
+		<commons-lang3.version>3.12.0</commons-lang3.version>
 
 		<!-- test dependencies -->
 		<junit.version>5.8.2</junit.version>
 
 		<!-- build plugin dependencies -->
-		<dependency-check.version>8.1.0</dependency-check.version>
+		<dependency-check.version>8.2.1</dependency-check.version>
 		<nexus-staging.version>1.6.8</nexus-staging.version>
 	</properties>
 
@@ -80,6 +82,18 @@
 			<artifactId>kdewallet</artifactId>
 			<version>${kdewallet.version}</version>
 		</dependency>
+		<!-- Apache Commons -->
+		<dependency>
+			<groupId>org.apache.commons</groupId>
+			<artifactId>commons-lang3</artifactId>
+			<version>${commons-lang3.version}</version>
+		</dependency>
+		<!-- Java bindings for appindicator -->
+		<dependency>
+			<groupId>org.purejava</groupId>
+			<artifactId>libappindicator-gtk3-java-minimal</artifactId>
+			<version>${appindicator.version}</version>
+		</dependency>
 		<dependency>
 			<groupId>org.junit.jupiter</groupId>
 			<artifactId>junit-jupiter</artifactId>
@@ -96,6 +110,9 @@
 				<version>3.9.0</version>
 				<configuration>
 					<release>${project.jdk.version}</release>
+					<compilerArgs>
+						<arg>--enable-preview</arg>
+					</compilerArgs>
 				</configuration>
 			</plugin>
 			<plugin>
@@ -190,6 +207,7 @@
 							<name>see</name>
 						</tag>
 					</tags>
+					<additionalOptions>--enable-preview</additionalOptions>
 				</configuration>
 			</plugin>
 		</plugins>
diff --git a/src/main/java/module-info.java b/src/main/java/module-info.java
@@ -0,0 +1,24 @@
+import org.cryptomator.integrations.keychain.KeychainAccessProvider;
+import org.cryptomator.integrations.revealpath.RevealPathService;
+import org.cryptomator.integrations.tray.TrayMenuController;
+import org.cryptomator.linux.keychain.KDEWalletKeychainAccess;
+import org.cryptomator.linux.keychain.SecretServiceKeychainAccess;
+import org.cryptomator.linux.revealpath.DBusSendRevealPathService;
+import org.cryptomator.linux.tray.AppindicatorTrayMenuController;
+
+module org.cryptomator.integrations.linux {
+	requires org.cryptomator.integrations.api;
+	requires org.slf4j;
+	requires com.google.common;
+	requires org.apache.commons.lang3;
+	requires org.freedesktop.dbus;
+	requires org.purejava.appindicator;
+	requires org.purejava.kwallet;
+	requires secret.service;
+
+	provides KeychainAccessProvider with SecretServiceKeychainAccess, KDEWalletKeychainAccess;
+	provides RevealPathService with DBusSendRevealPathService;
+	provides TrayMenuController with AppindicatorTrayMenuController;
+
+	opens org.cryptomator.linux.tray to org.cryptomator.integrations.api;
+}
diff --git a/src/main/java/org/cryptomator/linux/keychain/KDEWalletKeychainAccess.java b/src/main/java/org/cryptomator/linux/keychain/KDEWalletKeychainAccess.java
@@ -10,9 +10,9 @@
 import org.freedesktop.dbus.exceptions.DBusConnectionException;
 import org.freedesktop.dbus.exceptions.DBusException;
 import org.freedesktop.dbus.exceptions.DBusExecutionException;
-import org.kde.KWallet;
-import org.kde.Static;
-import org.purejava.KDEWallet;
+import org.purejava.kwallet.KWallet;
+import org.purejava.kwallet.KDEWallet;
+import org.purejava.kwallet.Static;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
diff --git a/src/main/java/org/cryptomator/linux/tray/ActionItemCallback.java b/src/main/java/org/cryptomator/linux/tray/ActionItemCallback.java
@@ -0,0 +1,16 @@
+package org.cryptomator.linux.tray;
+
+import org.cryptomator.integrations.tray.ActionItem;
+import org.purejava.appindicator.GCallback;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+record ActionItemCallback (ActionItem actionItem) implements GCallback {
+	private static final Logger LOG = LoggerFactory.getLogger(ActionItemCallback.class);
+
+	@Override
+	public void apply() {
+		LOG.trace("Hit tray menu action '{}'", actionItem.title());
+		actionItem.action().run();
+	}
+}
diff --git a/src/main/java/org/cryptomator/linux/tray/AppindicatorTrayMenuController.java b/src/main/java/org/cryptomator/linux/tray/AppindicatorTrayMenuController.java
@@ -0,0 +1,127 @@
+package org.cryptomator.linux.tray;
+
+import org.apache.commons.lang3.StringUtils;
+import org.cryptomator.integrations.common.CheckAvailability;
+import org.cryptomator.integrations.common.OperatingSystem;
+import org.cryptomator.integrations.common.Priority;
+import org.cryptomator.integrations.tray.ActionItem;
+import org.cryptomator.integrations.tray.SeparatorItem;
+import org.cryptomator.integrations.tray.SubMenuItem;
+import org.cryptomator.integrations.tray.TrayIconLoader;
+import org.cryptomator.integrations.tray.TrayMenuController;
+import org.cryptomator.integrations.tray.TrayMenuException;
+import org.cryptomator.integrations.tray.TrayMenuItem;
+import org.purejava.appindicator.GCallback;
+import org.purejava.appindicator.NativeLibUtilities;
+
+import java.lang.foreign.Arena;
+import java.lang.foreign.MemorySegment;
+import java.lang.foreign.SegmentScope;
+import java.util.List;
+import java.util.Optional;
+import java.util.function.Consumer;
+
+import static org.purejava.appindicator.app_indicator_h.*;
+
+@Priority(1000)
+@CheckAvailability
+@OperatingSystem(OperatingSystem.Value.LINUX)
+public class AppindicatorTrayMenuController implements TrayMenuController {
+	private static final String APP_INDICATOR_ID = "org.cryptomator.Cryptomator";
+	private static final String SVG_SOURCE_PROPERTY = "cryptomator.integrationsLinux.trayIconsDir";
+
+	private static final SegmentScope SCOPE = SegmentScope.global();
+	private MemorySegment indicator;
+	private MemorySegment menu = gtk_menu_new();
+	private Optional<String> svgSourcePath;
+
+	@CheckAvailability
+	public static boolean isAvailable() {
+		return NativeLibUtilities.isLoadedNativeLib();
+	}
+
+	@Override
+	public void showTrayIcon(Consumer<TrayIconLoader> iconLoader, Runnable runnable, String s) throws TrayMenuException {
+		TrayIconLoader.FreedesktopIconName callback = this::showTrayIconWithSVG;
+		iconLoader.accept(callback);
+		gtk_widget_show_all(menu);
+		app_indicator_set_status(indicator, APP_INDICATOR_STATUS_ACTIVE());
+	}
+
+	private void showTrayIconWithSVG(String s) {
+		try (var arena = Arena.openConfined()) {
+			svgSourcePath = Optional.ofNullable(System.getProperty(SVG_SOURCE_PROPERTY));
+			// flatpak
+			if (svgSourcePath.isEmpty()) {
+				indicator = app_indicator_new(arena.allocateUtf8String(APP_INDICATOR_ID),
+						arena.allocateUtf8String(s),
+						APP_INDICATOR_CATEGORY_APPLICATION_STATUS());
+			// AppImage and ppa
+			} else {
+				indicator = app_indicator_new_with_path(arena.allocateUtf8String(APP_INDICATOR_ID),
+						arena.allocateUtf8String(s),
+						APP_INDICATOR_CATEGORY_APPLICATION_STATUS(),
+						// find tray icons theme in mounted AppImage / installed on system by ppa
+						arena.allocateUtf8String(svgSourcePath.get()));
+			}
+		}
+	}
+
+	@Override
+	public void updateTrayIcon(Consumer<TrayIconLoader> iconLoader) {
+		TrayIconLoader.FreedesktopIconName callback = this::updateTrayIconWithSVG;
+		iconLoader.accept(callback);
+	}
+
+	private void updateTrayIconWithSVG(String s) {
+		try (var arena = Arena.openConfined()) {
+			app_indicator_set_icon(indicator, arena.allocateUtf8String(s));
+		}
+	}
+
+	@Override
+	public void updateTrayMenu(List<TrayMenuItem> items) throws TrayMenuException {
+		menu = gtk_menu_new();
+		addChildren(menu, items);
+		gtk_widget_show_all(menu);
+		app_indicator_set_menu(indicator, menu);
+	}
+
+	@Override
+	public void onBeforeOpenMenu(Runnable runnable) {
+
+	}
+
+	private void addChildren(MemorySegment menu, List<TrayMenuItem> items) {
+		for (var item : items) {
+			switch (item) {
+				case ActionItem a -> {
+					var gtkMenuItem = gtk_menu_item_new();
+					try (var arena = Arena.openConfined()) {
+						gtk_menu_item_set_label(gtkMenuItem, arena.allocateUtf8String(a.title()));
+						g_signal_connect_object(gtkMenuItem,
+								arena.allocateUtf8String("activate"),
+								GCallback.allocate(new ActionItemCallback(a), SCOPE),
+								menu,
+								0);
+					}
+					gtk_menu_shell_append(menu, gtkMenuItem);
+				}
+				case SeparatorItem separatorItem -> {
+					var gtkSeparator = gtk_menu_item_new();
+					gtk_menu_shell_append(menu, gtkSeparator);
+				}
+				case SubMenuItem s -> {
+					var gtkMenuItem = gtk_menu_item_new();
+					var gtkSubmenu = gtk_menu_new();
+					try (var arena = Arena.openConfined()) {
+						gtk_menu_item_set_label(gtkMenuItem, arena.allocateUtf8String(s.title()));
+					}
+					addChildren(gtkSubmenu, s.items());
+					gtk_menu_item_set_submenu(gtkMenuItem, gtkSubmenu);
+					gtk_menu_shell_append(menu, gtkMenuItem);
+				}
+			}
+		}
+	}
+}
diff --git a/src/main/resources/META-INF/services/org.cryptomator.integrations.tray.TrayMenuController b/src/main/resources/META-INF/services/org.cryptomator.integrations.tray.TrayMenuController
@@ -0,0 +1 @@
+org.cryptomator.linux.tray.AppindicatorTrayMenuController
diff --git a/src/test/java/org/cryptomator/linux/keychain/SecretServiceKeychainAccessTest.java b/src/test/java/org/cryptomator/linux/keychain/SecretServiceKeychainAccessTest.java
@@ -3,8 +3,7 @@
 import org.junit.jupiter.api.Assertions;
 import org.junit.jupiter.api.BeforeAll;
 import org.junit.jupiter.api.Test;
-import org.junit.jupiter.api.condition.EnabledOnOs;
-import org.junit.jupiter.api.condition.OS;
+import org.junit.jupiter.api.condition.EnabledIf;
 
 import java.io.IOException;
 import java.util.List;
@@ -13,14 +12,13 @@
 /**
  * Unit tests for GNOME keyring access via DBUS.
  */
-@EnabledOnOs(OS.LINUX)
 public class SecretServiceKeychainAccessTest {
 
 	private static boolean isInstalled;
 
 	@BeforeAll
 	public static void checkSystemAndSetup() throws IOException {
-		ProcessBuilder dbusSend = new ProcessBuilder("dbus-send","--print-reply","--dest=org.freedesktop.DBus", "/org/freedesktop/DBus", "org.freedesktop.DBus.ListNames");
+		ProcessBuilder dbusSend = new ProcessBuilder("dbus-send", "--print-reply", "--dest=org.freedesktop.DBus", "/org/freedesktop/DBus", "org.freedesktop.DBus.ListNames");
 		ProcessBuilder grep = new ProcessBuilder("grep", "org.gnome.keyring");
 		try {
 			Process end = ProcessBuilder.startPipeline(List.of(dbusSend, grep)).get(1);
@@ -36,10 +34,13 @@ public static void checkSystemAndSetup() throws IOException {
 
 
 	@Test
-	public void testIsSupported(){
+	@EnabledIf("isXdgDisplayEnvVarSet")
+	public void testIsSupported() {
 		SecretServiceKeychainAccess secretService = new SecretServiceKeychainAccess();
 		Assertions.assertEquals(isInstalled, secretService.isSupported());
 	}
 
-
-}
+	public boolean isXdgDisplayEnvVarSet() {
+		return System.getenv("DISPLAY") != null;
+	}
+}
diff --git a/suppression.xml b/suppression.xml
@@ -1,19 +1,3 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <suppressions xmlns="https://jeremylong.github.io/DependencyCheck/dependency-suppression.1.3.xsd">
-	<suppress>
-		<notes><![CDATA[
-        Incorrectly matched CPE, see https://github.com/jeremylong/DependencyCheck/issues/4177git
-		]]></notes>
-		<gav regex="true">^org\.cryptomator:.*$</gav>
-		<cpe>cpe:/a:cryptomator:cryptomator</cpe>
-		<cve>CVE-2022-25366</cve>
-	</suppress>
-	<suppress>
-		<notes><![CDATA[
-			False postive, because secret-service only accesses the external gnome-keyring service
-		]]></notes>
-		<gav regex="true">^de\.swiesend\:secret\-service:.*$</gav>
-		<cve>CVE-2018-19358</cve>
-		<cve>CVE-2018-20781</cve>
-	</suppress>
 </suppressions>
