Merge ~mustafakemalgilor/ubuntu/+source/metacity:ubuntu/jammy-devel into ubuntu/+source/metacity:ubuntu/jammy-devel

[Mustafa Kemal Gilor]

Metacity crashes when a docked window in an application is un-docked, and the owning parent window is minimized. This MP includes two patches for fixing the crash (0001,0002), and another one (0003) for fixing restoring docked windows back when the main window is minimized and unminimized while a docked window is un-docked.

SRU LP#2003176

Unmerged commits

a59bbed... by Mustafa Kemal Gilor on 2023-01-18

changelog

Signed-off-by: Mustafa Kemal Gilor <email address hidden>

9883bab... by Mustafa Kemal Gilor on 2023-01-18

* d/p/0001-add-meta-window-is-focusable.patch: add meta_window
  is_focusable function (needed by patch #0002) (LP: #2003176)
* d/p/0002-focus-only-ancestors-that-are-focusable.patch: patch that
  fixes undocked window parent minimize crash (LP: #2003176)
* d/p/0003-remove-extra-unmap-events-window-and-serial.patch: fix docked
  child window restore on main window unminimize (LP: #2003176)

Signed-off-by: Mustafa Kemal Gilor <email address hidden>

diff --git a/debian/changelog b/debian/changelog
index 139d6ae..4d3a354 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -1,3 +1,12 @@
+metacity (1:3.44.0-1ubuntu1) jammy; urgency=medium
+
+  * Backport upstream patch to fix metacity crash when a parent window is
+    minimized while a docked window is undocked.
+  * Backport upstream patch to fix restoring docked window when the parent
+    window is unminimized.
+
+ -- Mustafa Kemal GILOR <[e-mail]>  Wed, 18 Jan 2023 15:50:17 +0300
+
 metacity (1:3.44.0-1) unstable; urgency=medium
 
   * New upstream release.
diff --git a/debian/patches/0001-add-meta-window-is-focusable.patch b/debian/patches/0001-add-meta-window-is-focusable.patch
new file mode 100644
index 0000000..dc2f380
--- /dev/null
+++ b/debian/patches/0001-add-meta-window-is-focusable.patch
@@ -0,0 +1,69 @@
+From abcbdcce1e67a7c652a21c7578aba69e1bda08c4 Mon Sep 17 00:00:00 2001
+From: =?UTF-8?q?Alberts=20Muktup=C4=81vels?= <[e-mail]>
+Date: Mon, 3 Oct 2022 19:52:39 +0300
+Subject: [PATCH] window: add meta_window_is_focusable
+
+Based on mutter commits:
+https://gitlab.gnome.org/GNOME/mutter/-/commit/43633d6b2f6f602ba87956d5c20ee336b8b56236
+https://gitlab.gnome.org/GNOME/mutter/-/commit/58d2a674c466b607e18e6c8e129a6cf1646fde7f
+---
+ src/core/stack.c          |  2 +-
+ src/core/window-private.h |  2 ++
+ src/core/window.c         | 10 ++++++++--
+ 3 files changed, 11 insertions(+), 3 deletions(-)
+
+--- a/src/core/stack.c
++++ b/src/core/stack.c
+@@ -1243,7 +1243,7 @@
+       if (window->unmanaging)
+         continue;
+ 
+-      if (!(window->input || window->take_focus))
++      if (!meta_window_is_focusable (window))
+         continue;
+ 
+       if (!meta_window_should_be_showing_on_workspace (window, workspace))
+--- a/src/core/window-private.h
++++ b/src/core/window-private.h
+@@ -592,6 +592,8 @@
+ void     meta_window_set_focused_internal (MetaWindow *window,
+                                            gboolean    focused);
+ 
++gboolean meta_window_is_focusable (MetaWindow *self);
++
+ void     meta_window_set_current_workspace_hint (MetaWindow *window);
+ 
+ unsigned long meta_window_get_net_wm_desktop (MetaWindow *window);
+--- a/src/core/window.c
++++ b/src/core/window.c
+@@ -2043,7 +2043,7 @@
+   /* don't initially focus windows that are intended to not accept
+    * focus
+    */
+-  if (!(window->input || window->take_focus))
++  if (!meta_window_is_focusable (window))
+     {
+       *takes_focus = FALSE;
+       return;
+@@ -4417,7 +4417,7 @@
+    */
+   if (window->frame &&
+       (window->shaded ||
+-       !(window->input || window->take_focus)))
++       !meta_window_is_focusable (window)))
+     {
+       if (window->frame)
+         {
+@@ -5902,6 +5902,12 @@
+     }
+ }
+ 
++gboolean
++meta_window_is_focusable (MetaWindow *self)
++{
++  return self->input || self->take_focus;
++}
++
+ static gboolean
+ process_property_notify (MetaWindow     *window,
+                          XPropertyEvent *event)
diff --git a/debian/patches/0002-focus-only-ancestors-that-are-focusable.patch b/debian/patches/0002-focus-only-ancestors-that-are-focusable.patch
new file mode 100644
index 0000000..8f57831
--- /dev/null
+++ b/debian/patches/0002-focus-only-ancestors-that-are-focusable.patch
@@ -0,0 +1,74 @@
+From 398fa63cff7b791e78c0a7b7e2234b0344959819 Mon Sep 17 00:00:00 2001
+From: =?UTF-8?q?Alberts=20Muktup=C4=81vels?= <[e-mail]>
+Date: Mon, 3 Oct 2022 20:19:38 +0300
+Subject: [PATCH] workspace: focus only ancestors that are focusable
+
+Based on mutter commit:
+https://gitlab.gnome.org/GNOME/mutter/-/commit/eccc791f3b3451216f957e67fec47a73b65ed2b2
+---
+ src/core/workspace.c | 39 ++++++++++++++++++++++++++++++++-------
+ 1 file changed, 32 insertions(+), 7 deletions(-)
+
+diff --git a/src/core/workspace.c b/src/core/workspace.c
+index 19e3a9a8..45306dd6 100644
+--- a/src/core/workspace.c
++++ b/src/core/workspace.c
+@@ -969,14 +969,30 @@ meta_workspace_focus_default_window (MetaWorkspace *workspace,
+     }
+ }
+ 
++typedef struct
++{
++  MetaWorkspace *workspace;
++  MetaWindow    *ancestor;
++} FindFocusableAncestorData;
++
+ static gboolean
+-record_ancestor (MetaWindow *window,
+-                 void       *data)
++find_focusable_ancestor (MetaWindow *window,
++                         gpointer    user_data)
+ {
+-  MetaWindow **result = data;
++  FindFocusableAncestorData *data;
+ 
+-  *result = window;
+-  return FALSE; /* quit with the first ancestor we find */
++  data = user_data;
++
++  if (!window->unmanaging &&
++      meta_window_is_focusable (window) &&
++      meta_window_located_on_workspace (window, data->workspace) &&
++      meta_window_showing_on_its_workspace (window))
++    {
++      data->ancestor = window;
++      return FALSE;
++    }
++
++  return TRUE;
+ }
+ 
+ /* Focus ancestor of not_this_one if there is one */
+@@ -998,8 +1014,17 @@ focus_ancestor_or_top_window (MetaWorkspace *workspace,
+   if (not_this_one)
+     {
+       MetaWindow *ancestor;
+-      ancestor = NULL;
+-      meta_window_foreach_ancestor (not_this_one, record_ancestor, &ancestor);
++      FindFocusableAncestorData data;
++
++      data.workspace = workspace;
++      data.ancestor = NULL;
++
++      meta_window_foreach_ancestor (not_this_one,
++                                    find_focusable_ancestor,
++                                    &data);
++
++      ancestor = data.ancestor;
++
+       if (ancestor != NULL)
+         {
+           meta_topic (META_DEBUG_FOCUS,
+-- 
+GitLab
+
diff --git a/debian/patches/0003-remove-extra-unmap-events-window-and-serial.patch b/debian/patches/0003-remove-extra-unmap-events-window-and-serial.patch
new file mode 100644
index 0000000..01cca21
--- /dev/null
+++ b/debian/patches/0003-remove-extra-unmap-events-window-and-serial.patch
@@ -0,0 +1,95 @@
+From 3db07fafa1c7ff9749b6a82ccb36d8b62f2304d9 Mon Sep 17 00:00:00 2001
+From: =?UTF-8?q?Alberts=20Muktup=C4=81vels?= <[e-mail]>
+Date: Wed, 5 Oct 2022 01:57:04 +0300
+Subject: [PATCH] display: remove extra unmap events with same window and
+ serial
+
+Single XUnmapWindow call can result in multiple UnmapNotify events.
+
+Linked issue has attached python code intended to reproduce original
+bug and can be used to reproduce multiple UnmapNotify events for the
+same window.
+
+Steps to reproduce problem:
+1. Run python3 Untitled.py;
+2. Undock one of the application's child windows;
+3. Minimize main window;
+4. Unminimize main window.
+
+On drag start metacity gets map event - new MetaWindow is created.
+This window has override_redirect set to true, metacity selects
+StructureNotifyMask events. When child window is dropped outside
+main window we get 3 unmap events!
+
+One event was sent because we asked X server to do that by selecting
+StructureNotifyMask events. Second event was sent because child
+window parent was root window. We have asked for such events on root
+window by selecting SubstructureNotifyMask events. Third event seems
+to come from XSendEvent.
+
+At this point these multiple events are not problem. MetaWindow is
+destroyed when we get first event and rest are ignored.
+
+After that application sends map request and we create new
+MetaWindow. This time override_redirect is not set and we choose to
+not select StructureNotifyMask events. Unfortunately this mask is
+already in your_event_mask as we are not unselecting events when
+window is unmanaged.
+
+Now when we minimize main window (step 3) also dock window is
+minimized. We are just hiding window so we are adding pending unmap
+event so we can ignore it when it will arrive. On first event we
+correctly detect that it should be ignored but once second event
+arrives we are unmanaging this window.
+
+And here is our problem - trying to unminimize main window only
+main window gets restored! Main window does not find child window
+because it is destroyed.
+
+Use XCheckIfEvent to remove extra UnmapNotify events that has same
+window and serial preventing unnecessary window destruction.
+
+https://gitlab.gnome.org/GNOME/metacity/-/issues/31
+---
+ src/core/display.c | 23 +++++++++++++++++++++++
+ 1 file changed, 23 insertions(+)
+
+--- a/src/core/display.c
++++ b/src/core/display.c
+@@ -1696,6 +1696,20 @@
+     }
+ }
+ 
++static Bool
++unmap_predicate (Display  *display,
++                 XEvent   *event,
++                 XPointer  arg)
++{
++  XUnmapEvent *unmap;
++
++  unmap = (XUnmapEvent *) arg;
++
++  return event->type == UnmapNotify &&
++         event->xunmap.window == unmap->window &&
++         event->xunmap.serial == unmap->serial;
++}
++
+ /**
+  * This is the most important function in the whole program. It is the heart,
+  * it is the nexus, it is the Grand Central Station of Metacity's world.
+@@ -2283,6 +2297,15 @@
+ 
+           if (!frame_was_receiver)
+             {
++              XEvent unmap_event;
++
++              while (XCheckIfEvent (display->xdisplay,
++                                    &unmap_event,
++                                    unmap_predicate,
++                                    (XPointer) &event->xunmap))
++                {
++                }
++
+               if (!meta_window_remove_pending_unmap (window, event->xany.serial))
+                 {
+                   meta_topic (META_DEBUG_WINDOW_STATE,
diff --git a/debian/patches/series b/debian/patches/series
new file mode 100644
index 0000000..aebba11
--- /dev/null
+++ b/debian/patches/series
@@ -0,0 +1,3 @@
+0001-add-meta-window-is-focusable.patch
+0002-focus-only-ancestors-that-are-focusable.patch
+0003-remove-extra-unmap-events-window-and-serial.patch