geovisio 2.8.0__tar.gz → 2.8.1__tar.gz

{geovisio-2.8.0 → geovisio-2.8.1}/CHANGELOG.md

@@ -9,6 +9,22 @@ Before _1.6.0_, [Viewer](https://gitlab.com/panoramax/clients/web-viewer) was em
 
 ## [Unreleased]
 
+## [2.8.1] - 2025-03-13
+
+### Added
+
+- Add a way to know the role and permission of the logged user in `/api/users/me`.
+- Add the ability to update an upload set parameters through a `PATCH` on `/api/upload_sets/:id`.
+- Add a debug endpoint `/api/debug_headers` that can be handy when setting a new instance to check if the proxies are correctly setting the headers.
+
+### Fixed
+
+- Fix a bug where dispatching several time the same upload set would not cleanup unused sequences.
+
+### Changed
+
+- Only display `tos_accepted` field in `/api/users/me` if ToS are mandatory.
+
 ## [2.8.0] - 2025-02-10
 
 ### Added
@@ -606,7 +622,8 @@ FLASK_APP="src" flask process-sequences
 - Viewer based on Photo Sphere Viewer automatically calling API to search and retrieve pictures
 - Dockerfile for easy server setup
 
-[Unreleased]: https://gitlab.com/panoramax/server/api/-/compare/2.8.0...develop
+[Unreleased]: https://gitlab.com/panoramax/server/api/-/compare/2.8.1...develop
+[2.8.1]: https://gitlab.com/panoramax/server/api/-/compare/2.8.0...2.8.1
 [2.8.0]: https://gitlab.com/panoramax/server/api/-/compare/2.7.1...2.8.0
 [2.7.1]: https://gitlab.com/panoramax/server/api/-/compare/2.7.0...2.7.1
 [2.7.0]: https://gitlab.com/panoramax/server/api/-/compare/2.6.0...2.7.0

{geovisio-2.8.0 → geovisio-2.8.1}/PKG-INFO

@@ -1,18 +1,19 @@
-Metadata-Version: 2.3
+Metadata-Version: 2.4
 Name: geovisio
-Version: 2.8.0
+Version: 2.8.1
 Summary: GeoVisio API - Main
 Author-email: Adrien PAVIE <panieravide@riseup.net>, Antoine Desbordes <antoine.desbordes@gmail.com>
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 Classifier: License :: OSI Approved :: MIT License
+License-File: LICENSE
 Requires-Dist: Flask ~= 2.3
 Requires-Dist: psycopg[pool] ~= 3.1
 Requires-Dist: flasgger ~= 0.9.7
 Requires-Dist: Pillow ~= 9.4
 Requires-Dist: Flask-Cors ~= 4.0
 Requires-Dist: fs ~= 2.4
-Requires-Dist: fs-s3fs-forked ~= 1.1.3
+Requires-Dist: fs-s3fs-forked ~= 1.1.4
 Requires-Dist: flask-compress ~= 1.14
 Requires-Dist: requests ~= 2.31
 Requires-Dist: yoyo-migrations ~= 8.2

{geovisio-2.8.0 → geovisio-2.8.1}/docker/docker-compose-full.yml

@@ -59,7 +59,7 @@ services:
       - |
         python3 -m flask user elysee --set-role admin --create
     depends_on:
-      elysee-account-creator:
+      migrations:
         condition: service_completed_successfully
     environment:
       DB_URL: postgres://gvs:gvspwd@db/geovisio

{geovisio-2.8.0 → geovisio-2.8.1}/docker/full-keycloak-auth/nginx.conf

@@ -52,7 +52,7 @@ http {
 
             # add X-forward- headers for keycloak to know it's canonical host
             # force https
-    	    proxy_set_header X-Forwarded-Scheme https;
+    	    proxy_set_header X-Forwarded-Proto https;
             proxy_set_header X-Forwarded-Host $host;
 
 			proxy_redirect default;

{geovisio-2.8.0 → geovisio-2.8.1}/docs/api/open_api.json

@@ -1,7 +1,7 @@
 {
     "info": {
         "title": "geovisio",
-        "version": "2.7.1",
+        "version": "2.8.0",
         "description": "# ![Panoramax](https://upload.wikimedia.org/wikipedia/commons/thumb/a/a9/Panoramax.svg/40px-Panoramax.svg.png) Panoramax\n\n__Panoramax__ is a digital resource for sharing and using \ud83d\udccd\ud83d\udcf7 field photos. Anyone can take photographs of places visible from the public streets and contribute them to the Panoramax database. This data is then freely accessible and reusable by all. More information available at [gitlab.com/panoramax](https://gitlab.com/panoramax) and [panoramax.fr](https://panoramax.fr/).\n\n\n# \ud83c\udf10 Panoramax API\n\nThis repository only contains __the backend and web API__ of a Panoramax instance.\n\n## Features\n\n* A __web API__ to search and upload pictures collections\n  * Search pictures by ID, date, location\n  * Compatible with [SpatioTemporal Asset Catalog](https://stacspec.org/) and [OGC WFS 3](https://github.com/opengeospatial/WFS_FES) specifications\n  * Upload your pictures and sequences\n* An easy-to-use __backend__\n  * Generates automatically thumbnail, small and tiled versions of your pictures\n  * Compatible with various filesystems (classic, S3, FTP...)\n  * Authentication and blurring API can be plugged-in for production-ready use\n\n\n## Install & run\n\nOur [documentation](https://gitlab.com/panoramax/server/api/-/tree/develop/docs) will help you install, configure and run a Panoramax instance.\n\nIf at some point you're lost or need help, you can contact us through [issues](https://gitlab.com/panoramax/server/api/-/issues) or by [email](mailto:panieravide@riseup.net).\n\n\n## Contributing\n\nPull requests are welcome. For major changes, please open an [issue](https://gitlab.com/panoramax/server/api/-/issues) first to discuss what you would like to change.\n\nMore information about developing is available in [documentation](https://gitlab.com/panoramax/server/api/-/tree/develop/docs).\n\n\n## \u2696\ufe0f License\n\nCopyright (c) Panoramax team 2022-2024, [released under MIT license](https://gitlab.com/panoramax/server/api/-/blob/develop/LICENSE).\n\n",
         "contact": {
             "name": "Adrien PAVIE",
@@ -271,6 +271,7 @@
         "/api/users/{userId}/catalog/": {
             "get": {
                 "summary": "Retrieves an user list of sequences (catalog)",
+                "description": "<br/>Note that this route is deprecated in favor of `/api/users/<uuid:userId>/collection`. This new route provides more information and offers more filtering and sorting options.<br/>",
                 "responses": {
                     "200": {
                         "description": "the Catalog listing all sequences associated to given user",
@@ -300,7 +301,8 @@
                 "tags": [
                     "Sequences",
                     "Users"
-                ]
+                ],
+                "deprecated": true
             }
         },
         "/api/collections": {
@@ -627,7 +629,7 @@
         "/api/users/{userId}/collection": {
             "get": {
                 "summary": "Retrieves an collection of the user list collections",
-                "description": "<br/>It's quite the same as \"/users/<uuid:userId>/catalog/\" but with additional information, as a STAC collection have more metadatas than STAC catalogs.<br/><br/>Links contain information of user sequences (child), as well as pagination links (next/prev).<br/><br/>Also, links are filtered to match passed conditions, so you can have pagination and filters on client-side.<br/><br/>Note that on paginated results, filter can only be used with column used in sortby parameter.<br/><br/>The result can also be a CSV file, if the \"Accept\" header is set to \"text/csv\", or if the \"format\" query parameter is set to \"csv\".<br/>Note that at most 1000 sequences are returned in CSV format, if there is more sequences, use directly the paginated json api.<br/>",
+                "description": "<br/>It's quite the same as \"/users/<uuid:userId>/catalog/\" but with additional information, as a STAC collection have more metadatas than STAC catalogs.<br/><br/>Links contain information of user sequences (child), as well as pagination links (next/prev).<br/><br/>Also, links are filtered to match passed conditions, so you can have pagination and filters on client-side.<br/><br/>Note that on paginated results, filter can only be used with column used in sortby parameter.<br/><br/>The result can also be a CSV file, if the \"Accept\" header is set to \"text/csv\", or if the \"format\" query parameter is set to \"csv\".<br/>Note that when requesting a CSV file, the filters/sortby/pagination parameters are not supported, and `limit` is ignored, you always get the full list of collections.<br/>",
                 "responses": {
                     "200": {
                         "description": "the Collection listing all sequences associated to given user",
@@ -658,7 +660,7 @@
                     {
                         "name": "format",
                         "in": "query",
-                        "description": "Expected output format (STAC JSON or a csv file)",
+                        "description": "Expected output format (STAC JSON or a csv file). Note that the CSV format support less parameters than the JSON format (cf documentation).",
                         "required": false,
                         "schema": {
                             "type": "string",
@@ -1374,7 +1376,7 @@
         "/api/users/me/catalog": {
             "get": {
                 "summary": "Get current logged user catalog.",
-                "description": "<br/>Note that it's similar to the user's colletion, but with less metadata since a STAC collection is an enhanced STAC catalog.<br/>The user's collection endpoint (\"/users/<uuid:userId>/collection\") also handle more parameters, like filters and sort.<br/>",
+                "description": "<br/>Note that this route is deprecated in favor of `/api/users/me/collection`. This new route provides more information and offers more filtering and sorting options.<br/>",
                 "responses": {
                     "200": {
                         "description": "the Catalog listing all sequences associated to given user. Note that it's similar to the user's colletion, but with less metadata since a STAC collection is an enhanced STAC catalog.",
@@ -1390,7 +1392,8 @@
                 "tags": [
                     "Users",
                     "Sequences"
-                ]
+                ],
+                "deprecated": true
             }
         },
         "/api/users/me/collection": {
@@ -1713,6 +1716,53 @@
             }
         },
         "/api/upload_sets/{upload_set_id}": {
+            "patch": {
+                "summary": "Update an existing UploadSet",
+                "requestBody": {
+                    "content": {
+                        "application/json": {
+                            "schema": {
+                                "$ref": "#/components/schemas/GeoVisioUploadSet"
+                            }
+                        }
+                    }
+                },
+                "responses": {
+                    "200": {
+                        "description": "the UploadSet metadata",
+                        "content": {
+                            "application/json": {
+                                "schema": {
+                                    "$ref": "#/components/schemas/GeoVisioUploadSet"
+                                }
+                            }
+                        }
+                    }
+                },
+                "parameters": [
+                    {
+                        "in": "header",
+                        "name": "User-Agent",
+                        "required": false,
+                        "schema": {
+                            "type": "string"
+                        },
+                        "description": "An explicit User-Agent value is prefered if you create a production-ready tool, formatted like \"GeoVisioCLI/1.0\""
+                    }
+                ],
+                "tags": [
+                    "Upload",
+                    "UploadSet"
+                ],
+                "security": [
+                    {
+                        "bearerToken": []
+                    },
+                    {
+                        "cookieAuth": []
+                    }
+                ]
+            },
             "get": {
                 "summary": "Get an existing UploadSet",
                 "description": "<br/>The UploadSet are used to group pictures during an upload.<br/>",
@@ -4507,7 +4557,7 @@
             },
             "GeoVisioCSVCollections": {
                 "type": "string",
-                "descrition": "CSV file containing the collections.\n\nThe CSV headers will be:\n* id: ID of the collection\n* status: Status of the collection\n* name: Name of the collection (its title)\n* created: Creation date of the collection\n* updated: Last update date of the collection\n* capture_date: Computed capture date of the collection (date of its first picture)\n* minimum_capture_time: Capture datetime of the first picture\n* maximum_capture_time: Capture datetime of the last picture\n* min_x: Minimum X coordinate of the bounding box of the collection\n* min_y: Minimum Y coordinate of the bounding box of the collection\n* max_x: Maximum X coordinate of the bounding box of the collection\n* max_y: Maximum Y coordinate of the bounding box of the collection\n* nb_pictures: Number of pictures in the collection\n* length_km: Total length of the collection in kilometers\n* computed_h_pixel_density: Horizontal pixel density of the pictures in the collection, if all pictures have the same one\n* computed_gps_accuracy: GPS accuracy of the pictures in the collection, if all pictures have the same one\n"
+                "descrition": "CSV file containing the collections.\n\nThe CSV headers will be:\n* id: ID of the collection\n* status: Status of the collection\n* name: Name of the collection (its title)\n* created: Creation date of the collection\n* updated: Last update date of the collection\n* capture_date: Computed capture date of the collection (date of its first picture)\n* minimum_capture_time: Capture datetime of the first picture\n* maximum_capture_time: Capture datetime of the last picture\n* min_x: Minimum X coordinate of the bounding box of the collection\n* min_y: Minimum Y coordinate of the bounding box of the collection\n* max_x: Maximum X coordinate of the bounding box of the collection\n* max_y: Maximum Y coordinate of the bounding box of the collection\n* nb_pictures: Number of pictures in the collection\n* length_km: Total length of the collection in kilometers\n* computed_h_pixel_density: Horizontal pixel density of the pictures in the collection, if all pictures have the same one\n* computed_gps_accuracy: GPS accuracy of the pictures in the collection, if all pictures have the same one\n\n"
             },
             "GeoVisioCollections": {
                 "allOf": [
@@ -7133,33 +7183,149 @@
                 "type": "object"
             },
             "GeoVisioUser": {
-                "type": "object",
-                "properties": {
-                    "id": {
-                        "type": "string",
-                        "format": "uuid"
+                "$defs": {
+                    "AccountRole": {
+                        "enum": [
+                            "user",
+                            "admin"
+                        ],
+                        "title": "AccountRole",
+                        "type": "string"
                     },
+                    "Link": {
+                        "properties": {
+                            "rel": {
+                                "title": "Rel",
+                                "type": "string"
+                            },
+                            "type": {
+                                "title": "Type",
+                                "type": "string"
+                            },
+                            "title": {
+                                "anyOf": [
+                                    {
+                                        "type": "string"
+                                    },
+                                    {
+                                        "type": "null"
+                                    }
+                                ],
+                                "default": null,
+                                "title": "Title"
+                            },
+                            "href": {
+                                "title": "Href",
+                                "type": "string"
+                            }
+                        },
+                        "required": [
+                            "rel",
+                            "type",
+                            "href"
+                        ],
+                        "title": "Link",
+                        "type": "object"
+                    },
+                    "Permissions": {
+                        "description": "Role and permissions of a user",
+                        "properties": {
+                            "role": {
+                                "$ref": "#/components/schemas/GeoVisioUser/$defs/AccountRole",
+                                "description": "Role of the user"
+                            },
+                            "can_check_reports": {
+                                "description": "Is account legitimate to read any report ?",
+                                "title": "Can Check Reports",
+                                "type": "boolean"
+                            },
+                            "can_edit_excluded_areas": {
+                                "description": "Is account legitimate to read and edit excluded areas ?",
+                                "title": "Can Edit Excluded Areas",
+                                "type": "boolean"
+                            },
+                            "can_edit_pages": {
+                                "description": "Is account legitimate to edit web pages ?",
+                                "title": "Can Edit Pages",
+                                "type": "boolean"
+                            }
+                        },
+                        "required": [
+                            "role",
+                            "can_check_reports",
+                            "can_edit_excluded_areas",
+                            "can_edit_pages"
+                        ],
+                        "title": "Permissions",
+                        "type": "object"
+                    }
+                },
+                "properties": {
                     "name": {
+                        "description": "Name of the user",
+                        "title": "Name",
                         "type": "string"
                     },
+                    "id": {
+                        "description": "Unique identifier of the user",
+                        "format": "uuid",
+                        "title": "Id",
+                        "type": "string"
+                    },
+                    "collaborative_metadata": {
+                        "anyOf": [
+                            {
+                                "type": "boolean"
+                            },
+                            {
+                                "type": "null"
+                            }
+                        ],
+                        "default": null,
+                        "description": "If true, the user can edit the metadata of all sequences. If unset, default to the instance's default configuration.",
+                        "title": "Collaborative Metadata"
+                    },
+                    "tos_accepted": {
+                        "anyOf": [
+                            {
+                                "type": "boolean"
+                            },
+                            {
+                                "type": "null"
+                            }
+                        ],
+                        "default": null,
+                        "description": "True means the user has accepted the terms of service (tos). Can only be seen by the user itself",
+                        "title": "Tos Accepted"
+                    },
+                    "permissions": {
+                        "anyOf": [
+                            {
+                                "$ref": "#/components/schemas/GeoVisioUser/$defs/Permissions"
+                            },
+                            {
+                                "type": "null"
+                            }
+                        ],
+                        "default": null,
+                        "description": "The user role and permissions. Can only be seen by the user itself"
+                    },
                     "links": {
-                        "type": "array",
                         "items": {
-                            "type": "object",
-                            "properties": {
-                                "href": {
-                                    "type": "string"
-                                },
-                                "ref": {
-                                    "type": "string"
-                                },
-                                "type": {
-                                    "type": "string"
-                                }
-                            }
-                        }
+                            "$ref": "#/components/schemas/GeoVisioUser/$defs/Link"
+                        },
+                        "readOnly": true,
+                        "title": "Links",
+                        "type": "array"
                     }
-                }
+                },
+                "required": [
+                    "name",
+                    "id",
+                    "links"
+                ],
+                "title": "UserInfo",
+                "type": "object"
             },
             "GeoVisioUserAuth": {
                 "type": "object",
@@ -7402,7 +7568,7 @@
                             "enabled": {
                                 "type": "boolean"
                             },
-                            "enforce_tos_acceptance\ttrue": {
+                            "enforce_tos_acceptance": {
                                 "type": "boolean"
                             }
                         },

{geovisio-2.8.0 → geovisio-2.8.1}/docs/install/tutorials/running_docker_keycloak.md

@@ -104,6 +104,17 @@ my.domain.org {
 }
 ```
 
+??? Note
+    The API need the [X-Forwarded-*](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-For) headers to be set in order to build correct internal links.
+    
+    You can check that the proxy is setting all the necessary headers by querying the API with:
+
+    ```bash
+    curl <your_domain>/api/debug_headers
+    ```
+
+    And checking the API logs to see all headers set. The response `test_url` should be the correct URL of the API.
+
 ## 🔄 Updating the instance
 
 If at one point you want to update your API version (and you should, we try to add nice functionalities often!), you can run:

{geovisio-2.8.0 → geovisio-2.8.1}/geovisio/__init__.py

@@ -1,9 +1,9 @@
 """GeoVisio API - Main"""
 
-__version__ = "2.8.0"
+__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
@@ -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-2.8.0 → geovisio-2.8.1}/geovisio/config_app.py

@@ -38,7 +38,6 @@ class DefaultConfig:
     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 = (