AnnounceLocal plugin

plugins/AnnounceLocal/AnnounceLocalPlugin.py

@@ -0,0 +1,138 @@
+import time
+
+import gevent
+
+from Plugin import PluginManager
+from Config import config
+import BroadcastServer
+
+
+@PluginManager.registerTo("Site")
+class SitePlugin(object):
+    def announce(self, force=False, mode="start", *args, **kwargs):
+        local_announcer = self.connection_server.local_announcer
+
+        if force or time.time() - local_announcer.last_discover > 5 * 50:
+            local_announcer.discover(force=force)
+
+        return super(SitePlugin, self).announce(force=force, mode=mode, *args, **kwargs)
+
+class LocalAnnouncer(BroadcastServer.BroadcastServer):
+    def __init__(self, server, listen_port):
+        super(LocalAnnouncer, self).__init__("zeronet", listen_port=listen_port)
+        self.server = server
+
+        self.sender_info["peer_id"] = self.server.peer_id
+        self.sender_info["port"] = self.server.port
+        self.sender_info["broadcast_port"] = listen_port
+        self.sender_info["rev"] = config.rev
+
+        self.known_peers = {}
+        self.last_discover = 0
+
+    def discover(self, force=False):
+        self.log.debug("Sending discover request (force: %s)" % force)
+        if force:  # Probably new site added, clean cache
+            self.known_peers = {}
+
+        for peer_id, known_peer in self.known_peers.items():
+            if time.time() - known_peer["found"] > 10 * 60:
+                del(self.known_peers[peer_id])
+                self.log.debug("Timeout, removing from known_peers: %s" % peer_id)
+        self.broadcast({"cmd": "discoverRequest", "params": {}}, port=self.listen_port)
+        self.last_discover = time.time()
+
+    def actionDiscoverRequest(self, sender, params):
+        back = {
+            "cmd": "discoverResponse",
+            "params": {
+                "sites_changed": self.server.site_manager.sites_changed
+            }
+        }
+
+        if sender["peer_id"] not in self.known_peers:
+            self.log.debug("Got discover request from unknown peer %s, time to refresh known peers" % sender["ip"])
+            self.discover()
+
+        return back
+
+    def actionDiscoverResponse(self, sender, params):
+        if sender["peer_id"] in self.known_peers:
+            self.known_peers[sender["peer_id"]]["found"] = time.time()
+        if params["sites_changed"] != self.known_peers.get(sender["peer_id"], {}).get("sites_changed"):
+            # Peer's site list changed, request the list of new sites
+            return {"cmd": "siteListRequest"}
+        else:
+            # Peer's site list is the same
+            for site in self.server.sites.values():
+                peer = site.peers.get("%s:%s" % (sender["ip"], sender["port"]))
+                if peer:
+                    peer.found("local")
+
+    def actionSiteListRequest(self, sender, params):
+        back = []
+        sites = self.server.sites.values()
+
+        # Split adresses to group of 100 to avoid UDP size limit
+        site_groups = [sites[i:i + 100] for i in range(0, len(sites), 100)]
+        for site_group in site_groups:
+            res = {}
+            res["sites_changed"] = self.server.site_manager.sites_changed
+            res["sites"] = [site.address_hash for site in site_group]
+            back.append({"cmd": "siteListResponse", "params": res})
+        return back
+
+    def actionSiteListResponse(self, sender, params):
+        s = time.time()
+        peer_sites = set(params["sites"])
+        num_found = 0
+        added_sites = []
+        for site in self.server.sites.values():
+            if site.address_hash in peer_sites:
+                added = site.addPeer(sender["ip"], sender["port"], source="local")
+                num_found += 1
+                if added:
+                    site.worker_manager.onPeers()
+                    site.updateWebsocket(peers_added=1)
+                    added_sites.append(site)
+
+        # Save sites changed value to avoid unnecessary site list download
+        if sender["peer_id"] not in self.known_peers:
+            self.known_peers[sender["peer_id"]] = {"added": time.time()}
+
+        self.known_peers[sender["peer_id"]]["sites_changed"] = params["sites_changed"]
+        self.known_peers[sender["peer_id"]]["updated"] = time.time()
+        self.known_peers[sender["peer_id"]]["found"] = time.time()
+
+        self.log.debug("Discover from %s response parsed in %.3fs, found: %s added: %s of %s" % (sender["ip"], time.time() - s, num_found, added_sites, len(peer_sites)))
+
+
+@PluginManager.registerTo("FileServer")
+class FileServerPlugin(object):
+    def __init__(self, *args, **kwargs):
+        res = super(FileServerPlugin, self).__init__(*args, **kwargs)
+        if config.broadcast_port and config.tor != "always" and not config.disable_udp:
+            self.local_announcer = LocalAnnouncer(self, config.broadcast_port)
+        else:
+            self.local_announcer = None
+        return res
+
+    def start(self, *args, **kwargs):
+        if self.local_announcer:
+            gevent.spawn(self.local_announcer.start)
+        return super(FileServerPlugin, self).start(*args, **kwargs)
+
+    def stop(self):
+        if self.local_announcer:
+            self.local_announcer.stop()
+        res = super(FileServerPlugin, self).stop()
+        return res
+
+
+@PluginManager.registerTo("ConfigPlugin")
+class ConfigPlugin(object):
+    def createArguments(self):
+        group = self.parser.add_argument_group("AnnounceLocal plugin")
+        group.add_argument('--broadcast_port', help='UDP broadcasting port for local peer discovery', default=1544, type=int)
+
+        return super(ConfigPlugin, self).createArguments()