2 Bookmarks storage manager - json.
4 Written by Broytman, Jul 2010. Copyright (C) 2010 PhiloSoft Design
11 import simplejson as json
13 from bkmk_objects import Folder, Bookmark, Ruler, Walker
16 class storage_json(Walker):
17 filename = "bookmarks_db.json"
19 def root_folder(self, f):
21 dict["children"] = children = []
22 self.folder_stack = [children]
23 dict["dateAdded"] = f.add_date
25 dict["lastModified"] = f.last_modified
26 dict["root"] = "placesRoot"
28 dict["type"] = "text/x-moz-place-container"
30 def start_folder(self, f, level):
32 comment = getattr(f, 'comment')
33 if comment: dict["annos"] = make_annos(comment)
34 dict["children"] = children = []
35 dict["dateAdded"] = f.add_date
37 index = getattr(f, 'index')
38 if index: dict["index"] = index
39 dict["lastModified"] = f.last_modified
40 parent_idx = getattr(f, 'parent_idx')
41 if parent_idx: dict["parent"] = parent_idx
42 dict["title"] = f.name.decode('utf-8')
43 dict["type"] = "text/x-moz-place-container"
44 self.folder_stack[-1].append(dict)
45 self.folder_stack.append(children)
47 def end_folder(self, f, level):
48 del self.folder_stack[-1]
50 def bookmark(self, b, level):
52 comment = getattr(b, 'comment')
53 if comment: dict["annos"] = make_annos(comment)
54 charset = getattr(b, 'charset')
55 if charset: dict["charset"] = charset
56 dict["dateAdded"] = b.add_date
58 index = getattr(b, 'index')
59 if index: dict["index"] = index
60 keyword = getattr(b, 'keyword')
61 if keyword: dict["keyword"] = keyword
62 dict["lastModified"] = b.last_modified
63 dict["parent"] = b.parent_idx
64 dict["title"] = b.name.decode('utf-8')
65 dict["type"] = "text/x-moz-place"
67 self.folder_stack[-1].append(dict)
69 def ruler(self, r, level):
71 comment = getattr(r, 'comment')
72 if comment: dict["annos"] = make_annos(comment)
73 dict["dateAdded"] = r.add_date
75 dict["index"] = r.index
76 dict["lastModified"] = r.last_modified
77 dict["parent"] = r.parent_idx
78 dict["title"] = r.name.decode('utf-8')
79 dict["type"] = "text/x-moz-place-separator"
80 self.folder_stack[-1].append(dict)
82 def store(self, root_folder):
83 root_folder.walk_depth(self)
85 outfile = open(self.filename, 'wb')
86 json.dump(self.dict, outfile)
92 infile = open(self.filename, 'rb')
93 bkmk_s = infile.read()
96 # Work around a bug in Mozilla - remove the trailing comma
97 bkmk_s = bkmk_s.strip().replace(',]', ']')
98 bookmarks_dict = json.loads(bkmk_s)
100 root_folder = Folder()
101 root_folder.header = ''
102 self.folder_stack = [root_folder]
103 self.current_folder = root_folder
105 self.load_folder(root_folder, bookmarks_dict)
106 if self.folder_stack:
107 raise RuntimeError('Excessive folder stack: %s' % self.folder_stack)
111 def load_folder(self, folder, _dict):
112 if _dict["type"] != "text/x-moz-place-container":
113 raise ValueError("Root object is not a Mozilla container")
115 folder.id = _dict["id"]
116 folder.index = _dict.get("index")
117 folder.parent_idx = _dict.get("parent")
119 folder.name = encode(_dict["title"])
121 folder.add_date = _dict["dateAdded"]
122 folder.last_modified = _dict["lastModified"]
124 for record in _dict["children"]:
125 if record["type"] == "text/x-moz-place-container":
127 add_date=record["dateAdded"],
128 comment=get_comment(record.get("annos")),
129 last_modified=record["lastModified"])
130 folder.id = record["id"]
131 folder.parent_idx = record["parent"]
132 folder.name = encode(record["title"])
133 self.current_folder.append(folder)
134 self.folder_stack.append(folder)
135 self.current_folder = folder
136 self.load_folder(folder, record)
138 elif record["type"] == "text/x-moz-place":
141 add_date=record.get("dateAdded"),
142 last_modified=record.get("lastModified"),
143 keyword=record.get("keyword"),
144 comment=get_comment(record.get("annos")),
145 charset=record.get("charset"))
146 bookmark.id = record["id"]
147 bookmark.index = record.get("index")
148 bookmark.parent_idx = record["parent"]
149 bookmark.name = encode(record["title"])
150 self.current_folder.append(bookmark)
152 elif record["type"] == "text/x-moz-place-separator":
154 ruler.add_date = record["dateAdded"]
155 ruler.id = record["id"]
156 ruler.index = record["index"]
157 ruler.last_modified = record["lastModified"]
158 ruler.parent_idx = record["parent"]
159 ruler.name = encode(record["title"])
160 ruler.comment = get_comment(record.get("annos"))
161 self.current_folder.append(ruler)
164 raise ValueError('Unknown record type "%s"' % record["type"])
166 del self.folder_stack[-1]
167 if self.folder_stack:
168 self.current_folder = self.folder_stack[-1]
170 self.current_folder = None
173 return title.encode("UTF-8", "xmlcharrefreplace")
175 def get_comment(annos):
180 if a["name"] == "bookmarkProperties/description" and \
182 return a["value"].encode('utf-8')
186 def make_annos(comment):
191 "name": "bookmarkProperties/description",
193 "value": comment.decode('utf-8')}]