]> git.phdru.name Git - bookmarks_db.git/blobdiff - Storage/bkmk_stjson.py
Added docstrings, __{version,revision,etc}__ boilerplates.
[bookmarks_db.git] / Storage / bkmk_stjson.py
index 32efdff1d24dc41962b9b2eae0b14d967dbda18f..437ca6d414687e19f0e2a5f8504b4106f4f8691b 100644 (file)
@@ -1,9 +1,14 @@
-"""
-    Bookmarks storage manager - json.
+"""Bookmarks storage manager - json
 
-    Written by Broytman, Jul 2010. Copyright (C) 2010 PhiloSoft Design
+This file is a part of Bookmarks database and Internet robot.
 """
 
+__version__ = "$Revision$"[11:-2]
+__revision__ = "$Id$"[5:-2]
+__date__ = "$Date$"[7:-2]
+__author__ = "Oleg Broytman <phd@phdru.name>"
+__copyright__ = "Copyright (C) 2010, 2011 PhiloSoft Design"
+__license__ = "GNU GPL"
 
 try:
    import json
@@ -17,16 +22,79 @@ class storage_json(Walker):
     filename = "bookmarks_db.json"
 
     def root_folder(self, f):
-        self.dict = {}
+        self.dict = dict = {}
+        dict["children"] = children = []
+        self.folder_stack = [children]
+        dict["dateAdded"] = f.add_date
+        dict["id"] = f.id
+        dict["lastModified"] = f.last_modified
+        dict["root"] = "placesRoot"
+        dict["title"] = ""
+        dict["type"] = "text/x-moz-place-container"
 
     def start_folder(self, f, level):
-        pass
+        dict = {}
+        comment = getattr(f, 'comment')
+        if comment: dict["annos"] = make_annos(comment)
+        dict["children"] = children = []
+        dict["dateAdded"] = f.add_date
+        dict["id"] = f.id
+        index = getattr(f, 'index')
+        if index: dict["index"] = index
+        dict["lastModified"] = f.last_modified
+        parent_idx = getattr(f, 'parent_idx')
+        if parent_idx: dict["parent"] = parent_idx
+        root = getattr(f, 'root')
+        if root: dict["root"] = root
+        dict["title"] = f.name.decode('utf-8')
+        dict["type"] = "text/x-moz-place-container"
+        self.folder_stack[-1].append(dict)
+        self.folder_stack.append(children)
+
+    def end_folder(self, f, level):
+        del self.folder_stack[-1]
 
     def bookmark(self, b, level):
-        pass
+        dict = {}
+        comment = getattr(b, 'comment')
+        if comment: dict["annos"] = make_annos(comment)
+        charset = getattr(b, 'charset')
+        if charset: dict["charset"] = charset
+        dict["dateAdded"] = b.add_date
+        dict["id"] = b.id
+        index = getattr(b, 'index')
+        if index: dict["index"] = index
+        keyword = getattr(b, 'keyword')
+        if keyword: dict["keyword"] = keyword
+        dict["lastModified"] = b.last_modified
+        dict["parent"] = b.parent_idx
+        dict["title"] = b.name.decode('utf-8')
+        dict["type"] = "text/x-moz-place"
+        dict["uri"] = uri = b.href
+        if uri.startswith('place:'):
+            if uri.startswith('place:sort=8'):
+                value = 'MostVisited'
+            elif uri.startswith('place:folder=BOOKMARKS_MENU'):
+                value = 'RecentlyBookmarked'
+            elif uri.startswith('place:sort=14'):
+                value = 'RecentTags'
+            dict["annos"] = make_annos(value, name='Places/SmartBookmark')
+            del dict["dateAdded"]
+            del dict["lastModified"]
+        self.folder_stack[-1].append(dict)
 
     def ruler(self, r, level):
-        pass
+        dict = {}
+        comment = getattr(r, 'comment')
+        if comment: dict["annos"] = make_annos(comment)
+        dict["dateAdded"] = r.add_date
+        dict["id"] = r.id
+        dict["index"] = r.index
+        dict["lastModified"] = r.last_modified
+        dict["parent"] = r.parent_idx
+        dict["title"] = r.name.decode('utf-8')
+        dict["type"] = "text/x-moz-place-separator"
+        self.folder_stack[-1].append(dict)
 
     def store(self, root_folder):
         root_folder.walk_depth(self)
@@ -45,9 +113,13 @@ class storage_json(Walker):
         # Work around a bug in Mozilla - remove the trailing comma
         bkmk_s = bkmk_s.strip().replace(',]', ']')
         bookmarks_dict = json.loads(bkmk_s)
+        del bkmk_s
 
         root_folder = Folder()
         root_folder.header = ''
+        root_folder.add_date = bookmarks_dict["dateAdded"]
+        root_folder.comment = ''
+        root_folder.last_modified = bookmarks_dict["lastModified"]
         self.folder_stack = [root_folder]
         self.current_folder = root_folder
 
@@ -57,44 +129,41 @@ class storage_json(Walker):
 
         return root_folder
 
-    def load_folder(self, folder, _dict):
-        if _dict["type"] != "text/x-moz-place-container":
-            raise ValueError("Root object is not a Mozilla container")
+    def load_folder(self, folder, fdict):
+        if fdict["type"] != "text/x-moz-place-container":
+            raise ValueError("The object is not a Mozilla container")
 
-        folder.id = _dict["id"]
-        folder.index = _dict.get("index")
-        folder.parent_idx = _dict.get("parent")
+        folder.id = fdict["id"]
+        folder.index = fdict.get("index")
+        folder.parent_idx = fdict.get("parent")
+        folder.root = fdict.get("root")
+        folder.name = encode(fdict["title"])
 
-        folder.name = encode(_dict["title"])
-        folder.href = _dict.get("uri")
-        folder.comment = ''
-        folder.add_date = _dict["dateAdded"]
-        folder.last_modified = _dict["lastModified"]
+        for record in fdict["children"]:
+            if record["type"] == "text/x-moz-place-container":
+                folder = Folder(
+                    add_date=record["dateAdded"],
+                    comment=get_comment(record.get("annos")),
+                    last_modified=record["lastModified"])
+                self.current_folder.append(folder)
+                self.folder_stack.append(folder)
+                self.current_folder = folder
+                self.load_folder(folder, record)
 
-        for record in _dict["children"]:
-            if record["type"] == "text/x-moz-place":
+            elif record["type"] == "text/x-moz-place":
                 bookmark = Bookmark(
                     href=record["uri"],
                     add_date=record.get("dateAdded"),
                     last_modified=record.get("lastModified"),
+                    keyword=record.get("keyword"),
+                    comment=get_comment(record.get("annos")),
                     charset=record.get("charset"))
                 bookmark.id = record["id"]
+                bookmark.index = record.get("index")
                 bookmark.parent_idx = record["parent"]
                 bookmark.name = encode(record["title"])
                 self.current_folder.append(bookmark)
 
-            elif record["type"] == "text/x-moz-place-container":
-                folder = Folder(
-                    add_date=record["dateAdded"], comment=None,
-                    last_modified=record["lastModified"])
-                folder.id = record["id"]
-                folder.parent_idx = record["parent"]
-                folder.name = encode(record["title"])
-                self.current_folder.append(folder)
-                self.folder_stack.append(folder)
-                self.current_folder = folder
-                self.load_folder(folder, record)
-
             elif record["type"] == "text/x-moz-place-separator":
                 ruler = Ruler()
                 ruler.add_date = record["dateAdded"]
@@ -103,6 +172,7 @@ class storage_json(Walker):
                 ruler.last_modified = record["lastModified"]
                 ruler.parent_idx = record["parent"]
                 ruler.name = encode(record["title"])
+                ruler.comment = get_comment(record.get("annos"))
                 self.current_folder.append(ruler)
 
             else:
@@ -116,3 +186,23 @@ class storage_json(Walker):
 
 def encode(title):
     return title.encode("UTF-8", "xmlcharrefreplace")
+
+def get_comment(annos):
+    if not annos:
+        return ''
+
+    for a in annos:
+        if a["name"] == "bookmarkProperties/description" and \
+                a["type"] == 3:
+            return a["value"].encode('utf-8')
+
+    return ''
+
+def make_annos(value, name="bookmarkProperties/description"):
+    return [{
+        "expires": 4,
+        "flags": 0,
+        "mimeType": None,
+        "name": name,
+        "type": 3,
+        "value": value.decode('utf-8')}]