Merge ubiquity:gtk-show-passwords into ubiquity:master

[Łukasz Zemczak]

Add the ability to show passwords that are being typed-in on various stages (GTK only for now).

Add the ability to show passwords that are being typed-in on various stages (GTK only for now).

The rationale for this change is the following: currently users are suffering from bugs like LP: #1875062 which are really hard to pin-point and reproduce. A semi-workaround for that is this change, meaning that users can double-check if the password they think they write was actually written correctly (in case the keyboard layout is wrong).
This is by no means a real fix for that issue, but I think such an ability is good anyway.

I'll look into doing the same for KDE, although I see KDE has a very much less intuitive UI for disk encryption. This will be a separate MP.

[Łukasz Zemczak (sil2100)]

We could backport that to focal as well and have it part of 20.04.4.

[Sebastien Bacher (seb128)]

Thanks for working on those change, it's an useful addition. I've one question, see inline review

review: Needs Fixing

[Gunnar Hjalmarsson (gunnarhj)]

Thanks for a creative step. A thought: Even if you add a toggle to make the password visible, how does the user know that they should use it? Maybe make it visible by default? Or that would possibly be too aggressive..

[Łukasz Zemczak (sil2100)]

Thank you for the review seb, let me address that point (as mentioned inline)!

Gunnar: I think that would be too invasive. This is why I only said that this is a semi-workaround, as some users will still be broken. I think it's anyway important to have this feature regardless of the bug with keyboard layout - but that one I think we simply need to find the root cause and eliminate it properly.

[Sebastien Bacher (seb128)]

Thanks for pointing that you copied it, I asked jibel and it was done on purpose, probably just glade doing something weird. If it works without it we should also fix the stepPartCrypto.ui one

review: Approve

[Łukasz Zemczak (sil2100)]

I'll merge this and then look into fixing the previous one! Thanks for the review!

[Łukasz Zemczak (sil2100)]

Now also submitted the KDE counterpart here: https://code.launchpad.net/~ubuntu-installer/ubiquity/+git/ubiquity/+merge/414453

diff --git a/debian/changelog b/debian/changelog
index 4d6d9e1..bb4e2b9 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -1,9 +1,14 @@
 ubiquity (22.04.4) UNRELEASED; urgency=medium
 
+  [ Brian Murray ]
   * debian/ubiquity.templates: capitalize Wi-Fi in multiple places so that is
     consistent throughout the installer.
 
- -- Brian Murray <[e-mail]>  Fri, 07 Jan 2022 11:28:10 -0800
+  [ Łukasz 'sil2100' Zemczak ]
+  * Add the ability to unhide passwords that are being typed-in during various
+    stages (GTK for now).
+
+ -- Łukasz 'sil2100' Zemczak <[e-mail]>  Thu, 20 Jan 2022 16:07:46 +0100
 
 ubiquity (22.04.3) jammy; urgency=medium
 
diff --git a/gui/gtk/stepPartCrypto.ui b/gui/gtk/stepPartCrypto.ui
index 6095b82..eacd931 100644
--- a/gui/gtk/stepPartCrypto.ui
+++ b/gui/gtk/stepPartCrypto.ui
@@ -120,7 +120,9 @@
                 <property name="invisible-char">●</property>
                 <property name="activates-default">True</property>
                 <property name="width-chars">36</property>
+                <property name="secondary-icon-name">view-reveal-symbolic</property>
                 <signal name="changed" handler="info_loop" swapped="no"/>
+                <signal name="icon-press" handler="on_password_toggle_visibility" swapped="no"/>
               </object>
               <packing>
                 <property name="left-attach">0</property>
diff --git a/gui/gtk/stepUserInfo.ui b/gui/gtk/stepUserInfo.ui
index f39d818..33bf94c 100644
--- a/gui/gtk/stepUserInfo.ui
+++ b/gui/gtk/stepUserInfo.ui
@@ -138,7 +138,9 @@
                     <property name="invisible_char">●</property>
                     <property name="activates_default">True</property>
                     <property name="width_chars">20</property>
+                    <property name="secondary-icon-name">view-reveal-symbolic</property>
                     <signal name="changed" handler="info_loop" swapped="no"/>
+                    <signal name="icon-press" handler="on_password_toggle_visibility" swapped="no"/>
                     <accessibility>
                       <relation type="labelled-by" target="password_label"/>
                     </accessibility>
diff --git a/ubiquity/plugins/ubi-partman.py b/ubiquity/plugins/ubi-partman.py
index 9bb1ae6..b9f3d9e 100644
--- a/ubiquity/plugins/ubi-partman.py
+++ b/ubiquity/plugins/ubi-partman.py
@@ -308,6 +308,14 @@ class PageGtk(PageBase):
                                       width, height)
             widget.show()
 
+    def on_password_toggle_visibility(self, widget, icon_pos, event):
+        from gi.repository import Gtk
+        visibility = self.password.get_visibility()
+        self.password.set_visibility(not visibility)
+        self.verified_password.set_visibility(not visibility)
+        self.password.set_icon_from_icon_name(
+            Gtk.EntryIconPosition.SECONDARY, ('view-conceal-symbolic', 'view-reveal-symbolic')[visibility])
+
     def generate_recovery_key(self):
         if not self.recovery_key_enable.get_active():
             return
diff --git a/ubiquity/plugins/ubi-usersetup.py b/ubiquity/plugins/ubi-usersetup.py
index ee3cc98..ceb067f 100644
--- a/ubiquity/plugins/ubi-usersetup.py
+++ b/ubiquity/plugins/ubi-usersetup.py
@@ -411,6 +411,14 @@ class PageGtk(PageBase):
 
         self.controller.allow_go_forward(complete)
 
+    def on_password_toggle_visibility(self, widget, icon_pos, event):
+        from gi.repository import Gtk
+        visibility = self.password.get_visibility()
+        self.password.set_visibility(not visibility)
+        self.verified_password.set_visibility(not visibility)
+        self.password.set_icon_from_icon_name(
+            Gtk.EntryIconPosition.SECONDARY, ('view-conceal-symbolic', 'view-reveal-symbolic')[visibility])
+
     def on_username_changed(self, widget):
         self.username_edited = (widget.get_text() != '')