commit b6033f573408e8af4d5d26a63f14401b1614d226 Author: teor <teor2345@gmail.com> Date: Sun Dec 24 12:50:42 2017 +1100 Add a delimiter to the end of each fallback entry This helps external parsers. Also, add comments indicating where to add new fields in the fallback format. Part of 24725. --- changes/ticket24725 | 1 + scripts/maint/updateFallbackDirs.py | 22 ++++++++++++++++++++++ 2 files changed, 23 insertions(+) diff --git a/changes/ticket24725 b/changes/ticket24725 index 2fe1848ab..9db7ef8b1 100644 --- a/changes/ticket24725 +++ b/changes/ticket24725 @@ -1,4 +1,5 @@ o Minor features (fallback directory mirrors): - Add a type and version header to the fallback directory mirror file. + Also add a delimiter to the end of each fallback entry. This helps external parsers like stem and Relay Search. Implements ticket 24725. diff --git a/scripts/maint/updateFallbackDirs.py b/scripts/maint/updateFallbackDirs.py index 52ae886bd..30c63a5b8 100755 --- a/scripts/maint/updateFallbackDirs.py +++ b/scripts/maint/updateFallbackDirs.py @@ -76,6 +76,8 @@ except ImportError: # * patch changes include changing header comments or other unstructured # content FALLBACK_FORMAT_VERSION = '2.0.0' +SECTION_SEPARATOR_BASE = '=====' +SECTION_SEPARATOR_COMMENT = '/* ' + SECTION_SEPARATOR_BASE + ' */' # Output all candidate fallbacks, or only output selected fallbacks? OUTPUT_CANDIDATES = False @@ -1339,9 +1341,13 @@ class Candidate(object): # comment-out the returned string def fallbackdir_info(self, dl_speed_ok): # "address:dirport orport=port id=fingerprint" + # (insert additional madatory fields here) # "[ipv6=addr:orport]" + # (insert additional optional fields here) # /* nickname=name */ # /* extrainfo={0,1} */ + # (insert additional comment fields here) + # /* ===== */ # , # # Do we want a C string, or a commented-out string? @@ -1363,9 +1369,11 @@ class Candidate(object): self.orport, cleanse_c_string(self._fpr)) s += '\n' + # (insert additional madatory fields here) if self.has_ipv6(): s += '" ipv6=%s:%d"'%(cleanse_c_string(self.ipv6addr), self.ipv6orport) s += '\n' + # (insert additional optional fields here) if not comment_string: s += '/* ' s += 'nickname=%s'%(cleanse_c_string(self._data['nickname'])) @@ -1380,6 +1388,14 @@ class Candidate(object): if not comment_string: s += ' */' s += '\n' + # (insert additional comment fields here) + # The terminator and comma must be the last line in each fallback entry + if not comment_string: + s += '/* ' + s += SECTION_SEPARATOR_BASE + if not comment_string: + s += ' */' + s += '\n' s += ',' if comment_string: s += '\n' @@ -2205,6 +2221,9 @@ def list_fallbacks(whitelist, blacklist): print "/* type=fallback */" print ("/* version={} */" .format(cleanse_c_multiline_comment(FALLBACK_FORMAT_VERSION))) + # end the header with a separator, to make it easier for parsers + print SECTION_SEPARATOR_COMMENT + logging.warning('Downloading and parsing Onionoo data. ' + 'This may take some time.') # find relays that could be fallbacks @@ -2296,6 +2315,9 @@ def list_fallbacks(whitelist, blacklist): for s in fetch_source_list(): print describe_fetch_source(s) + # start the list with a separator, to make it easy for parsers + print SECTION_SEPARATOR_COMMENT + # sort the list differently depending on why we've created it: # if we're outputting the final fallback list, sort by fingerprint # this makes diffs much more stable