Merge ~waveform/ubiquity:soup3 into ubiquity:main

[Dave Jones]

[Dave Jones (waveform)]

This merge fixes the oem-config process on preinstalled desktop images (most notably, the Ubuntu Desktop for Raspberry Pi images) by updating the ubi-timezone plugin to support the libsoup3 API. This is now required by other components, and libsoup2.4 and libsoup3 cannot co-exist in the process, so ubi-timezone must be updated.

The change has been successfully tested on the noble Desktop for Pi images, with networking present, absent, and initially present but removed when the plugin is active (to test the cancellation pathway).

[Steve Langasek (vorlon)]

review: Approve

diff --git a/debian/changelog b/debian/changelog
index 62abe5b..e9e8ab2 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -1,3 +1,9 @@
+ubiquity (24.04.5) UNRELEASED; urgency=medium
+
+  * plugins/ubi-timezone.py: Update to support libsoup3 API (LP: #1987454)
+
+ -- Dave Jones <[e-mail]>  Sun, 14 Apr 2024 14:23:58 +0100
+
 ubiquity (24.04.4) noble; urgency=medium
 
   * Bump webkit gir dependency to 4.1.
diff --git a/ubiquity/plugins/ubi-timezone.py b/ubiquity/plugins/ubi-timezone.py
index 4f2fdb7..3806a1a 100644
--- a/ubiquity/plugins/ubi-timezone.py
+++ b/ubiquity/plugins/ubi-timezone.py
@@ -95,7 +95,7 @@ class PageGtk(plugin.PluginUI):
     def changed(self, entry):
         import gi
         gi.require_version('Soup', '3.0')
-        from gi.repository import Gtk, GObject, GLib, Soup
+        from gi.repository import Gtk, GObject, GLib, Gio, Soup
 
         text = misc.utf8(self.city_entry.get_text())
         if not text:
@@ -114,15 +114,17 @@ class PageGtk(plugin.PluginUI):
                 self.geoname_session = Soup.Session()
             url = _geoname_url % (quote(text), misc.get_release().version)
             message = Soup.Message.new('GET', url)
-            message.request_headers.append('User-agent', 'Ubiquity/1.0')
+            message.get_request_headers().replace('User-agent', 'Ubiquity/1.0')
             self.geoname_session.abort()
             if self.geoname_timeout_id is not None:
                 GLib.source_remove(self.geoname_timeout_id)
+            cancellable = Gio.Cancellable()
             self.geoname_timeout_id = \
                 GLib.timeout_add_seconds(2, self.geoname_timeout,
-                                         (text, model))
-            self.geoname_session.queue_message(message, self.geoname_cb,
-                                               (text, model))
+                                         (text, model, cancellable))
+            self.geoname_session.send_and_read_async(
+                message, GLib.PRIORITY_DEFAULT, cancellable, self.geoname_cb,
+                (text, model))
 
     def geoname_add_tzdb(self, text, model):
         if len(model):
@@ -147,16 +149,17 @@ class PageGtk(plugin.PluginUI):
                               str(loc.latitude), str(loc.longitude)])
 
     def geoname_timeout(self, user_data):
-        text, model = user_data
+        text, model, cancellable = user_data
+        cancellable.cancel()
         self.geoname_add_tzdb(text, model)
         self.geoname_timeout_id = None
         self.city_entry.get_completion().set_model(model)
         return False
 
-    def geoname_cb(self, session, message, user_data):
+    def geoname_cb(self, session, result, user_data):
         import syslog
         import json
-        from gi.repository import GLib, Soup
+        from gi.repository import GLib, Gio, Soup
 
         text, model = user_data
 
@@ -165,27 +168,37 @@ class PageGtk(plugin.PluginUI):
             self.geoname_timeout_id = None
         self.geoname_add_tzdb(text, model)
 
-        if message.status_code == Soup.KnownStatusCode.CANCELLED:
-            # Silently ignore cancellation.
-            pass
-        elif message.status_code != Soup.KnownStatusCode.OK:
-            # Log but otherwise ignore failures.
-            syslog.syslog(
-                'Geoname lookup for "%s" failed: %d %s' %
-                (text, message.status_code, message.reason_phrase))
+        message = session.get_async_result_message(result)
+        try:
+            response = session.send_and_read_finish(result)
+        except GLib.GError as err:
+            if err.code == Gio.IOErrorEnum.CANCELLED:
+                # Silently ignore cancellation.
+                pass
+            else:
+                # Log but otherwise ignore failures.
+                syslog.syslog(
+                    'Geoname lookup for "%s" failed: %s' % (text, err.message))
         else:
-            try:
-                for result in json.loads(message.response_body.data):
-                    model.append([
-                        result['name'], result['admin1'], result['country'],
-                        result['latitude'], result['longitude']])
-
-                # Only cache positive results.
-                self.geoname_cache[text] = model
-
-            except ValueError:
+            if message.get_status() != Soup.Status.OK:
+                # Log but otherwise ignore failures
                 syslog.syslog(
-                    'Server return does not appear to be valid JSON.')
+                    'Geoname lookup for "%s" failed: %s %s' %
+                    (text, message.get_status(), message.get_reason_phrase()))
+            else:
+                try:
+                    for result in json.loads(response.get_data().decode()):
+                        model.append([
+                            result['name'], result['admin1'],
+                            result['country'], result['latitude'],
+                            result['longitude']])
+
+                    # Only cache positive results.
+                    self.geoname_cache[text] = model
+
+                except ValueError:
+                    syslog.syslog(
+                        'Server return does not appear to be valid JSON.')
 
         self.city_entry.get_completion().set_model(model)