Mercurial Repositories > eric / file diff

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/src/eric7/WebBrowser/Bookmarks/BookmarksImporters/SafariImporter.py	Thu Jul 07 11:23:56 2022 +0200
@@ -0,0 +1,151 @@
+# -*- coding: utf-8 -*-
+
+# Copyright (c) 2012 - 2022 Detlev Offenbach <detlev@die-offenbachs.de>
+#
+
+"""
+Module implementing an importer for Apple Safari bookmarks.
+"""
+
+import os
+import plistlib
+
+from PyQt6.QtCore import QCoreApplication, QDate, Qt
+
+from .BookmarksImporter import BookmarksImporter
+
+import UI.PixmapCache
+import Globals
+
+
+def getImporterInfo(sourceId):
+    """
+    Module function to get information for the given source id.
+    
+    @param sourceId id of the browser ("chrome" or "chromium")
+    @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)
+    @exception ValueError raised to indicate an invalid browser ID
+    """
+    if sourceId != "safari":
+        raise ValueError(
+            "Unsupported browser ID given ({0}).".format(sourceId))
+    
+    if Globals.isWindowsPlatform():
+        standardDir = os.path.expandvars(
+            "%APPDATA%\\Apple Computer\\Safari")
+    elif Globals.isMacPlatform():
+        standardDir = os.path.expanduser("~/Library/Safari")
+    else:
+        standardDir = ""
+    return (
+        UI.PixmapCache.getPixmap("safari"),
+        "Apple Safari",
+        "Bookmarks.plist",
+        QCoreApplication.translate(
+            "SafariImporter",
+            """Apple Safari stores its bookmarks in the"""
+            """ <b>Bookmarks.plist</b> file. This file is usually"""
+            """ located in"""),
+        QCoreApplication.translate(
+            "SafariImporter",
+            """Please choose the file to begin importing bookmarks."""),
+        standardDir,
+    )
+
+
+class SafariImporter(BookmarksImporter):
+    """
+    Class implementing the Apple Safari bookmarks importer.
+    """
+    def __init__(self, sourceId="", parent=None):
+        """
+        Constructor
+        
+        @param sourceId source ID (string)
+        @param parent reference to the parent object (QObject)
+        """
+        super().__init__(sourceId, 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.tr(
+                "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)
+        """
+        try:
+            with open(self.__fileName, "rb") as f:
+                bookmarksDict = plistlib.load(f)
+        except (plistlib.InvalidFileException, OSError) as err:
+            self._error = True
+            self._errorString = self.tr(
+                "Bookmarks file cannot be read.\nReason: {0}".format(str(err)))
+            return None
+        
+        from ..BookmarkNode import BookmarkNode
+        importRootNode = BookmarkNode(BookmarkNode.Folder)
+        if (
+            bookmarksDict["WebBookmarkFileVersion"] == 1 and
+            bookmarksDict["WebBookmarkType"] == "WebBookmarkTypeList"
+        ):
+            self.__processChildren(bookmarksDict["Children"], importRootNode)
+        
+        if self._id == "safari":
+            importRootNode.title = self.tr("Apple Safari Import")
+        else:
+            importRootNode.title = self.tr(
+                "Imported {0}"
+            ).format(QDate.currentDate().toString(
+                Qt.DateFormat.SystemLocaleShortDate))
+        return importRootNode
+    
+    def __processChildren(self, children, rootNode):
+        """
+        Private method to process the list of children.
+        
+        @param children list of child nodes to be processed (list of dict)
+        @param rootNode node to add the bookmarks to (BookmarkNode)
+        """
+        from ..BookmarkNode import BookmarkNode
+        for child in children:
+            if child["WebBookmarkType"] == "WebBookmarkTypeList":
+                folder = BookmarkNode(BookmarkNode.Folder, rootNode)
+                folder.title = child["Title"].replace("&", "&&")
+                if "Children" in child:
+                    self.__processChildren(child["Children"], folder)
+            elif child["WebBookmarkType"] == "WebBookmarkTypeLeaf":
+                url = child["URLString"]
+                if url.startswith(("place:", "about:")):
+                    continue
+                
+                bookmark = BookmarkNode(BookmarkNode.Bookmark, rootNode)
+                bookmark.url = url
+                bookmark.title = (
+                    child["URIDictionary"]["title"].replace("&", "&&")
+                )