manage_feeds.py

#!/usr/bin/env python2
# -*- encoding: utf-8 -*-
from __future__ import unicode_literals
from gi.repository import Gtk
import xml.etree.ElementTree as et

from io import open
import sys
import os

UI_INFO = """
<ui>
  <menubar name='MenuBar'>
    <menu action='ImportMenu'>
      <menuitem action='ImportOPML' />
      <menuitem action='ImportFeedFile' />
    </menu>
    <menu action='ExportMenu'>
      <menuitem action='ExportFeedFile' />
    </menu>
  </menubar>
</ui>
"""

class MainWindow(Gtk.Window):

    def __init__(self, filename):
        super(Gtk.Window, self).__init__(title="Manage your feeds")

        self.filename = filename;
        self.feeds = Gtk.ListStore(str, str, bool)
        for f in self.load_feed_file(filename):
            self.feeds.append(f)

        # Set window properties
        self.set_default_size(600, 200)
        icon_path = os.path.abspath(os.path.join(os.path.dirname(__file__),"icon.png"))
        self.set_icon_from_file(icon_path)

        box = Gtk.Box(False, 10, orientation=Gtk.Orientation.VERTICAL);
        button_box = Gtk.Box(False, 10);

        # Build menus
        self.build_menus()
        menubar = self.uimanager.get_widget("/MenuBar")
        box.pack_start(menubar, False, False, 0)

        # Build feed table
        self.treeview = Gtk.TreeView(model=self.feeds)
        self.treeview.set_reorderable(True)

        renderer_url= Gtk.CellRendererText()
        renderer_url.set_property("editable", True)
        renderer_url.connect("edited", self.url_edited)
        column_url = Gtk.TreeViewColumn("Url", renderer_url, text=0)
        column_url.set_expand(True)
        self.treeview.append_column(column_url)

        renderer_title= Gtk.CellRendererText()
        renderer_title.set_property("editable", True)
        renderer_title.connect("edited", self.title_edited)
        column_title = Gtk.TreeViewColumn("Custom title", renderer_title, text=1)
        column_title.set_expand(True)
        self.treeview.append_column(column_title)

        renderer_enable = Gtk.CellRendererToggle()
        renderer_enable.connect("toggled", self.enable_toggled)
        column_enable = Gtk.TreeViewColumn("Enable", renderer_enable, active=2)
        column_enable.set_expand(False)
        self.treeview.append_column(column_enable)

        scrolled_window = Gtk.ScrolledWindow()
        scrolled_window.set_policy(Gtk.PolicyType.AUTOMATIC,
                        Gtk.PolicyType.AUTOMATIC)
        scrolled_window.add(self.treeview)
        box.pack_start(scrolled_window, True, True, 0)

        # Add buttons
        add_button = Gtk.Button(stock=Gtk.STOCK_ADD)
        add_button.connect("clicked", self.new_feed)

        del_button = Gtk.Button(stock=Gtk.STOCK_DELETE)
        del_button.connect("clicked", self.remove_feed)

        cancel_button = Gtk.Button(stock=Gtk.STOCK_CANCEL)
        cancel_button.connect("clicked", Gtk.main_quit)

        save_button = Gtk.Button(stock=Gtk.STOCK_APPLY)
        save_button.connect("clicked", self.write_feed_file)
        save_button.connect("clicked", Gtk.main_quit)

        button_box.pack_start(add_button, False, False, 0);
        button_box.pack_start(del_button, False, False, 0);
        button_box.pack_end(save_button, False, False, 0);
        button_box.pack_end(cancel_button, False, False, 0);

        box.add(button_box)

        self.add(box)

    def build_menus(self):
        action_group = Gtk.ActionGroup("global_actions");

        # Create Import menu
        action_import_menu = Gtk.Action("ImportMenu", "Import", None, None)
        action_group.add_action(action_import_menu)

        action_import_opml= Gtk.Action("ImportOPML", "_Import OPML",
                        "Import feeds from OPML file", Gtk.STOCK_FILE)
        action_import_opml.connect("activate", self.on_menu_import_opml)
        action_group.add_action(action_import_opml)

        action_import_file = Gtk.Action("ImportFeedFile", "_Import Feeds File",
                        "Import feeds from file", Gtk.STOCK_FILE)
        action_import_file.connect("activate", self.on_menu_import_feeds)
        action_group.add_action(action_import_file)

        # Create Export menu
        action_export_menu = Gtk.Action("ExportMenu", "Export", None, None)
        action_group.add_action(action_export_menu)

        action_export_file= Gtk.Action("ExportFeedFile", "_Export Feeds File",
                        "Export feeds to file", Gtk.STOCK_FILE)
        action_export_file.connect("activate", self.on_menu_export_feeds)
        action_group.add_action(action_export_file)

        # Create UI manager
        self.uimanager = Gtk.UIManager()
        self.uimanager.add_ui_from_string(UI_INFO)
        self.add_accel_group(self.uimanager.get_accel_group())
        self.uimanager.insert_action_group(action_group)

    def url_edited(self, widget, path, text):
        self.feeds[path][0] = text

    def title_edited(self, widget, path, text):
        if len(text) > 0:
            self.feeds[path][1] = text
        else:
            self.feeds[path][1] = None

    def enable_toggled(self, widget, path):
        self.feeds[path][2] = not self.feeds[path][2]

    def remove_feed(self, button):
        selection = self.treeview.get_selection()
        result = selection.get_selected()
        if result:
            model, iter = result
        model.remove(iter)

    def new_feed(self, button):
        self.feeds.append(["http://", "", True])
        self.treeview.set_cursor(len(self.feeds) - 1,
                        self.treeview.get_column(0), True)

    def on_menu_import_opml(self, widget):
        dialog = Gtk.FileChooserDialog("Choose a OPML feed file", self,
                Gtk.FileChooserAction.OPEN, (
                        Gtk.STOCK_CANCEL, Gtk.ResponseType.CANCEL,
                        Gtk.STOCK_OPEN, Gtk.ResponseType.OK)
                )

        # Add filters to dialog box
        filter_xml = Gtk.FileFilter()
        filter_xml.set_name("OPML files")
        filter_xml.add_pattern("*.opml")
        dialog.add_filter(filter_xml)

        filter_any = Gtk.FileFilter()
        filter_any.set_name("All files")
        filter_any.add_pattern("*")
        dialog.add_filter(filter_any)

        response = dialog.run()
        filename = dialog.get_filename()
        dialog.destroy()
        if response == Gtk.ResponseType.OK:
            new_feeds = self.import_opml_file(filename)
            for f in new_feeds:
                self.feeds.append(f)

    def on_menu_import_feeds(self, widget):
        dialog = Gtk.FileChooserDialog("Load a feed file", self,
                Gtk.FileChooserAction.OPEN, (
                        Gtk.STOCK_CANCEL, Gtk.ResponseType.CANCEL,
                        Gtk.STOCK_OPEN, Gtk.ResponseType.OK)
                )

        # Add filters to dialog box
        filter_text = Gtk.FileFilter()
        filter_text.set_name("Text files")
        filter_text.add_mime_type("text/plain")
        dialog.add_filter(filter_text)

        filter_any = Gtk.FileFilter()
        filter_any.set_name("All files")
        filter_any.add_pattern("*")
        dialog.add_filter(filter_any)

        response = dialog.run()
        filename = dialog.get_filename()
        dialog.destroy()
        if response == Gtk.ResponseType.OK:
            new_feeds = self.load_feed_file(filename)
            for f in new_feeds:
                self.feeds.append(f)

    def on_menu_export_feeds(self, widget):
        dialog = Gtk.FileChooserDialog("Save a feed file", self,
                Gtk.FileChooserAction.SAVE, (
                        Gtk.STOCK_CANCEL, Gtk.ResponseType.CANCEL,
                        Gtk.STOCK_SAVE, Gtk.ResponseType.OK)
                )

        # Add filters to dialog box
        filter_text = Gtk.FileFilter()
        filter_text.set_name("Text files")
        filter_text.add_mime_type("text/plain")
        dialog.add_filter(filter_text)

        filter_any = Gtk.FileFilter()
        filter_any.set_name("All files")
        filter_any.add_pattern("*")
        dialog.add_filter(filter_any)

        response = dialog.run()
        filename = dialog.get_filename()
        dialog.destroy()
        if response == Gtk.ResponseType.OK:
            new_feeds = self.write_feed_file(filename=filename)

    def write_feed_file(self, button=None, filename=None):
        """
            Writes the feeds list to the file/stdout
        """
        if filename is None:
           filename = self.filename

        if filename is None:
            f = sys.stdout
        else:
            f = open(filename, mode="w", encoding="utf-8")

        for feed in self.feeds:
            if not feed[2]:
                f.write(u'#')
            f.write(unicode(feed[0], 'utf8'))
            if feed[1] is not None:
                f.write(u' ')
                f.write(unicode(feed[1], 'utf8'))
            f.write(u'\n')

    def load_feed_file(self, filename):
        """
            Reads content of the feed file/stdin and returns a list of lists
        """
        content = []

        if (filename is None):
            f = sys.stdin
        else:
            f = open(filename, "r")

        for line in f:
            try:
                # If input is coming from the command line, convert to utf8
                if (filename is None):
                    line = unicode(line, 'utf8')
                if line[0] == "#":
                    # cut out the comment and define this item as disabled
                    line = line[1:]
                    enable = False
                else:
                    enable = True
                temp = line.split()
                url = temp[0]
                custom_title = None
                if len(temp) > 1:
                    custom_title = " ".join(temp[1:])
                content.append([url, custom_title, enable])
            except IndexError:
                # empty lines are ignored
                pass

        return content

    def import_opml_file(self, filename):
        """
            Reads feeds list from an OPML file
        """
        new_feeds = []

        try:
            tree = et.parse(filename)
            root = tree.getroot()
            for outline in root.findall(".//outline[@type='rss']"):
                new_feeds.append([
                        unicode(outline.attrib.get('xmlUrl', '')),
                        unicode(outline.attrib.get('text','')),
                        False])
        except Exception as e:
            dialog = Gtk.MessageDialog(self, 0, Gtk.MessageType.ERROR,
                    Gtk.ButtonsType.CANCEL, "Failed to import OPML")
            dialog.format_secondary_text(str(e))
            dialog.run()
            dialog.destroy()
            return new_feeds

        dialog = Gtk.MessageDialog(self, 0, Gtk.MessageType.INFO,
                Gtk.ButtonsType.OK, "OPML file imported")
        dialog.format_secondary_text("Imported %d feeds" % len(new_feeds))
        dialog.run()
        dialog.destroy()

        return new_feeds

if __name__ == '__main__':

    # get feed file name
    if len(sys.argv) > 1:
        feed_file_name = sys.argv[1]
    else:
        feed_file_name = None

    window = MainWindow(filename=feed_file_name)
    window.connect("delete-event", Gtk.main_quit);
    window.show_all()
    Gtk.main()