1 """Objects to represent bookmarks.html structure
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) 2000-2011 PhiloSoft Design"
11 __license__ = "GNU GPL"
13 __all__ = ['Folder', 'Bookmark', 'Ruler', 'Walker', 'Writer', 'Robot',
14 'InverseLinker', 'Linear', 'make_linear', 'make_tree', 'break_tree',
15 'quote_title', 'unquote_title',
21 BKMK_FORMAT = os.environ.get("BKMK_FORMAT", "MOZILLA")
27 def __init__(self, add_date=None, comment='', last_modified=None):
28 super(Folder, self).__init__()
29 self.comment = comment
30 self.add_date = add_date
31 self.last_modified = last_modified
33 def walk_depth(self, walker, level=0):
34 if hasattr(self, "header"): # root folder
36 walker.root_folder(self)
38 prune = walker.prune_folder(self)
40 walker.start_folder(self, level)
45 object.walk_depth(walker, level+1)
46 elif object.isBookmark:
47 walker.bookmark(object, level)
49 walker.ruler(object, level)
51 walker.end_folder(self, level)
58 def __init__(self, href, add_date, last_visit=None, last_modified=None,
59 keyword=None, comment='', icon_href=None, icon=None, charset=None):
60 if isinstance(href, str):
62 href = href.decode('idna')
63 except UnicodeDecodeError: # Non-ascii href
64 href = href.decode('utf-8')
65 elif not isinstance(href, unicode):
66 raise TypeError("Bookmark's href must be str or unicode, not %r" % type(href))
68 self.add_date = add_date
69 self.last_visit = last_visit
70 self.last_modified = last_modified
71 self.keyword = keyword
72 self.comment = comment
73 self.icon_href = icon_href
75 self.charset = charset
85 Interface class. Any instance that will be passed to Folder.walk_depth
86 may be derived from this class. It is not mandatory - unlike Java
87 Python does not require interface classes; but it is convenient to have
88 some methods predefined to no-op, in case you do not want to
89 provide end_folder etc.
92 def root_folder(self, r):
95 def start_folder(self, f, level):
98 def end_folder(self, f, level):
101 def bookmark(self, b, level):
104 def ruler(self, r, level):
107 def prune_folder(self, folder):
111 class Writer(Walker):
112 def __init__(self, outfile, prune=None):
113 self.outfile = outfile
116 def prune_folder(self, folder):
117 return self.prune == folder.name
121 def __init__(self, log):
125 pass # Nothing to do on cleanup
128 # Helper class to make inverese links (nodes linked to their parent)
129 class InverseLinker(Walker):
130 def root_folder(self, r):
131 self.parent_stack = [r]
133 def start_folder(self, f, level):
134 f.parent = self.parent_stack[-1]
135 self.parent_stack.append(f) # Push the folder onto the stack of parents
137 def end_folder(self, f, level):
138 del self.parent_stack[-1] # Pop off the stack
140 def bookmark(self, b, level):
141 b.parent = self.parent_stack[-1]
143 def ruler(self, r, level):
144 r.parent = self.parent_stack[-1]
147 # Helper class to make linear represenatation of the tree
148 class Linear(Walker):
149 def root_folder(self, r):
151 self.linear = r.linear
153 def add_object(self, object):
154 self.linear.append(object)
156 def start_folder(self, f, level):
159 def bookmark(self, b, level):
162 def ruler(self, r, level):
166 # Helper - make linked linear represenatation of the tree, suitable to be stored in sequential storage
167 def make_linear(root_folder):
168 linker = InverseLinker()
169 root_folder.walk_depth(linker)
172 root_folder.walk_depth(linear)
175 # Helper, opposite of make_linear - make a tree from the linked linear representation
176 def make_tree(linear):
177 root_folder = linear[0]
180 for object in linear:
181 object.parent.append(object)
185 def break_tree(linear):
188 for object in linear:
192 def quote_title(title):
193 if BKMK_FORMAT == "MOZILLA":
194 title = title.replace("'", "'")
197 def unquote_title(title):
198 if BKMK_FORMAT == "MOZILLA":
199 from HTMLParser import HTMLParser
200 title = HTMLParser().unescape(title.replace("&", '&'))
201 title = title.replace("'", "'")