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-2023 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', 'parse_params', 'set_params',
20 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)
54 class Bookmark(object):
58 def __init__(self, href, add_date, last_visit=None, last_modified=None,
59 keyword=None, comment='', icon_href=None, icon=None,
60 charset=None, parser_charset=None):
61 protocol, request = urllib.splittype(href)
62 user, password, port = None, None, None
63 host, path = urllib.splithost(request)
65 user, host = urllib.splituser(host)
67 user, password = urllib.splitpasswd(user)
68 host, port = urllib.splitport(host)
69 if port: port = int(port)
71 if protocol == 'place':
74 href = protocol + "://"
76 href += urllib.quote(user)
78 href += ':' + urllib.quote(password)
81 href += host.decode(parser_charset or 'utf-8').encode('idna')
88 self.add_date = add_date
89 self.last_visit = last_visit
90 self.last_modified = last_modified
91 self.keyword = keyword
92 self.comment = comment
93 self.icon_href = icon_href
95 self.charset = charset
103 class Walker(object):
105 Interface class. Any instance that will be passed to Folder.walk_depth
106 may be derived from this class. It is not mandatory - unlike Java
107 Python does not require interface classes; but it is convenient to have
108 some methods predefined to no-op, in case you do not want to
109 provide end_folder etc.
112 def root_folder(self, r):
115 def start_folder(self, f, level):
118 def end_folder(self, f, level):
121 def bookmark(self, b, level):
124 def ruler(self, r, level):
127 def prune_folder(self, folder):
131 class Writer(Walker):
132 def __init__(self, outfile, prune=None):
133 self.outfile = outfile
136 def prune_folder(self, folder):
137 return self.prune == folder.name
141 def __init__(self, log):
145 pass # Nothing to do on cleanup
148 # Helper class to make inverese links (nodes linked to their parent)
149 class InverseLinker(Walker):
150 def root_folder(self, r):
151 self.parent_stack = [r]
153 def start_folder(self, f, level):
154 f.parent = self.parent_stack[-1]
155 self.parent_stack.append(f) # Push the folder onto the stack of parents
157 def end_folder(self, f, level):
158 del self.parent_stack[-1] # Pop off the stack
160 def bookmark(self, b, level):
161 b.parent = self.parent_stack[-1]
163 def ruler(self, r, level):
164 r.parent = self.parent_stack[-1]
167 # Helper class to make linear represenatation of the tree
168 class Linear(Walker):
169 def root_folder(self, r):
171 self.linear = r.linear
173 def add_object(self, object):
174 self.linear.append(object)
176 def start_folder(self, f, level):
179 def bookmark(self, b, level):
182 def ruler(self, r, level):
186 # Helper - make linked linear represenatation of the tree, suitable to be stored in sequential storage
187 def make_linear(root_folder):
188 linker = InverseLinker()
189 root_folder.walk_depth(linker)
192 root_folder.walk_depth(linear)
195 # Helper, opposite of make_linear - make a tree from the linked linear representation
196 def make_tree(linear):
197 root_folder = linear[0]
200 for object in linear:
201 object.parent.append(object)
206 def break_tree(linear):
209 for object in linear:
213 def quote_title(title):
214 if BKMK_FORMAT == "MOZILLA":
215 title = title.replace("'", "'")
219 def unquote_title(title):
220 if BKMK_FORMAT == "MOZILLA":
221 from HTMLParser import HTMLParser
222 title = HTMLParser().unescape(title.replace("&", '&').decode('utf-8'))
223 title = title.encode('utf-8').replace("'", "'")
227 def parse_params(param_str):
228 params = param_str.split(':')
229 main_param = params.pop(0)
232 key, value = param.split('=', 1)
233 param_list[key] = value
234 return main_param, param_list
237 def set_params(obj, params):
238 if hasattr(params, "items"):
239 params = params.items()
240 for key, value in params:
241 setattr(obj, key, value)