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         dict["title"] = f.name.decode('utf-8')
  43         dict["type"] = "text/x-moz-place-container"
  44         self.folder_stack[-1].append(dict)
  45         self.folder_stack.append(children)
  46
  47     def end_folder(self, f, level):
  48         del self.folder_stack[-1]
  49
  50     def bookmark(self, b, level):
  51         dict = {}
  52         comment = getattr(b, 'comment')
  53         if comment: dict["annos"] = make_annos(comment)
  54         charset = getattr(b, 'charset')
  55         if charset: dict["charset"] = charset
  56         dict["dateAdded"] = b.add_date
  57         dict["id"] = b.id
  58         index = getattr(b, 'index')
  59         if index: dict["index"] = index
  60         dict["lastModified"] = b.last_modified
  61         dict["parent"] = b.parent_idx
  62         dict["title"] = b.name.decode('utf-8')
  63         dict["type"] = "text/x-moz-place"
  64         dict["uri"] = b.href
  65         self.folder_stack[-1].append(dict)
  66
  67     def ruler(self, r, level):
  68         dict = {}
  69         comment = getattr(r, 'comment')
  70         if comment: dict["annos"] = make_annos(comment)
  71         dict["dateAdded"] = r.add_date
  72         dict["id"] = r.id
  73         dict["index"] = r.index
  74         dict["lastModified"] = r.last_modified
  75         dict["parent"] = r.parent_idx
  76         dict["title"] = r.name.decode('utf-8')
  77         dict["type"] = "text/x-moz-place-separator"
  78         self.folder_stack[-1].append(dict)
  79
  80     def store(self, root_folder):
  81         root_folder.walk_depth(self)
  82
  83         outfile = open(self.filename, 'wb')
  84         json.dump(self.dict, outfile)
  85         outfile.close()
  86         del self.dict
  87
  88
  89     def load(self):
  90         infile = open(self.filename, 'rb')
  91         bkmk_s = infile.read()
  92         infile.close()
  93
  94         # Work around a bug in Mozilla - remove the trailing comma
  95         bkmk_s = bkmk_s.strip().replace(',]', ']')
  96         bookmarks_dict = json.loads(bkmk_s)
  97
  98         root_folder = Folder()
  99         root_folder.header = ''
 100         self.folder_stack = [root_folder]
 101         self.current_folder = root_folder
 102
 103         self.load_folder(root_folder, bookmarks_dict)
 104         if self.folder_stack:
 105             raise RuntimeError('Excessive folder stack: %s' % self.folder_stack)
 106
 107         return root_folder
 108
 109     def load_folder(self, folder, _dict):
 110         if _dict["type"] != "text/x-moz-place-container":
 111             raise ValueError("Root object is not a Mozilla container")
 112
 113         folder.id = _dict["id"]
 114         folder.index = _dict.get("index")
 115         folder.parent_idx = _dict.get("parent")
 116
 117         folder.name = encode(_dict["title"])
 118         folder.comment = ''
 119         folder.add_date = _dict["dateAdded"]
 120         folder.last_modified = _dict["lastModified"]
 121
 122         for record in _dict["children"]:
 123             if record["type"] == "text/x-moz-place-container":
 124                 folder = Folder(
 125                     add_date=record["dateAdded"],
 126                     comment=get_comment(record.get("annos")),
 127                     last_modified=record["lastModified"])
 128                 folder.id = record["id"]
 129                 folder.parent_idx = record["parent"]
 130                 folder.name = encode(record["title"])
 131                 self.current_folder.append(folder)
 132                 self.folder_stack.append(folder)
 133                 self.current_folder = folder
 134                 self.load_folder(folder, record)
 135
 136             elif record["type"] == "text/x-moz-place":
 137                 bookmark = Bookmark(
 138                     href=record["uri"],
 139                     add_date=record.get("dateAdded"),
 140                     last_modified=record.get("lastModified"),
 141                     comment=get_comment(record.get("annos")),
 142                     charset=record.get("charset"))
 143                 bookmark.id = record["id"]
 144                 bookmark.index = record.get("index")
 145                 bookmark.parent_idx = record["parent"]
 146                 bookmark.name = encode(record["title"])
 147                 self.current_folder.append(bookmark)
 148
 149             elif record["type"] == "text/x-moz-place-separator":
 150                 ruler = Ruler()
 151                 ruler.add_date = record["dateAdded"]
 152                 ruler.id = record["id"]
 153                 ruler.index = record["index"]
 154                 ruler.last_modified = record["lastModified"]
 155                 ruler.parent_idx = record["parent"]
 156                 ruler.name = encode(record["title"])
 157                 ruler.comment = get_comment(record.get("annos"))
 158                 self.current_folder.append(ruler)
 159
 160             else:
 161                 raise ValueError('Unknown record type "%s"' % record["type"])
 162
 163         del self.folder_stack[-1]
 164         if self.folder_stack:
 165             self.current_folder = self.folder_stack[-1]
 166         else:
 167             self.current_folder = None
 168
 169 def encode(title):
 170     return title.encode("UTF-8", "xmlcharrefreplace")
 171
 172 def get_comment(annos):
 173     if not annos:
 174         return None
 175
 176     for a in annos:
 177         if a["name"] == "bookmarkProperties/description" and \
 178                 a["type"] == 3:
 179             return a["value"].encode('utf-8')
 180
 181     return None
 182
 183 def make_annos(comment):
 184     return [{
 185         "expires": 4,
 186         "flags": 0,
 187         "mimeType": None,
 188         "name": "bookmarkProperties/description",
 189         "type": 3,
 190         "value": comment.decode('utf-8')}]