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"] = convert_date_to_json(f.add_date)
33 dict["lastModified"] = convert_date_to_json(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"] = convert_date_to_json(f.add_date)
45 index = getattr(f, 'index')
46 if index: dict["index"] = index
47 dict["lastModified"] = convert_date_to_json(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"] = convert_date_to_json(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"] = convert_date_to_json(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:folder'):
79 value = 'Recently Bookmarked'
80 elif uri.startswith('place:sort=8') or \
81 uri.startswith('place:redirectsMode'):
82 value = 'Most Visited'
83 elif uri.startswith('place:sort=14') or \
84 uri.startswith('place:type=6'):
87 raise ValueError('UNKNOWN place URI: %s' % uri)
88 dict["annos"] = make_annos(value, name='Places/SmartBookmark')
90 del dict["lastModified"]
91 self.folder_stack[-1].append(dict)
93 def ruler(self, r, level):
95 comment = getattr(r, 'comment')
96 if comment: dict["annos"] = make_annos(comment)
97 dict["dateAdded"] = convert_date_to_json(r.add_date)
99 dict["index"] = r.index
100 dict["lastModified"] = convert_date_to_json(r.last_modified)
101 dict["parent"] = r.parent_idx
102 dict["title"] = r.name.decode('utf-8')
103 dict["type"] = "text/x-moz-place-separator"
104 self.folder_stack[-1].append(dict)
106 def store(self, root_folder):
107 root_folder.walk_depth(self)
109 outfile = open(self.filename, 'wb')
110 json.dump(self.dict, outfile)
115 infile = open(self.filename, 'rb')
116 bkmk_s = infile.read()
119 # Work around a bug in Mozilla - remove the trailing comma
120 bkmk_s = bkmk_s.strip().replace(',]', ']')
121 bookmarks_dict = json.loads(bkmk_s)
124 root_folder = Folder()
125 root_folder.header = ''
126 root_folder.add_date = convert_date_from_json(bookmarks_dict["dateAdded"])
127 root_folder.comment = ''
128 root_folder.last_modified = convert_date_from_json(bookmarks_dict["lastModified"])
129 self.folder_stack = [root_folder]
130 self.current_folder = root_folder
132 self.load_folder(root_folder, bookmarks_dict)
133 if self.folder_stack:
134 raise RuntimeError('Excessive folder stack: %s' % self.folder_stack)
138 def load_folder(self, folder, fdict):
139 if fdict["type"] != "text/x-moz-place-container":
140 raise ValueError("The object is not a Mozilla container")
142 folder.id = fdict["id"]
143 folder.index = fdict.get("index")
144 folder.parent_idx = fdict.get("parent")
145 folder.root = fdict.get("root")
146 folder.name = encode_title(fdict["title"])
148 for record in fdict["children"]:
149 if record["type"] == "text/x-moz-place-container":
151 add_date=convert_date_from_json(record["dateAdded"]),
152 comment=get_comment(record.get("annos")),
153 last_modified=convert_date_from_json(record["lastModified"]))
154 self.current_folder.append(folder)
155 self.folder_stack.append(folder)
156 self.current_folder = folder
157 self.load_folder(folder, record)
159 elif record["type"] == "text/x-moz-place":
161 href=record["uri"].encode('utf-8'),
162 add_date=convert_date_from_json(record.get("dateAdded")),
163 last_modified=convert_date_from_json(record.get("lastModified")),
164 keyword=get_str(record, "keyword"),
165 comment=get_comment(record.get("annos")),
166 charset=get_str(record, "charset"))
167 bookmark.id = record["id"]
168 bookmark.index = record.get("index")
169 bookmark.parent_idx = record["parent"]
170 bookmark.name = encode_title(record["title"])
171 self.current_folder.append(bookmark)
173 elif record["type"] == "text/x-moz-place-separator":
175 ruler.add_date = convert_date_from_json(record["dateAdded"])
176 ruler.id = record["id"]
177 ruler.index = record["index"]
178 ruler.last_modified = convert_date_from_json(record["lastModified"])
179 ruler.parent_idx = record["parent"]
180 ruler.name = encode_title(record["title"])
181 ruler.comment = get_comment(record.get("annos"))
182 self.current_folder.append(ruler)
185 raise ValueError('Unknown record type "%s"' % record["type"])
187 del self.folder_stack[-1]
188 if self.folder_stack:
189 self.current_folder = self.folder_stack[-1]
191 self.current_folder = None
194 def convert_date_to_json(date):
196 date = int(date) * 10**6
199 def convert_date_from_json(date):
206 def encode_title(title):
207 return title.encode("UTF-8", "xmlcharrefreplace")
209 def get_str(record, name):
211 return record[name].encode('utf-8')
214 def get_comment(annos):
219 if a["name"] == "bookmarkProperties/description" and \
221 return a["value"].encode('utf-8')
225 def make_annos(value, name="bookmarkProperties/description"):
232 "value": value.decode('utf-8')}]