8326712: Robot tests fail on XWayland

buildSrc/linux.gradle

@@ -89,21 +89,22 @@ setupTools("linux_gtk3",
     { propFile ->
         ByteArrayOutputStream results2 = new ByteArrayOutputStream();
         exec {
-            commandLine("${toolchainDir}pkg-config", "--cflags", "gtk+-3.0", "gthread-2.0", "xtst")
+            commandLine("${toolchainDir}pkg-config", "--cflags", "gtk+-3.0", "gthread-2.0", "xtst", "gio-unix-2.0")
             setStandardOutput(results2);
         }
         propFile << "cflagsGTK3=" << results2.toString().trim() << "\n";
 
         ByteArrayOutputStream results4 = new ByteArrayOutputStream();
         exec {
-            commandLine("${toolchainDir}pkg-config", "--libs", "gtk+-3.0", "gthread-2.0", "xtst")
+            commandLine("${toolchainDir}pkg-config", "--libs", "gtk+-3.0", "gthread-2.0", "xtst", "gio-unix-2.0")
             setStandardOutput(results4);
         }
         propFile << "libsGTK3=" << results4.toString().trim()  << "\n";
 
     },
     { properties ->
-        def cflagsGTK3 = properties.getProperty("cflagsGTK3")
+        def cflagsGTK3 = properties.getProperty("cflagsGTK3") \
+                            + " -I${project(":graphics").projectDir}/src/main/native-glass/gtk/libpipewire/include"
         def libsGTK3 = properties.getProperty("libsGTK3")
         if (cflagsGTK3 && libsGTK3) {
             gtk3CCFlags.addAll(cflagsGTK3.split(" "))
@@ -172,7 +173,7 @@ setupTools("linux_freetype_tools",
                 freetypeLinkFlags.addAll(libs.split(" "))
             }
         } else {
-            throw new IllegalStateException("Linux freetype packages not found.\nIf freetype pacakges are installed, please remove the build directory and try again.")
+            throw new IllegalStateException("Linux freetype packages not found.\nIf freetype packages are installed, please remove the build directory and try again.")
         }
     }
 )

modules/javafx.graphics/src/main/java/com/sun/glass/ui/gtk/GtkRobot.java

@@ -24,6 +24,7 @@
  */
 package com.sun.glass.ui.gtk;
 
+import com.sun.glass.ui.gtk.screencast.ScreencastHelper;
 import javafx.scene.input.KeyCode;
 import javafx.scene.input.MouseButton;
 import javafx.scene.paint.Color;
@@ -32,8 +33,32 @@
 import com.sun.glass.ui.GlassRobot;
 import com.sun.glass.ui.Screen;
 
+import java.security.AccessController;
+import java.security.PrivilegedAction;
+
 final class GtkRobot extends GlassRobot {
 
+    private static final String screenshotMethod;
+    private static final String METHOD_GTK = "gtk";
+    private static final String METHOD_SCREENCAST = "dbusScreencast";
+
+    static {
+        @SuppressWarnings("removal")
+        boolean isOnWayland = AccessController.doPrivileged((PrivilegedAction<Boolean>) () -> {
+            String waylandDisplay = System.getenv("WAYLAND_DISPLAY");
+            return waylandDisplay != null && !waylandDisplay.isBlank();
+        });
+
+        @SuppressWarnings("removal")
+        String method = AccessController
+                .doPrivileged((PrivilegedAction<String>) () ->
+                        System.getProperty(
+                                "javafx.robot.screenshotMethod",
+                                isOnWayland ? METHOD_SCREENCAST : METHOD_GTK
+                        ));
+        screenshotMethod = method;
+    }
+
     @Override
     public void create() {
         // no-op
@@ -115,7 +140,11 @@ public Color getPixelColor(double x, double y) {
         x = (int) Math.floor((x + 0.5) * mainScreen.getPlatformScaleX());
         y = (int) Math.floor((y + 0.5) * mainScreen.getPlatformScaleY());
         int[] result = new int[1];
-        _getScreenCapture((int) x, (int) y, 1, 1, result);
+        if (METHOD_SCREENCAST.equals(screenshotMethod)) {
+            ScreencastHelper.getRGBPixels((int) x, (int) y, 1, 1, result);
+        } else {
+            _getScreenCapture((int) x, (int) y, 1, 1, result);
+        }
         return GlassRobot.convertFromIntArgb(result[0]);
     }
 
@@ -124,6 +153,10 @@ public Color getPixelColor(double x, double y) {
     @Override
     public void getScreenCapture(int x, int y, int width, int height, int[] data, boolean scaleToFit) {
         Application.checkEventThread();
-        _getScreenCapture(x, y, width, height, data);
+        if (METHOD_SCREENCAST.equals(screenshotMethod)) {
+            ScreencastHelper.getRGBPixels(x, y, width, height, data);
+        } else {
+            _getScreenCapture(x, y, width, height, data);
+        }
     }
 }

modules/javafx.graphics/src/main/java/com/sun/glass/ui/gtk/screencast/ScreencastHelper.java

@@ -0,0 +1,218 @@
+/*
+ * Copyright (c) 2023, Oracle and/or its affiliates. All rights reserved.
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * This code is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License version 2 only, as
+ * published by the Free Software Foundation.  Oracle designates this
+ * particular file as subject to the "Classpath" exception as provided
+ * by Oracle in the LICENSE file that accompanied this code.
+ *
+ * This code is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
+ * version 2 for more details (a copy is included in the LICENSE file that
+ * accompanied this code).
+ *
+ * You should have received a copy of the GNU General Public License version
+ * 2 along with this work; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
+ *
+ * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
+ * or visit www.oracle.com if you need additional information or have any
+ * questions.
+ */
+
+package com.sun.glass.ui.gtk.screencast;
+
+import com.sun.glass.ui.Screen;
+
+import com.sun.javafx.geom.Rectangle;
+import java.security.AccessController;
+import java.security.PrivilegedAction;
+import java.util.List;
+import java.util.Set;
+import java.util.Timer;
+import java.util.TimerTask;
+import java.util.stream.IntStream;
+
+/**
+ * Helper class for grabbing pixels from the screen using the
+ * <a href="https://flatpak.github.io/xdg-desktop-portal/#gdbus-org.freedesktop.portal.ScreenCast">
+ * org.freedesktop.portal.ScreenCast API</a>
+ */
+
+public class ScreencastHelper {
+
+    static final boolean SCREENCAST_DEBUG;
+    private static final boolean IS_NATIVE_LOADED;
+
+
+    private static final int ERROR = -1;
+    private static final int DENIED = -11;
+    private static final int OUT_OF_BOUNDS = -12;
+
+    private static final int DELAY_BEFORE_SESSION_CLOSE = 2000;
+
+    private static volatile TimerTask timerTask = null;
+    private static final Timer timerCloseSession
+            = new Timer("auto-close screencast session", true);
+
+
+    private ScreencastHelper() {
+    }
+
+    static {
+        @SuppressWarnings("removal")
+        boolean isDebugEnabled =
+                AccessController.doPrivileged((PrivilegedAction<Boolean>) () -> {
+                    final String str =
+                            System.getProperty("javafx.robot.screenshotDebug", "false");
+                    return "true".equalsIgnoreCase(str);
+                });
+        SCREENCAST_DEBUG = isDebugEnabled;
+
+        IS_NATIVE_LOADED = loadPipewire(SCREENCAST_DEBUG);
+    }
+
+    public static boolean isAvailable() {
+        return IS_NATIVE_LOADED;
+    }
+
+    private static native boolean loadPipewire(boolean screencastDebug);
+
+    private static native int getRGBPixelsImpl(
+            int x, int y, int width, int height,
+            int[] pixelArray,
+            int[] affectedScreensBoundsArray,
+            String token
+    );
+
+    public static int clipRound(final double coordinate) {
+        final double newv = coordinate - 0.5;
+        if (newv < Integer.MIN_VALUE) {
+            return Integer.MIN_VALUE;
+        }
+        if (newv > Integer.MAX_VALUE) {
+            return Integer.MAX_VALUE;
+        }
+        return (int) Math.ceil(newv);
+    }
+
+    private static List<Rectangle> getSystemScreensBounds() {
+        return Screen
+                .getScreens()
+                .stream()
+                .map(screen -> new Rectangle(
+                        clipRound(screen.getPlatformX() * screen.getPlatformScaleX()),
+                        clipRound(screen.getPlatformY() * screen.getPlatformScaleY()),
+                        clipRound(screen.getPlatformWidth() * screen.getPlatformScaleX()),
+                        clipRound(screen.getPlatformHeight() * screen.getPlatformScaleY())
+                ))
+                .toList();
+    }
+
+    private static synchronized native void closeSession();
+
+    private static void timerCloseSessionRestart() {
+        if (timerTask != null) {
+            timerTask.cancel();
+        }
+
+        timerTask = new TimerTask() {
+            @Override
+            public void run() {
+                closeSession();
+            }
+        };
+
+        timerCloseSession.schedule(timerTask, DELAY_BEFORE_SESSION_CLOSE);
+    }
+
+    public static synchronized void getRGBPixels(
+            int x, int y, int width, int height, int[] pixelArray
+    ) {
+        if (!IS_NATIVE_LOADED) return;
+
+        timerCloseSessionRestart();
+
+        Rectangle captureArea = new Rectangle(x, y, width, height);
+
+        List<Rectangle> affectedScreenBounds = getSystemScreensBounds()
+                .stream()
+                .filter(r -> !captureArea.intersection(r).isEmpty())
+                .toList();
+
+        if (SCREENCAST_DEBUG) {
+            System.out.printf("// getRGBPixels in %s, affectedScreenBounds %s\n",
+                    captureArea, affectedScreenBounds);
+        }
+
+        if (affectedScreenBounds.isEmpty()) {
+            if (SCREENCAST_DEBUG) {
+                System.out.println("// getRGBPixels - requested area "
+                        + "outside of any screen");
+            }
+            return;
+        }
+
+        int retVal;
+        Set<TokenItem> tokensForRectangle =
+                TokenStorage.getTokens(affectedScreenBounds);
+
+        int[] affectedScreenBoundsArray = affectedScreenBounds
+                .stream()
+                .filter(r -> !captureArea.intersection(r).isEmpty())
+                .flatMapToInt(bounds -> IntStream.of(
+                        bounds.x, bounds.y,
+                        bounds.width, bounds.height
+                ))
+                .toArray();
+
+        for (TokenItem tokenItem : tokensForRectangle) {
+            retVal = getRGBPixelsImpl(
+                    x, y, width, height,
+                    pixelArray,
+                    affectedScreenBoundsArray,
+                    tokenItem.token
+            );
+
+            debugReturnValue(retVal);
+
+            if (retVal >= 0  // we have received a screen data
+                || retVal == ERROR
+                || retVal == DENIED) {
+                return;
+            } // else, try other tokens
+        }
+
+        // we do not have a saved token or it did not work,
+        // try without the token to show the system's permission request window
+        retVal = getRGBPixelsImpl(
+                x, y, width, height,
+                pixelArray,
+                affectedScreenBoundsArray,
+                null
+        );
+
+        debugReturnValue(retVal);
+    }
+
+    private static void debugReturnValue(int retVal) {
+        if (retVal == DENIED) {
+            // user explicitly denied the capture, no more tries.
+            if (SCREENCAST_DEBUG) {
+                System.err.println("Screen Capture in the selected area was not allowed");
+            }
+        } else if (retVal == ERROR) {
+            if (SCREENCAST_DEBUG) {
+                System.err.println("Screen capture failed.");
+            }
+        } else if (retVal == OUT_OF_BOUNDS) {
+            if (SCREENCAST_DEBUG) {
+                System.err.println(
+                        "Token does not provide access to requested area.");
+            }
+        }
+    }
+}