chiark / gitweb /
~ian / hippotat.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
config: Some new options
[hippotat.git] / hippotatd
diff --git a/hippotatd b/hippotatd
index 49521683b250d503f2e61dddf34f4ef70843134a..1865dad819a7231b2b743ac071076ec2b0e2f5e6 100755 (executable)
--- a/hippotatd
+++ b/hippotatd
@@ -1,16 +1,44 @@
 #!/usr/bin/python3
 #!/usr/bin/python3
-
+#
+# Hippotat - Asinine IP Over HTTP program
+# ./hippotatd - server main program
+#
+# Copyright 2017 Ian Jackson
+#
+# AGPLv3+ + CAFv2+
+#
+#    This program is free software: you can redistribute it and/or
+#    modify it under the terms of the GNU Affero General Public
+#    License as published by the Free Software Foundation, either
+#    version 3 of the License, or (at your option) any later version,
+#    with the "CAF Login Exception" as published by Ian Jackson
+#    (version 2, or at your option any later version) as an Additional
+#    Permission.
+#
+#    This program is distributed in the hope that it will be useful,
+#    but WITHOUT ANY WARRANTY; without even the implied warranty of
+#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+#    Affero General Public License for more details.
+#
+#    You should have received a copy of the GNU Affero General Public
+#    License and the CAF Login Exception along with this program, in
+#    the file AGPLv3+CAFv2.  If not, email Ian Jackson
+#    <ijackson@chiark.greenend.org.uk>.
+
+#@ sys.path.append(@PYBUILD_INSTALL_DIR@)
 from hippotatlib import *
 
 import os
 import tempfile
 import atexit
 import shutil
 from hippotatlib import *
 
 import os
 import tempfile
 import atexit
 import shutil
+import subprocess
 
 import twisted.internet
 from twisted.web.server import NOT_DONE_YET
 
 import twisted.web.static
 
 import twisted.internet
 from twisted.web.server import NOT_DONE_YET
 
 import twisted.web.static
+import twisted.python.syslog
 
 import hippotatlib.ownsource
 from hippotatlib.ownsource import SourceShipmentPreparer
 
 import hippotatlib.ownsource
 from hippotatlib.ownsource import SourceShipmentPreparer
@@ -208,47 +236,65 @@ class IphttpResource(NotStupidResource):
     log_debug(DBG.HTTP_CTRL, '...', idof=id(request))
     return NOT_DONE_YET
 
     log_debug(DBG.HTTP_CTRL, '...', idof=id(request))
     return NOT_DONE_YET
 
-  def render_GET(self, request):
-    log_debug(DBG.HTTP, 'GET request')
-    return b'''
-<html><body>
-hippotat
-<p>
-<a href="source">source</a> available
-</body></html>
-'''
-
-class SourceResource(twisted.web.static.File):
+  # instantiator should set
+  # self.hippotat_sources = (source_names[0], source_names[1])
   def __init__(self):
   def __init__(self):
-    td = tempfile.mkdtemp()
-
-    def cleanup():
-      try: shutil.rmtree(td)
-      except FileNotFoundError: pass
-
-    cleanups.append(cleanup)
+    self.hippotat_sources = [None, None]
+    super().__init__()
 
 
-    self._ssp = SourceShipmentPreparer(td)
-    self._ssp.logger = self.log
-    self._ssp.generate()
-
-    super().__init__(self._ssp.output_path)
-
-  def log(self, m):
-    log_debug(DBG.OWNSOURCE, m)
+  def render_GET(self, request):
+    log_debug(DBG.HTTP, 'GET request')
+    s = '<html><body>hippotat\n'
+    (s0,s1) = self.hippotat_sources
+    if s0:
+      s += '<p><a href="%s">source</a>\n' % s0
+      if self.hippotat_sources[1]:
+        s += ('(and that of dependency <a href="%s">packages</a>)\n' % s1)
+      s += 'available'
+    else:
+      s += 'TESTING'
+    s += '</body></html>'
+    return s.encode('utf-8')
 
 def start_http():
   resource = IphttpResource()
 
 def start_http():
   resource = IphttpResource()
-  resource.putChild(b'source',SourceResource())
   site = twisted.web.server.Site(resource)
   site = twisted.web.server.Site(resource)
+
   for sa in c.saddrs:
     ep = sa.make_endpoint()
     crash_on_defer(ep.listen(site))
     log_debug(DBG.INIT, 'listening on %s' % sa)
 
   for sa in c.saddrs:
     ep = sa.make_endpoint()
     crash_on_defer(ep.listen(site))
     log_debug(DBG.INIT, 'listening on %s' % sa)
 
+  td = tempfile.mkdtemp()
+
+  def cleanup():
+    try: shutil.rmtree(td)
+    except FileNotFoundError: pass
+    
+  cleanups.append(cleanup)
+
+  ssp = SourceShipmentPreparer(td)
+  ssp.logger = partial(log_debug, DBG.OWNSOURCE)
+  if DBG.OWNSOURCE in debug_set: ssp.stream_debug = sys.stdout
+  ssp.download_packages = opts.ownsource >= 2
+  if opts.ownsource >= 1: ssp.generate()
+
+  for ix in (0,1):
+    bn = ssp.output_names[ix]
+    op = ssp.output_paths[ix]
+    if op is None: continue
+    resource.hippotat_sources[ix] = bn
+    subresource =twisted.web.static.File(op)
+    resource.putChild(bn.encode('utf-8'), subresource)
+
+  reactor.callLater(0.1, (lambda: log.info('hippotatd started', dflag=False)))
+
 #---------- config and setup ----------
 
 #---------- config and setup ----------
 
-def process_cfg(putative_servers, putative_clients):
+def process_cfg(_opts, putative_servers, putative_clients):
+  global opts
+  opts = _opts
+
   global c
   c = ConfigResults()
   c.server = cfg.get('SERVER','server')
   global c
   c = ConfigResults()
   c.server = cfg.get('SERVER','server')
@@ -280,6 +326,12 @@ def process_cfg(putative_servers, putative_clients):
                     ('peer', 'vrelay'),
                     ('rnets','vnetwork')))
 
                     ('peer', 'vrelay'),
                     ('rnets','vnetwork')))
 
+  if opts.printconfig is not None:
+    try: val = cfg.get(c.server, opts.printconfig)
+    except NoOptionError: pass
+    else: print(val)
+    sys.exit(0)
+
 def catch_termination():
   def run_cleanups():
     for cleanup in cleanups:
 def catch_termination():
   def run_cleanups():
     for cleanup in cleanups:
@@ -297,8 +349,120 @@ def catch_termination():
   for sig in (signal.SIGINT, signal.SIGTERM):
     signal.signal(sig, partial(signal_handler, sig.name))
 
   for sig in (signal.SIGINT, signal.SIGTERM):
     signal.signal(sig, partial(signal_handler, sig.name))
 
+def daemonise():
+  global syslogfacility
+  if opts.daemon and opts.syslogfacility is None:
+    opts.syslogfacility = 'daemon'
+
+  if opts.syslogfacility is not None:
+    facilnum = syslog.__dict__['LOG_' + opts.syslogfacility.upper()]
+    syslog.openlog('hippotatd',
+                   facility=facilnum,
+                   logoption=syslog.LOG_PID)
+    def emit(event):
+      m = twisted.logger.formatEvent(event)
+      #print(repr(event), m, file=org_stderr)
+      level = event.get('log_level')
+      if   event.get('dflag',None) is not None: sl = syslog.LOG_DEBUG
+      elif level == LogLevel.critical         : sl = syslog.LOG_CRIT
+      elif level == LogLevel.error            : sl = syslog.LOG_ERR
+      elif level == LogLevel.warn             : sl = syslog.LOG_WARNING
+      else                                    : sl = syslog.LOG_INFO
+      syslog.syslog(sl,m)
+    glp = twisted.logger.globalLogPublisher
+    glp.addObserver(emit)
+    log_debug(DBG.INIT, 'starting to log to syslog')
+
+  #log.crit('daemonic hippotatd crashed', dflag=False)
+  if opts.daemon:
+    daemonic_reactor = (twisted.internet.interfaces.IReactorDaemonize
+                        .providedBy(reactor))
+    if daemonic_reactor: reactor.beforeDaemonize()
+    if opts.pidfile is not None:
+      pidfile_h = open(opts.pidfile, 'w')
+    rfd, wfd = os.pipe()
+    childpid = os.fork()
+    if childpid:
+      # we are the parent
+      os.close(wfd)
+      st = os.read(rfd, 1)
+      try:
+        st = st[0]
+      except IndexError:
+        st = 127
+        log.critical('daemonic hippotatd crashed', dflag=False)
+      os._exit(st)
+    os.close(rfd)
+    os.setsid()
+    grandchildpid = os.fork()
+    if grandchildpid:
+      # we are the intermediate child
+      if opts.pidfile is not None:
+        print(grandchildpid, file=pfh)
+        pfh.close()
+      os._exit(0)
+
+    mypid = os.getpid()
+    pfh.close()
+                                                                        
+    logger = subprocess.Popen(['logger','-d',
+                               '-t','hippotat(stderr)',
+                               '--id=%d' % mypid,
+                               '-p',opts.syslogfacility + '.err'],
+                              stdin=subprocess.PIPE,
+                              stdout=subprocess.DEVNULL,
+                              stderr=subprocess.DEVNULL,
+                              restore_signals=True)
+    
+    nullfd = os.open('/dev/null', os.O_RDWR)
+    os.dup2(nullfd, 0)
+    os.dup2(nullfd, 1)
+    os.dup2(logger.stdin.fileno(), 2)
+    os.close(nullfd)
+    if daemonic_reactor: reactor.afterDaemonize()
+    log_debug(DBG.INIT, 'daemonised')
+    os.write(wfd, b'\0')
+    os.close(wfd)
+
+  if opts.syslogfacility is not None:
+    glp.removeObserver(hippotatlib.file_log_observer)
+
+optparser.add_option('--ownsource', default=2,
+                     action='store_const', dest='ownsource', const=2,
+                     help='source download fully enabled (default)')
+
+optparser.add_option('--ownsource-local',
+                     action='store_const', dest='ownsource', const=1,
+                     help='source download is local source code only')
+
+optparser.add_option('--no-ownsource',
+                     action='store_const', dest='ownsource', const=0,
+                     help='source download disabled (for testing only)')
+
+optparser.add_option('--daemon',
+                     action='store_true', dest='daemon', default=False,
+                     help='daemonize (and log to syslog)')
+
+optparser.add_option('--pidfile',
+                     nargs=1, type='string',
+                     action='store', dest='pidfile', default=None,
+                     help='write pid to this file')
+
+optparser.add_option('--syslog-facility',
+                     nargs=1, type='string',action='store',
+                     metavar='FACILITY', dest='syslogfacility',
+                     default=None,
+                     help='log to syslog, with specified facility')
+
+optparser.add_option('--print-config',
+                     nargs=1, type='string',action='store',
+                     metavar='OPTION', dest='printconfig',
+                     default=None,
+                     help='print one config option value and exit')
+
 common_startup(process_cfg)
 catch_termination()
 common_startup(process_cfg)
 catch_termination()
-ipif = start_ipif(c.ipif_command, (lambda p,s,d: route(p,"[ipif]",s,d)))
 start_http()
 start_http()
+daemonise()
+ipif = start_ipif(c.ipif_command, (lambda p,s,d: route(p,"[ipif]",s,d)))
 common_run()
 common_run()
Unnamed repository; edit this file 'description' to name the repository.