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 root = getattr(f, 'root')
43 if root: dict["root"] = root
44 dict["title"] = f.name.decode('utf-8')
45 dict["type"] = "text/x-moz-place-container"
46 self.folder_stack[-1].append(dict)
47 self.folder_stack.append(children)
49 def end_folder(self, f, level):
50 del self.folder_stack[-1]
52 def bookmark(self, b, level):
54 comment = getattr(b, 'comment')
55 if comment: dict["annos"] = make_annos(comment)
56 charset = getattr(b, 'charset')
57 if charset: dict["charset"] = charset
58 dict["dateAdded"] = b.add_date
60 index = getattr(b, 'index')
61 if index: dict["index"] = index
62 keyword = getattr(b, 'keyword')
63 if keyword: dict["keyword"] = keyword
64 dict["lastModified"] = b.last_modified
65 dict["parent"] = b.parent_idx
66 dict["title"] = b.name.decode('utf-8')
67 dict["type"] = "text/x-moz-place"
68 dict["uri"] = uri = b.href
69 if uri.startswith('place:'):
70 if uri.startswith('place:sort=8'):
72 elif uri.startswith('place:folder=BOOKMARKS_MENU'):
73 value = 'RecentlyBookmarked'
74 elif uri.startswith('place:sort=14'):
76 dict["annos"] = make_annos(value, name='Places/SmartBookmark')
78 del dict["lastModified"]
79 self.folder_stack[-1].append(dict)
81 def ruler(self, r, level):
83 comment = getattr(r, 'comment')
84 if comment: dict["annos"] = make_annos(comment)
85 dict["dateAdded"] = r.add_date
87 dict["index"] = r.index
88 dict["lastModified"] = r.last_modified
89 dict["parent"] = r.parent_idx
90 dict["title"] = r.name.decode('utf-8')
91 dict["type"] = "text/x-moz-place-separator"
92 self.folder_stack[-1].append(dict)
94 def store(self, root_folder):
95 root_folder.walk_depth(self)
97 outfile = open(self.filename, 'wb')
98 json.dump(self.dict, outfile)
104 infile = open(self.filename, 'rb')
105 bkmk_s = infile.read()
108 # Work around a bug in Mozilla - remove the trailing comma
109 bkmk_s = bkmk_s.strip().replace(',]', ']')
110 bookmarks_dict = json.loads(bkmk_s)
113 root_folder = Folder()
114 root_folder.header = ''
115 root_folder.add_date = bookmarks_dict["dateAdded"]
116 root_folder.comment = ''
117 root_folder.last_modified = bookmarks_dict["lastModified"]
118 self.folder_stack = [root_folder]
119 self.current_folder = root_folder
121 self.load_folder(root_folder, bookmarks_dict)
122 if self.folder_stack:
123 raise RuntimeError('Excessive folder stack: %s' % self.folder_stack)
127 def load_folder(self, folder, fdict):
128 if fdict["type"] != "text/x-moz-place-container":
129 raise ValueError("The object is not a Mozilla container")
131 folder.id = fdict["id"]
132 folder.index = fdict.get("index")
133 folder.parent_idx = fdict.get("parent")
134 folder.root = fdict.get("root")
135 folder.name = encode(fdict["title"])
137 for record in fdict["children"]:
138 if record["type"] == "text/x-moz-place-container":
140 add_date=record["dateAdded"],
141 comment=get_comment(record.get("annos")),
142 last_modified=record["lastModified"])
143 self.current_folder.append(folder)
144 self.folder_stack.append(folder)
145 self.current_folder = folder
146 self.load_folder(folder, record)
148 elif record["type"] == "text/x-moz-place":
151 add_date=record.get("dateAdded"),
152 last_modified=record.get("lastModified"),
153 keyword=record.get("keyword"),
154 comment=get_comment(record.get("annos")),
155 charset=record.get("charset"))
156 bookmark.id = record["id"]
157 bookmark.index = record.get("index")
158 bookmark.parent_idx = record["parent"]
159 bookmark.name = encode(record["title"])
160 self.current_folder.append(bookmark)
162 elif record["type"] == "text/x-moz-place-separator":
164 ruler.add_date = record["dateAdded"]
165 ruler.id = record["id"]
166 ruler.index = record["index"]
167 ruler.last_modified = record["lastModified"]
168 ruler.parent_idx = record["parent"]
169 ruler.name = encode(record["title"])
170 ruler.comment = get_comment(record.get("annos"))
171 self.current_folder.append(ruler)
174 raise ValueError('Unknown record type "%s"' % record["type"])
176 del self.folder_stack[-1]
177 if self.folder_stack:
178 self.current_folder = self.folder_stack[-1]
180 self.current_folder = None
183 return title.encode("UTF-8", "xmlcharrefreplace")
185 def get_comment(annos):
190 if a["name"] == "bookmarkProperties/description" and \
192 return a["value"].encode('utf-8')
196 def make_annos(value, name="bookmarkProperties/description"):
203 "value": value.decode('utf-8')}]