feat: implement screen saver inhibition on Linux using D-Bus

Author: moetayuko

app/desktop/build.gradle.kts

@@ -103,6 +103,7 @@ compose.desktop {
                 "gluegen.rt",
                 "jogl.all",
                 "java.instrument", // ByteBuddy, for disabling PagingLogger
+                "jdk.security.auth", // com.sun.security.auth.module.UnixSystem used by dbus-java SASL auth
             )
 
             // ./gradlew suggestRuntimeModules

app/desktop/proguard-desktop.pro

@@ -72,6 +72,7 @@
 -keep class ** extends uk.co.caprica.vlcj.factory.discovery.provider.DiscoveryDirectoryProvider { *; }
 -keep class org.apache.logging.slf4j.SLF4JServiceProvider { *; }
 -keep class ** extends org.slf4j.spi.SLF4JServiceProvider { *; }
+-keep class org.freedesktop.dbus.** { *; } # dbus-java uses ServiceLoader and extensive reflection
 
 # Ktor related
 

app/shared/ui-foundation/build.gradle.kts

@@ -68,6 +68,8 @@ kotlin {
     sourceSets.desktopMain.dependencies {
         implementation(libs.jna)
         implementation(libs.jna.platform)
+        implementation(libs.dbus.java.core)
+        implementation(libs.dbus.java.transport.native.unixsocket)
         api(libs.directories)
     }
 }

app/shared/ui-foundation/src/desktopMain/kotlin/platform/window/LinuxWindowUtils.kt

@@ -11,7 +11,14 @@ package me.him188.ani.app.platform.window
 
 import androidx.compose.ui.window.WindowPlacement
 import androidx.compose.ui.window.WindowState
+import kotlinx.atomicfu.locks.ReentrantLock
+import kotlinx.atomicfu.locks.withLock
 import me.him188.ani.app.platform.PlatformWindow
+import me.him188.ani.utils.logging.logger
+import org.freedesktop.dbus.connections.impl.DBusConnection
+import org.freedesktop.dbus.connections.impl.DBusConnectionBuilder
+import org.freedesktop.dbus.interfaces.DBusInterface
+import org.freedesktop.dbus.types.UInt32
 
 class LinuxWindowUtils : AwtWindowUtils() {
     override suspend fun setUndecoratedFullscreen(
@@ -25,4 +32,87 @@ class LinuxWindowUtils : AwtWindowUtils() {
             windowState.apply { placement = WindowPlacement.Floating }
         }
     }
+
+    private val preventScreenSaverLock = ReentrantLock()
+
+    @Volatile
+    private var inhibitCookie: UInt32? = null
+
+    @Volatile
+    private var dbusConnection: DBusConnection? = null
+
+    override fun setPreventScreenSaver(prevent: Boolean) = preventScreenSaverLock.withLock {
+        if (prevent) {
+            if (inhibitCookie == null) {
+                logger.info("Inhibiting screen saver via org.freedesktop.ScreenSaver D-Bus")
+                try {
+                    val connection = withDbusClassLoader {
+                        DBusConnectionBuilder.forSessionBus().build()
+                    }
+                    val screenSaver = connection.getRemoteObject(
+                        "org.freedesktop.ScreenSaver",
+                        "/org/freedesktop/ScreenSaver",
+                        ScreenSaverInterface::class.java,
+                    )
+                    val cookie = screenSaver.Inhibit("Animeko", "Playing video")
+                    dbusConnection = connection
+                    inhibitCookie = cookie
+                    logger.info("Screen saver inhibited with cookie: $cookie")
+                } catch (e: Exception) {
+                    logger.error("Failed to inhibit screen saver, see cause", e)
+                }
+            }
+        } else {
+            val cookie = inhibitCookie
+            val connection = dbusConnection
+            if (cookie != null && connection != null) {
+                logger.info("Uninhibiting screen saver with cookie: $cookie")
+                try {
+                    val screenSaver = connection.getRemoteObject(
+                        "org.freedesktop.ScreenSaver",
+                        "/org/freedesktop/ScreenSaver",
+                        ScreenSaverInterface::class.java,
+                    )
+                    screenSaver.UnInhibit(cookie)
+                } catch (e: Exception) {
+                    logger.error("Failed to uninhibit screen saver, see cause", e)
+                } finally {
+                    try {
+                        connection.close()
+                    } catch (_: Exception) {
+                    }
+                    dbusConnection = null
+                    inhibitCookie = null
+                }
+            }
+        }
+    }
+
+    @Suppress("FunctionName")
+    @org.freedesktop.dbus.annotations.DBusInterfaceName("org.freedesktop.ScreenSaver")
+    interface ScreenSaverInterface : DBusInterface {
+        fun Inhibit(applicationName: String, reason: String): UInt32
+        fun UnInhibit(cookie: UInt32)
+    }
+
+    private companion object {
+        private val logger = logger<LinuxWindowUtils>()
+
+        /**
+         * ServiceLoader uses the thread context classloader to discover providers.
+         * On the AWT EventDispatch thread, this may differ from the classloader that
+         * loaded dbus-java, causing transport provider discovery to fail.
+         * Temporarily switch to the classloader that loaded [DBusConnectionBuilder].
+         */
+        private inline fun <T> withDbusClassLoader(block: () -> T): T {
+            val currentThread = Thread.currentThread()
+            val originalClassLoader = currentThread.contextClassLoader
+            currentThread.contextClassLoader = DBusConnectionBuilder::class.java.classLoader
+            try {
+                return block()
+            } finally {
+                currentThread.contextClassLoader = originalClassLoader
+            }
+        }
+    }
 }

gradle/libs.versions.toml

@@ -54,6 +54,7 @@ androidx-compose-material3-adaptive = "1.2.0-alpha11"
 
 bytebuddy = "1.17.4" # https://github.com/raphw/byte-buddy/releases
 jna = "5.13.0" # 不要轻易改这个版本, 它可能导致 VLC 兼容性问题
+dbus-java = "5.2.0"
 jsonpathkt-kotlinx = "3.0.2"
 ksoup = "0.2.2"
 filekit = "0.10.0-beta04" # https://github.com/vinceglb/FileKit/releases
@@ -296,6 +297,8 @@ ipaddress-parser = { module = "com.github.seancfoley:ipaddress", version.ref = "
 vlcj = { module = "uk.co.caprica:vlcj", version.ref = "vlcj" }
 jna = { module = "net.java.dev.jna:jna", version.ref = "jna" }
 jna-platform = { module = "net.java.dev.jna:jna-platform", version.ref = "jna" }
+dbus-java-core = { module = "com.github.hypfvieh:dbus-java-core", version.ref = "dbus-java" }
+dbus-java-transport-native-unixsocket = { module = "com.github.hypfvieh:dbus-java-transport-native-unixsocket", version.ref = "dbus-java" }
 jsoup = { module = "org.jsoup:jsoup", version.ref = "jsoup" }
 ksoup = { module = "com.fleeksoft.ksoup:ksoup", version.ref = "ksoup" }
 ksoup-kotlinx = { module = "com.fleeksoft.ksoup:ksoup-kotlinx", version.ref = "ksoup" }