+__author__ = "Oleg Broytman <phd@phdru.name>"
+__copyright__ = "Copyright (C) 2000-2023 PhiloSoft Design"
+__license__ = "GNU GPL"
+
+__all__ = ['Folder', 'Bookmark', 'Ruler', 'Walker', 'Writer', 'Robot',
+ 'InverseLinker', 'Linear', 'make_linear', 'make_tree', 'break_tree',
+ 'quote_title', 'unquote_title', 'parse_params', 'set_params',
+ ]
+
+
+import os
+try:
+ from urllib.parse import quote, \
+ splittype, splithost, splituser, splitpasswd, \
+ splitport
+except ImportError:
+ from urllib import quote, \
+ splittype, splithost, splituser, splitpasswd, \
+ splitport
+
+BKMK_FORMAT = os.environ.get("BKMK_FORMAT", "MOZILLA")
+
+
+class Folder(list):
+ isFolder = 1
+ isBookmark = 0
+
+ def __init__(self, add_date=None, comment='', last_modified=None):
+ super(Folder, self).__init__()
+ self.comment = comment
+ self.add_date = add_date
+ self.last_modified = last_modified
+
+ def walk_depth(self, walker, level=0):
+ if hasattr(self, "header"): # root folder
+ prune = 0
+ walker.root_folder(self)
+ else:
+ prune = walker.prune_folder(self)
+ if not prune:
+ walker.start_folder(self, level)
+
+ if not prune:
+ for object in self:
+ if object.isFolder:
+ object.walk_depth(walker, level+1)
+ elif object.isBookmark:
+ walker.bookmark(object, level)
+ else:
+ walker.ruler(object, level)
+
+ walker.end_folder(self, level)
+
+
+class Bookmark(object):
+ isFolder = 0
+ isBookmark = 1
+
+ def __init__(self, href, add_date, last_visit=None, last_modified=None,
+ keyword=None, comment='', icon_href=None, icon=None,
+ charset=None, parser_charset=None):
+ protocol, request = splittype(href)
+ user, password, port = None, None, None
+ host, path = splithost(request)
+ if host:
+ user, host = splituser(host)
+ if user:
+ user, password = splitpasswd(user)
+ host, port = splitport(host)
+ if port: port = int(port)
+
+ if protocol == 'place':
+ href = protocol + ":"
+ else:
+ href = protocol + "://"
+ if user:
+ href += quote(user)
+ if password:
+ href += ':' + quote(password)
+ href += '@'
+ if host:
+ href += host.decode(parser_charset or 'utf-8').encode('idna')
+ if port:
+ href += ':%d' % port
+ if path:
+ href += path
+
+ self.href = href
+ self.add_date = add_date
+ self.last_visit = last_visit
+ self.last_modified = last_modified
+ self.keyword = keyword
+ self.comment = comment
+ self.icon_href = icon_href
+ self.icon = icon
+ self.charset = charset
+
+
+class Ruler(object):
+ isFolder = 0
+ isBookmark = 0
+
+
+class Walker(object):
+ """
+ Interface class. Any instance that will be passed to Folder.walk_depth
+ may be derived from this class. It is not mandatory - unlike Java
+ Python does not require interface classes; but it is convenient to have
+ some methods predefined to no-op, in case you do not want to
+ provide end_folder etc.
+ """
+
+ def root_folder(self, r):
+ pass
+
+ def start_folder(self, f, level):
+ pass
+
+ def end_folder(self, f, level):
+ pass
+
+ def bookmark(self, b, level):
+ pass
+
+ def ruler(self, r, level):
+ pass
+
+ def prune_folder(self, folder):
+ return 0