1 """Objects to represent bookmarks.html structure
3 This file is a part of Bookmarks database and Internet robot.
7 __author__ = "Oleg Broytman <phd@phdru.name>"
8 __copyright__ = "Copyright (C) 2000-2012 PhiloSoft Design"
9 __license__ = "GNU GPL"
11 __all__ = ['Folder', 'Bookmark', 'Ruler', 'Walker', 'Writer', 'Robot',
12 'InverseLinker', 'Linear', 'make_linear', 'make_tree', 'break_tree',
13 'quote_title', 'unquote_title',
19 BKMK_FORMAT = os.environ.get("BKMK_FORMAT", "MOZILLA")
25 def __init__(self, add_date=None, comment='', last_modified=None):
26 super(Folder, self).__init__()
27 self.comment = comment
28 self.add_date = add_date
29 self.last_modified = last_modified
31 def walk_depth(self, walker, level=0):
32 if hasattr(self, "header"): # root folder
34 walker.root_folder(self)
36 prune = walker.prune_folder(self)
38 walker.start_folder(self, level)
43 object.walk_depth(walker, level+1)
44 elif object.isBookmark:
45 walker.bookmark(object, level)
47 walker.ruler(object, level)
49 walker.end_folder(self, level)
56 def __init__(self, href, add_date, last_visit=None, last_modified=None,
57 keyword=None, comment='', icon_href=None, icon=None,
58 charset=None, parser_charset=None):
59 protocol, request = urllib.splittype(href)
60 user, password, port = None, None, None
61 host, path = urllib.splithost(request)
63 user, host = urllib.splituser(host)
65 user, password = urllib.splitpasswd(user)
66 host, port = urllib.splitport(host)
67 if port: port = int(port)
69 if protocol == 'place':
72 href = protocol + "://"
74 href += urllib.quote(user)
76 href += ':' + urllib.quote(password)
79 href += host.decode(parser_charset or 'utf-8').encode('idna')
86 self.add_date = add_date
87 self.last_visit = last_visit
88 self.last_modified = last_modified
89 self.keyword = keyword
90 self.comment = comment
91 self.icon_href = icon_href
93 self.charset = charset
103 Interface class. Any instance that will be passed to Folder.walk_depth
104 may be derived from this class. It is not mandatory - unlike Java
105 Python does not require interface classes; but it is convenient to have
106 some methods predefined to no-op, in case you do not want to
107 provide end_folder etc.
110 def root_folder(self, r):
113 def start_folder(self, f, level):
116 def end_folder(self, f, level):
119 def bookmark(self, b, level):
122 def ruler(self, r, level):
125 def prune_folder(self, folder):
129 class Writer(Walker):
130 def __init__(self, outfile, prune=None):
131 self.outfile = outfile
134 def prune_folder(self, folder):
135 return self.prune == folder.name
139 def __init__(self, log):
143 pass # Nothing to do on cleanup
146 # Helper class to make inverese links (nodes linked to their parent)
147 class InverseLinker(Walker):
148 def root_folder(self, r):
149 self.parent_stack = [r]
151 def start_folder(self, f, level):
152 f.parent = self.parent_stack[-1]
153 self.parent_stack.append(f) # Push the folder onto the stack of parents
155 def end_folder(self, f, level):
156 del self.parent_stack[-1] # Pop off the stack
158 def bookmark(self, b, level):
159 b.parent = self.parent_stack[-1]
161 def ruler(self, r, level):
162 r.parent = self.parent_stack[-1]
165 # Helper class to make linear represenatation of the tree
166 class Linear(Walker):
167 def root_folder(self, r):
169 self.linear = r.linear
171 def add_object(self, object):
172 self.linear.append(object)
174 def start_folder(self, f, level):
177 def bookmark(self, b, level):
180 def ruler(self, r, level):
184 # Helper - make linked linear represenatation of the tree, suitable to be stored in sequential storage
185 def make_linear(root_folder):
186 linker = InverseLinker()
187 root_folder.walk_depth(linker)
190 root_folder.walk_depth(linear)
193 # Helper, opposite of make_linear - make a tree from the linked linear representation
194 def make_tree(linear):
195 root_folder = linear[0]
198 for object in linear:
199 object.parent.append(object)
203 def break_tree(linear):
206 for object in linear:
210 def quote_title(title):
211 if BKMK_FORMAT == "MOZILLA":
212 title = title.replace("'", "'")
215 def unquote_title(title):
216 if BKMK_FORMAT == "MOZILLA":
217 from HTMLParser import HTMLParser
218 title = HTMLParser().unescape(title.replace("&", '&').decode('utf-8'))
219 title = title.encode('utf-8').replace("'", "'")