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') \
79 or uri.startswith('place://sort=8'):
81 elif uri.startswith('place://redirectsMode'):
82 value = 'Most Visited'
83 elif uri.startswith('place:folder=BOOKMARKS_MENU') \
84 or uri.startswith('place://folder=BOOKMARKS_MENU'):
85 value = 'RecentlyBookmarked'
86 elif uri.startswith('place://folder'):
87 value = 'Recently Bookmarked'
88 elif uri.startswith('place:sort=14') \
89 or uri.startswith('place://sort=14'):
91 elif uri.startswith('place://type'):
94 raise ValueError('UNKNOWN place URI: %s' % uri)
95 dict["annos"] = make_annos(value, name='Places/SmartBookmark')
97 del dict["lastModified"]
98 self.folder_stack[-1].append(dict)
100 def ruler(self, r, level):
102 comment = getattr(r, 'comment')
103 if comment: dict["annos"] = make_annos(comment)
104 dict["dateAdded"] = r.add_date
106 dict["index"] = r.index
107 dict["lastModified"] = r.last_modified
108 dict["parent"] = r.parent_idx
109 dict["title"] = r.name.decode('utf-8')
110 dict["type"] = "text/x-moz-place-separator"
111 self.folder_stack[-1].append(dict)
113 def store(self, root_folder):
114 root_folder.walk_depth(self)
116 outfile = open(self.filename, 'wb')
117 json.dump(self.dict, outfile)
122 infile = open(self.filename, 'rb')
123 bkmk_s = infile.read()
126 # Work around a bug in Mozilla - remove the trailing comma
127 bkmk_s = bkmk_s.strip().replace(',]', ']')
128 bookmarks_dict = json.loads(bkmk_s)
131 root_folder = Folder()
132 root_folder.header = ''
133 root_folder.add_date = bookmarks_dict["dateAdded"]
134 root_folder.comment = ''
135 root_folder.last_modified = bookmarks_dict["lastModified"]
136 self.folder_stack = [root_folder]
137 self.current_folder = root_folder
139 self.load_folder(root_folder, bookmarks_dict)
140 if self.folder_stack:
141 raise RuntimeError('Excessive folder stack: %s' % self.folder_stack)
145 def load_folder(self, folder, fdict):
146 if fdict["type"] != "text/x-moz-place-container":
147 raise ValueError("The object is not a Mozilla container")
149 folder.id = fdict["id"]
150 folder.index = fdict.get("index")
151 folder.parent_idx = fdict.get("parent")
152 folder.root = fdict.get("root")
153 folder.name = encode_title(fdict["title"])
155 for record in fdict["children"]:
156 if record["type"] == "text/x-moz-place-container":
158 add_date=record["dateAdded"],
159 comment=get_comment(record.get("annos")),
160 last_modified=record["lastModified"])
161 self.current_folder.append(folder)
162 self.folder_stack.append(folder)
163 self.current_folder = folder
164 self.load_folder(folder, record)
166 elif record["type"] == "text/x-moz-place":
168 href=record["uri"].encode('utf-8'),
169 add_date=record.get("dateAdded"),
170 last_modified=record.get("lastModified"),
171 keyword=get_str(record, "keyword"),
172 comment=get_comment(record.get("annos")),
173 charset=get_str(record, "charset"))
174 bookmark.id = record["id"]
175 bookmark.index = record.get("index")
176 bookmark.parent_idx = record["parent"]
177 bookmark.name = encode_title(record["title"])
178 self.current_folder.append(bookmark)
180 elif record["type"] == "text/x-moz-place-separator":
182 ruler.add_date = record["dateAdded"]
183 ruler.id = record["id"]
184 ruler.index = record["index"]
185 ruler.last_modified = record["lastModified"]
186 ruler.parent_idx = record["parent"]
187 ruler.name = encode_title(record["title"])
188 ruler.comment = get_comment(record.get("annos"))
189 self.current_folder.append(ruler)
192 raise ValueError('Unknown record type "%s"' % record["type"])
194 del self.folder_stack[-1]
195 if self.folder_stack:
196 self.current_folder = self.folder_stack[-1]
198 self.current_folder = None
200 def encode_title(title):
201 return title.encode("UTF-8", "xmlcharrefreplace")
203 def get_str(record, name):
205 return record[name].encode('utf-8')
208 def get_comment(annos):
213 if a["name"] == "bookmarkProperties/description" and \
215 return a["value"].encode('utf-8')
219 def make_annos(value, name="bookmarkProperties/description"):
226 "value": value.decode('utf-8')}]