Merge ~enr0n/software-properties:deb822 into software-properties:ubuntu/master

[Nick Rosbrook]

[Julian Andres Klode (juliank)]

Can you bump Depends: python3-apt to `(>= 2.5.3~)`? I'll still have to release that of course, but um, this will prevent software-properties from breaking if you edit deb822 sources (because python-apt 2.5.2 doesn't accept strings for Deb822SourceEntry).

review: Needs Fixing

[Nick Rosbrook (enr0n)]

Good catch, thanks. I pushed the change.

diff --git a/data/gtkbuilder/dialog-edit-deb822-source.ui b/data/gtkbuilder/dialog-edit-deb822-source.ui
new file mode 100644
index 0000000..b819c9a
--- /dev/null
+++ b/data/gtkbuilder/dialog-edit-deb822-source.ui
@@ -0,0 +1,298 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!-- Generated with glade 3.40.0 -->
+<interface>
+  <requires lib="gtk+" version="3.24"/>
+  <object class="GtkDialog" id="dialog_edit_deb822">
+    <property name="can-focus">False</property>
+    <property name="border-width">6</property>
+    <property name="title" translatable="yes">Edit Source</property>
+    <property name="default-width">400</property>
+    <property name="type-hint">dialog</property>
+    <child internal-child="vbox">
+      <object class="GtkBox">
+        <property name="can-focus">False</property>
+        <property name="orientation">vertical</property>
+        <property name="spacing">12</property>
+        <child internal-child="action_area">
+          <object class="GtkButtonBox">
+            <property name="can-focus">False</property>
+            <property name="layout-style">end</property>
+            <child>
+              <object class="GtkButton" id="button_edit_cancel">
+                <property name="label">gtk-cancel</property>
+                <property name="visible">True</property>
+                <property name="can-focus">True</property>
+                <property name="can-default">True</property>
+                <property name="receives-default">False</property>
+                <property name="use-stock">True</property>
+              </object>
+              <packing>
+                <property name="expand">True</property>
+                <property name="fill">True</property>
+                <property name="position">0</property>
+              </packing>
+            </child>
+            <child>
+              <object class="GtkButton" id="button_edit_ok">
+                <property name="label">gtk-ok</property>
+                <property name="visible">True</property>
+                <property name="can-focus">True</property>
+                <property name="has-focus">True</property>
+                <property name="can-default">True</property>
+                <property name="has-default">True</property>
+                <property name="receives-default">False</property>
+                <property name="use-stock">True</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>
+            <property name="position">0</property>
+          </packing>
+        </child>
+        <child>
+          <object class="GtkTable">
+            <property name="visible">True</property>
+            <property name="can-focus">False</property>
+            <property name="n-rows">10</property>
+            <property name="n-columns">2</property>
+            <property name="column-spacing">12</property>
+            <property name="row-spacing">6</property>
+            <child>
+              <placeholder/>
+            </child>
+            <child>
+              <placeholder/>
+            </child>
+            <child>
+              <placeholder/>
+            </child>
+            <child>
+              <placeholder/>
+            </child>
+            <child>
+              <placeholder/>
+            </child>
+            <child>
+              <placeholder/>
+            </child>
+            <child>
+              <placeholder/>
+            </child>
+            <child>
+              <placeholder/>
+            </child>
+            <child>
+              <object class="GtkLabel">
+                <property name="visible">True</property>
+                <property name="can-focus">False</property>
+                <property name="label" translatable="yes">Types:</property>
+                <property name="use-markup">True</property>
+                <property name="xalign">1</property>
+              </object>
+              <packing>
+                <property name="top-attach">1</property>
+                <property name="bottom-attach">2</property>
+              </packing>
+            </child>
+            <child>
+              <object class="GtkLabel">
+                <property name="visible">True</property>
+                <property name="can-focus">False</property>
+                <property name="label" translatable="yes">URIs:</property>
+                <property name="xalign">1</property>
+              </object>
+              <packing>
+                <property name="top-attach">3</property>
+                <property name="bottom-attach">4</property>
+              </packing>
+            </child>
+            <child>
+              <placeholder/>
+            </child>
+            <child>
+              <object class="GtkLabel">
+                <property name="visible">True</property>
+                <property name="can-focus">False</property>
+                <property name="label" translatable="yes">Suites:</property>
+                <property name="xalign">1</property>
+              </object>
+              <packing>
+                <property name="top-attach">5</property>
+                <property name="bottom-attach">6</property>
+              </packing>
+            </child>
+            <child>
+              <object class="GtkLabel">
+                <property name="visible">True</property>
+                <property name="can-focus">False</property>
+                <property name="label" translatable="yes">Components:</property>
+                <property name="xalign">1</property>
+              </object>
+              <packing>
+                <property name="top-attach">7</property>
+                <property name="bottom-attach">8</property>
+              </packing>
+            </child>
+            <child>
+              <object class="GtkLabel">
+                <property name="visible">True</property>
+                <property name="can-focus">False</property>
+                <property name="label" translatable="yes">Comment:</property>
+                <property name="xalign">1</property>
+              </object>
+              <packing>
+                <property name="top-attach">9</property>
+                <property name="bottom-attach">10</property>
+              </packing>
+            </child>
+            <child>
+              <object class="GtkEntry" id="entry_types">
+                <property name="visible">True</property>
+                <property name="can-focus">True</property>
+              </object>
+              <packing>
+                <property name="left-attach">1</property>
+                <property name="right-attach">2</property>
+                <property name="top-attach">1</property>
+                <property name="bottom-attach">2</property>
+              </packing>
+            </child>
+            <child>
+              <object class="GtkEntry" id="entry_uris">
+                <property name="visible">True</property>
+                <property name="can-focus">True</property>
+              </object>
+              <packing>
+                <property name="left-attach">1</property>
+                <property name="right-attach">2</property>
+                <property name="top-attach">3</property>
+                <property name="bottom-attach">4</property>
+              </packing>
+            </child>
+            <child>
+              <object class="GtkEntry" id="entry_suites">
+                <property name="visible">True</property>
+                <property name="can-focus">True</property>
+              </object>
+              <packing>
+                <property name="left-attach">1</property>
+                <property name="right-attach">2</property>
+                <property name="top-attach">5</property>
+                <property name="bottom-attach">6</property>
+              </packing>
+            </child>
+            <child>
+              <object class="GtkEntry" id="entry_comps">
+                <property name="visible">True</property>
+                <property name="can-focus">True</property>
+              </object>
+              <packing>
+                <property name="left-attach">1</property>
+                <property name="right-attach">2</property>
+                <property name="top-attach">7</property>
+                <property name="bottom-attach">8</property>
+              </packing>
+            </child>
+            <child>
+              <object class="GtkEntry" id="entry_comment">
+                <property name="visible">True</property>
+                <property name="can-focus">True</property>
+              </object>
+              <packing>
+                <property name="left-attach">1</property>
+                <property name="right-attach">2</property>
+                <property name="top-attach">9</property>
+                <property name="bottom-attach">10</property>
+              </packing>
+            </child>
+            <child>
+              <placeholder/>
+            </child>
+            <child>
+              <placeholder/>
+            </child>
+          </object>
+          <packing>
+            <property name="expand">False</property>
+            <property name="fill">True</property>
+            <property name="position">0</property>
+          </packing>
+        </child>
+        <child>
+          <object class="GtkSeparator">
+            <property name="visible">True</property>
+            <property name="can-focus">False</property>
+          </object>
+          <packing>
+            <property name="expand">False</property>
+            <property name="fill">True</property>
+            <property name="padding">12</property>
+            <property name="position">1</property>
+          </packing>
+        </child>
+        <child>
+          <!-- n-columns=1 n-rows=2 -->
+          <object class="GtkGrid">
+            <property name="visible">True</property>
+            <property name="can-focus">False</property>
+            <property name="row-spacing">12</property>
+            <child>
+              <object class="GtkLabel">
+                <property name="visible">True</property>
+                <property name="can-focus">False</property>
+                <property name="label" translatable="yes">Additional Fields:</property>
+              </object>
+              <packing>
+                <property name="left-attach">0</property>
+                <property name="top-attach">0</property>
+              </packing>
+            </child>
+            <child>
+              <object class="GtkButton" id="button_add_field">
+                <property name="label">gtk-add</property>
+                <property name="visible">True</property>
+                <property name="can-focus">True</property>
+                <property name="receives-default">True</property>
+                <property name="use-stock">True</property>
+              </object>
+              <packing>
+                <property name="left-attach">0</property>
+                <property name="top-attach">1</property>
+              </packing>
+            </child>
+          </object>
+          <packing>
+            <property name="expand">False</property>
+            <property name="fill">False</property>
+            <property name="position">2</property>
+          </packing>
+        </child>
+        <child>
+          <object class="GtkListBox" id="list_box_additional_fields">
+            <property name="visible">True</property>
+            <property name="can-focus">False</property>
+            <property name="selection-mode">none</property>
+            <property name="activate-on-single-click">False</property>
+          </object>
+          <packing>
+            <property name="expand">False</property>
+            <property name="fill">False</property>
+            <property name="padding">12</property>
+            <property name="position">4</property>
+          </packing>
+        </child>
+      </object>
+    </child>
+    <action-widgets>
+      <action-widget response="-6">button_edit_cancel</action-widget>
+      <action-widget response="-5">button_edit_ok</action-widget>
+    </action-widgets>
+  </object>
+</interface>
diff --git a/debian/changelog b/debian/changelog
index 74ca49e..9acc69d 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -1,3 +1,15 @@
+software-properties (0.99.33) lunar; urgency=medium
+
+  [ Sebastien Bacher ]
+  * Replace the ubuntu pro images using the version provided by design
+
+  [ Nick Rosbrook ]
+  * Add GTK edit dialog for deb822 sources
+  * Add deb822 parameter to SoftwareProperties class
+  * Bump python3-apt dependency to >= 2.5.3
+
+ -- Nick Rosbrook <[e-mail]>  Thu, 23 Feb 2023 11:27:37 -0500
+
 software-properties (0.99.32) lunar; urgency=medium
 
   [ Nathan Pratta Teodosio ]
diff --git a/debian/control b/debian/control
index 1453ad0..fcb6123 100644
--- a/debian/control
+++ b/debian/control
@@ -14,7 +14,7 @@ Build-Depends: dbus-x11 <!nocheck>,
                lsb-release <!nocheck>,
                pyflakes3 <!nocheck>,
                python3-all,
-               python3-apt <!nocheck>,
+               python3-apt (>= 2.5.3~) <!nocheck>,
                python3-dateutil <!nocheck>,
                python3-dbus <!nocheck>,
                python3-distro-info <!nocheck>,
@@ -37,8 +37,7 @@ Depends: gpg,
          iso-codes,
          lsb-release,
          python3,
-         python3-apt (>=
- 0.6.20ubuntu16),
+         python3-apt (>= 2.5.3~),
          python3-gi,
          python3-launchpadlib,
          ${misc:Depends},
diff --git a/softwareproperties/SoftwareProperties.py b/softwareproperties/SoftwareProperties.py
index 835a1c6..d8f7435 100644
--- a/softwareproperties/SoftwareProperties.py
+++ b/softwareproperties/SoftwareProperties.py
@@ -57,7 +57,7 @@ import aptsources.distro
 import softwareproperties
 
 from .AptAuth import AptAuth
-from aptsources.sourceslist import (SourcesList, SourceEntry)
+from aptsources.sourceslist import (SourcesList, SourceEntry, Deb822SourceEntry)
 from softwareproperties.shortcuthandler import InvalidShortcutException
 from softwareproperties.shortcuts import shortcut_handler
 
@@ -83,7 +83,7 @@ class SoftwareProperties(object):
     RELEASE_UPGRADES_NEVER  : 'never',
   }
 
-  def __init__(self, datadir=None, options=None, rootdir="/"):
+  def __init__(self, datadir=None, options=None, rootdir="/", deb822=False):
     """ Provides the core functionality to configure the used software
         repositories, the corresponding authentication keys and
         update automation """
@@ -99,7 +99,7 @@ class SoftwareProperties(object):
     self.options = options
     self.datadir = datadir
 
-    self.sourceslist = SourcesList()
+    self.sourceslist = SourcesList(deb822=deb822)
     self.distro = aptsources.distro.get_distro()
 
     self.seen_server = []
@@ -458,7 +458,10 @@ class SoftwareProperties(object):
     for (index, entry) in enumerate(self.sourceslist.list):
       if str(entry) == old_entry:
         file = self.sourceslist.list[index].file
-        self.sourceslist.list[index] = SourceEntry(new_entry, file)
+        if isinstance(entry, Deb822SourceEntry):
+            self.sourceslist.list[index] = Deb822SourceEntry(new_entry, file)
+        else:
+            self.sourceslist.list[index] = SourceEntry(new_entry, file)
         self.set_modified_sourceslist()
         return True
     return False
diff --git a/softwareproperties/dbus/SoftwarePropertiesDBus.py b/softwareproperties/dbus/SoftwarePropertiesDBus.py
index fcdd2ab..26eb131 100644
--- a/softwareproperties/dbus/SoftwarePropertiesDBus.py
+++ b/softwareproperties/dbus/SoftwarePropertiesDBus.py
@@ -50,7 +50,8 @@ class SoftwarePropertiesDBus(dbus.service.Object, SoftwareProperties):
 
     def __init__(self, bus, options=None, datadir=None, rootdir="/"):
         # init software properties
-        SoftwareProperties.__init__(self, options=options, datadir=datadir, rootdir=rootdir)
+        SoftwareProperties.__init__(self, options=options, datadir=datadir,
+                                    rootdir=rootdir, deb822=True)
         # used in _check_policykit_priviledge
         self.dbus_info = None
         self.polkit = None
diff --git a/softwareproperties/gtk/DialogEditDeb822.py b/softwareproperties/gtk/DialogEditDeb822.py
new file mode 100644
index 0000000..ae8b438
--- /dev/null
+++ b/softwareproperties/gtk/DialogEditDeb822.py
@@ -0,0 +1,163 @@
+#  Copyright (c) 2023 Canonical
+#
+#  This program is free software; you can redistribute it and/or
+#  modify it under the terms of the GNU General Public License as
+#  published by the Free Software Foundation; either version 2 of the
+#  License, or (at your option) any later version.
+#
+#  This program is distributed in the hope that it will be useful,
+#  but WITHOUT ANY WARRANTY; without even the implied warranty of
+#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#  GNU General Public License for more details.
+#
+#  You should have received a copy of the GNU General Public License
+#  along with this program; if not, write to the Free Software
+#  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
+#  USA
+
+import os
+import gi
+gi.require_version("Gtk", "3.0")
+from gi.repository import Gtk
+
+from aptsources.sourceslist import Deb822SourceEntry
+from softwareproperties.gtk.utils import (
+    setup_ui,
+)
+
+
+class _CustomSourceEntryField(Gtk.Grid):
+    def __init__(self, window, input_changed_callback, key=None, value=None):
+        super(Gtk.Grid, self).__init__()
+
+        self.window = window
+        self.entry_key = Gtk.Entry(name='field_key', placeholder_text='Key')
+        self.entry_val = Gtk.Entry(name='field_value', placeholder_text='Value')
+        self.button_delete = Gtk.Button.new_from_stock('gtk-delete')
+
+        if key is not None:
+            self.entry_key.set_text(key)
+
+        if value is not None:
+            self.entry_val.set_text(value)
+
+        self.set_column_spacing(12)
+        self.attach(self.entry_key, 0, 0, 1, 1)
+        self.attach(self.entry_val, 1, 0, 1, 1)
+        self.attach(self.button_delete, 2, 0, 1, 1)
+
+        self.connect('destroy', input_changed_callback)
+        self.entry_key.connect('changed', input_changed_callback)
+        self.entry_val.connect('changed', input_changed_callback)
+        self.button_delete.connect('clicked',
+                                  self._button_del_field_clicked_callback)
+
+    def _button_del_field_clicked_callback(self, *data):
+        parent = self.get_parent()
+        parent.get_parent().remove(parent)
+
+        # Shrink the height back to size after deleting items.
+        width = self.window.get_default_size()[0]
+        self.window.resize(width, 1)
+
+    def get_key(self):
+        return self.entry_key.get_text()
+
+    def get_val(self):
+        return self.entry_val.get_text()
+
+
+class DialogEditDeb822:
+    def __init__(self, parent, sourceslist, source_entry, datadir):
+        self.sourceslist = sourceslist
+        self.source_entry = source_entry
+        self.new_source_entry = None
+
+        setup_ui(
+            self,
+            os.path.join(datadir, 'gtkbuilder', 'dialog-edit-deb822-source.ui'),
+            domain='software-properties'
+        )
+        self.main = self.dialog_edit_deb822
+        self.main.set_transient_for(parent)
+
+        self._populate_with_existing_source_entry()
+        self._connect_signal_callbacks()
+
+    def _populate_with_existing_source_entry(self):
+        self.entry_types.set_text(" ".join(self.source_entry.types))
+        self.entry_uris.set_text(" ".join(self.source_entry.uris))
+        self.entry_suites.set_text(" ".join(self.source_entry.suites))
+        self.entry_comps.set_text(" ".join(self.source_entry.comps))
+        self.entry_comment.set_text(self.source_entry.comment.rstrip())
+
+        for key, value in self.source_entry.section.tags.items():
+            if key not in ['Types', 'URIs', 'Suites', 'Components']:
+                self._append_custom_source_entry_field(key=key, value=value)
+
+    def _append_custom_source_entry_field(self, key=None, value=None):
+        row = Gtk.ListBoxRow(selectable=False, activatable=False)
+        field = _CustomSourceEntryField(
+            self.main, self._input_changed_callback, key, value
+        )
+
+        row.add(field)
+
+        self.list_box_additional_fields.insert(row, -1)
+        self.list_box_additional_fields.show_all()
+
+    def _get_custom_source_entry_fields(self):
+        rows = self.list_box_additional_fields.get_children()
+        fields = [r.get_children()[0] for r in rows]
+
+        return [f for f in fields if any((f.get_key(), f.get_val()))]
+
+    def _is_current_input_valid(self):
+        if '' in (self.entry_types.get_text(),
+                  self.entry_uris.get_text(),
+                  self.entry_suites.get_text(),
+                  self.entry_comps.get_text()):
+            return False
+
+        for field in self._get_custom_source_entry_fields():
+            if '' in (field.get_key(), field.get_val()):
+                return False
+
+        return True
+
+    def _connect_signal_callbacks(self):
+        for entry in (self.entry_types, self.entry_uris, self.entry_suites,
+                      self.entry_comps, self.entry_comment):
+            entry.connect('changed', self._input_changed_callback)
+
+        self.button_add_field.connect('clicked',
+                                      self._button_add_field_clicked_callback)
+
+    def _input_changed_callback(self, *data):
+        self.button_edit_ok.set_sensitive(self._is_current_input_valid())
+
+    def _button_add_field_clicked_callback(self, *data):
+        self._append_custom_source_entry_field()
+
+    def _source_entry_from_input(self):
+        source_entry = Deb822SourceEntry(None, self.source_entry.file)
+
+        source_entry.types = self.entry_types.get_text().split()
+        source_entry.uris = self.entry_uris.get_text().split()
+        source_entry.suites = self.entry_suites.get_text().split()
+        source_entry.comps = self.entry_comps.get_text().split()
+        source_entry.comment = self.entry_comment.get_text()
+
+        for field in self._get_custom_source_entry_fields():
+            source_entry.section[field.get_key()] = field.get_val()
+
+        return source_entry
+
+    def run(self):
+        res = self.main.run()
+        if res == Gtk.ResponseType.OK:
+            self.new_source_entry = self._source_entry_from_input()
+
+        self.main.hide()
+
+        return res
diff --git a/softwareproperties/gtk/SoftwarePropertiesGtk.py b/softwareproperties/gtk/SoftwarePropertiesGtk.py
index 707b25c..0cced00 100644
--- a/softwareproperties/gtk/SoftwarePropertiesGtk.py
+++ b/softwareproperties/gtk/SoftwarePropertiesGtk.py
@@ -46,10 +46,13 @@ gi.require_version("PackageKitGlib", "1.0")
 from gi.repository import PackageKitGlib as packagekit
 from gi.repository import GObject, Gdk, Gtk, Gio, GLib, Handy
 
+from aptsources.sourceslist import Deb822SourceEntry
+
 from .SimpleGtkbuilderApp import SimpleGtkbuilderApp
 from .DialogAdd import DialogAdd
 from .DialogMirror import DialogMirror
 from .DialogEdit import DialogEdit
+from .DialogEditDeb822 import DialogEditDeb822
 from .DialogCacheOutdated import DialogCacheOutdated
 from .DialogAddSourcesList import DialogAddSourcesList
 from .UbuntuProPage import UbuntuProPage
@@ -157,7 +160,8 @@ class SoftwarePropertiesGtk(SoftwareProperties, SimpleGtkbuilderApp):
         """ Provide a GTK based graphical user interface to configure
             the used software repositories, corresponding authentication keys
             and update automation """
-        SoftwareProperties.__init__(self, options=options, datadir=datadir)
+        SoftwareProperties.__init__(self, options=options, datadir=datadir,
+                                    deb822=True)
         Gtk.Window.set_default_icon_name("software-properties")
 
         # Support GNOME 42 dark mode
@@ -1101,8 +1105,13 @@ class SoftwarePropertiesGtk(SoftwareProperties, SimpleGtkbuilderApp):
         if not iter:
             return
         old_source_entry = model.get_value(iter, LIST_ENTRY_OBJ)
-        dialog = DialogEdit(self.window_main, self.sourceslist,
-                            old_source_entry, self.datadir)
+
+        if isinstance(old_source_entry, Deb822SourceEntry):
+            dialog = DialogEditDeb822(self.window_main, self.sourceslist,
+                                      old_source_entry, self.datadir)
+        else:
+            dialog = DialogEdit(self.window_main, self.sourceslist,
+                                old_source_entry, self.datadir)
         if dialog.run() == Gtk.ResponseType.OK:
             try:
                 self.backend.ReplaceSourceEntry(str(old_source_entry),