1 """Bookmarks storage manager - json
3 This file is a part of Bookmarks database and Internet robot.
6 __version__ = "$Revision$"[11:-2]
7 __revision__ = "$Id$"[5:-2]
8 __date__ = "$Date$"[7:-2]
9 __author__ = "Oleg Broytman <phd@phdru.name>"
10 __copyright__ = "Copyright (C) 2010, 2011 PhiloSoft Design"
11 __license__ = "GNU GPL"
13 __all__ = ['storage_json']
19 import simplejson as json
21 from bkmk_objects import Folder, Bookmark, Ruler, Walker
24 class storage_json(Walker):
25 filename = "bookmarks_db.json"
27 def root_folder(self, f):
29 dict["children"] = children = []
30 self.folder_stack = [children]
31 dict["dateAdded"] = f.add_date
33 dict["lastModified"] = f.last_modified
34 dict["root"] = "placesRoot"
36 dict["type"] = "text/x-moz-place-container"
38 def start_folder(self, f, level):
40 comment = getattr(f, 'comment')
41 if comment: dict["annos"] = make_annos(comment)
42 dict["children"] = children = []
43 dict["dateAdded"] = f.add_date
45 index = getattr(f, 'index')
46 if index: dict["index"] = index
47 dict["lastModified"] = f.last_modified
48 parent_idx = getattr(f, 'parent_idx')
49 if parent_idx: dict["parent"] = parent_idx
50 root = getattr(f, 'root')
51 if root: dict["root"] = root
52 dict["title"] = f.name.decode('utf-8')
53 dict["type"] = "text/x-moz-place-container"
54 self.folder_stack[-1].append(dict)
55 self.folder_stack.append(children)
57 def end_folder(self, f, level):
58 del self.folder_stack[-1]
60 def bookmark(self, b, level):
62 comment = getattr(b, 'comment')
63 if comment: dict["annos"] = make_annos(comment)
64 charset = getattr(b, 'charset')
65 if charset: dict["charset"] = charset
66 dict["dateAdded"] = b.add_date
68 index = getattr(b, 'index')
69 if index: dict["index"] = index
70 keyword = getattr(b, 'keyword')
71 if keyword: dict["keyword"] = keyword
72 dict["lastModified"] = b.last_modified
73 dict["parent"] = b.parent_idx
74 dict["title"] = b.name.decode('utf-8')
75 dict["type"] = "text/x-moz-place"
76 dict["uri"] = uri = b.href
77 if uri.startswith('place:'):
78 if uri.startswith('place:sort=8'):
80 elif uri.startswith('place:folder=BOOKMARKS_MENU'):
81 value = 'RecentlyBookmarked'
82 elif uri.startswith('place:sort=14'):
84 dict["annos"] = make_annos(value, name='Places/SmartBookmark')
86 del dict["lastModified"]
87 self.folder_stack[-1].append(dict)
89 def ruler(self, r, level):
91 comment = getattr(r, 'comment')
92 if comment: dict["annos"] = make_annos(comment)
93 dict["dateAdded"] = r.add_date
95 dict["index"] = r.index
96 dict["lastModified"] = r.last_modified
97 dict["parent"] = r.parent_idx
98 dict["title"] = r.name.decode('utf-8')
99 dict["type"] = "text/x-moz-place-separator"
100 self.folder_stack[-1].append(dict)
102 def store(self, root_folder):
103 root_folder.walk_depth(self)
105 outfile = open(self.filename, 'wb')
106 json.dump(self.dict, outfile)
111 infile = open(self.filename, 'rb')
112 bkmk_s = infile.read()
115 # Work around a bug in Mozilla - remove the trailing comma
116 bkmk_s = bkmk_s.strip().replace(',]', ']')
117 bookmarks_dict = json.loads(bkmk_s)
120 root_folder = Folder()
121 root_folder.header = ''
122 root_folder.add_date = bookmarks_dict["dateAdded"]
123 root_folder.comment = ''
124 root_folder.last_modified = bookmarks_dict["lastModified"]
125 self.folder_stack = [root_folder]
126 self.current_folder = root_folder
128 self.load_folder(root_folder, bookmarks_dict)
129 if self.folder_stack:
130 raise RuntimeError('Excessive folder stack: %s' % self.folder_stack)
134 def load_folder(self, folder, fdict):
135 if fdict["type"] != "text/x-moz-place-container":
136 raise ValueError("The object is not a Mozilla container")
138 folder.id = fdict["id"]
139 folder.index = fdict.get("index")
140 folder.parent_idx = fdict.get("parent")
141 folder.root = fdict.get("root")
142 folder.name = encode(fdict["title"])
144 for record in fdict["children"]:
145 if record["type"] == "text/x-moz-place-container":
147 add_date=record["dateAdded"],
148 comment=get_comment(record.get("annos")),
149 last_modified=record["lastModified"])
150 self.current_folder.append(folder)
151 self.folder_stack.append(folder)
152 self.current_folder = folder
153 self.load_folder(folder, record)
155 elif record["type"] == "text/x-moz-place":
158 add_date=record.get("dateAdded"),
159 last_modified=record.get("lastModified"),
160 keyword=record.get("keyword"),
161 comment=get_comment(record.get("annos")),
162 charset=record.get("charset"))
163 bookmark.id = record["id"]
164 bookmark.index = record.get("index")
165 bookmark.parent_idx = record["parent"]
166 bookmark.name = encode(record["title"])
167 self.current_folder.append(bookmark)
169 elif record["type"] == "text/x-moz-place-separator":
171 ruler.add_date = record["dateAdded"]
172 ruler.id = record["id"]
173 ruler.index = record["index"]
174 ruler.last_modified = record["lastModified"]
175 ruler.parent_idx = record["parent"]
176 ruler.name = encode(record["title"])
177 ruler.comment = get_comment(record.get("annos"))
178 self.current_folder.append(ruler)
181 raise ValueError('Unknown record type "%s"' % record["type"])
183 del self.folder_stack[-1]
184 if self.folder_stack:
185 self.current_folder = self.folder_stack[-1]
187 self.current_folder = None
190 return title.encode("UTF-8", "xmlcharrefreplace")
192 def get_comment(annos):
197 if a["name"] == "bookmarkProperties/description" and \
199 return a["value"].encode('utf-8')
203 def make_annos(value, name="bookmarkProperties/description"):
210 "value": value.decode('utf-8')}]