[gnome-builder/wip/gtk4-port: 1379/1774] plugins/web-browser: add workbench addin to open URLs

[Christian Hergert <chergert src gnome org>]

commit b5321e97f5917ee4a5b6b24956bf207357129054
Author: Christian Hergert <chergert redhat com>
Date:   Mon Jun 6 15:54:00 2022 -0700

    plugins/web-browser: add workbench addin to open URLs
    
    If we get a request to open a URL, we can just open it internally using
    the browser page instead of externally, which can be a problem with things
    like Flatpak anyway.
    
    Probably can look into making this work for documentation as well.

 .../web-browser/gbp-web-browser-workbench-addin.c  | 213 +++++++++++++++++++++
 .../web-browser/gbp-web-browser-workbench-addin.h  |  31 +++
 src/plugins/web-browser/meson.build                |   1 +
 src/plugins/web-browser/web-browser-plugin.c       |   4 +
 4 files changed, 249 insertions(+)
---
diff --git a/src/plugins/web-browser/gbp-web-browser-workbench-addin.c 
b/src/plugins/web-browser/gbp-web-browser-workbench-addin.c
new file mode 100644
index 000000000..83f2549b3
--- /dev/null
+++ b/src/plugins/web-browser/gbp-web-browser-workbench-addin.c
@@ -0,0 +1,213 @@
+/* gbp-web-browser-workbench-addin.c
+ *
+ * Copyright 2022 Christian Hergert <chergert redhat com>
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program 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 for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * SPDX-License-Identifier: GPL-3.0-or-later
+ */
+
+#define G_LOG_DOMAIN "gbp-web-browser-workbench-addin"
+
+#include "config.h"
+
+#include <libide-editor.h>
+#include <libide-gui.h>
+#include <libide-webkit.h>
+
+#include "gbp-web-browser-workbench-addin.h"
+
+struct _GbpWebBrowserWorkbenchAddin
+{
+  GObject parent_instance;
+  IdeWorkbench *workbench;
+};
+
+static gboolean
+gbp_web_browser_workbench_addin_can_open (IdeWorkbenchAddin *addin,
+                                          GFile             *file,
+                                          const char        *content_type,
+                                          int               *priority)
+{
+  g_autofree char *scheme = NULL;
+
+  g_assert (IDE_IS_MAIN_THREAD ());
+  g_assert (GBP_IS_WEB_BROWSER_WORKBENCH_ADDIN (addin));
+  g_assert (G_IS_FILE (file));
+  g_assert (priority != NULL);
+
+  scheme = g_file_get_uri_scheme (file);
+
+  if (ide_str_equal0 (scheme, "https") || ide_str_equal0 (scheme, "http"))
+    {
+      *priority = -1000;
+      return TRUE;
+    }
+
+  return FALSE;
+}
+
+static inline gboolean
+can_use_workspace (IdeWorkspace *workspace)
+{
+  if (workspace != NULL)
+    {
+      GType type = G_OBJECT_TYPE (workspace);
+
+      return g_type_is_a (type, IDE_TYPE_PRIMARY_WORKSPACE) ||
+             g_type_is_a (type, IDE_TYPE_EDITOR_WORKSPACE);
+    }
+
+  return FALSE;
+}
+
+static void
+find_suitable_workspace_cb (IdeWorkspace *workspace,
+                            gpointer      data)
+{
+  IdeWorkspace **ptr = data;
+
+  if (*ptr == NULL && can_use_workspace (workspace))
+    *ptr = workspace;
+}
+
+static void
+gbp_web_browser_workbench_addin_open_async (IdeWorkbenchAddin   *addin,
+                                            GFile               *file,
+                                            const char          *content_type,
+                                            int                  at_line,
+                                            int                  at_line_offset,
+                                            IdeBufferOpenFlags   flags,
+                                            IdePanelPosition    *position,
+                                            GCancellable        *cancellable,
+                                            GAsyncReadyCallback  callback,
+                                            gpointer             user_data)
+{
+  GbpWebBrowserWorkbenchAddin *self = (GbpWebBrowserWorkbenchAddin *)addin;
+  g_autoptr(IdeTask) task = NULL;
+  g_autofree char *uri = NULL;
+  IdeWebkitPage *page;
+  IdeWorkspace *workspace;
+
+  IDE_ENTRY;
+
+  g_assert (IDE_IS_MAIN_THREAD ());
+  g_assert (GBP_IS_WEB_BROWSER_WORKBENCH_ADDIN (self));
+  g_assert (G_IS_FILE (file));
+  g_assert (!cancellable || G_IS_CANCELLABLE (cancellable));
+  g_assert (IDE_IS_WORKBENCH (self->workbench));
+
+  task = ide_task_new (self, cancellable, callback, user_data);
+  ide_task_set_source_tag (task, gbp_web_browser_workbench_addin_open_async);
+
+  workspace = ide_workbench_get_current_workspace (self->workbench);
+  if (!can_use_workspace (workspace))
+    {
+      workspace = NULL;
+      ide_workbench_foreach_workspace (self->workbench,
+                                       find_suitable_workspace_cb,
+                                       &workspace);
+    }
+
+  if (workspace == NULL)
+    {
+      ide_task_return_unsupported_error (task);
+      IDE_EXIT;
+    }
+
+  page = ide_webkit_page_new ();
+  uri = g_file_get_uri (file);
+
+  ide_workspace_add_page (workspace, IDE_PAGE (page), position);
+  panel_widget_raise (PANEL_WIDGET (page));
+
+  ide_webkit_page_load_uri (page, uri);
+
+  ide_task_return_boolean (task, TRUE);
+
+  IDE_EXIT;
+}
+
+static gboolean
+gbp_web_browser_workbench_addin_open_finish (IdeWorkbenchAddin  *addin,
+                                             GAsyncResult       *result,
+                                             GError            **error)
+{
+  gboolean ret;
+
+  IDE_ENTRY;
+
+  g_assert (IDE_IS_MAIN_THREAD ());
+  g_assert (IDE_IS_TASK (result));
+  g_assert (GBP_IS_WEB_BROWSER_WORKBENCH_ADDIN (addin));
+
+  ret = ide_task_propagate_boolean (IDE_TASK (result), error);
+
+  IDE_RETURN (ret);
+}
+
+static void
+gbp_web_browser_workbench_addin_load (IdeWorkbenchAddin *addin,
+                                      IdeWorkbench      *workbench)
+{
+  GbpWebBrowserWorkbenchAddin *self = (GbpWebBrowserWorkbenchAddin *)addin;
+
+  IDE_ENTRY;
+
+  g_assert (GBP_IS_WEB_BROWSER_WORKBENCH_ADDIN (self));
+  g_assert (IDE_IS_WORKBENCH (workbench));
+
+  self->workbench = workbench;
+
+  IDE_EXIT;
+}
+
+static void
+gbp_web_browser_workbench_addin_unload (IdeWorkbenchAddin *addin,
+                                        IdeWorkbench      *workbench)
+{
+  GbpWebBrowserWorkbenchAddin *self = (GbpWebBrowserWorkbenchAddin *)addin;
+
+  IDE_ENTRY;
+
+  g_assert (GBP_IS_WEB_BROWSER_WORKBENCH_ADDIN (self));
+  g_assert (IDE_IS_WORKBENCH (workbench));
+
+  self->workbench = NULL;
+
+  IDE_EXIT;
+}
+
+static void
+workbench_addin_iface_init (IdeWorkbenchAddinInterface *iface)
+{
+  iface->can_open = gbp_web_browser_workbench_addin_can_open;
+  iface->open_async = gbp_web_browser_workbench_addin_open_async;
+  iface->open_finish = gbp_web_browser_workbench_addin_open_finish;
+  iface->load = gbp_web_browser_workbench_addin_load;
+  iface->unload = gbp_web_browser_workbench_addin_unload;
+}
+
+G_DEFINE_FINAL_TYPE_WITH_CODE (GbpWebBrowserWorkbenchAddin, gbp_web_browser_workbench_addin, G_TYPE_OBJECT,
+                               G_IMPLEMENT_INTERFACE (IDE_TYPE_WORKBENCH_ADDIN, workbench_addin_iface_init))
+
+static void
+gbp_web_browser_workbench_addin_class_init (GbpWebBrowserWorkbenchAddinClass *klass)
+{
+}
+
+static void
+gbp_web_browser_workbench_addin_init (GbpWebBrowserWorkbenchAddin *self)
+{
+}
diff --git a/src/plugins/web-browser/gbp-web-browser-workbench-addin.h 
b/src/plugins/web-browser/gbp-web-browser-workbench-addin.h
new file mode 100644
index 000000000..76b8d2a24
--- /dev/null
+++ b/src/plugins/web-browser/gbp-web-browser-workbench-addin.h
@@ -0,0 +1,31 @@
+/* gbp-web-browser-workbench-addin.h
+ *
+ * Copyright 2022 Christian Hergert <chergert redhat com>
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program 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 for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * SPDX-License-Identifier: GPL-3.0-or-later
+ */
+
+#pragma once
+
+#include <glib-object.h>
+
+G_BEGIN_DECLS
+
+#define GBP_TYPE_WEB_BROWSER_WORKBENCH_ADDIN (gbp_web_browser_workbench_addin_get_type())
+
+G_DECLARE_FINAL_TYPE (GbpWebBrowserWorkbenchAddin, gbp_web_browser_workbench_addin, GBP, 
WEB_BROWSER_WORKBENCH_ADDIN, GObject)
+
+G_END_DECLS
diff --git a/src/plugins/web-browser/meson.build b/src/plugins/web-browser/meson.build
index ba1933ca0..50d3fb568 100644
--- a/src/plugins/web-browser/meson.build
+++ b/src/plugins/web-browser/meson.build
@@ -2,6 +2,7 @@ if get_option('webkit').enabled()
 
 plugins_sources += files([
   'web-browser-plugin.c',
+  'gbp-web-browser-workbench-addin.c',
   'gbp-web-browser-workspace-addin.c',
 ])
 
diff --git a/src/plugins/web-browser/web-browser-plugin.c b/src/plugins/web-browser/web-browser-plugin.c
index f8500deb6..2e46c0c04 100644
--- a/src/plugins/web-browser/web-browser-plugin.c
+++ b/src/plugins/web-browser/web-browser-plugin.c
@@ -25,11 +25,15 @@
 #include <libide-gui.h>
 #include <libide-webkit.h>
 
+#include "gbp-web-browser-workbench-addin.h"
 #include "gbp-web-browser-workspace-addin.h"
 
 _IDE_EXTERN void
 _gbp_web_browser_register_types (PeasObjectModule *module)
 {
+  peas_object_module_register_extension_type (module,
+                                              IDE_TYPE_WORKBENCH_ADDIN,
+                                              GBP_TYPE_WEB_BROWSER_WORKBENCH_ADDIN);
   peas_object_module_register_extension_type (module,
                                               IDE_TYPE_WORKSPACE_ADDIN,
                                               GBP_TYPE_WEB_BROWSER_WORKSPACE_ADDIN);