geovisio 2.7.1__py3-none-any.whl → 2.8.1__py3-none-any.whl

geovisio/__init__.py

@@ -1,9 +1,9 @@
 """GeoVisio API - Main"""
 
-__version__ = "2.7.1"
+__version__ = "2.8.1"
 
 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
@@ -28,6 +28,9 @@ from geovisio.web import (
     upload_set,
     reports,
     excluded_areas,
+    prepare,
+    pages,
+    annotations,
 )
 from geovisio.workers import runner_pictures
 
@@ -73,12 +76,12 @@ def create_app(test_config=None, app=None):
     if app is None:
         app = Flask(__name__, instance_relative_config=True)
     CORS(app, supports_credentials=True)
-    Compress(app)
 
     config_app.read_config(app, test_config)
     sentry.init(app)
     db.create_db_pool(app)
     Babel(app, locale_selector=get_locale)
+    Compress(app)
 
     # Prepare filesystem
     createDirNoFailure(app.instance_path)
@@ -88,6 +91,8 @@ def create_app(test_config=None, app=None):
     if app.config.get("DB_CHECK_SCHEMA"):
         db_migrations.update_db_schema(app.config["DB_URL"])
 
+    config_app.persist_config(app)
+
     if app.config.get("OAUTH_PROVIDER"):
         utils.auth.make_auth(app)
         app.register_blueprint(auth.bp)
@@ -101,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)
@@ -121,6 +128,9 @@ def create_app(test_config=None, app=None):
     app.register_blueprint(upload_set.bp)
     app.register_blueprint(reports.bp)
     app.register_blueprint(excluded_areas.bp)
+    app.register_blueprint(prepare.bp)
+    app.register_blueprint(pages.bp)
+    app.register_blueprint(annotations.bp)
 
     # Register CLI comands
     app.register_blueprint(admin_cli.bp, cli_group=None)
@@ -177,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/admin_cli/__init__.py

@@ -1,12 +1,14 @@
 from flask import Blueprint
+from flask import cli
 from flask.cli import with_appcontext
 import click
 import logging
-from . import default_account_tokens, reorder_sequences, sequence_heading, cleanup, db
+from . import default_account_tokens, reorder_sequences, sequence_heading, cleanup, db, user
 
 bp = Blueprint("cli", __name__)
 
 bp.register_blueprint(default_account_tokens.bp, cli_group="default-account-tokens")
+bp.register_blueprint(user.bp, cli_group=None)
 bp.register_blueprint(db.bp, cli_group="db")
 
 

geovisio/admin_cli/user.py

@@ -0,0 +1,75 @@
+from uuid import UUID
+from attr import dataclass
+import click
+from flask import Blueprint, current_app
+from flask.cli import with_appcontext
+from geovisio.utils import db
+from geovisio.utils.auth import AccountRole
+from psycopg.rows import dict_row
+
+bp = Blueprint("user", __name__)
+
+
+@dataclass
+class Account:
+    id: UUID
+    name: str
+
+
+@bp.cli.command("user")
+@click.argument("account_id_or_name")
+@click.option("--set-role", required=True, help="Role you want to give to the account. Must be one of: admin or user")
+@click.option("--create", is_flag=True, show_default=True, default=False, help="If provided, create the account if it does not exist")
+@with_appcontext
+def update_user(account_id_or_name, set_role=None, create=False):
+    """
+    Update some information about a user.
+    To identify the account, either the account_id or the account_name must be provided.
+    """
+    with db.conn(current_app) as conn, conn.cursor(row_factory=dict_row) as cursor:
+
+        account = get_account(cursor, account_id_or_name, create)
+
+        if set_role is not None:
+            update_role(cursor, account, set_role)
+
+
+def get_account(cursor, account_id_or_name, create):
+    account_id = None
+    account_name = None
+    try:
+        account_id = UUID(account_id_or_name)
+    except ValueError:
+        account_name = account_id_or_name
+
+    if account_id is not None:
+        r = cursor.execute("SELECT id, name FROM accounts WHERE id = %s", [account_id]).fetchall()
+    elif account_name is not None:
+        r = cursor.execute("SELECT id, name FROM accounts WHERE name = %s", [account_name]).fetchall()
+    else:
+        raise click.ClickException("You must provide either an account_id or an account_name")
+
+    if create and not r:
+        if account_id is not None:
+            raise click.ClickException("You cannot create an account with an account_id, a name must be provided")
+        r = cursor.execute("INSERT INTO accounts (name) VALUES (%s) RETURNING id, name", [account_name]).fetchall()
+
+    if not r:
+        raise click.ClickException(f"Account {account_id_or_name} not found")
+    if len(r) > 1:
+        print(f"Several accounts found with name {account_id_or_name}")
+        for i in r:
+            print(f" * {i['id']}")
+        raise click.ClickException(f"Please provide an account_id instead")
+
+    return Account(id=r[0]["id"], name=r[0]["name"])
+
+
+def update_role(cursor, account, role):
+    try:
+        role = AccountRole(role)
+    except ValueError:
+        raise click.ClickException(f"Role {role} is not valid. Must be one of: admin or user")
+
+    print(f"Adding role {role.value} to account {account.name} ({account.id})")
+    cursor.execute("UPDATE accounts SET role = %s WHERE id = %s", [role.value, account.id])

geovisio/config_app.py

@@ -5,10 +5,15 @@ import datetime
 import logging
 from typing import Optional, Dict
 import croniter
-from pydantic import BaseModel
+from pydantic import BaseModel, EmailStr
 from pydantic.color import Color
 from pydantic.networks import HttpUrl
 import json
+from flask import Flask, current_app
+
+from geovisio.utils import website
+from geovisio.utils.model_query import get_db_params_and_values
+from geovisio.utils.website import Website
 
 
 class ApiSummary(BaseModel):
@@ -16,6 +21,8 @@ class ApiSummary(BaseModel):
     description: Dict[str, str] = {"en": "The open source photo mapping solution"}
     logo: HttpUrl = "https://gitlab.com/panoramax/gitlab-profile/-/raw/main/images/logo.svg"
     color: Color = "#bf360c"
+    email: EmailStr = "panoramax@panoramax.fr"
+    geo_coverage: Dict[str, str] = {"en": "Worldwide\nThe picture can be sent from anywhere in the world."}
 
 
 class DefaultConfig:
@@ -40,6 +47,10 @@ class DefaultConfig:
     DB_MAX_CNX = 10
     DB_STATEMENT_TIMEOUT = 5 * 60 * 1000  # default statement timeout in ms (5mn)
     API_ACCEPT_DUPLICATE = False
+    API_ENFORCE_TOS_ACCEPTANCE = False  # if True, users won't be able to upload pictures without accepting the terms of service
+    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
 
 
 def read_config(app, test_config):
@@ -78,6 +89,9 @@ def read_config(app, test_config):
         "API_PICTURES_LICENSE_URL",
         "API_ACCEPT_DUPLICATE",
         "API_GIT_VERSION",
+        "API_DEFAULT_COLLABORATIVE_METADATA_EDITING",
+        "API_ENFORCE_TOS_ACCEPTANCE",
+        "API_WEBSITE_URL",
         # Picture process
         "PICTURE_PROCESS_DERIVATES_STRATEGY",
         "PICTURE_PROCESS_THREADS_LIMIT",
@@ -111,7 +125,7 @@ def read_config(app, test_config):
         "CLIENT_ID": "OAUTH_CLIENT_ID",
         "CLIENT_SECRET": "OAUTH_CLIENT_SECRET",
         "NB_PROXIES": "INFRA_NB_PROXIES",
-        "SECRET_KEY": "FLASk_SECRET_KEY",
+        "SECRET_KEY": "FLASK_SECRET_KEY",
         "SESSION_COOKIE_DOMAIN": "FLASK_SESSION_COOKIE_DOMAIN",
     }
     for legacyKey, newKey in legacyVariables.items():
@@ -175,6 +189,8 @@ def read_config(app, test_config):
                 f"{pageParam} variable points to invalid template '{app.config[pageParam]}' (not found in '{templateFolder}' folder)"
             )
 
+    app.config["API_WEBSITE_URL"] = Website(app.config.get("API_WEBSITE_URL"))
+
     # The default is to use only one only 1 thread to process uploaded pictures
     # if set to 0 no background worker is run, if set to -1 all cpus will be used
     app.config["PICTURE_PROCESS_THREADS_LIMIT"] = _get_threads_limit(app.config["PICTURE_PROCESS_THREADS_LIMIT"])
@@ -205,6 +221,8 @@ def read_config(app, test_config):
         raise Exception(f"PICTURE_PROCESS_REFRESH_CRON should be a valid cron syntax, got '{cron_val}'")
 
     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")
 
     app.config["DB_STATEMENT_TIMEOUT"] = int(app.config["DB_STATEMENT_TIMEOUT"])
 
@@ -212,7 +230,21 @@ def read_config(app, test_config):
     # Add generated config vars
     #
     app.url_map.strict_slashes = False
-    app.config["COMPRESS_MIMETYPES"].append("application/geo+json")
+
+    if app.config.get("API_COMPRESSION", True) is False:
+        # Note that this API_COMPRESSION variable is only used in tests
+        app.config["COMPRESS_MIMETYPES"] = []
+    else:
+        app.config["COMPRESS_MIMETYPES"] = [
+            "text/html",
+            "text/css",
+            "text/plain",
+            "text/xml",
+            "application/x-javascript",
+            "application/json",
+            "application/rss+xml",
+            "application/geo+json",
+        ]
     app.config["EXECUTOR_MAX_WORKERS"] = app.config["PICTURE_PROCESS_THREADS_LIMIT"]
     app.config["EXECUTOR_PROPAGATE_EXCEPTIONS"] = True  # propagate the excecutor's exceptions, to be able to trace them
 
@@ -248,7 +280,57 @@ def _get_threads_limit(param: str) -> int:
     nb_cpu = os.cpu_count()
     if p == -1:
         if nb_cpu is None:
-            logging.warn("Number of cpu is unknown, using only 1 thread")
+            logging.warning("Number of cpu is unknown, using only 1 thread")
             return 1
         return nb_cpu
     return min(p, os.cpu_count() or 1)
+
+
+class DBConfiguration(BaseModel):
+    """Configuration persisted in the database.
+    Not all configurations are meant to be persisted in the database"""
+
+    collaborative_metadata: Optional[bool] = None
+
+
+def persist_config(app: Flask):
+    """
+    Persist the configuration in the database if needed.
+
+    Note that the configuration can only be initialized like this, if the configuration has been changed in the database, it will not be updated using environment variables.
+    """
+    from geovisio.utils import db
+    from psycopg.rows import class_row
+    from psycopg.sql import SQL, Literal
+    from psycopg.errors import UndefinedTable
+
+    with db.conn(app) as conn, conn.transaction() as tr, conn.cursor(row_factory=class_row(DBConfiguration)) as cur:
+        try:
+            db_config = cur.execute("SELECT * FROM configurations LIMIT 1").fetchone()
+        except UndefinedTable:
+            logging.warning("Database schema has not been updated yet, configuration will not be persisted")
+            return
+        if not db_config:
+            raise Exception("Database has not been correctly initialized, there should always be a default")
+        config_to_persist = DBConfiguration()
+
+        # add the fields we want to persist here
+        collaborative_metadata = app.config["API_DEFAULT_COLLABORATIVE_METADATA_EDITING"]
+        if db_config.collaborative_metadata is None:
+            config_to_persist.collaborative_metadata = collaborative_metadata
+        elif db_config.collaborative_metadata != collaborative_metadata and collaborative_metadata is not None:
+            logging.warning(
+                "The environment variable `API_DEFAULT_COLLABORATIVE_METADATA_EDITING` has a different value than its value in the database, it will be ignored. Update the `collaborative_metadata` field in the database if you want to change it."
+            )
+
+        params_as_dict = get_db_params_and_values(config_to_persist)
+        fields = params_as_dict.fields_for_set()
+        if not params_as_dict.has_updates():
+            return
+
+        logging.info("Persisting configuration to the database from environement variables")
+        # Persist all set fields in the database
+        cur.execute(
+            SQL("UPDATE configurations SET {fields} RETURNING *").format(fields=fields),
+            params_as_dict.params_as_dict,
+        )

geovisio/templates/main.html

@@ -29,7 +29,7 @@
 
 	<script>
 		var baseUrl = window.location.href.replace(/\/$/, '');
-		var viewerUrl = "https://cdn.jsdelivr.net/npm/geovisio@~3.0/build";
+		var viewerUrl = "https://cdn.jsdelivr.net/npm/@panoramax/web-viewer@~3.2/build";
 		function encodeHTML(html) {
 			return html
 				.replace(/</g, "&lt;")
@@ -68,7 +68,7 @@
 			+'&lt;script>\n'
 			+'\t// All options available are listed here\n'
 			+'\t// https://gitlab.com/panoramax/clients/web-viewer/-/blob/develop/docs/02_Usage.md\n'
-			+'\tvar instance = new GeoVisio.default(\n'
+			+'\tvar instance = new Panoramax.default(\n'
 			+'\t\t"viewer",\n'
 			+'\t\t"'+baseUrl+'/api",\n'
 			+'\t\t{ map: true }\n'

geovisio/templates/viewer.html

@@ -6,7 +6,7 @@
 	<link rel="shortcut icon" href="/favicon.ico" />
 	<link rel="icon" type="image/svg+xml" href="/static/img/favicon.svg" />
 	<title>GeoVisio</title>
-	<link rel="stylesheet" type="text/css" href="https://cdn.jsdelivr.net/npm/geovisio@~3.0/build/index.css" />
+	<link rel="stylesheet" type="text/css" href="https://cdn.jsdelivr.net/npm/@panoramax/web-viewer@~3.2/build/index.css" />
 	<style>
 		#viewer {
 			position: absolute;
@@ -22,9 +22,9 @@
 		<noscript>{%trans%}You need to enable JavaScript to run this app.{%endtrans%}</noscript>
 	</div>
 
-	<script src="https://cdn.jsdelivr.net/npm/geovisio@~3.0/build/index.js"></script>
+	<script src="https://cdn.jsdelivr.net/npm/@panoramax/web-viewer@~3.2/build/index.js"></script>
 	<script>
-		var instance = new GeoVisio.default(
+		var instance = new Panoramax.default(
 			"viewer",
 			"/api",
 			{ map: { startWide: true } }