src/allmydata/node.py

   1 from base64 import b32encode
   2
   3 import os.path, re
   4
   5 import twisted
   6 from twisted.python import log
   7 from twisted.application import service
   8 from twisted.internet import defer, reactor
   9 from foolscap import Tub, eventual
  10 from allmydata.util import iputil, observer
  11 from allmydata.util.assertutil import precondition
  12
  13
  14 # Just to get their versions:
  15 import allmydata
  16 import zfec
  17 import foolscap
  18
  19 # group 1 will be addr (dotted quad string), group 3 if any will be portnum (string)
  20 ADDR_RE=re.compile("^([1-9][0-9]*\.[1-9][0-9]*\.[1-9][0-9]*\.[1-9][0-9]*)(:([1-9][0-9]*))?$")
  21
  22 class Node(service.MultiService):
  23     # this implements common functionality of both Client nodes, Introducer
  24     # nodes, and Vdrive nodes
  25     NODETYPE = "unknown NODETYPE"
  26     PORTNUMFILE = None
  27     CERTFILE = "node.pem"
  28     LOCAL_IP_FILE = "advertised_ip_addresses"
  29     NODEIDFILE = "my_nodeid"
  30
  31     def __init__(self, basedir="."):
  32         service.MultiService.__init__(self)
  33         self.basedir = os.path.abspath(basedir)
  34         self._tub_ready_observerlist = observer.OneShotObserverList()
  35         certfile = os.path.join(self.basedir, self.CERTFILE)
  36         self.tub = Tub(certFile=certfile)
  37         self.tub.setOption("logLocalFailures", True)
  38         self.tub.setOption("logRemoteFailures", True)
  39         self.nodeid = b32encode(self.tub.tubID).lower()
  40         f = open(os.path.join(self.basedir, self.NODEIDFILE), "w")
  41         f.write(b32encode(self.nodeid).lower() + "\n")
  42         f.close()
  43         self.short_nodeid = self.tub.tubID[:4] # ready for printing
  44         assert self.PORTNUMFILE, "Your node.Node subclass must provide PORTNUMFILE"
  45         self._portnumfile = os.path.join(self.basedir, self.PORTNUMFILE)
  46         try:
  47             portnum = int(open(self._portnumfile, "rU").read())
  48         except (EnvironmentError, ValueError):
  49             portnum = 0
  50         self.tub.listenOn("tcp:%d" % portnum)
  51         # we must wait until our service has started before we can find out
  52         # our IP address and thus do tub.setLocation, and we can't register
  53         # any services with the Tub until after that point
  54         self.tub.setServiceParent(self)
  55
  56         AUTHKEYSFILEBASE = "authorized_keys."
  57         for f in os.listdir(self.basedir):
  58             if f.startswith(AUTHKEYSFILEBASE):
  59                 keyfile = os.path.join(self.basedir, f)
  60                 portnum = int(f[len(AUTHKEYSFILEBASE):])
  61                 from allmydata import manhole
  62                 m = manhole.AuthorizedKeysManhole(portnum, keyfile)
  63                 m.setServiceParent(self)
  64                 self.log("AuthorizedKeysManhole listening on %d" % portnum)
  65
  66         self.log("Node constructed.  tahoe version: %s, foolscap: %s,"
  67                  " twisted: %s, zfec: %s"
  68                  % (allmydata.__version__, foolscap.__version__,
  69                     twisted.__version__, zfec.__version__,))
  70
  71     def get_versions(self):
  72         return {'allmydata': allmydata.__version__,
  73                 'foolscap': foolscap.__version__,
  74                 'twisted': twisted.__version__,
  75                 'zfec': zfec.__version__,
  76                 }
  77
  78     def startService(self):
  79         # note: this class can only be started and stopped once.
  80         self.log("Node.startService")
  81         eventual.eventually(self._startService)
  82
  83     def _startService(self):
  84         precondition(reactor.running)
  85         self.log("Node._startService")
  86
  87         service.MultiService.startService(self)
  88         d = defer.succeed(None)
  89         d.addCallback(lambda res: iputil.get_local_addresses_async())
  90         d.addCallback(self._setup_tub)
  91         d.addCallback(lambda res: self.tub_ready())
  92         def _ready(res):
  93             self.log("%s running" % self.NODETYPE)
  94             self._tub_ready_observerlist.fire(self)
  95             return self
  96         d.addCallback(_ready)
  97         def _die(failure):
  98             self.log('_startService() failed')
  99             log.err(failure)
 100             #reactor.stop() # for unknown reasons, reactor.stop() isn't working.  [ ] TODO
 101             self.log('calling os.abort()')
 102             os.abort()
 103         d.addErrback(_die)
 104
 105     def stopService(self):
 106         self.log("Node.stopService")
 107         d = self._tub_ready_observerlist.when_fired()
 108         def _really_stopService(ignored):
 109             self.log("Node._really_stopService")
 110             return service.MultiService.stopService(self)
 111         d.addCallback(_really_stopService)
 112         return d
 113
 114     def shutdown(self):
 115         """Shut down the node. Returns a Deferred that fires (with None) when
 116         it finally stops kicking."""
 117         self.log("Node.shutdown")
 118         return self.stopService()
 119
 120     def log(self, msg):
 121         log.msg(self.short_nodeid + ": " + msg)
 122
 123     def _setup_tub(self, local_addresses):
 124         # we can't get a dynamically-assigned portnum until our Tub is
 125         # running, which means after startService.
 126         l = self.tub.getListeners()[0]
 127         portnum = l.getPortnum()
 128         # record which port we're listening on, so we can grab the same one next time
 129         open(self._portnumfile, "w").write("%d\n" % portnum)
 130
 131         local_addresses = [ "%s:%d" % (addr, portnum,) for addr in local_addresses ]
 132
 133         addresses = []
 134         try:
 135             for addrline in open(os.path.join(self.basedir, self.LOCAL_IP_FILE), "rU"):
 136                 mo = ADDR_RE.search(addrline)
 137                 if mo:
 138                     (addr, dummy, aportnum,) = mo.groups()
 139                     if aportnum is None:
 140                         aportnum = portnum
 141                     addresses.append("%s:%d" % (addr, int(aportnum),))
 142         except EnvironmentError:
 143             pass
 144
 145         addresses.extend(local_addresses)
 146
 147         location = ",".join(addresses)
 148         self.log("Tub location set to %s" % location)
 149         self.tub.setLocation(location)
 150         return self.tub
 151
 152     def tub_ready(self):
 153         # called when the Tub is available for registerReference
 154         pass
 155
 156     def when_tub_ready(self):
 157         return self._tub_ready_observerlist.when_fired()
 158
 159     def add_service(self, s):
 160         s.setServiceParent(self)
 161         return s
 162