source download plumbed in
[hippotat] / hippotatd
CommitLineData
094ee3a2 1#!/usr/bin/python3
3fba9787 2
5a37bac8 3from hippotatlib import *
aa663282 4
e2d41dc1 5import os
4a780703
IJ
6import tempfile
7import atexit
8import shutil
e2d41dc1 9
e2d41dc1 10import twisted.internet
e2d41dc1 11from twisted.web.server import NOT_DONE_YET
e2d41dc1 12
99e6411f
IJ
13import twisted.web.static
14
4a780703
IJ
15import hippotatlib.ownsource
16from hippotatlib.ownsource import SourceShipmentPreparer
17
5da7763e
IJ
18#import twisted.web.server import Site
19#from twisted.web.resource import Resource
3fba9787 20
c4b6d990
IJ
21import syslog
22
4a780703
IJ
23cleanups = [ ]
24
b0cfbfce 25clients = { }
3fba9787 26
5da7763e
IJ
27#---------- "router" ----------
28
a8827d59 29def route(packet, iface, saddr, daddr):
d579a048 30 def lt(dest):
8c3b6620 31 log_debug(DBG.ROUTE, 'route: %s -> %s: %s' % (saddr,daddr,dest), d=packet)
84e763c7 32 try: dclient = clients[daddr]
5da7763e
IJ
33 except KeyError: dclient = None
34 if dclient is not None:
d579a048 35 lt('client')
5da7763e 36 dclient.queue_outbound(packet)
8d374606 37 elif daddr == c.vaddr or daddr not in c.vnetwork:
d579a048 38 lt('inbound')
909e0ff3 39 queue_inbound(ipif, packet)
74934d63 40 elif daddr == c.relay:
d579a048 41 lt('discard relay')
a8827d59 42 log_discard(packet, iface, saddr, daddr, 'relay')
5da7763e 43 else:
d579a048 44 lt('discard no-client')
a8827d59 45 log_discard(packet, iface, saddr, daddr, 'no-client')
5da7763e 46
5da7763e 47#---------- client ----------
c4b6d990 48
ec88b1f1 49class Client():
8d374606 50 def __init__(self, ip, cc):
ec88b1f1
IJ
51 # instance data members
52 self._ip = ip
8d374606 53 self.cc = cc
0ac316c8 54 self._rq = collections.deque() # requests
74934d63 55 self._pq = PacketQueue(str(ip), self.cc.max_queue_time)
88487243 56
8d374606 57 if ip not in c.vnetwork:
c7f134ce 58 raise ValueError('client %s not in vnetwork' % ip)
88487243 59
88487243
IJ
60 if ip in clients:
61 raise ValueError('multiple client cfg sections for %s' % ip)
62 clients[ip] = self
63
8c3b6620
IJ
64 self._log(DBG.INIT, 'new')
65
b68c0739
IJ
66 def _log(self, dflag, msg, **kwargs):
67 log_debug(dflag, ('client %s: ' % self._ip)+msg, **kwargs)
d579a048 68
88487243 69 def process_arriving_data(self, d):
e8fcf3b7 70 self._log(DBG.FLOW, "req data (enc'd)", d=d)
8718b02c 71 if not len(d): return
88487243
IJ
72 for packet in slip.decode(d):
73 (saddr, daddr) = packet_addrs(packet)
74 if saddr != self._ip:
75 raise ValueError('wrong source address %s' % saddr)
a8827d59 76 route(packet, self._ip, saddr, daddr)
88487243
IJ
77
78 def _req_cancel(self, request):
8718b02c 79 self._log(DBG.HTTP_CTRL, 'cancel', idof=request)
88487243
IJ
80 request.finish()
81
82 def _req_error(self, err, request):
8718b02c 83 self._log(DBG.HTTP_CTRL, 'error %s' % err, idof=request)
88487243
IJ
84 self._req_cancel(request)
85
86 def queue_outbound(self, packet):
87 self._pq.append(packet)
ca732796 88 self._check_outbound()
88487243 89
7432045d
IJ
90 def _req_fin(self, dummy, request, cl):
91 self._log(DBG.HTTP_CTRL, '_req_fin ' + repr(dummy), idof=request)
92 try: cl.cancel()
93 except twisted.internet.error.AlreadyCalled: pass
94
d579a048 95 def new_request(self, request):
88487243 96 request.setHeader('Content-Type','application/octet-stream')
74934d63 97 cl = reactor.callLater(self.cc.http_timeout, self._req_cancel, request)
7432045d
IJ
98 nf = request.notifyFinish()
99 nf.addErrback(self._req_error, request)
100 nf.addCallback(self._req_fin, request, cl)
88487243
IJ
101 self._rq.append(request)
102 self._check_outbound()
103
3d003cdd
IJ
104 def _req_write(self, req, d):
105 self._log(DBG.HTTP, 'req_write ', idof=req, d=d)
106 req.write(d)
107
88487243 108 def _check_outbound(self):
8718b02c 109 log_debug(DBG.HTTP_CTRL, 'CHKO')
88487243
IJ
110 while True:
111 try: request = self._rq[0]
112 except IndexError: request = None
113 if request and request.finished:
8c3b6620 114 self._log(DBG.HTTP_CTRL, 'CHKO req finished, discard', idof=request)
88487243
IJ
115 self._rq.popleft()
116 continue
117
118 if not self._pq.nonempty():
119 # no packets, oh well
8c3b6620 120 self._log(DBG.HTTP_CTRL, 'CHKO no packets, OUT-DONE', idof=request)
d579a048 121 break
88487243
IJ
122
123 if request is None:
124 # no request
8c3b6620 125 self._log(DBG.HTTP_CTRL, 'CHKO no request, OUT-DONE', idof=request)
88487243
IJ
126 break
127
8c3b6620 128 self._log(DBG.HTTP_CTRL, 'CHKO processing', idof=request)
88487243 129 # request, and also some non-expired packets
7b07f0b5 130 self._pq.process((lambda: request.sentLength),
3d003cdd 131 (lambda d: self._req_write(request, d)),
74934d63 132 self.cc.max_batch_down)
0ac316c8 133
88487243 134 assert(request.sentLength)
84e763c7 135 self._rq.popleft()
88487243 136 request.finish()
8c3b6620 137 self._log(DBG.HTTP, 'complete', idof=request)
88487243 138 # round again, looking for more to do
0ac316c8 139
74934d63 140 while len(self._rq) > self.cc.target_requests_outstanding:
88487243 141 request = self._rq.popleft()
8c3b6620 142 self._log(DBG.HTTP, 'CHKO above target, returning empty', idof=request)
88487243 143 request.finish()
650a3251 144
d579a048 145def process_request(request, desca):
a4e03162 146 # find client, update config, etc.
5dd3275b 147 metadata = request.args[b'm'][0]
00192d6a 148 metadata = metadata.split(b'\r\n')
ba5630fd
IJ
149 (ci_s, pw, tro, cto) = metadata[0:4]
150 desca['m[0,2:3]'] = [ci_s, tro, cto]
a9a369c7 151 ci_s = ci_s.decode('utf-8')
ba5630fd
IJ
152 tro = int(tro); desca['tro']= tro
153 cto = int(cto); desca['cto']= cto
a4e03162 154 ci = ipaddr(ci_s)
d579a048 155 desca['ci'] = ci
a4e03162 156 cl = clients[ci]
74934d63 157 if pw != cl.cc.password: raise ValueError('bad password')
b68c0739 158 desca['pwok']=True
1672ded0 159
74934d63
IJ
160 if tro != cl.cc.target_requests_outstanding:
161 raise ValueError('tro must be %d' % cl.cc.target_requests_outstanding)
5da7763e 162
74934d63
IJ
163 if cto < cl.cc.http_timeout:
164 raise ValueError('cto must be >= %d' % cl.cc.http_timeout)
ba5630fd 165
d579a048 166 try:
e8fcf3b7 167 d = request.args[b'd'][0]
d579a048 168 desca['d'] = d
19f5f9b5
IJ
169 desca['dlen'] = len(d)
170 except KeyError:
171 d = b''
172 desca['dlen'] = None
173
174 log_http(desca, 'processing', idof=id(request), d=d)
5da7763e 175
6f387df3
IJ
176 d = mime_translate(d)
177
a4e03162
IJ
178 cl.process_arriving_data(d)
179 cl.new_request(request)
5da7763e 180
19f5f9b5 181def log_http(desca, msg, **kwargs):
8c3b6620 182 try:
19f5f9b5 183 kwargs['d'] = desca['d']
8c3b6620
IJ
184 del desca['d']
185 except KeyError:
19f5f9b5
IJ
186 pass
187 log_debug(DBG.HTTP, msg + repr(desca), **kwargs)
8c3b6620 188
eb113b2c
IJ
189class NotStupidResource(twisted.web.resource.Resource):
190 # why this is not the default is a mystery!
191 def getChild(self, name, request):
192 if name == b'': return self
193 else: return twisted.web.resource.Resource.getChild(name, request)
194
195class IphttpResource(NotStupidResource):
a4e03162 196 def render_POST(self, request):
297b3ebf
IJ
197 log_debug(DBG.HTTP_FULL,
198 'req recv: ' + repr(request) + ' ' + repr(request.args),
199 idof=id(request))
d579a048
IJ
200 desca = {'d': None}
201 try: process_request(request, desca)
0d10f35f 202 except Exception as e:
68afd97b 203 emsg = traceback.format_exc()
6f387df3 204 log_http(desca, 'RETURNING EXCEPTION ' + emsg)
0d10f35f
IJ
205 request.setHeader('Content-Type','text/plain; charset="utf-8"')
206 request.setResponseCode(400)
a9a369c7 207 return (emsg + ' # ' + repr(desca) + '\r\n').encode('utf-8')
19f5f9b5 208 log_debug(DBG.HTTP_CTRL, '...', idof=id(request))
d579a048 209 return NOT_DONE_YET
84f2d011 210
8e279651 211 def render_GET(self, request):
d579a048 212 log_debug(DBG.HTTP, 'GET request')
99e6411f
IJ
213 return b'''
214<html><body>
215hippotat
216<p>
217<a href="source">source</a> available
218</body></html>
219'''
220
221class SourceResource(twisted.web.static.File):
4a780703
IJ
222 def __init__(self):
223 td = tempfile.mkdtemp()
224
225 def cleanup():
226 try: shutil.rmtree(td)
227 except FileNotFoundError: pass
228
229 cleanups.append(cleanup)
230
231 self._ssp = SourceShipmentPreparer(td)
232 self._ssp.logger = self.log
233 self._ssp.generate()
234
99e6411f
IJ
235 super().__init__(self._ssp.output_path)
236
4a780703
IJ
237 def log(self, m):
238 log_debug(DBG.OWNSOURCE, m)
239
5da7763e
IJ
240def start_http():
241 resource = IphttpResource()
de2b215e 242 resource.putChild(b'source',SourceResource())
b11c6e7a 243 site = twisted.web.server.Site(resource)
88487243
IJ
244 for sa in c.saddrs:
245 ep = sa.make_endpoint()
b11c6e7a 246 crash_on_defer(ep.listen(site))
d579a048 247 log_debug(DBG.INIT, 'listening on %s' % sa)
5da7763e
IJ
248
249#---------- config and setup ----------
4a780703 250
c7fb640e 251def process_cfg(putative_servers, putative_clients):
8d374606 252 global c
c7fb640e
IJ
253 c = ConfigResults()
254 c.server = cfg.get('SERVER','server')
255
8d374606
IJ
256 cfg_process_common(c, c.server)
257 cfg_process_saddrs(c, c.server)
258 cfg_process_vnetwork(c, c.server)
259 cfg_process_vaddr(c, c.server)
c7fb640e
IJ
260
261 for (ci,cs) in putative_clients.items():
262 cc = ConfigResults()
74934d63 263 sections = cfg_process_client_common(cc,c.server,cs,ci)
c7fb640e
IJ
264 if not sections: continue
265 cfg_process_client_limited(cc,c.server,sections, 'max_batch_down')
266 cfg_process_client_limited(cc,c.server,sections, 'max_queue_time')
74934d63 267 Client(ci, cc)
e75e9c17
IJ
268
269 try:
74934d63 270 c.vrelay = cfg.get(c.server, 'vrelay')
e2d41dc1 271 except NoOptionError:
8d374606
IJ
272 for search in c.vnetwork.hosts():
273 if search == c.vaddr: continue
74934d63 274 c.vrelay = search
e75e9c17 275 break
3fba9787 276
8d374606 277 cfg_process_ipif(c,
c7fb640e
IJ
278 [c.server, 'DEFAULT'],
279 (('local','vaddr'),
280 ('peer', 'vrelay'),
281 ('rnets','vnetwork')))
5bae5ba3 282
4a780703
IJ
283def catch_termination():
284 def run_cleanups():
285 for cleanup in cleanups:
286 cleanup()
287
288 atexit.register(run_cleanups)
289
290 def signal_handler(name, sig, *args):
291 signal.signal(sig, signal.SIG_DFL)
292 print('exiting due to %s' % name, file=sys.stderr)
293 run_cleanups()
294 os.kill(os.getpid(), sig)
295 raise RuntimeError('did not die due to signal %s !' % name)
296
297 for sig in (signal.SIGINT, signal.SIGTERM):
298 signal.signal(sig, partial(signal_handler, sig.name))
299
5510890e 300common_startup(process_cfg)
4a780703 301catch_termination()
909e0ff3 302ipif = start_ipif(c.ipif_command, (lambda p,s,d: route(p,"[ipif]",s,d)))
87a7c0c7 303start_http()
ae7c7784 304common_run()