Storage/bkmk_stjson.py

   1 """
   2     Bookmarks storage manager - json.
   3
   4     Written by Broytman, Jul 2010. Copyright (C) 2010 PhiloSoft Design
   5 """
   6
   7
   8 try:
   9    import json
  10 except ImportError:
  11    import simplejson as json
  12
  13 from bkmk_objects import Folder, Bookmark, Ruler, Walker
  14
  15
  16 class storage_json(Walker):
  17     filename = "bookmarks_db.json"
  18
  19     def root_folder(self, f):
  20         self.dict = dict = {}
  21         dict["children"] = children = []
  22         self.folder_stack = [children]
  23         dict["dateAdded"] = f.add_date
  24         dict["id"] = f.id
  25         dict["lastModified"] = f.last_modified
  26         dict["root"] = "placesRoot"
  27         dict["title"] = ""
  28         dict["type"] = "text/x-moz-place-container"
  29
  30     def start_folder(self, f, level):
  31         dict = {}
  32         comment = getattr(f, 'comment')
  33         if comment: dict["annos"] = make_annos(comment)
  34         dict["children"] = children = []
  35         dict["dateAdded"] = f.add_date
  36         dict["id"] = f.id
  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)
  48
  49     def end_folder(self, f, level):
  50         del self.folder_stack[-1]
  51
  52     def bookmark(self, b, level):
  53         dict = {}
  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
  59         dict["id"] = b.id
  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'):
  71                 value = 'MostVisited'
  72             elif uri.startswith('place:folder=BOOKMARKS_MENU'):
  73                 value = 'RecentlyBookmarked'
  74             elif uri.startswith('place:sort=14'):
  75                 value = 'RecentTags'
  76             dict["annos"] = make_annos(value, name='Places/SmartBookmark')
  77             del dict["dateAdded"]
  78             del dict["lastModified"]
  79         self.folder_stack[-1].append(dict)
  80
  81     def ruler(self, r, level):
  82         dict = {}
  83         comment = getattr(r, 'comment')
  84         if comment: dict["annos"] = make_annos(comment)
  85         dict["dateAdded"] = r.add_date
  86         dict["id"] = r.id
  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)
  93
  94     def store(self, root_folder):
  95         root_folder.walk_depth(self)
  96
  97         outfile = open(self.filename, 'wb')
  98         json.dump(self.dict, outfile)
  99         outfile.close()
 100         del self.dict
 101
 102
 103     def load(self):
 104         infile = open(self.filename, 'rb')
 105         bkmk_s = infile.read()
 106         infile.close()
 107
 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)
 111         del bkmk_s
 112
 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
 120
 121         self.load_folder(root_folder, bookmarks_dict)
 122         if self.folder_stack:
 123             raise RuntimeError('Excessive folder stack: %s' % self.folder_stack)
 124
 125         return root_folder
 126
 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")
 130
 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"])
 136
 137         for record in fdict["children"]:
 138             if record["type"] == "text/x-moz-place-container":
 139                 folder = Folder(
 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)
 147
 148             elif record["type"] == "text/x-moz-place":
 149                 bookmark = Bookmark(
 150                     href=record["uri"],
 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)
 161
 162             elif record["type"] == "text/x-moz-place-separator":
 163                 ruler = Ruler()
 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)
 172
 173             else:
 174                 raise ValueError('Unknown record type "%s"' % record["type"])
 175
 176         del self.folder_stack[-1]
 177         if self.folder_stack:
 178             self.current_folder = self.folder_stack[-1]
 179         else:
 180             self.current_folder = None
 181
 182 def encode(title):
 183     return title.encode("UTF-8", "xmlcharrefreplace")
 184
 185 def get_comment(annos):
 186     if not annos:
 187         return ''
 188
 189     for a in annos:
 190         if a["name"] == "bookmarkProperties/description" and \
 191                 a["type"] == 3:
 192             return a["value"].encode('utf-8')
 193
 194     return ''
 195
 196 def make_annos(value, name="bookmarkProperties/description"):
 197     return [{
 198         "expires": 4,
 199         "flags": 0,
 200         "mimeType": None,
 201         "name": name,
 202         "type": 3,
 203         "value": value.decode('utf-8')}]