naming.py 30 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673
  1. """
  2. Name Server and helper functions.
  3. Pyro - Python Remote Objects. Copyright by Irmen de Jong (irmen@razorvine.net).
  4. """
  5. import warnings
  6. import random
  7. import re
  8. import logging
  9. import socket
  10. import sys
  11. import time
  12. from Pyro4.threadutil import RLock, Thread
  13. from Pyro4.errors import NamingError, PyroError, ProtocolError
  14. from Pyro4 import core, socketutil
  15. import Pyro4.constants
  16. __all__ = ["locateNS", "resolve", "type_meta", "startNS", "startNSloop", "MemoryStorage"]
  17. if sys.version_info >= (3, 0):
  18. basestring = str
  19. log = logging.getLogger("Pyro4.naming")
  20. class MemoryStorage(dict):
  21. """
  22. Storage implementation that is just an in-memory dict.
  23. (because it inherits from dict it is automatically a collections.MutableMapping)
  24. Stopping the nameserver will make the server instantly forget about everything.
  25. """
  26. def __init__(self, **kwargs):
  27. super(MemoryStorage, self).__init__(**kwargs)
  28. def __setitem__(self, key, value):
  29. uri, metadata = value
  30. super(MemoryStorage, self).__setitem__(key, (uri, metadata or frozenset()))
  31. def optimized_prefix_list(self, prefix, return_metadata=False):
  32. return None
  33. def optimized_regex_list(self, regex, return_metadata=False):
  34. return None
  35. def optimized_metadata_search(self, metadata_all=None, metadata_any=None, return_metadata=False):
  36. return None
  37. def everything(self, return_metadata=False):
  38. if return_metadata:
  39. return self.copy()
  40. return {name: uri for name, (uri, metadata) in self.items()}
  41. def remove_items(self, items):
  42. for item in items:
  43. try:
  44. del self[item]
  45. except KeyError:
  46. pass
  47. def close(self):
  48. pass
  49. @Pyro4.expose
  50. class NameServer(object):
  51. """
  52. Pyro name server. Provides a simple flat name space to map logical object names to Pyro URIs.
  53. Default storage is done in an in-memory dictionary. You can provide custom storage types.
  54. """
  55. def __init__(self, storageProvider=None):
  56. self.storage = storageProvider
  57. if storageProvider is None:
  58. self.storage = MemoryStorage()
  59. log.debug("using volatile in-memory dict storage")
  60. self.lock = RLock()
  61. def count(self):
  62. return len(self.storage)
  63. def lookup(self, name, return_metadata=False):
  64. """
  65. Lookup the given name, returns an URI if found.
  66. Returns tuple (uri, metadata) if return_metadata is True.
  67. """
  68. try:
  69. uri, metadata = self.storage[name]
  70. uri = core.URI(uri)
  71. if return_metadata:
  72. metadata = list(metadata) if metadata else []
  73. return uri, metadata
  74. return uri
  75. except KeyError:
  76. raise NamingError("unknown name: " + name)
  77. def register(self, name, uri, safe=False, metadata=None):
  78. """Register a name with an URI. If safe is true, name cannot be registered twice.
  79. The uri can be a string or an URI object. Metadata must be None, or a collection of strings."""
  80. if isinstance(uri, core.URI):
  81. uri = uri.asString()
  82. elif not isinstance(uri, basestring):
  83. raise TypeError("only URIs or strings can be registered")
  84. else:
  85. core.URI(uri) # check if uri is valid
  86. if not isinstance(name, basestring):
  87. raise TypeError("name must be a str")
  88. if isinstance(metadata, basestring):
  89. raise TypeError("metadata should not be a str, but another iterable (set, list, etc)")
  90. metadata and iter(metadata) # validate that metadata is iterable
  91. with self.lock:
  92. if safe and name in self.storage:
  93. raise NamingError("name already registered: " + name)
  94. if metadata:
  95. metadata = set(metadata)
  96. self.storage[name] = uri, metadata
  97. def set_metadata(self, name, metadata):
  98. """update the metadata for an existing registration"""
  99. if not isinstance(name, basestring):
  100. raise TypeError("name must be a str")
  101. if isinstance(metadata, basestring):
  102. raise TypeError("metadata should not be a str, but another iterable (set, list, etc)")
  103. metadata and iter(metadata) # validate that metadata is iterable
  104. with self.lock:
  105. try:
  106. uri, old_meta = self.storage[name]
  107. if metadata:
  108. metadata = set(metadata)
  109. self.storage[name] = uri, metadata
  110. except KeyError:
  111. raise NamingError("unknown name: " + name)
  112. def remove(self, name=None, prefix=None, regex=None):
  113. """Remove a registration. returns the number of items removed."""
  114. if name and name in self.storage and name != Pyro4.constants.NAMESERVER_NAME:
  115. with self.lock:
  116. del self.storage[name]
  117. return 1
  118. if prefix:
  119. items = list(self.list(prefix=prefix).keys())
  120. if Pyro4.constants.NAMESERVER_NAME in items:
  121. items.remove(Pyro4.constants.NAMESERVER_NAME)
  122. self.storage.remove_items(items)
  123. return len(items)
  124. if regex:
  125. items = list(self.list(regex=regex).keys())
  126. if Pyro4.constants.NAMESERVER_NAME in items:
  127. items.remove(Pyro4.constants.NAMESERVER_NAME)
  128. self.storage.remove_items(items)
  129. return len(items)
  130. return 0
  131. # noinspection PyNoneFunctionAssignment
  132. def list(self, prefix=None, regex=None, metadata_all=None, metadata_any=None, return_metadata=False):
  133. """Retrieve the registered items as a dictionary name-to-URI. The URIs
  134. in the resulting dict are strings, not URI objects.
  135. You can filter by prefix or by regex or by metadata subset (separately)"""
  136. def fix_set(result):
  137. # for python 2 compatibility we cannot send sets to the default (serpent) serializer.
  138. # that's why we will convert them to lists here.
  139. if return_metadata:
  140. fixed = {}
  141. for name, data in result.items():
  142. fixed[name] = (data[0], list(data[1]))
  143. return fixed
  144. return result
  145. if sum(1 for x in [prefix, regex, metadata_all, metadata_any] if x is not None) > 1:
  146. raise ValueError("you can only filter on one thing at a time")
  147. with self.lock:
  148. if prefix:
  149. result = self.storage.optimized_prefix_list(prefix, return_metadata)
  150. if result is not None:
  151. return fix_set(result)
  152. result = {}
  153. for name in self.storage:
  154. if name.startswith(prefix):
  155. result[name] = self.storage[name] if return_metadata else self.storage[name][0]
  156. return fix_set(result)
  157. elif regex:
  158. result = self.storage.optimized_regex_list(regex, return_metadata)
  159. if result is not None:
  160. return fix_set(result)
  161. result = {}
  162. try:
  163. regex = re.compile(regex)
  164. except re.error:
  165. x = sys.exc_info()[1]
  166. raise NamingError("invalid regex: " + str(x))
  167. else:
  168. for name in self.storage:
  169. if regex.match(name):
  170. result[name] = self.storage[name] if return_metadata else self.storage[name][0]
  171. return fix_set(result)
  172. elif metadata_all:
  173. # return the entries which have all of the given metadata as (a subset of) their metadata
  174. if isinstance(metadata_all, basestring):
  175. raise TypeError("metadata_all should not be a str, but another iterable (set, list, etc)")
  176. metadata_all and iter(metadata_all) # validate that metadata is iterable
  177. result = self.storage.optimized_metadata_search(metadata_all=metadata_all, return_metadata=return_metadata)
  178. if result is not None:
  179. return fix_set(result)
  180. metadata_all = frozenset(metadata_all)
  181. result = {}
  182. for name, (uri, meta) in self.storage.everything(return_metadata=True).items():
  183. if metadata_all.issubset(meta):
  184. result[name] = (uri, meta) if return_metadata else uri
  185. return fix_set(result)
  186. elif metadata_any:
  187. # return the entries which have any of the given metadata as part of their metadata
  188. if isinstance(metadata_any, basestring):
  189. raise TypeError("metadata_any should not be a str, but another iterable (set, list, etc)")
  190. metadata_any and iter(metadata_any) # validate that metadata is iterable
  191. result = self.storage.optimized_metadata_search(metadata_any=metadata_any, return_metadata=return_metadata)
  192. if result is not None:
  193. return fix_set(result)
  194. metadata_any = frozenset(metadata_any)
  195. result = {}
  196. for name, (uri, meta) in self.storage.everything(return_metadata=True).items():
  197. if metadata_any & meta:
  198. result[name] = (uri, meta) if return_metadata else uri
  199. return fix_set(result)
  200. else:
  201. # just return (a copy of) everything
  202. return fix_set(self.storage.everything(return_metadata))
  203. def ping(self):
  204. """A simple test method to check if the name server is running correctly."""
  205. pass
  206. class NameServerDaemon(core.Daemon):
  207. """Daemon that contains the Name Server."""
  208. def __init__(self, host=None, port=None, unixsocket=None, nathost=None, natport=None, storage=None):
  209. if host is None:
  210. host = Pyro4.config.HOST
  211. if port is None:
  212. port = Pyro4.config.NS_PORT
  213. if nathost is None:
  214. nathost = Pyro4.config.NATHOST
  215. if natport is None:
  216. natport = Pyro4.config.NATPORT or None
  217. storage = storage or "memory"
  218. if storage == "memory":
  219. log.debug("using volatile in-memory dict storage")
  220. self.nameserver = NameServer(MemoryStorage())
  221. elif storage.startswith("dbm:") and len(storage) > 4:
  222. dbmfile = storage[4:]
  223. log.debug("using persistent dbm storage in file %s", dbmfile)
  224. from Pyro4.naming_storage import DbmStorage
  225. self.nameserver = NameServer(DbmStorage(dbmfile))
  226. warning = "Warning: the DbmStorage doesn't support metadata."
  227. log.warning(warning)
  228. print(warning)
  229. elif storage.startswith("sql:") and len(storage) > 4:
  230. sqlfile = storage[4:]
  231. log.debug("using persistent sql storage in file %s", sqlfile)
  232. from Pyro4.naming_storage import SqlStorage
  233. self.nameserver = NameServer(SqlStorage(sqlfile))
  234. else:
  235. raise ValueError("invalid storage type '%s'" % storage)
  236. existing_count = self.nameserver.count()
  237. if existing_count > 0:
  238. log.debug("number of existing entries in storage: %d", existing_count)
  239. super(NameServerDaemon, self).__init__(host, port, unixsocket, nathost=nathost, natport=natport)
  240. self.register(self.nameserver, Pyro4.constants.NAMESERVER_NAME)
  241. metadata = {"class:Pyro4.naming.NameServer"}
  242. self.nameserver.register(Pyro4.constants.NAMESERVER_NAME, self.uriFor(self.nameserver), metadata=metadata)
  243. if Pyro4.config.NS_AUTOCLEAN > 0:
  244. if not AutoCleaner.override_autoclean_min and Pyro4.config.NS_AUTOCLEAN < AutoCleaner.min_autoclean_value:
  245. raise ValueError("NS_AUTOCLEAN cannot be smaller than " + str(AutoCleaner.min_autoclean_value))
  246. log.debug("autoclean enabled")
  247. self.cleaner_thread = AutoCleaner(self.nameserver)
  248. self.cleaner_thread.start()
  249. else:
  250. log.debug("autoclean not enabled")
  251. self.cleaner_thread = None
  252. log.info("nameserver daemon created")
  253. def close(self):
  254. super(NameServerDaemon, self).close()
  255. if self.nameserver is not None:
  256. self.nameserver.storage.close()
  257. self.nameserver = None
  258. if self.cleaner_thread:
  259. self.cleaner_thread.stop = True
  260. self.cleaner_thread.join()
  261. self.cleaner_thread = None
  262. def __enter__(self):
  263. if not self.nameserver:
  264. raise PyroError("cannot reuse this object")
  265. return self
  266. def __exit__(self, exc_type, exc_value, traceback):
  267. if self.nameserver is not None:
  268. self.nameserver.storage.close()
  269. self.nameserver = None
  270. if self.cleaner_thread:
  271. self.cleaner_thread.stop = True
  272. self.cleaner_thread.join()
  273. self.cleaner_thread = None
  274. return super(NameServerDaemon, self).__exit__(exc_type, exc_value, traceback)
  275. def handleRequest(self, conn):
  276. try:
  277. return super(NameServerDaemon, self).handleRequest(conn)
  278. except ProtocolError as x:
  279. # Notify the user that a protocol error occurred.
  280. # This is useful for instance when a wrong serializer is used, it helps
  281. # a lot to immediately see what is going wrong.
  282. warnings.warn("Pyro protocol error occurred: " + str(x))
  283. raise
  284. class AutoCleaner(Thread):
  285. """
  286. Takes care of checking every registration in the name server.
  287. If it cannot be contacted anymore, it will be removed after ~20 seconds.
  288. """
  289. min_autoclean_value = 3
  290. max_unreachable_time = 20.0
  291. loop_delay = 2.0
  292. override_autoclean_min = False # only for unit test purposes
  293. def __init__(self, nameserver):
  294. assert Pyro4.config.NS_AUTOCLEAN > 0
  295. if not self.override_autoclean_min and Pyro4.config.NS_AUTOCLEAN < self.min_autoclean_value:
  296. raise ValueError("NS_AUTOCLEAN cannot be smaller than "+str(self.min_autoclean_value))
  297. super(AutoCleaner, self).__init__()
  298. self.nameserver = nameserver
  299. self.stop = False
  300. self.daemon = True
  301. self.last_cleaned = time.time()
  302. self.unreachable = {} # name->since when
  303. def run(self):
  304. while not self.stop:
  305. time.sleep(self.loop_delay)
  306. time_since_last_autoclean = time.time() - self.last_cleaned
  307. if time_since_last_autoclean < Pyro4.config.NS_AUTOCLEAN:
  308. continue
  309. for name, uri in self.nameserver.list().items():
  310. if name in (Pyro4.constants.DAEMON_NAME, Pyro4.constants.NAMESERVER_NAME):
  311. continue
  312. try:
  313. uri_obj = Pyro4.URI(uri)
  314. timeout = Pyro4.config.COMMTIMEOUT or 5
  315. sock = socketutil.createSocket(connect=(uri_obj.host, uri_obj.port), timeout=timeout)
  316. sock.close()
  317. # if we get here, the listed server is still answering on its port
  318. if name in self.unreachable:
  319. del self.unreachable[name]
  320. except socket.error:
  321. if name not in self.unreachable:
  322. self.unreachable[name] = time.time()
  323. if time.time() - self.unreachable[name] >= self.max_unreachable_time:
  324. log.info("autoclean: unregistering %s; cannot connect uri %s for %d sec", name, uri, self.max_unreachable_time)
  325. self.nameserver.remove(name)
  326. del self.unreachable[name]
  327. continue
  328. self.last_cleaned = time.time()
  329. if self.unreachable:
  330. log.debug("autoclean: %d/%d names currently unreachable", len(self.unreachable), self.nameserver.count())
  331. class BroadcastServer(object):
  332. REQUEST_NSURI = b"GET_NSURI"
  333. class TransportServerAdapter(object):
  334. # this adapter is used to be able to pass the BroadcastServer to Daemon.combine() to integrate the event loops.
  335. def __init__(self, bcserver):
  336. self.sockets = [bcserver]
  337. def events(self, eventobjects):
  338. for bc in eventobjects:
  339. bc.processRequest()
  340. def __init__(self, nsUri, bchost=None, bcport=None):
  341. self.transportServer = self.TransportServerAdapter(self)
  342. self.nsUri = nsUri
  343. if bcport is None:
  344. bcport = Pyro4.config.NS_BCPORT
  345. if bchost is None:
  346. bchost = Pyro4.config.NS_BCHOST
  347. if ":" in nsUri.host: # ipv6
  348. bchost = bchost or "::"
  349. self.sock = Pyro4.socketutil.createBroadcastSocket((bchost, bcport, 0, 0), reuseaddr=Pyro4.config.SOCK_REUSE, timeout=2.0)
  350. else:
  351. self.sock = Pyro4.socketutil.createBroadcastSocket((bchost, bcport), reuseaddr=Pyro4.config.SOCK_REUSE, timeout=2.0)
  352. self._sockaddr = self.sock.getsockname()
  353. bchost = bchost or self._sockaddr[0]
  354. bcport = bcport or self._sockaddr[1]
  355. if ":" in bchost: # ipv6
  356. self.locationStr = "[%s]:%d" % (bchost, bcport)
  357. else:
  358. self.locationStr = "%s:%d" % (bchost, bcport)
  359. log.info("ns broadcast server created on %s", self.locationStr)
  360. self.running = True
  361. def close(self):
  362. log.debug("ns broadcast server closing")
  363. self.running = False
  364. try:
  365. self.sock.shutdown(socket.SHUT_RDWR)
  366. except (OSError, socket.error):
  367. pass
  368. self.sock.close()
  369. def getPort(self):
  370. return self.sock.getsockname()[1]
  371. def fileno(self):
  372. return self.sock.fileno()
  373. def runInThread(self):
  374. """Run the broadcast server loop in its own thread."""
  375. thread = Thread(target=self.__requestLoop)
  376. thread.setDaemon(True)
  377. thread.start()
  378. log.debug("broadcast server loop running in own thread")
  379. return thread
  380. def __requestLoop(self):
  381. while self.running:
  382. self.processRequest()
  383. log.debug("broadcast server loop terminating")
  384. def processRequest(self):
  385. try:
  386. data, addr = self.sock.recvfrom(100)
  387. if data == self.REQUEST_NSURI:
  388. responsedata = core.URI(self.nsUri)
  389. if responsedata.host == "0.0.0.0":
  390. # replace INADDR_ANY address by the interface IP address that connects to the requesting client
  391. try:
  392. interface_ip = socketutil.getInterfaceAddress(addr[0])
  393. responsedata.host = interface_ip
  394. except socket.error:
  395. pass
  396. log.debug("responding to broadcast request from %s: interface %s", addr[0], responsedata.host)
  397. responsedata = str(responsedata).encode("iso-8859-1")
  398. self.sock.sendto(responsedata, 0, addr)
  399. except socket.error:
  400. pass
  401. except SystemError:
  402. if sys.platform == "cli" and not self.running:
  403. # ironpython throws these systemerrors when shutting down... we can ignore them.
  404. pass
  405. else:
  406. raise
  407. def __enter__(self):
  408. return self
  409. def __exit__(self, exc_type, exc_value, traceback):
  410. self.close()
  411. def startNSloop(host=None, port=None, enableBroadcast=True, bchost=None, bcport=None, unixsocket=None, nathost=None, natport=None, storage=None, hmac=None):
  412. """utility function that starts a new Name server and enters its requestloop."""
  413. daemon = NameServerDaemon(host, port, unixsocket, nathost=nathost, natport=natport, storage=storage)
  414. daemon._pyroHmacKey = hmac
  415. nsUri = daemon.uriFor(daemon.nameserver)
  416. internalUri = daemon.uriFor(daemon.nameserver, nat=False)
  417. bcserver = None
  418. if unixsocket:
  419. hostip = "Unix domain socket"
  420. else:
  421. hostip = daemon.sock.getsockname()[0]
  422. if hostip.startswith("127."):
  423. print("Not starting broadcast server for localhost.")
  424. log.info("Not starting NS broadcast server because NS is bound to localhost")
  425. enableBroadcast = False
  426. if enableBroadcast:
  427. # Make sure to pass the internal uri to the broadcast responder.
  428. # It is almost always useless to let it return the external uri,
  429. # because external systems won't be able to talk to this thing anyway.
  430. bcserver = BroadcastServer(internalUri, bchost, bcport)
  431. print("Broadcast server running on %s" % bcserver.locationStr)
  432. bcserver.runInThread()
  433. existing = daemon.nameserver.count()
  434. if existing > 1: # don't count our own nameserver registration
  435. print("Persistent store contains %d existing registrations." % existing)
  436. print("NS running on %s (%s)" % (daemon.locationStr, hostip))
  437. if not hmac:
  438. print("Warning: HMAC key not set. Anyone can connect to this server!")
  439. if daemon.natLocationStr:
  440. print("internal URI = %s" % internalUri)
  441. print("external URI = %s" % nsUri)
  442. else:
  443. print("URI = %s" % nsUri)
  444. try:
  445. daemon.requestLoop()
  446. finally:
  447. daemon.close()
  448. if bcserver is not None:
  449. bcserver.close()
  450. print("NS shut down.")
  451. def startNS(host=None, port=None, enableBroadcast=True, bchost=None, bcport=None, unixsocket=None, nathost=None, natport=None, storage=None, hmac=None):
  452. """utility fuction to quickly get a Name server daemon to be used in your own event loops.
  453. Returns (nameserverUri, nameserverDaemon, broadcastServer)."""
  454. daemon = NameServerDaemon(host, port, unixsocket, nathost=nathost, natport=natport, storage=storage)
  455. daemon._pyroHmacKey = hmac
  456. bcserver = None
  457. nsUri = daemon.uriFor(daemon.nameserver)
  458. if not unixsocket:
  459. hostip = daemon.sock.getsockname()[0]
  460. if hostip.startswith("127."):
  461. # not starting broadcast server for localhost.
  462. enableBroadcast = False
  463. if enableBroadcast:
  464. internalUri = daemon.uriFor(daemon.nameserver, nat=False)
  465. bcserver = BroadcastServer(internalUri, bchost, bcport)
  466. return nsUri, daemon, bcserver
  467. def locateNS(host=None, port=None, broadcast=True, hmac_key=None):
  468. """Get a proxy for a name server somewhere in the network."""
  469. if host is None:
  470. # first try localhost if we have a good chance of finding it there
  471. if Pyro4.config.NS_HOST in ("localhost", "::1") or Pyro4.config.NS_HOST.startswith("127."):
  472. if ":" in Pyro4.config.NS_HOST: # ipv6
  473. hosts = ["[%s]" % Pyro4.config.NS_HOST]
  474. else:
  475. # Some systems (Debian Linux) have 127.0.1.1 in the hosts file assigned to the hostname,
  476. # try this too for convenience sake (only if it's actually used as a valid ip address)
  477. try:
  478. socket.gethostbyaddr("127.0.1.1")
  479. hosts = [Pyro4.config.NS_HOST] if Pyro4.config.NS_HOST == "127.0.1.1" else [Pyro4.config.NS_HOST, "127.0.1.1"]
  480. except socket.error:
  481. hosts = [Pyro4.config.NS_HOST]
  482. for host in hosts:
  483. uristring = "PYRO:%s@%s:%d" % (Pyro4.constants.NAMESERVER_NAME, host, port or Pyro4.config.NS_PORT)
  484. log.debug("locating the NS: %s", uristring)
  485. proxy = core.Proxy(uristring)
  486. proxy._pyroHmacKey = hmac_key
  487. try:
  488. proxy._pyroBind()
  489. log.debug("located NS")
  490. return proxy
  491. except PyroError:
  492. pass
  493. if broadcast:
  494. # broadcast lookup
  495. if not port:
  496. port = Pyro4.config.NS_BCPORT
  497. log.debug("broadcast locate")
  498. sock = Pyro4.socketutil.createBroadcastSocket(reuseaddr=Pyro4.config.SOCK_REUSE, timeout=0.7)
  499. for _ in range(3):
  500. try:
  501. for bcaddr in Pyro4.config.parseAddressesString(Pyro4.config.BROADCAST_ADDRS):
  502. try:
  503. sock.sendto(BroadcastServer.REQUEST_NSURI, 0, (bcaddr, port))
  504. except socket.error:
  505. x = sys.exc_info()[1]
  506. err = getattr(x, "errno", x.args[0])
  507. # handle some errno's that some platforms like to throw:
  508. if err not in Pyro4.socketutil.ERRNO_EADDRNOTAVAIL and err not in Pyro4.socketutil.ERRNO_EADDRINUSE:
  509. raise
  510. data, _ = sock.recvfrom(100)
  511. sock.close()
  512. if sys.version_info >= (3, 0):
  513. data = data.decode("iso-8859-1")
  514. log.debug("located NS: %s", data)
  515. proxy = core.Proxy(data)
  516. proxy._pyroHmacKey = hmac_key
  517. return proxy
  518. except socket.timeout:
  519. continue
  520. try:
  521. sock.shutdown(socket.SHUT_RDWR)
  522. except (OSError, socket.error):
  523. pass
  524. sock.close()
  525. log.debug("broadcast locate failed, try direct connection on NS_HOST")
  526. else:
  527. log.debug("skipping broadcast lookup")
  528. # broadcast failed or skipped, try PYRO directly on specific host
  529. host = Pyro4.config.NS_HOST
  530. port = Pyro4.config.NS_PORT
  531. # pyro direct lookup
  532. if not port:
  533. port = Pyro4.config.NS_PORT
  534. if core.URI.isUnixsockLocation(host):
  535. uristring = "PYRO:%s@%s" % (Pyro4.constants.NAMESERVER_NAME, host)
  536. else:
  537. # if not a unix socket, check for ipv6
  538. if ":" in host:
  539. host = "[%s]" % host
  540. uristring = "PYRO:%s@%s:%d" % (Pyro4.constants.NAMESERVER_NAME, host, port)
  541. uri = core.URI(uristring)
  542. log.debug("locating the NS: %s", uri)
  543. proxy = core.Proxy(uri)
  544. proxy._pyroHmacKey = hmac_key
  545. try:
  546. proxy._pyroBind()
  547. log.debug("located NS")
  548. return proxy
  549. except PyroError as x:
  550. e = NamingError("Failed to locate the nameserver")
  551. if sys.version_info >= (3, 0):
  552. e.__cause__ = x
  553. raise e
  554. def resolve(uri, hmac_key=None):
  555. """
  556. Resolve a 'magic' uri (PYRONAME, PYROMETA) into the direct PYRO uri.
  557. It finds a name server, and use that to resolve a PYRONAME uri into the direct PYRO uri pointing to the named object.
  558. If uri is already a PYRO uri, it is returned unmodified.
  559. You can consider this a shortcut function so that you don't have to locate and use a name server proxy yourself.
  560. Note: if you need to resolve more than a few names, consider using the name server directly instead of repeatedly
  561. calling this function, to avoid the name server lookup overhead from each call.
  562. """
  563. if isinstance(uri, basestring):
  564. uri = core.URI(uri)
  565. elif not isinstance(uri, core.URI):
  566. raise TypeError("can only resolve Pyro URIs")
  567. if uri.protocol == "PYRO":
  568. return uri
  569. log.debug("resolving %s", uri)
  570. if uri.protocol == "PYRONAME":
  571. with locateNS(uri.host, uri.port, hmac_key=hmac_key) as nameserver:
  572. return nameserver.lookup(uri.object)
  573. elif uri.protocol == "PYROMETA":
  574. with locateNS(uri.host, uri.port, hmac_key=hmac_key) as nameserver:
  575. candidates = nameserver.list(metadata_all=uri.object)
  576. if candidates:
  577. candidate = random.choice(list(candidates.values()))
  578. log.debug("resolved to candidate %s", candidate)
  579. return core.URI(candidate)
  580. raise NamingError("no registrations available with desired metadata properties %s" % uri.object)
  581. else:
  582. raise PyroError("invalid uri protocol")
  583. def type_meta(class_or_object, prefix="class:"):
  584. """extracts type metadata from the given class or object, can be used as Name server metadata."""
  585. if hasattr(class_or_object, "__mro__"):
  586. return {prefix+c.__module__+"."+c.__name__ for c in class_or_object.__mro__ if c.__module__ not in ("builtins", "__builtin__")}
  587. if hasattr(class_or_object, "__class__"):
  588. return type_meta(class_or_object.__class__)
  589. return frozenset()
  590. def main(args=None):
  591. from optparse import OptionParser
  592. parser = OptionParser()
  593. parser.add_option("-n", "--host", dest="host", help="hostname to bind server on")
  594. parser.add_option("-p", "--port", dest="port", type="int", help="port to bind server on (0=random)")
  595. parser.add_option("-u", "--unixsocket", help="Unix domain socket name to bind server on")
  596. parser.add_option("-s", "--storage", help="Storage system to use (memory, dbm:file, sql:file)", default="memory")
  597. parser.add_option("", "--bchost", dest="bchost", help="hostname to bind broadcast server on (default is \"\")")
  598. parser.add_option("", "--bcport", dest="bcport", type="int",
  599. help="port to bind broadcast server on (0=random)")
  600. parser.add_option("", "--nathost", dest="nathost", help="external hostname in case of NAT")
  601. parser.add_option("", "--natport", dest="natport", type="int", help="external port in case of NAT")
  602. parser.add_option("-x", "--nobc", dest="enablebc", action="store_false", default=True,
  603. help="don't start a broadcast server")
  604. parser.add_option("-k", "--key", help="the HMAC key to use")
  605. options, args = parser.parse_args(args)
  606. startNSloop(options.host, options.port, enableBroadcast=options.enablebc,
  607. bchost=options.bchost, bcport=options.bcport, unixsocket=options.unixsocket,
  608. nathost=options.nathost, natport=options.natport, storage=options.storage,
  609. hmac=options.key)
  610. if __name__ == "__main__":
  611. main()