[gtk/filechooser-amberol] filechooser: Improve "Open in File Manager"

[Matthias Clasen <matthiasc src gnome org>]

commit 3931fa600a06e85f8f68c4b5e931e0e1061b66d2
Author: Matthias Clasen <mclasen redhat com>
Date:   Wed Oct 19 01:51:19 2022 -0400

    filechooser: Improve "Open in File Manager"
    
    Just relying on GAppInfo leads to suboptimal
    results. Instead, call either the OpenURI portal
    or the org.freedesktop.FileManager1 interface
    directly, and only fall back to GAppInfo.
    
    Fixes: #5260

 gtk/gtkfilechooserwidget.c             |  59 +++++++++++-
 gtk/meson.build                        |   9 +-
 gtk/org.freedesktop.portal.OpenURI.xml | 167 +++++++++++++++++++++++++++++++++
 3 files changed, 230 insertions(+), 5 deletions(-)
---
diff --git a/gtk/gtkfilechooserwidget.c b/gtk/gtkfilechooserwidget.c
index 3cd9a18942..2b6bb84e42 100644
--- a/gtk/gtkfilechooserwidget.c
+++ b/gtk/gtkfilechooserwidget.c
@@ -86,6 +86,7 @@
 #include "gtkshortcutaction.h"
 #include "gtkshortcut.h"
 #include "gtkstringlist.h"
+#include "gopenuriportal.h"
 
 #include <cairo-gobject.h>
 
@@ -1442,6 +1443,10 @@ visit_file_cb (GSimpleAction *action,
   g_slist_free_full (files, g_object_unref);
 }
 
+#define FILE_MANAGER_DBUS_NAME "org.freedesktop.FileManager1"
+#define FILE_MANAGER_DBUS_IFACE "org.freedesktop.FileManager1"
+#define FILE_MANAGER_DBUS_PATH "/org/freedesktop/FileManager1"
+
 /* Callback used when the "Open this folder" menu item is activated */
 static void
 open_folder_cb (GSimpleAction *action,
@@ -1449,19 +1454,65 @@ open_folder_cb (GSimpleAction *action,
                 gpointer       data)
 {
   GtkFileChooserWidget *impl = data;
-  GtkWidget *toplevel = GTK_WIDGET (gtk_widget_get_root (GTK_WIDGET (impl)));
+  GtkRoot *root = gtk_widget_get_root (GTK_WIDGET (impl));
+  GtkWindow *toplevel = GTK_IS_WINDOW (root) ? GTK_WINDOW (root) : NULL;
   GSList *files;
+  GFile *file;
 
   files = get_selected_files (impl);
 
+  if (!files)
+    return;
+
   /* Sigh, just use the first one */
-  if (files && GTK_IS_WINDOW (toplevel))
+  file = files->data;
+
+  if (gdk_should_use_portal ())
     {
-      GFile *file = files->data;
+      g_openuri_portal_open_async (file, toplevel, NULL, NULL, NULL);
+    }
+  else
+    {
+      GDBusConnection *bus;
+      GVariantBuilder *uris_builder;
+      GVariant *result;
       char *uri;
+      GError *error = NULL;
 
       uri = g_file_get_uri (file);
-      gtk_show_uri (GTK_WINDOW (toplevel), uri, GDK_CURRENT_TIME);
+
+      bus = g_bus_get_sync (G_BUS_TYPE_SESSION, NULL, NULL);
+
+      uris_builder = g_variant_builder_new (G_VARIANT_TYPE ("as"));
+      g_variant_builder_add (uris_builder, "s", uri);
+
+      result = g_dbus_connection_call_sync (bus,
+                                   FILE_MANAGER_DBUS_NAME,
+                                   FILE_MANAGER_DBUS_PATH,
+                                   FILE_MANAGER_DBUS_IFACE,
+                                   "ShowFolders",
+                                   g_variant_new ("(ass)", uris_builder, ""),
+                                   NULL,   /* ignore returned type */
+                                   G_DBUS_CALL_FLAGS_NONE,
+                                   -1,
+                                   NULL,
+                                   &error);
+      if (error)
+        {
+          if (g_error_matches (error, G_DBUS_ERROR, G_DBUS_ERROR_NAME_HAS_NO_OWNER) ||
+              g_error_matches (error, G_DBUS_ERROR, G_DBUS_ERROR_SERVICE_UNKNOWN))
+            g_debug ("No " FILE_MANAGER_DBUS_NAME " available");
+          else
+            g_warning ("Failed to call ShowFolders: %s", error->message);
+
+          g_error_free (error);
+        }
+
+      if (result)
+        g_variant_unref (result);
+      else
+        gtk_show_uri (toplevel, uri, GDK_CURRENT_TIME);
+
       g_free (uri);
     }
 
diff --git a/gtk/meson.build b/gtk/meson.build
index 4e7325ad57..0df22b5ea0 100644
--- a/gtk/meson.build
+++ b/gtk/meson.build
@@ -147,6 +147,7 @@ gtk_private_sources = files([
   'gtktextviewchild.c',
   'timsort/gtktimsort.c',
   'gtktrashmonitor.c',
+  'gopenuriportal.c',
 ])
 
 # List of files that contain public API, and should be introspected
@@ -997,6 +998,12 @@ typefuncs = custom_target('gtktypefuncs.inc',
   install: false,
 )
 
+xdp_dbus_generated = gnome.gdbus_codegen('xdp-dbus',
+  sources : 'org.freedesktop.portal.OpenURI.xml',
+  interface_prefix : 'org.freedesktop.portal.',
+  namespace : 'GXdp',
+)
+
 gtkversion_cdata = configuration_data()
 gtkversion_cdata.set('GTK_MAJOR_VERSION', gtk_major_version)
 gtkversion_cdata.set('GTK_MINOR_VERSION', gtk_minor_version)
@@ -1156,7 +1163,7 @@ darwin_versions = [
 
 # Library
 libgtk_static = static_library('gtk',
-  sources: [typefuncs, gtk_sources, gtkmarshal_h, gtkprivatetypebuiltins_h],
+  sources: [typefuncs, gtk_sources, gtkmarshal_h, gtkprivatetypebuiltins_h, xdp_dbus_generated],
   c_args: gtk_cargs + common_cflags,
   include_directories: [confinc, gdkinc, gskinc, gtkinc],
   dependencies: gtk_deps + [libgtk_css_dep, libgdk_dep, libgsk_dep],
diff --git a/gtk/org.freedesktop.portal.OpenURI.xml b/gtk/org.freedesktop.portal.OpenURI.xml
new file mode 100644
index 0000000000..5ed054cf16
--- /dev/null
+++ b/gtk/org.freedesktop.portal.OpenURI.xml
@@ -0,0 +1,167 @@
+<?xml version="1.0"?>
+<!--
+ Copyright (C) 2016 Red Hat, Inc.
+
+ This library is free software; you can redistribute it and/or
+ modify it under the terms of the GNU Lesser General Public
+ License as published by the Free Software Foundation; either
+ version 2 of the License, or (at your option) any later version.
+
+ This library 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
+ Lesser General Public License for more details.
+
+ You should have received a copy of the GNU Lesser General Public
+ License along with this library. If not, see <http://www.gnu.org/licenses/>.
+
+ Author: Matthias Clasen <mclasen redhat com>
+-->
+
+<node name="/" xmlns:doc="http://www.freedesktop.org/dbus/1.0/doc.dtd";>
+  <!--
+       org.freedesktop.portal.OpenURI:
+       @short_description: Portal for opening URIs
+
+       The OpenURI portal allows sandboxed applications to open
+       URIs (e.g. a http: link to the applications homepage)
+       under the control of the user.
+
+       This documentation describes version 3 of this interface.
+  -->
+  <interface name="org.freedesktop.portal.OpenURI">
+    <!--
+        OpenURI:
+        @parent_window: Identifier for the application window, see <link linkend="parent_window">Common 
Conventions</link>
+        @uri: The uri to open
+        @options: Vardict with optional further onformation
+        @handle: Object path for the #org.freedesktop.portal.Request object representing this call
+
+        Asks to open a uri.
+
+        Note that file:// uris are explicitly not supported by this method.
+        To request opening local files, use org.freedesktop.portal.OpenURI.OpenFile().
+
+        Supported keys in the @options vardict include:
+        <variablelist>
+          <varlistentry>
+            <term>handle_token s</term>
+            <listitem><para>
+              A string that will be used as the last element of the @handle. Must be a valid
+              object path element. See the #org.freedesktop.portal.Request documentation for
+              more information about the @handle.
+            </para></listitem>
+          </varlistentry>
+          <varlistentry>
+            <term>writable b</term>
+            <listitem><para>
+              Whether to allow the chosen application to write to the file.
+            </para><para>
+              This key only takes effect the uri points to a local file that
+              is exported in the document portal, and the chosen application
+              is sandboxed itself.
+            </para></listitem>
+          </varlistentry>
+          <varlistentry>
+            <term>ask b</term>
+            <listitem><para>
+              Whether to ask the user to choose an app. If this is not passed, or false,
+              the portal may use a default or pick the last choice.
+            </para><para>
+              The ask option was introduced in version 3 of the interface.
+            </para></listitem>
+          </varlistentry>
+        </variablelist>
+
+    -->
+    <method name="OpenURI">
+      <arg type="s" name="parent_window" direction="in"/>
+      <arg type="s" name="uri" direction="in"/>
+      <arg type="a{sv}" name="options" direction="in"/>
+      <arg type="o" name="handle" direction="out"/>
+    </method>
+
+    <!--
+        OpenFile:
+        @parent_window: Identifier for the application window, see <link linkend="parent_window">Common 
Conventions</link>
+        @fd: File descriptor for the file to open
+        @options: Vardict with optional further onformation
+        @handle: Object path for the #org.freedesktop.portal.Request object representing this call
+
+        Asks to open a local file.
+
+        Supported keys in the @options vardict include:
+        <variablelist>
+          <varlistentry>
+            <term>handle_token s</term>
+            <listitem><para>
+              A string that will be used as the last element of the @handle. Must be a valid
+              object path element. See the #org.freedesktop.portal.Request documentation for
+              more information about the @handle.
+            </para></listitem>
+          </varlistentry>
+          <varlistentry>
+            <term>writable b</term>
+            <listitem><para>
+              Whether to allow the chosen application to write to the file.
+            </para><para>
+              This key only takes effect the uri points to a local file that
+              is exported in the document portal, and the chosen application
+              is sandboxed itself.
+            </para></listitem>
+          </varlistentry>
+          <varlistentry>
+            <term>ask b</term>
+            <listitem><para>
+              Whether to ask the user to choose an app. If this is not passed, or false,
+              the portal may use a default or pick the last choice.
+            </para><para>
+              The ask option was introduced in version 3 of the interface.
+            </para></listitem>
+          </varlistentry>
+        </variablelist>
+
+        The OpenFile method was introduced in version 2 of the OpenURI portal API.
+    -->
+    <method name="OpenFile">
+      <annotation name="org.gtk.GDBus.C.UnixFD" value="true"/>
+      <arg type="s" name="parent_window" direction="in"/>
+      <arg type="h" name="fd" direction="in"/>
+      <arg type="a{sv}" name="options" direction="in"/>
+      <arg type="o" name="handle" direction="out"/>
+    </method>
+
+    <!--
+        OpenDirectory:
+        @parent_window: Identifier for the application window, see <link linkend="parent_window">Common 
Conventions</link>
+        @fd: File descriptor for a file
+        @options: Vardict with optional further onformation
+        @handle: Object path for the #org.freedesktop.portal.Request object representing this call
+
+        Asks to open the directory containing a local file in the file browser.
+
+        Supported keys in the @options vardict include:
+        <variablelist>
+          <varlistentry>
+            <term>handle_token s</term>
+            <listitem><para>
+              A string that will be used as the last element of the @handle. Must be a valid
+              object path element. See the #org.freedesktop.portal.Request documentation for
+              more information about the @handle.
+            </para></listitem>
+          </varlistentry>
+        </variablelist>
+
+        The OpenDirectory method was introduced in version 3 of the OpenURI portal API.
+    -->
+    <method name="OpenDirectory">
+      <annotation name="org.gtk.GDBus.C.UnixFD" value="true"/>
+      <arg type="s" name="parent_window" direction="in"/>
+      <arg type="h" name="fd" direction="in"/>
+      <arg type="a{sv}" name="options" direction="in"/>
+      <arg type="o" name="handle" direction="out"/>
+    </method>
+
+    <property name="version" type="u" access="read"/>
+  </interface>
+</node>