--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/Helpviewer/Bookmarks/BookmarksImporters/XbelImporter.py Sun Mar 18 10:07:28 2012 +0100 @@ -0,0 +1,124 @@ +# -*- coding: utf-8 -*- + +# Copyright (c) 2012 Detlev Offenbach <detlev@die-offenbachs.de> +# + +""" +Module implementing an importer for XBEL files. +""" + +import os + +from PyQt4.QtCore import QCoreApplication, QXmlStreamReader, QDate, Qt + +from ..BookmarksManager import BookmarksManager +from ..BookmarkNode import BookmarkNode +from ..XbelReader import XbelReader + +from .BookmarksImporter import BookmarksImporter + +import UI.PixmapCache + + +def getImporterInfo(id): + """ + Module function to get information for the given XBEL source id. + + @return tuple with an icon (QPixmap), readable name (string), name of + the default bookmarks file (string), an info text (string), + a prompt (string) and the default directory of the bookmarks file (string) + """ + if id == "e5browser": + bookmarksFile = BookmarksManager.getFileName() + return ( + UI.PixmapCache.getPixmap("ericWeb48.png"), + "eric5 Web Browser", + os.path.basename(bookmarksFile), + QCoreApplication.translate("XbelImporter", + """eric5 Web Browser stores its bookmarks in the <b>{0}</b> XML file. """ + """This file is usually located in""" + ).format(os.path.basename(bookmarksFile)), + QCoreApplication.translate("XbelImporter", + """Please choose the file to begin importing bookmarks."""), + os.path.dirname(bookmarksFile), + ) + elif id == "xbel": + return ( + UI.PixmapCache.getPixmap("xbel.png"), + "XBEL Bookmarks", + QCoreApplication.translate("XbelImporter", "XBEL Bookmarks") + \ + " (*.xbel *.xml)", + QCoreApplication.translate("XbelImporter", + """You can import bookmarks from any browser that supports XBEL """ + """exporting. This file has usually the extension .xbel or .xml.""" ), + QCoreApplication.translate("XbelImporter", + """Please choose the file to begin importing bookmarks."""), + "", + ) + else: + raise ValueError("Unsupported browser ID given ({0}).".format(id)) + + +class XbelImporter(BookmarksImporter): + """ + Class implementing the XBEL bookmarks importer. + """ + def __init__(self, id="", parent=None): + """ + Constructor + + @param id source ID (string) + @param parent reference to the parent object (QObject) + """ + super().__init__(id, parent) + + self.__fileName = "" + + def setPath(self, path): + """ + Public method to set the path of the bookmarks file or directory. + + @param path bookmarks file or directory (string) + """ + self.__fileName = path + + def open(self): + """ + Public method to open the bookmarks file. + + @return flag indicating success (boolean) + """ + if not os.path.exists(self.__fileName): + self._error = True + self._errorString = self.trUtf8("File '{0}' does not exist.")\ + .format(self.__fileName) + return False + return True + + def importedBookmarks(self): + """ + Public method to get the imported bookmarks. + + @return imported bookmarks (BookmarkNode) + """ + reader = XbelReader() + importRootNode = reader.read(self.__fileName) + + if reader.error() != QXmlStreamReader.NoError: + self._error = True + self._errorString = self.trUtf8( + """Error when importing bookmarks on line {0}, column [1}:\n{2}""")\ + .format(reader.lineNumber(), + reader.columnNumber(), + reader.errorString()) + return None + + importRootNode.setType(BookmarkNode.Folder) + if self._id == "e5browser": + importRootNode.title = self.trUtf8("eric5 Web Browser Import") + elif self._id == "xbel": + importRootNode.title = self.trUtf8("XBEL Import") + else: + importRootNode.title = self.trUtf8("Imported {0}")\ + .format(QDate.currentDate().toString(Qt.SystemLocaleShortDate)) + return importRootNode