Fix gpodder#1405 Group subscriptions in exported OPML files

also implement sections in OPML import.
Adapted from the same feature by Keeper-of-the-Keys in gpodder-core, thanks!

Now any DirectoryProvider can set the channel['section'] to have it
added as is.

Author: elelay

bin/gpo

@@ -313,7 +313,7 @@ class gPodderCli(object):
 
     def import_(self, url):
         for channel in opml.Importer(url).items:
-            self.subscribe(channel['url'], channel.get('title'))
+            self.subscribe(channel['url'], channel.get('title'), channel.get('section'))
 
     def export(self, filename):
         podcasts = self._model.get_podcasts()
@@ -369,7 +369,7 @@ class gPodderCli(object):
             self._error(_('You are not subscribed to %s.') % url)
         return None
 
-    def subscribe(self, url, title=None):
+    def subscribe(self, url, title=None, section=None):
         existing = self.get_podcast(url, check_only=True)
         if existing is not None:
             self._error(_('Already subscribed to %s.') % existing.url)
@@ -814,7 +814,7 @@ class gPodderCli(object):
 
             title, url = results[index - 1]
             self._info(_('Adding %s...') % title)
-            self.subscribe(url)
+            self.subscribe(url, title=title)
             if not multiple:
                 break
 

src/gpodder/directory.py

@@ -44,12 +44,13 @@ def __init__(self, warning):
 
 
 class DirectoryEntry(object):
-    def __init__(self, title, url, image=None, subscribers=-1, description=None):
+    def __init__(self, title, url, image=None, subscribers=-1, description=None, section=None):
         self.title = title
         self.url = url
         self.image = image
         self.subscribers = subscribers
         self.description = description
+        self.section = section
 
 
 class DirectoryTag(object):
@@ -92,7 +93,7 @@ def get_tags(self):
 
 
 def directory_entry_from_opml(url):
-    return [DirectoryEntry(d['title'], d['url'], description=d['description']) for d in opml.Importer(url).items]
+    return [DirectoryEntry(d['title'], d['url'], description=d['description'], section=d['section']) for d in opml.Importer(url).items]
 
 
 def directory_entry_from_mygpo_json(url):

src/gpodder/gtkui/desktop/podcastdirectory.py

@@ -43,21 +43,21 @@
 
 
 class DirectoryPodcastsModel(Gtk.ListStore):
-    C_SELECTED, C_MARKUP, C_TITLE, C_URL = list(range(4))
+    C_SELECTED, C_MARKUP, C_TITLE, C_URL, C_SECTION = list(range(5))
 
     def __init__(self, callback_can_subscribe):
-        Gtk.ListStore.__init__(self, bool, str, str, str)
+        Gtk.ListStore.__init__(self, bool, str, str, str, str)
         self.callback_can_subscribe = callback_can_subscribe
 
     def load(self, directory_entries):
         self.clear()
         for entry in directory_entries:
             if entry.subscribers != -1:
                 self.append((False, '%s (%d)\n<small>%s</small>' % (html.escape(entry.title),
-                    entry.subscribers, html.escape(entry.url)), entry.title, entry.url))
+                    entry.subscribers, html.escape(entry.url)), entry.title, entry.url, entry.section))
             else:
                 self.append((False, '%s\n<small>%s</small>' % (html.escape(entry.title),
-                    html.escape(entry.url)), entry.title, entry.url))
+                    html.escape(entry.url)), entry.title, entry.url, entry.section))
         self.callback_can_subscribe(len(self.get_selected_podcasts()) > 0)
 
     def toggle(self, path):
@@ -70,7 +70,7 @@ def set_selection_to(self, selected):
         self.callback_can_subscribe(len(self.get_selected_podcasts()) > 0)
 
     def get_selected_podcasts(self):
-        return [(row[self.C_TITLE], row[self.C_URL]) for row in self if row[self.C_SELECTED]]
+        return [(row[self.C_TITLE], row[self.C_URL], row[self.C_SECTION]) for row in self if row[self.C_SELECTED]]
 
 
 class DirectoryProvidersModel(Gtk.ListStore):
@@ -159,7 +159,7 @@ def setup_podcasts_treeview(self):
         self.tv_podcasts.append_column(column)
 
         self.tv_podcasts.set_model(self.podcasts_model)
-        self.podcasts_model.append((False, 'a', 'b', 'c'))
+        self.podcasts_model.append((False, 'a', 'b', 'c', 'd'))
 
     def setup_providers_treeview(self):
         column = Gtk.TreeViewColumn('')

src/gpodder/gtkui/interface/addpodcast.py

@@ -92,4 +92,4 @@ def on_btn_add_clicked(self, widget):
         self.on_btn_close_clicked(widget)
         if self.add_podcast_list is not None:
             title = None  # FIXME: Add title GUI element
-            self.add_podcast_list([(title, url)])
+            self.add_podcast_list([(title, url, None)])

src/gpodder/gtkui/main.py

@@ -610,7 +610,8 @@ def execute_podcast_actions(selected):
             # In the future, we might retrieve the title from gpodder.net here,
             # but for now, we just use "None" to use the feed-provided title
             title = None
-            add_list = [(title, c.action.url)
+            section = None
+            add_list = [(title, c.action.url, section)
                     for c in selected if c.action.is_add]
             remove_list = [c.podcast for c in selected if c.action.is_remove]
 
@@ -2561,9 +2562,12 @@ def add_podcast_list(self, podcasts, auth_tokens=None):
         # For a given URL, the desired title (or None)
         title_for_url = {}
 
+        # For a given URL, the desired section (or None)
+        section_for_url = {}
+
         # Sort and split the URL list into five buckets
         queued, failed, existing, worked, authreq = [], [], [], [], []
-        for input_title, input_url in podcasts:
+        for input_title, input_url, input_section in podcasts:
             url = util.normalize_feed_url(input_url)
 
             # Check if it's a YouTube channel, user, or playlist and resolves it to its feed if that's the case
@@ -2580,6 +2584,7 @@ def add_podcast_list(self, podcasts, auth_tokens=None):
             else:
                 # This URL has survived the first round - queue for add
                 title_for_url[url] = input_title
+                section_for_url[url] = input_section
                 queued.append(url)
                 if url != input_url and input_url in auth_tokens:
                     auth_tokens[url] = auth_tokens[input_url]
@@ -2654,7 +2659,7 @@ def on_after_update():
 
             # If we have authentication data to retry, do so here
             if retry_podcasts:
-                podcasts = [(title_for_url.get(url), url)
+                podcasts = [(title_for_url.get(url), url, section_for_url.get(url))
                         for url in list(retry_podcasts.keys())]
                 self.add_podcast_list(podcasts, retry_podcasts)
                 # This will NOT show new episodes for podcasts that have
@@ -2680,6 +2685,7 @@ def thread_proc():
             length = len(queued)
             for index, url in enumerate(queued):
                 title = title_for_url.get(url)
+                section = section_for_url.get(url)
                 progress.on_progress(float(index) / float(length))
                 progress.on_message(title or url)
                 try:
@@ -2696,6 +2702,8 @@ def thread_proc():
                     if title is not None:
                         # Prefer title from subscription source (bug 1711)
                         channel.title = title
+                    if section is not None:
+                        channel.section = section
 
                     if username is not None and channel.auth_username is None and \
                             password is not None and channel.auth_password is None:

src/gpodder/my.py

@@ -657,11 +657,11 @@ def __init__(self):
         self.client = public.PublicClient()
 
     def toplist(self):
-        return [(p.title or p.url, p.url)
+        return [(p.title or p.url, p.url, None)
                 for p in self.client.get_toplist()
                 if p.url]
 
     def search(self, query):
-        return [(p.title or p.url, p.url)
+        return [(p.title or p.url, p.url, None)
                 for p in self.client.search_podcasts(query)
                 if p.url]

src/gpodder/opml.py

@@ -70,10 +70,17 @@ def __init__(self, url):
         else:
             doc = xml.dom.minidom.parse(io.BytesIO(util.urlopen(url).content))
 
+        section = None
         for outline in doc.getElementsByTagName('outline'):
             # Make sure we are dealing with a valid link type (ignore case)
             otl_type = outline.getAttribute('type')
             if otl_type is None or otl_type.lower() not in self.VALID_TYPES:
+                breakpoint()
+                otl_title = outline.getAttribute('title')
+                otl_text = outline.getAttribute('text')
+                # gPodder sections will have name == text, if OPML accepts it type=section
+                if otl_title is not None and otl_title == otl_text:
+                    section = otl_title
                 continue
 
             if outline.getAttribute('xmlUrl') or outline.getAttribute('url'):
@@ -90,6 +97,7 @@ def __init__(self, url):
                         outline.getAttribute('text')
                         or outline.getAttribute('xmlUrl')
                         or outline.getAttribute('url'),
+                    'section': section or 'audio',
                 }
 
                 if channel['description'] == channel['title']:
@@ -143,6 +151,15 @@ def create_outline(self, doc, channel):
         outline.setAttribute('type', self.FEED_TYPE)
         return outline
 
+    def create_section(self, doc, name):
+        """
+        Creates an empty OPML outline element used to divide sections.
+        """
+        section = doc.createElement('outline')
+        section.setAttribute('title', name)
+        section.setAttribute('text', name)
+        return section
+
     def write(self, channels):
         """
         Creates a XML document containing metadata for each
@@ -169,8 +186,16 @@ def write(self, channels):
         opml.appendChild(head)
 
         body = doc.createElement('body')
+
+        sections = {}
         for channel in channels:
-            body.appendChild(self.create_outline(doc, channel))
+            if channel.section not in sections.keys():
+                sections[channel.section] = self.create_section(doc, channel.section)
+            sections[channel.section].appendChild(self.create_outline(doc, channel))
+
+        for section in sections.values():
+            body.appendChild(section)
+
         opml.appendChild(body)
 
         try: