Merge ~robert-ancell/software-properties:esm-bionic into software-properties:ubuntu/bionic

[Robert Ancell]

[Robert Ancell (robert-ancell)]

See https://code.launchpad.net/~robert-ancell/software-properties/+git/software-properties/+merge/400153 for the related change to master.

Unmerged commits

b8e712d... by Robert Ancell on 2021-03-08

Show extended security maintenance status

Also worked on by Chad Smith.

diff --git a/data/gtkbuilder/main.ui b/data/gtkbuilder/main.ui
index 642e45c..7df32b9 100644
--- a/data/gtkbuilder/main.ui
+++ b/data/gtkbuilder/main.ui
@@ -550,7 +550,18 @@
                   <packing>
                     <property name="expand">False</property>
                     <property name="fill">True</property>
-                    <property name="position">0</property>
+                  </packing>
+                </child>
+                <child>
+                  <object class="GtkLabel">
+                    <property name="visible">True</property>
+                    <property name="can_focus">False</property>
+                    <property name="label" translatable="yes">Snap package updates are checked routinely and installed automatically.</property>
+                    <property name="xalign">0</property>
+                  </object>
+                  <packing>
+                    <property name="expand">False</property>
+                    <property name="fill">False</property>
                   </packing>
                 </child>
                 <child>
@@ -565,6 +576,98 @@
                         <property name="can_focus">False</property>
                         <property name="spacing">6</property>
                         <child>
+                          <object class="GtkHBox">
+                            <property name="visible">True</property>
+                            <property name="can_focus">False</property>
+                            <property name="spacing">6</property>
+                            <child>
+                              <object class="GtkLabel" id="label_esm_heading">
+                                <property name="visible">True</property>
+                                <property name="can_focus">False</property>
+                                <property name="xalign">1</property>
+                                <property name="label" translatable="yes">For other packages, this system has:</property>
+                              </object>
+                              <packing>
+                                <property name="expand">False</property>
+                                <property name="fill">False</property>
+                                <property name="position">0</property>
+                              </packing>
+                            </child>
+                            <child>
+                              <object class="GtkHBox">
+                                <property name="visible">True</property>
+                                <property name="can_focus">False</property>
+                                <property name="spacing">6</property>
+                                <child>
+                                  <object class="GtkLabel" id="label_esm_status">
+                                    <property name="visible">True</property>
+                                    <property name="can_focus">False</property>
+                                    <property name="xalign">0</property>
+                                  </object>
+                                  <packing>
+                                    <property name="expand">False</property>
+                                    <property name="fill">True</property>
+                                  </packing>
+                                </child>
+                                <child>
+                                  <object class="GtkLabel" id="label_esm_subscribe">
+                                    <property name="visible">True</property>
+                                    <property name="can_focus">False</property>
+                                    <property name="xalign">1</property>
+                                  </object>
+                                  <packing>
+                                    <property name="expand">True</property>
+                                    <property name="fill">True</property>
+                                  </packing>
+                                </child>
+                              </object>
+                              <packing>
+                                <property name="expand">True</property>
+                                <property name="fill">True</property>
+                                <property name="position">1</property>
+                              </packing>
+                            </child>
+                          </object>
+                          <packing>
+                            <property name="expand">False</property>
+                            <property name="fill">False</property>
+                          </packing>
+                        </child>
+                        <child>
+                          <object class="GtkHBox">
+                            <property name="visible">True</property>
+                            <property name="can_focus">False</property>
+                            <property name="spacing">6</property>
+                            <child>
+                              <object class="GtkLabel" id="label_eol_heading">
+                                <property name="visible">True</property>
+                                <property name="can_focus">False</property>
+                              </object>
+                              <packing>
+                                <property name="expand">False</property>
+                                <property name="fill">False</property>
+                                <property name="position">0</property>
+                              </packing>
+                            </child>
+                            <child>
+                              <object class="GtkLabel" id="label_eol">
+                                <property name="visible">True</property>
+                                <property name="can_focus">False</property>
+                                <property name="xalign">0</property>
+                              </object>
+                              <packing>
+                                <property name="expand">True</property>
+                                <property name="fill">True</property>
+                                <property name="position">1</property>
+                              </packing>
+                            </child>
+                          </object>
+                          <packing>
+                            <property name="expand">False</property>
+                            <property name="fill">False</property>
+                          </packing>
+                        </child>
+                        <child>
                           <object class="GtkHBox" id="hbox_check_for_updates">
                             <property name="visible">True</property>
                             <property name="can_focus">False</property>
@@ -604,7 +707,6 @@
                           <packing>
                             <property name="expand">False</property>
                             <property name="fill">False</property>
-                            <property name="position">0</property>
                           </packing>
                         </child>
                         <child>
@@ -647,7 +749,6 @@
                           <packing>
                             <property name="expand">False</property>
                             <property name="fill">False</property>
-                            <property name="position">1</property>
                           </packing>
                         </child>
                         <child>
@@ -690,7 +791,6 @@
                           <packing>
                             <property name="expand">False</property>
                             <property name="fill">False</property>
-                            <property name="position">2</property>
                           </packing>
                         </child>
                       </object>
@@ -699,7 +799,6 @@
                   <packing>
                     <property name="expand">True</property>
                     <property name="fill">True</property>
-                    <property name="position">1</property>
                   </packing>
                 </child>
                 <child>
@@ -749,7 +848,6 @@
                   <packing>
                     <property name="expand">False</property>
                     <property name="fill">False</property>
-                    <property name="position">2</property>
                   </packing>
                 </child>
               </object>
@@ -1406,6 +1504,8 @@
   </object>
   <object class="GtkSizeGroup" id="sizegroup1">
     <widgets>
+      <widget name="label_esm_heading"/>
+      <widget name="label_eol_heading"/>
       <widget name="label3"/>
       <widget name="label4"/>
       <widget name="label5"/>
diff --git a/debian/changelog b/debian/changelog
index 0079494..463fc2c 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -1,3 +1,9 @@
+software-properties (0.96.24.32.15) UNRELEASED; urgency=medium
+
+  * Show ESM support status (LP: #1920836)
+
+ -- Robert Ancell <[e-mail]>  Tue, 23 Mar 2021 16:44:44 +1300
+
 software-properties (0.96.24.32.14) bionic-security; urgency=medium
 
   * SECURITY UPDATE: malicious repo could send ANSI sequences to terminal
diff --git a/softwareproperties/gtk/SoftwarePropertiesGtk.py b/softwareproperties/gtk/SoftwarePropertiesGtk.py
index 9444e55..867b7a8 100644
--- a/softwareproperties/gtk/SoftwarePropertiesGtk.py
+++ b/softwareproperties/gtk/SoftwarePropertiesGtk.py
@@ -27,6 +27,7 @@ from __future__ import absolute_import, print_function
 
 import apt
 import apt_pkg
+import datetime
 import dbus
 from gettext import gettext as _
 import gettext
@@ -57,6 +58,13 @@ import softwareproperties.distro
 from softwareproperties.SoftwareProperties import SoftwareProperties
 import softwareproperties.SoftwareProperties
 
+from softwareproperties.gtk.utils import (
+    get_ua_status,
+    get_ua_service_status,
+    current_distro,
+    is_current_distro_lts,
+)
+
 from UbuntuDrivers import detect
 
 if GLib.pyglib_version < (3, 9, 1):
@@ -369,6 +377,54 @@ class SoftwarePropertiesGtk(SoftwareProperties, SimpleGtkbuilderApp):
                 self.vbox_updates.add(checkbox)
             checkbox.show()
 
+        status = get_ua_status()
+        if not is_current_distro_lts():
+                esm_available = False
+                esm_enabled = False
+        else:
+                (infra_available, infra_status) = get_ua_service_status("esm-infra", status=status)
+                (apps_available, apps_status) = get_ua_service_status("esm-apps", status=status)
+                esm_available = bool(infra_available or apps_available)
+                esm_enabled = "enabled" in (infra_status, apps_status)
+        distro = current_distro()
+        if esm_enabled:
+                eol_text = _("Extended Security Maintenance")
+                # EOL date should probably be UA contract expiry.
+                # This is probably sooner than ESM EOL for the distro and
+                # gives software properties dialogs a chance to interact about
+                # renewals if needed.
+                try:
+                        eol_date = datetime.datetime.strptime(
+                                status.get("expires"), "%Y-%m-%dT%H:%M:%S"
+                        ).date()
+                except ValueError:
+                        print("Unable to determine UA contract expiry")
+                        eol_date = distro.eol
+        else:
+                eol_text = _("Basic Security Maintenance")
+                eol_date = distro.eol
+        self.label_esm_status.set_markup(eol_text)
+        esm_url = "https://ubuntu.com/esm"  # Non-EOL LTS generic ESM
+        today = datetime.datetime.now().date()
+        if today >= eol_date:
+                if esm_available:
+                        # EOL LTS uses release-specific ESM ubuntu.com/XX-YY
+                        distro_ver = distro.version.replace(' LTS', '')
+                        esm_url = "https://ubuntu.com/%s" % distro_ver.replace(".", "-")
+                eol_expiry_text = _("Ended %s - extend or upgrade now") % eol_date.strftime("%x")
+        elif today >= eol_date - datetime.timedelta(days=60):
+                eol_expiry_text = _("Ends %s - extend or upgrade soon") % eol_date.strftime("%x")
+        else:
+                eol_expiry_text = _("Active until %s") % eol_date.strftime("%x")
+        self.label_eol.set_label(eol_expiry_text)
+        self.label_esm_subscribe.set_markup(
+                "<a href=\"%s\">%s</a>" % (esm_url, _("Extend…"))
+        )
+        self.label_esm_subscribe.set_visible(
+                esm_available and not esm_enabled
+        )
+        eol_expiry_text = _("Ended %s") % eol_date.strftime("%x")
+
         # setup the server chooser
         cell = Gtk.CellRendererText()
         self.combobox_server.pack_start(cell, True)
diff --git a/softwareproperties/gtk/utils.py b/softwareproperties/gtk/utils.py
index e0ddca9..0061785 100644
--- a/softwareproperties/gtk/utils.py
+++ b/softwareproperties/gtk/utils.py
@@ -25,12 +25,16 @@ from functools import wraps
 import gi
 gi.require_version("Gtk", "3.0")
 from gi.repository import Gio, Gtk
+import json
+import subprocess
 
 import logging
 LOG=logging.getLogger(__name__)
 
 import time
 
+UA_STATUS_JSON = "/var/lib/ubuntu-advantage/status.json"
+
 def setup_ui(self, path, domain):
     # setup ui
     self.builder = Gtk.Builder()
@@ -61,6 +65,67 @@ def is_current_distro_supported():
     di = distro_info.UbuntuDistroInfo()
     return distro.codename in di.supported(datetime.now().date())
 
+def current_distro():
+    distro = aptsources.distro.get_distro()
+    di = distro_info.UbuntuDistroInfo()
+    releases = di.get_all(result="object")
+    for release in releases:
+        if release.series == distro.codename:
+            return release
+
+def get_ua_status():
+    """Return a dict of all UA status information or empty dict on error."""
+    # status.json will exist on any attached system or any unattached system
+    # which has already run `ua status`. Calling ua status directly on
+    # network disconnected machines will raise a TimeoutException trying to
+    # access contracts.canonical.com/v1/resources.
+    try:
+        # Success writes UA_STATUS_JSON
+        result = subprocess.run(['ua', 'status', '--format=json'], stdout=subprocess.PIPE)
+    except Exception as e:
+        print("Failed to call ubuntu advantage client:\n%s" % e)
+        return {}
+    if result.returncode != 0:
+        print("Ubuntu advantage client returned code %d" % result.returncode)
+        return {}
+
+    with open(UA_STATUS_JSON, "r") as stream:
+        status_json = stream.read()
+    try:
+        status = json.loads(status_json)
+    except json.JSONDecodeError as e:
+        print("Failed to parse ubuntu advantage client JSON:\n%s" % e)
+        return {}
+    return status
+
+def get_ua_service_status(service_name='esm-infra', status=None):
+    """Get service availability and status for a specific UA service.
+
+    Return a tuple (available, service_status).
+      :boolean available: set True when either:
+        - attached contract is entitled to the service
+        - unattached machine reports service "availability" as "yes"
+      :str service_status: will be one of the following:
+        - "disabled" when the service is available but not active
+        - "enabled" when the service is available and active
+        - "n/a" when the service is not applicable on the environment or not
+          entitled for the attached contract
+    """
+    if not status:
+        status = get_ua_status()
+    available = False
+    service_status = "n/a"
+    for service in status.get("services", []):
+        if service.get("name") == service_name:
+            if service.get("available"):  # then we are not attached
+                if service["available"] == "yes":
+                     available = True
+                     service_status = "disabled"  # Disabled since unattached
+            else:  # attached
+                available = service.get("entitled") == "yes"
+                service_status = service.get("status")  # Will be enabled, disabled or n/a
+    return (available, service_status)
+
 def retry(exceptions, tries=10, delay=0.1, backoff=2):
     """
     Retry calling the decorated function using an exponential backoff.