Merge ~ddstreet/software-properties:simple_http_unix_connection into software-properties:ubuntu/master

[Dan Streetman]

[Shivaram Lingamneni (slingamn)]

This crashed for me on 20.04:

Jan 26 12:17:00 guivm gnome-control-center.desktop[2058]: Traceback (most recent call last):
Jan 26 12:17:00 guivm gnome-control-center.desktop[2058]: File "/usr/bin/software-properties-gtk", line 37, in <module>
Jan 26 12:17:00 guivm gnome-control-center.desktop[2058]: from softwareproperties.gtk.SoftwarePropertiesGtk import SoftwarePropertiesGtk
Jan 26 12:17:00 guivm gnome-control-center.desktop[2058]: File "/usr/lib/python3/dist-packages/softwareproperties/gtk/SoftwarePropertiesGtk.py", line 56, in <module>
Jan 26 12:17:00 guivm gnome-control-center.desktop[2058]: from .LivepatchPage import LivepatchPage
Jan 26 12:17:00 guivm gnome-control-center.desktop[2058]: File "/usr/lib/python3/dist-packages/softwareproperties/gtk/LivepatchPage.py", line 31, in <module>
Jan 26 12:17:00 guivm gnome-control-center.desktop[2058]: from softwareproperties.LivepatchService import (
Jan 26 12:17:00 guivm gnome-control-center.desktop[2058]: File "/usr/lib/python3/dist-packages/softwareproperties/LivepatchService.py", line 24, in <module>
Jan 26 12:17:00 guivm gnome-control-center.desktop[2058]: from urllib import urlparse, urlencode
Jan 26 12:17:00 guivm gnome-control-center.desktop[2058]: ImportError: cannot import name 'urlparse' from 'urllib' (/usr/lib/python3.8/urllib/__init__.py)

With the import changed to `from urllib.parse import urlparse, urlencode`, it doesn't crash, but the UI displays "Failed to retrieve Livepatch status.". I think it might be hitting an exception somewhere?

[Shivaram Lingamneni (slingamn)]

Found this in strace: "WARNING:root:name 'socket' is not defined, Retrying in 12.8 seconds..."

I added the missing import of `socket`, but then I got this from strace:

connect(9, {sa_family=AF_UNIX, sun_path=http+unix://%2Fvar%2Fsnap%2Fcanonical-livepatch%2Fcurrent%2Flivepatchd-priv.sock/disable}, 90) = -1 ENOENT (No such file or directory)

so it's not correctly decoding the socket path from the URL.

[Dan Streetman (ddstreet)]

thanks - added the import socket and fixed the socket paths; can you try again?

[Shivaram Lingamneni (slingamn)]

I believe I tested this successfully in 20.04, with minor backporting. The following changes are necessary on top of ecf462b:

1. `sock.sock = sock` should be `self.sock = sock`
2. A reference to `self.LIVEPATCH_RUNNING_FILE` should be to `LIVEPATCH_RUNNING_FILE` instead

[Dan Streetman (ddstreet)]

thanks, think it should be all corrected now

[Shivaram Lingamneni (slingamn)]

Looks good to me --- fe44624 is identical to the version I successfully tested, except for the 20.04 backporting changes.

Thanks!

[Dan Streetman (ddstreet)]

thanks, merged!

diff --git a/softwareproperties/LivepatchService.py b/softwareproperties/LivepatchService.py
index 7dcd889..163f729 100644
--- a/softwareproperties/LivepatchService.py
+++ b/softwareproperties/LivepatchService.py
@@ -20,8 +20,12 @@
 #  USA
 
 from gettext import gettext as _
+from contextlib import closing
+from urllib.parse import urlencode
+import http.client
 import logging
 import json
+import socket
 
 import gi
 from gi.repository import Gio, GLib, GObject
@@ -43,8 +47,6 @@ from softwareproperties.gtk.utils import (
 
 from softwareproperties.LivepatchSnap import LivepatchSnap
 
-from .http_unixdomain import unix_http_request
-
 def datetime_parser(json_dict):
     for (key, value) in json_dict.items():
         try:
@@ -60,13 +62,27 @@ class LivepatchAvailability:
     CHECKING = 2
 
 
-class LivepatchService(GObject.GObject):
+# copied from update-manager package UpdateManager/Core/LivePatchSocket.py
+class UHTTPConnection(http.client.HTTPConnection):
+
+    def __init__(self, path):
+        http.client.HTTPConnection.__init__(self, 'localhost')
+        self.path = path
+
+    def connect(self):
+        sock = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM)
+        sock.connect(self.path)
+        self.sock = sock
 
-    # Constants
-    STATUS_ENDPOINT = 'http+unix://%2Fvar%2Fsnap%2Fcanonical-livepatch%2Fcurrent%2Flivepatchd.sock/status'
-    ENABLE_ENDPOINT = 'http+unix://%2Fvar%2Fsnap%2Fcanonical-livepatch%2Fcurrent%2Flivepatchd-priv.sock/enable'
-    DISABLE_ENDPOINT = 'http+unix://%2Fvar%2Fsnap%2Fcanonical-livepatch%2Fcurrent%2Flivepatchd-priv.sock/disable'
-    LIVEPATCH_RUNNING_FILE = '/var/snap/canonical-livepatch/common/machine-token'
+
+# Constants
+LIVEPATCH_SNAP_CURRENT_DIR = '/var/snap/canonical-livepatch/current'
+LIVEPATCH_SOCKET = f'{LIVEPATCH_SNAP_CURRENT_DIR}/livepatchd.sock'
+LIVEPATCH_PRIV_SOCKET = f'{LIVEPATCH_SNAP_CURRENT_DIR}/livepatchd-priv.sock'
+LIVEPATCH_RUNNING_FILE = '/var/snap/canonical-livepatch/common/machine-token'
+
+
+class LivepatchService(GObject.GObject):
 
     ENABLE_ERROR_MSG = _('Failed to enable Livepatch: {}')
     DISABLE_ERROR_MSG = _('Failed to disable Livepatch: {}')
@@ -95,7 +111,7 @@ class LivepatchService(GObject.GObject):
         # Init Properties
         self._availability = LivepatchAvailability.FALSE
         self._availability_message = None
-        lp_file = Gio.File.new_for_path(path=self.LIVEPATCH_RUNNING_FILE)
+        lp_file = Gio.File.new_for_path(path=LIVEPATCH_RUNNING_FILE)
         self._enabled = lp_file.query_exists()
 
         # Monitor connectivity status
@@ -196,8 +212,11 @@ class LivepatchService(GObject.GObject):
         """
         try:
             params = {'verbosity': 3, 'format': 'json'}
-            _, response = unix_http_request('GET', self.STATUS_ENDPOINT, params=params)
-            return json.loads(response, object_hook=datetime_parser)
+            with closing(UHTTPConnection(LIVEPATCH_SOCKET)) as c:
+                url = f'/status?{urlencode(params)}'
+                c.request('GET', url)
+                response = c.getresponse()
+                return json.loads(response.read(), object_hook=datetime_parser)
         except Exception as e:
             logging.debug('Failed to get Livepatch status: {}'.format(str(e)))
             return None
@@ -222,9 +241,12 @@ class LivepatchService(GObject.GObject):
     @retry(Exception)
     def _enable_service_with_retry(self, token):
         params = {'auth-token': token}
-        code, response = unix_http_request('PUT', self.ENABLE_ENDPOINT, params=params)
-        if 400 <= code < 600:
-            return True, self.ENABLE_ERROR_MSG.format(response.decode('utf-8'))
+        with closing(UHTTPConnection(LIVEPATCH_PRIV_SOCKET)) as c:
+            url = f'/enable?{urlencode(params)}'
+            c.request('PUT', url)
+            response = c.getresponse()
+            if 400 <= response.status < 600:
+                return True, self.ENABLE_ERROR_MSG.format(response.read().decode('utf-8'))
         return False, ''
 
     def _disable_service(self):
@@ -242,9 +264,11 @@ class LivepatchService(GObject.GObject):
 
     @retry(Exception)
     def _disable_service_with_retry(self):
-        code, response = unix_http_request('PUT', self.DISABLE_ENDPOINT)
-        if 400 <= code < 600:
-            return True, self.DISABLE_ERROR_MSG.format(response.decode('utf-8'))
+        with closing(UHTTPConnection(LIVEPATCH_PRIV_SOCKET)) as c:
+            c.request('PUT', '/disable')
+            response = c.getresponse()
+            if 400 <= response.status < 600:
+                return True, self.DISABLE_ERROR_MSG.format(response.read().decode('utf-8'))
         return False, ''
 
     # Signals handlers
diff --git a/softwareproperties/http_unixdomain.py b/softwareproperties/http_unixdomain.py
 deleted file mode 100644
index 767a9f4..0000000
--- a/softwareproperties/http_unixdomain.py
+++ /dev/null
@@ -1,43 +0,0 @@
-import socket
-import http.client
-from urllib.parse import unquote, urlencode, urlparse
-
-# UnixHTTPConnection is from https://github.com/msabramo/requests-unixsocket
-# which is released under the Apache License 2.0
-class UnixHTTPConnection(http.client.HTTPConnection, object):
-
-    def __init__(self, unix_socket_url, timeout=60):
-        """Create an HTTP connection to a unix domain socket
-
-        :param unix_socket_url: A URL with a scheme of 'http+unix' and the
-        netloc is a percent-encoded path to a unix domain socket. E.g.:
-        'http+unix://%2Ftmp%2Fprofilesvc.sock/status/pid'
-        """
-        super(UnixHTTPConnection, self).__init__('localhost', timeout=timeout)
-        self.unix_socket_url = unix_socket_url
-        self.timeout = timeout
-        self.sock = None
-
-    def __del__(self):  # base class does not have d'tor
-        if self.sock:
-            self.sock.close()
-
-    def connect(self):
-        sock = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM)
-        sock.settimeout(self.timeout)
-        socket_path = unquote(urlparse(self.unix_socket_url).netloc)
-        sock.connect(socket_path)
-        self.sock = sock
-
-def unix_http_request(verb, url, params=None):
-    parsed_url = urlparse(url)
-    conn = UnixHTTPConnection(url)
-    try:
-        path = parsed_url.path
-        if params is not None:
-            path = '%s?%s' % (parsed_url.path, urlencode(params))
-        conn.request(verb.upper(), path)
-        response = conn.getresponse()
-        return response.status, response.read()
-    finally:
-        conn.close()