geovisio 2.8.0__py3-none-any.whl → 2.9.0__py3-none-any.whl

geovisio/__init__.py

@@ -1,9 +1,9 @@
 """GeoVisio API - Main"""
 
-__version__ = "2.8.0"
+__version__ = "2.9.0"
 
 import os
-from flask import Flask, jsonify, stream_template, send_from_directory, redirect, request
+from flask import Flask, jsonify, stream_template, send_from_directory, redirect, request, url_for
 from flask.cli import with_appcontext
 from flask_cors import CORS
 from flask_compress import Compress
@@ -106,7 +106,9 @@ def create_app(test_config=None, app=None):
         # https://flask.palletsprojects.com/en/2.2.x/deploying/proxy_fix/
         from werkzeug.middleware.proxy_fix import ProxyFix
 
-        app.wsgi_app = ProxyFix(app.wsgi_app, x_for=nb_proxies, x_proto=nb_proxies, x_host=nb_proxies, x_prefix=nb_proxies)
+        app.wsgi_app = ProxyFix(
+            app.wsgi_app, x_for=nb_proxies, x_proto=nb_proxies, x_host=nb_proxies, x_prefix=nb_proxies, x_port=nb_proxies
+        )
 
     # store the background processor in the app context
     app.background_processor = runner_pictures.PictureBackgroundProcessor(app)
@@ -185,6 +187,17 @@ def create_app(test_config=None, app=None):
     def favicon():
         return redirect("/static/img/favicon.ico")
 
+    @app.route("/api/debug_headers")
+    def debug_headers():
+        """Endpoint handy when setting a new instance to check if all the headers are set correctly,
+        and especially the X-Forwarded-* header that needs to be set by the proxies in order for the API to correctly build internal urls.
+
+        The headers are only printed to the console, so it's only for the instance administrator that has access to those logs.
+        """
+        logging.info(request.headers)
+
+        return jsonify({"test_url": url_for("index", _external=True)}), 200
+
     # Errors
     @app.errorhandler(errors.InvalidAPIUsage)
     def invalid_api_usage(e):

geovisio/config_app.py

@@ -33,12 +33,13 @@ class DefaultConfig:
     PERMANENT_SESSION_LIFETIME = datetime.timedelta(days=7).total_seconds()
     API_FORCE_AUTH_ON_UPLOAD = False
     PICTURE_PROCESS_DERIVATES_STRATEGY = "ON_DEMAND"
+    PICTURE_PROCESS_NB_RETRIES = 5
+    PICTURE_PROCESS_KEEP_UNBLURRED_PARTS = False
     API_BLUR_URL = None
     PICTURE_PROCESS_THREADS_LIMIT = 1
     DB_CHECK_SCHEMA = True  # If True check the database schema, and do not start the api if not up to date
     API_PICTURES_LICENSE_SPDX_ID = None
     API_PICTURES_LICENSE_URL = None
-    API_WEBSITE_URL = None  # URL to the website, used to generate links to the website. If not set, the API will presume the website runs from the same url.
     DEBUG_PICTURES_SKIP_FS_CHECKS_WITH_PUBLIC_URL = False
     SESSION_COOKIE_HTTPONLY = False
     PICTURE_PROCESS_REFRESH_CRON = (
@@ -52,6 +53,7 @@ class DefaultConfig:
     API_WEBSITE_URL = (
         website.WEBSITE_UNDER_SAME_HOST
     )  # by default we consider that there is a panoramax website on the same host as the API
+    API_REGISTRATION_IS_OPEN = False  # tells that anyone can create an account. Only used for reference in the federation for the moment
 
 
 def read_config(app, test_config):
@@ -93,10 +95,13 @@ def read_config(app, test_config):
         "API_DEFAULT_COLLABORATIVE_METADATA_EDITING",
         "API_ENFORCE_TOS_ACCEPTANCE",
         "API_WEBSITE_URL",
+        "API_REGISTRATION_IS_OPEN",
         # Picture process
         "PICTURE_PROCESS_DERIVATES_STRATEGY",
         "PICTURE_PROCESS_THREADS_LIMIT",
         "PICTURE_PROCESS_REFRESH_CRON",
+        "PICTURE_PROCESS_NB_RETRIES",
+        "PICTURE_PROCESS_KEEP_UNBLURRED_PARTS",
         # OAUTH
         "OAUTH_PROVIDER",
         "OAUTH_OIDC_URL",
@@ -166,6 +171,7 @@ def read_config(app, test_config):
         raise Exception(
             f"Unknown picture derivates strategy: '{app.config['PICTURE_PROCESS_DERIVATES_STRATEGY']}'. Please set to one of ON_DEMAND, PREPROCESS"
         )
+    app.config["PICTURE_PROCESS_NB_RETRIES"] = int(app.config["PICTURE_PROCESS_NB_RETRIES"])
 
     # Parse API summary
     if not isinstance(app.config.get("API_SUMMARY"), ApiSummary):
@@ -179,6 +185,8 @@ def read_config(app, test_config):
         except Exception as e:
             raise Exception("Parameter API_SUMMARY is not recognized") from e
 
+    app.config["API_REGISTRATION_IS_OPEN"] = _read_bool(app.config, "API_REGISTRATION_IS_OPEN")
+
     # Checks on front-end related variables
     templateFolder = os.path.join(app.root_path, app.template_folder)
     for pageParam in ["API_MAIN_PAGE", "API_VIEWER_PAGE"]:
@@ -221,6 +229,8 @@ def read_config(app, test_config):
     if not croniter.croniter.is_valid(cron_val):
         raise Exception(f"PICTURE_PROCESS_REFRESH_CRON should be a valid cron syntax, got '{cron_val}'")
 
+    app.config["PICTURE_PROCESS_KEEP_UNBLURRED_PARTS"] = _read_bool(app.config, "PICTURE_PROCESS_KEEP_UNBLURRED_PARTS")
+
     app.config["API_ACCEPT_DUPLICATE"] = _read_bool(app.config, "API_ACCEPT_DUPLICATE")
     app.config["API_ENFORCE_TOS_ACCEPTANCE"] = _read_bool(app.config, "API_ENFORCE_TOS_ACCEPTANCE")
     app.config["API_DEFAULT_COLLABORATIVE_METADATA_EDITING"] = _read_bool(app.config, "API_DEFAULT_COLLABORATIVE_METADATA_EDITING")