Merge ~seb128/software-properties:ubuntu-pro-focal into ~robert-ancell/software-properties:ubuntu-pro-focal

[Sebastien Bacher]

Updated version include the work for Nathan on the magic attach workflow

Uploaded also to https://launchpad.net/~ubuntu-desktop/+archive/ubuntu/ppa

[Sebastien Bacher (seb128)]

and it's not working because glib in that serie doesn't have https://gitlab.gnome.org/GNOME/glib/-/issues/602 so we will need to tweak...

diff --git a/data/gtkbuilder/dialog-ua-attach.ui b/data/gtkbuilder/dialog-ua-attach.ui
index 3ae3b1b..8563e86 100644
--- a/data/gtkbuilder/dialog-ua-attach.ui
+++ b/data/gtkbuilder/dialog-ua-attach.ui
@@ -1,119 +1,195 @@
-<?xml version="1.0"?>
+<?xml version="1.0" encoding="UTF-8"?>
 <interface>
+  <requires lib="gtk+" version="3.16"/>
   <object class="GtkDialog" id="dialog_ua_attach">
-    <property name="border_width">18</property>
+    <property name="can-focus">False</property>
+    <property name="border-width">18</property>
     <property name="title" translatable="yes">Enable Ubuntu Pro</property>
     <property name="resizable">False</property>
     <property name="modal">True</property>
-    <property name="type_hint">dialog</property>
-    <property name="skip_taskbar_hint">True</property>
+    <property name="type-hint">dialog</property>
+    <property name="skip-taskbar-hint">True</property>
+    <!-- interface-requires gtk+ 3.0 -->
     <child internal-child="vbox">
       <object class="GtkBox">
+        <property name="visible">True</property>
+        <property name="can-focus">False</property>
+        <property name="no-show-all">True</property>
         <property name="orientation">vertical</property>
-        <property name="spacing">18</property>
+            <child>
+              <object class="GtkLabel">
+                <property name="visible">True</property>
+                <property name="can-focus">True</property>
+                <property name="label" translatable="yes">To upgrade to Ubuntu Pro, use your existing free personal, or company Ubuntu One account, or provide a token. &lt;a href="https://ubuntu.com/login"&gt;Register a new account&lt;/a&gt;.</property>
+                <property name="use-markup">True</property>
+                <property name="wrap">True</property>
+                <property name="max-width-chars">130</property>
+              </object>
+            </child>
+        <child>
+          <object class="GtkRadioButton" id="magic_radio">
+            <property name="label" translatable="yes">Log in with Ubuntu One</property>
+            <property name="visible">True</property>
+            <property name="can-focus">True</property>
+            <property name="receives-default">False</property>
+            <property name="margin-top">30</property>
+            <property name="xalign">0</property>
+            <property name="group">magic_radio</property>
+            <signal name="toggled" handler="on_radio_toggled" swapped="no"/>
+            <signal name="clicked" handler="on_magic_radio_clicked" swapped="no"/>
+          </object>
+        </child>
         <child>
           <object class="GtkBox">
             <property name="visible">True</property>
-            <property name="orientation">vertical</property>
-            <property name="spacing">18</property>
+            <property name="can-focus">False</property>
+            <property name="orientation">horizontal</property>
             <child>
-              <object class="GtkLabel">
+              <object class="GtkBox" id="pin_label_box">
                 <property name="visible">True</property>
-                <property name="label" translatable="yes">Enter your Ubuntu Pro token here.
-From &lt;a href="https://ubuntu.com/pro"&gt;ubuntu.com/pro&lt;/a&gt; or your system administrator</property>
-                <property name="use_markup">True</property>
-                <property name="xalign">0</property>
+                <property name="margin-left">20</property>
+                <property name="margin-top">12</property>
+                <property name="margin-bottom">8</property>
+                <property name="can-focus">False</property>
+                <child>
+                  <object class="GtkLabel" id="pin_label">
+                    <property name="label">      </property>
+                    <property name="visible">True</property>
+                    <property name="selectable">True</property>
+                    <property name="can-focus">False</property>
+                    <property name="halign">start</property>
+                    <property name="margin-left">6</property>
+                    <property name="margin-right">6</property>
+                    <property name="margin-top">4</property>
+                    <property name="margin-bottom">4</property>
+                    <attributes>
+                      <attribute name="scale" value="2"/>
+                    </attributes>
+                  </object>
+                </child>
               </object>
             </child>
             <child>
-              <object class="GtkGrid">
+              <object class="GtkFixed">
                 <property name="visible">True</property>
-                <property name="row_spacing">6</property>
-                <property name="column_spacing">12</property>
+                <property name="valign">center</property>
+                <property name="margin">3</property>
                 <child>
-                  <object class="GtkLabel">
+                  <object class="GtkSpinner" id="pin_spinner">
                     <property name="visible">True</property>
-                    <property name="label" translatable="yes">Token:</property>
+                    <property name="valign">center</property>
                   </object>
-                  <packing>
-                    <property name="left_attach">0</property>
-                    <property name="top_attach">0</property>
-                  </packing>
                 </child>
                 <child>
-                  <object class="GtkBox">
-                    <property name="visible">True</property>
-                    <property name="spacing">12</property>
-                    <child>
-                      <object class="GtkEntry" id="entry_token">
-                        <property name="visible">True</property>
-                        <property name="max-width-chars">30</property>
-                        <signal name="changed" handler="on_token_entry_changed"/>
-                        <signal name="activate" handler="on_token_entry_activate"/>
-                      </object>
-                    </child>
-                    <child>
-                      <object class="GtkSpinner" id="spinner">
-                        <property name="visible">True</property>
-                      </object>
-                    </child>
+                  <object class="GtkImage" id="pin_status_icon">
+                    <property name="visible">False</property>
+                    <property name="valign">center</property>
                   </object>
-                  <packing>
-                    <property name="left_attach">1</property>
-                    <property name="top_attach">0</property>
-                  </packing>
                 </child>
+              </object>
+            </child>
+            <child>
+              <object class="GtkLabel" id="pin_status">
+                <property name="margin">3</property>
+                <property name="visible">True</property>
+                <property name="valign">center</property>
+                <property name="use-markup">True</property>
+              </object>
+            </child>
+          </object>
+        </child>
+        <child>
+          <object class="GtkRadioButton" id="token_radio">
+            <property name="label" translatable="yes">Or add token manually</property>
+            <property name="visible">True</property>
+            <property name="can-focus">True</property>
+            <property name="receives-default">False</property>
+            <property name="margin-top">6</property>
+            <property name="xalign">0</property>
+            <property name="group">magic_radio</property>
+            <signal name="toggled" handler="on_radio_toggled" swapped="no"/>
+          </object>
+        </child>
+        <child>
+          <object class="GtkBox">
+            <property name="visible">True</property>
+            <property name="can-focus">False</property>
+            <property name="no-show-all">True</property>
+            <child>
+              <object class="GtkEntry" id="token_field">
+                <property name="visible">True</property>
+                <property name="sensitive">False</property>
+                <property name="can-focus">True</property>
+                <property name="margin-left">20</property>
+                <property name="margin-top">12</property>
+                <property name="margin-bottom">12</property>
+                <property name="margin-right">4</property>
+                <property name="width-chars">35</property>
+                <property name="placeholder-text" translatable="yes">Token</property>
+                <property name="halign">start</property>
+                <signal name="activate" handler="on_token_entry_activate" swapped="no"/>
+                <signal name="changed" handler="on_token_typing" swapped="no"/>
+              </object>
+            </child>
+            <child>
+              <object class="GtkFixed">
+                <property name="visible">True</property>
+                <property name="valign">center</property>
+                <property name="margin">3</property>
                 <child>
-                  <object class="GtkLabel">
+                  <object class="GtkSpinner" id="token_spinner">
                     <property name="visible">True</property>
-                    <property name="xalign">0</property>
-                    <property name="label" translatable="yes">&lt;a href="https://login.ubuntu.com"&gt;Don't have a token yet? Register&lt;/a&gt;</property>
-                    <property name="use_markup">True</property>
+                    <property name="valign">center</property>
                   </object>
-                  <packing>
-                    <property name="left_attach">1</property>
-                    <property name="top_attach">1</property>
-                  </packing>
                 </child>
                 <child>
-                  <object class="GtkLabel" id="label_attach_error">
-                    <property name="visible">True</property>
-                    <property name="xalign">0</property>
-                    <attributes>
-                      <attribute name="foreground" value="red"/>
-                      <attribute name="scale" value="0.9"/>
-                    </attributes>
+                  <object class="GtkImage" id="token_status_icon">
+                    <property name="visible">False</property>
+                    <property name="valign">center</property>
                   </object>
-                  <packing>
-                    <property name="left_attach">1</property>
-                    <property name="top_attach">2</property>
-                  </packing>
                 </child>
               </object>
             </child>
+            <child>
+              <object class="GtkLabel" id="token_status">
+                <property name="margin">3</property>
+                <property name="visible">True</property>
+                <property name="valign">center</property>
+                <property name="use-markup">True</property>
+              </object>
+            </child>
           </object>
         </child>
-      </object>
-    </child>
-    <child internal-child="action_area">
-      <object class="GtkHButtonBox">
-        <property name="visible">True</property>
-        <property name="layout_style">end</property>
         <child>
-          <object class="GtkButton">
+          <object class="GtkLabel">
             <property name="visible">True</property>
-            <property name="label" translatable="yes">Cance_l</property>
-            <property name="use_underline">True</property>
-            <signal name="clicked" handler="on_cancel_clicked"/>
+            <property name="halign">start</property>
+            <property name="margin-left">20</property>
+            <property name="use-markup">True</property>
+            <property name="label" translatable="yes">From your admin, or from &lt;a href="https://ubuntu.com/pro"&gt;ubuntu.com/pro&lt;/a&gt;</property>
           </object>
         </child>
         <child>
-          <object class="GtkButton" id="button_attach">
+          <object class="GtkBox">
             <property name="visible">True</property>
-            <property name="sensitive">False</property>
-            <property name="label" translatable="yes">_Continue</property>
-            <property name="use_underline">True</property>
-            <signal name="clicked" handler="on_attach_clicked"/>
+            <property name="orientation">horizontal</property>
+            <property name="halign">end</property>
+            <child>
+              <object class="GtkButton" id="cancel">
+                <property name="visible">True</property>
+                <property name="margin-right">10</property>
+                <property name="label" translatable="yes">Cancel</property>
+                <signal name="clicked" handler="on_cancel_clicked" swapped="no"/>
+              </object>
+            </child>
+            <child>
+              <object class="GtkButton" id="confirm">
+                <property name="visible">True</property>
+                <property name="label" translatable="yes">Confirm</property>
+                <property name="sensitive">False</property>
+                <signal name="clicked" handler="on_confirm_clicked" swapped="no"/>
+              </object>
+            </child>
           </object>
         </child>
       </object>
diff --git a/data/gtkbuilder/main.ui b/data/gtkbuilder/main.ui
index a78bfe2..1cff6cf 100644
--- a/data/gtkbuilder/main.ui
+++ b/data/gtkbuilder/main.ui
@@ -1285,7 +1285,7 @@
                                       <object class="GtkLabel">
                                         <property name="visible">True</property>
                                         <property name="label" translatable="yes">&lt;b&gt;This machine is not covered by an Ubuntu Pro subscription.&lt;/b&gt;
-Receive security updates for over 25,000 Ubuntu packages, on up to 3 machines free for personal use. &lt;a href="https://ubuntu.com/pro"&gt;Learn more&lt;/a&gt;.</property>
+Receive security updates for over 25,000 Ubuntu packages, free for up to 5 machines. &lt;a href="https://ubuntu.com/pro"&gt;Learn more&lt;/a&gt;.</property>
                                         <property name="use_markup">True</property>
                                         <property name="wrap">True</property>
                                         <property name="max-width-chars">90</property>
diff --git a/debian/changelog b/debian/changelog
index 2be2114..0a94e7e 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -1,3 +1,9 @@
+software-properties (0.99.9.8+ubuntupro13.1) focal; urgency=medium
+
+  * Include the magic attach workflow, thanks Nathan!
+
+ -- Sebastien Bacher <[e-mail]>  Fri, 16 Dec 2022 11:20:29 +0100
+
 software-properties (0.99.9.8+ubuntupro12) focal; urgency=medium
 
   * Show Ubuntu Pro settings.
diff --git a/debian/control b/debian/control
index 7edc838..65227f5 100644
--- a/debian/control
+++ b/debian/control
@@ -76,6 +76,7 @@ Description: manage the repositories that you install software from (common)
 Package: software-properties-gtk
 Architecture: all
 Depends: ubuntu-advantage-desktop-daemon,
+         ubuntu-advantage-tools (>= 27.11~),
          gir1.2-gtk-3.0,
          libgtk3-perl,
          python3,
diff --git a/softwareproperties/SoftwareProperties.py b/softwareproperties/SoftwareProperties.py
index 5f6bf64..9532bfb 100644
--- a/softwareproperties/SoftwareProperties.py
+++ b/softwareproperties/SoftwareProperties.py
@@ -138,7 +138,8 @@ class SoftwareProperties(object):
     " wait for all running threads (PPA key fetchers) to exit "
     for t in threading.enumerate():
       if t.ident != threading.current_thread().ident:
-        t.join()
+        if not t.daemon:
+            t.join()
 
   def backup_apt_conf(self):
     """Backup all apt configuration options"""
diff --git a/softwareproperties/gtk/DialogUaAttach.py b/softwareproperties/gtk/DialogUaAttach.py
index 4649545..20bb543 100644
--- a/softwareproperties/gtk/DialogUaAttach.py
+++ b/softwareproperties/gtk/DialogUaAttach.py
@@ -20,11 +20,12 @@ import os
 from gettext import gettext as _
 import gi
 gi.require_version("Gtk", "3.0")
-from gi.repository import Gtk
-
-from softwareproperties.gtk.utils import (
-    setup_ui,
-)
+from gi.repository import Gtk,Gdk,GLib
+from softwareproperties.gtk.utils import setup_ui
+from uaclient.api.u.pro.attach.magic.initiate.v1 import initiate
+from uaclient.api.u.pro.attach.magic.wait.v1 import MagicAttachWaitOptions, wait
+from uaclient.exceptions import MagicAttachTokenError
+import threading
 
 class DialogUaAttach:
     def __init__(self, parent, datadir, ua_object):
@@ -35,50 +36,144 @@ class DialogUaAttach:
         self.dialog = self.dialog_ua_attach
         self.dialog.set_transient_for(parent)
 
+        self.contract_token = None
         self.attaching = False
+        self.poll = None
+        self.pin_label_box.override_background_color(Gtk.StateType.NORMAL, Gdk.RGBA(0.5, 0.5, 0.5, 0.5))
+
+        self.start_magic_attach()
 
     def run(self):
         self.dialog.run()
         self.dialog.hide()
 
-    def update_state(self):
-        have_token = self.entry_token.get_text() != ''
-        self.button_attach.set_sensitive(have_token and not self.attaching)
-        self.entry_token.set_sensitive(not self.attaching)
+    def update_state(self, case = None):
+        """
+        fail   : called by the attachment callback, and it failed.
+        success: called by the attachment callback, and it succeeded.
+        expired: called by the token polling when the token expires.
+        """
+        if self.token_radio.get_active():
+            self.pin_label.set_opacity(0)
+            self.confirm.set_sensitive(self.token_field.get_text() != "" and
+                                       not self.attaching)
+            icon = self.token_status_icon
+            spinner = self.token_spinner
+            status = self.token_status
+        else:
+            self.pin_label.set_text(self.pin)
+            self.pin_label.set_opacity(1)
+            self.confirm.set_sensitive(self.contract_token != None and
+                                       not self.attaching)
+            icon = self.pin_status_icon
+            spinner = self.pin_spinner
+            status = self.pin_status
+
         if self.attaching:
-            self.spinner.start()
+            spinner.start()
         else:
-            self.spinner.stop()
+            spinner.stop()
+
+        def lock_radio_buttons(boolean):
+            self.token_radio.set_sensitive(not boolean)
+            self.magic_radio.set_sensitive(not boolean)
+
+        lock_radio_buttons(self.attaching)
+        self.token_field.set_sensitive(not self.attaching
+                                       and self.token_radio.get_active())
+
+        if (case == "fail"):
+            status.set_markup('<span foreground="red">%s</span>' % _('Invalid token'))
+            icon.set_from_icon_name('emblem-unreadable', 1)
+        elif (case == "success"):
+            self.finish()
+        elif (case == "pin_validated"):
+            status.set_markup('<span foreground="green">%s</span>' % _('Valid token'))
+            icon.set_from_icon_name('emblem-default', 1)
+            lock_radio_buttons(True)
+        elif (case == "expired"):
+            status.set_markup(_('Code expired'))
+            icon.set_from_icon_name('gtk-dialog-warning', 1)
+
+        #Only show icons/status if case is set
+        self.token_status_icon.set_visible(False)
+        self.token_status.set_visible(False)
+        self.pin_status_icon.set_visible(False)
+        self.pin_status.set_visible(False)
+        icon.set_visible(case)
+        status.set_visible(case)
 
     def attach(self):
         if self.attaching:
             return
 
-        token = self.entry_token.get_text()
-        if token == '':
-            return
+        if self.token_radio.get_active():
+            token = self.token_field.get_text()
+        else:
+            token = self.contract_token
 
         self.attaching = True
-        self.label_attach_error.set_text('')
         def on_reply():
-            self.dialog.response(Gtk.ResponseType.OK)
+            self.attaching = False
+            self.update_state("success")
         def on_error(error):
-            # FIXME
-            print(error)
-            self.label_attach_error.set_text(_('Failed to attach. Please try again'))
             self.attaching = False
-            self.update_state()
+            if self.magic_radio.get_active():
+                self.contract_token = None
+            self.update_state("fail")
         self.ua_object.Attach(token, reply_handler=on_reply, error_handler=on_error, dbus_interface='com.canonical.UbuntuAdvantage.Manager', timeout=600)
         self.update_state()
 
-    def on_token_entry_changed(self, entry):
-        self.update_state()
+    def on_token_typing(self, entry):
+        self.confirm.set_sensitive(self.token_field.get_text() != '')
 
     def on_token_entry_activate(self, entry):
-        self.attach()
+        token = self.token_field.get_text()
+        if token != '':
+            self.attach()
 
-    def on_attach_clicked(self, button):
+    def on_confirm_clicked(self, button):
         self.attach()
 
     def on_cancel_clicked(self, button):
         self.dialog.response(Gtk.ResponseType.CANCEL)
+
+    def poll_for_magic_token(self):
+        options = MagicAttachWaitOptions(magic_token=self.req_id)
+        try:
+            response = wait(options)
+            self.contract_token = response.contract_token
+            GLib.idle_add(self.update_state, 'pin_validated')
+        except MagicAttachTokenError:
+            GLib.idle_add(self.update_state, 'expired')
+        finally:
+            self.poll = None
+
+    def start_magic_attach(self):
+        # Already polling, don't bother the server with a new request.
+        if self.poll != None or self.contract_token != None:
+            return
+
+        self.contract_token = None
+
+        # Request a magic attachment and parse relevants fields from response.
+        #  userCode:  The pin the user has to type in <ubuntu.com/pro/attach>;
+        #  token:     Identifies the request (used for polling for it).
+        try:
+            response = initiate()
+            self.pin = response.user_code
+            self.req_id = response.token
+        except Exception as e:
+            print(e)
+            return
+        self.update_state()
+        threading.Thread(target=self.poll_for_magic_token, daemon=True).start()
+
+    def on_radio_toggled(self, button):
+        self.update_state()
+
+    def on_magic_radio_clicked(self, button):
+        self.start_magic_attach()
+
+    def finish(self):
+        self.dialog.response(Gtk.ResponseType.OK)