Browse Source

Add a nickname to each fallback in a C comment

This makes it easier for operators to find their relays, and allows stem to
use nicknames to identify fallbacks.

Implements ticket 24600.
teor 6 years ago
parent
commit
561f18e724
2 changed files with 12 additions and 0 deletions
  1. 5 0
      changes/ticket24600
  2. 7 0
      scripts/maint/updateFallbackDirs.py

+ 5 - 0
changes/ticket24600

@@ -0,0 +1,5 @@
+  o Minor features (fallback directory mirrors):
+    - Add a nickname to each fallback in a C comment. This makes it easier for
+      operators to find their relays, and allows stem to use nicknames to
+      identify fallbacks.
+      Implements ticket 24600.

+ 7 - 0
scripts/maint/updateFallbackDirs.py

@@ -1331,6 +1331,7 @@ class Candidate(object):
   def fallbackdir_info(self, dl_speed_ok):
     # "address:dirport orport=port id=fingerprint"
     # "[ipv6=addr:orport]"
+    # /* nickname=name */
     # ,
     #
     # Do we want a C string, or a commented-out string?
@@ -1355,6 +1356,12 @@ class Candidate(object):
     if self.has_ipv6():
       s += '" ipv6=%s:%d"'%(cleanse_c_string(self.ipv6addr), self.ipv6orport)
       s += '\n'
+    if not comment_string:
+      s += '/* '
+    s += 'nickname=%s'%(cleanse_c_string(self._data['nickname']))
+    if not comment_string:
+      s += ' */'
+    s += '\n'
     s += ','
     if comment_string:
       s += '\n'