Merge branch 'main' into 95-send-spots-to-xota

# Conflicts:
#	README.md
#	config-example.yml
#	core/config.py
#	server/handlers/api/addspot.py
#	server/handlers/api/options.py
#	static/js/add-spot.js
#	static/js/bands.js
#	static/js/map.js

server/webserver.py

@@ -5,7 +5,7 @@ import os
 import tornado
 from tornado.web import StaticFileHandler
 
-from core.config import ALLOW_SPOTTING, WEB_SERVER_PORT, API_ONLY_MODE
+from core.config import ALLOW_SPOTTING, WEB_SERVER_PORT, API_ONLY_MODE, LOG_WEB_REQUESTS, BASE_URL
 from core.utils import empty_queue
 from server.handlers.api.addspot import APISpotHandler
 from server.handlers.api.v1_compatability import V1RedirectHandler, V1GoneHandler
@@ -16,6 +16,7 @@ from server.handlers.api.options import APIOptionsHandler
 from server.handlers.api.solar_conditions import APISolarConditionsHandler
 from server.handlers.api.spots import APISpotsHandler, APISpotsStreamHandler
 from server.handlers.api.status import APIStatusHandler
+from server.handlers.manifesthandler import ManifestHandler
 from server.handlers.metrics import PrometheusMetricsHandler
 from server.handlers.pagetemplate import PageTemplateHandler
 
@@ -110,11 +111,16 @@ class WebServer:
             if ALLOW_SPOTTING:
                 ui_routes += [(r"/add-spot", PageTemplateHandler, {"template_name": "add_spot", **handler_opts})]
 
-        # API docs, Prometheus metrics, and finally static assets are always available regardless of API-only mode.
+        # API docs, Prometheus metrics, webapp manifest and static assets are always available regardless of API-only
+        # mode.
         misc_routes = [
             (r"/apidocs", PageTemplateHandler, {"template_name": "apidocs", **handler_opts}),
             (r"/metrics", PrometheusMetricsHandler),
-            (r"/(.*)", StaticFileHandler, {"path": os.path.join(_HERE, "../webassets")})
+            (r"/manifest.webmanifest", ManifestHandler),
+            # If e.g. nginx is configured as a reverse proxy with a hard-coded path to static files, as per the README,
+            # this will never have to handle anything, but having it here allows Spothole to work without nginx for
+            # testing.
+            (r"/static/(.*)", StaticFileHandler, {"path": os.path.join(_HERE, "../static")})
         ]
 
         app = tornado.web.Application(api_routes + v1_compat_routes + ui_routes + misc_routes,
@@ -123,6 +129,7 @@ class WebServer:
                                       debug=False)
         app.listen(self._port, xheaders=True)
         logging.info("Web server running on port " + str(WEB_SERVER_PORT))
+        logging.info("You can access your copy of Spothole at " + BASE_URL)
         await self._shutdown_event.wait()
 
     def notify_new_spot(self, spot):
@@ -176,20 +183,22 @@ class WebServer:
         pass
 
 def request_log(handler):
-    """Custom log function to provide more data about requests."""
+    """Custom log function to provide more data about requests when enabled, and to provide the ability to turn off
+    web request logging altogetether."""
 
-    if handler.get_status() < 500:
-        log_method = logging.info
-    else:
-        log_method = logging.warning
+    if LOG_WEB_REQUESTS:
+        if handler.get_status() < 500:
+            log_method = logging.info
+        else:
+            log_method = logging.warning
 
-    request = handler.request
-    client_ip = request.remote_ip
-    referrer = request.headers.get("Referer", "-")
-    user_agent = request.headers.get("User-Agent", "-")
+        request = handler.request
+        client_ip = request.remote_ip
+        referrer = request.headers.get("Referer", "-")
+        user_agent = request.headers.get("User-Agent", "-")
 
-    log_method(
-        f'{client_ip} - "{request.method} {request.uri}" '
-        f'{handler.get_status()} {request.request_time():.2f}ms | '
-        f'Ref: {referrer} | UA: {user_agent}'
-    )
+        log_method(
+            f'{client_ip} - "{request.method} {request.uri}" '
+            f'{handler.get_status()} {request.request_time():.2f}ms | '
+            f'Ref: {referrer} | UA: {user_agent}'
+        )