Merge pull request #89 from geoadmin/develop

New Release v1.5.0 - #minor

Dockerfile

@@ -1,5 +1,5 @@
-# Buster slim python 3.9 base image.
-FROM python:3.9-slim-buster
+# Buster slim python 3.12 base image.
+FROM python:3.12-slim-bookworm
 ENV HTTP_PORT 8080
 RUN groupadd -r geoadmin && useradd -r -s /bin/false -g geoadmin geoadmin
 

Pipfile

@@ -4,14 +4,14 @@ verify_ssl = true
 name = "pypi"
 
 [packages]
-PyYAML = "~=5.4.1"
-gevent = "~=21.1.2"
-gunicorn = "~=20.1.0"
-Flask = "~=2.0.1"
-Pillow = "~=9.0.1"
-python-dotenv = "~=0.17.0"
-logging-utilities = "~=3.0"
-werkzeug = "~=2.2"
+PyYAML = "~=6.0.2"
+gevent = "~=24.2.1"
+gunicorn = "~=23.0.0"
+Flask = "~=3.0.3"
+pillow = "~=10.4.0"
+python-dotenv = "~=1.0.1"
+logging-utilities = "~=4.5.0"
+werkzeug = "~=3.0.4"
 
 [dev-packages]
 yapf = "*"
@@ -21,4 +21,4 @@ pylint-flask = "*"
 cairosvg = "*"
 
 [requires]
-python_version = "3.9"
+python_version = "3.12"

README.md

@@ -57,7 +57,7 @@ See also [Git Flow - Versioning](https://github.com/geoadmin/doc-guidelines/blob
 
 ### Make Dependencies
 
-The **Make** targets assume you have **python3.9**, **pipenv**, **bash**, **curl**, **tar**, **docker** and **docker-compose** installed.
+The **Make** targets assume you have **python3.12**, **pipenv**, **bash**, **curl**, **tar**, **docker** and **docker-compose** installed.
 
 ### Setting up to work
 
@@ -192,3 +192,4 @@ The service is configured by Environment Variable:
 | WSGI_TIMEOUT | `5` | WSGI timeout. |
 | GUNICORN_TMPFS_DIR | `None` |The working directory for the gunicorn workers. |
 | WSGI_WORKERS | `2` | The number of workers per CPU. | 
+| UNLISTED_ICON_SETS | `'babs'`| Comma separated list of icon set to un-list. Those sets won't be listed in the /sets endpoint.  |

app/helpers/description.py

@@ -0,0 +1,40 @@
+import json
+import logging
+import os
+
+from flask import abort
+
+from app.settings import DESCRIPTION_FOLDER
+
+logger = logging.getLogger(__name__)
+
+
+def get_icon_description(icon_name='', icon_set=''):
+    '''
+    Return json containing the description in all available languages for an icon in the specified
+    icon set
+    '''
+    path = find_descripton_file(icon_set)
+    if not os.path.isfile(path):
+        return None
+
+    with open(path, encoding='utf-8') as f:
+        df = json.load(f)
+
+    try:
+        icon_description = df[icon_name]
+    except KeyError:
+        logger.error("Description for icon not found: %s", icon_name)
+        abort(404, "Description for icon not found")
+
+    return icon_description
+
+
+def find_descripton_file(icon_set):
+    '''
+    Return file path of description file if it exists or False in case it doesn't
+    '''
+    path = os.path.abspath(os.path.join(DESCRIPTION_FOLDER, icon_set)) + '-dictionary.json'
+    if os.path.isfile(path):
+        return path
+    return False

app/icon.py

@@ -1,7 +1,10 @@
 import os
 
+from PIL import Image
+
 from flask import url_for
 
+from app.helpers.description import get_icon_description
 from app.helpers.icons import get_icon_template_url
 from app.helpers.url import get_base_url
 from app.settings import DEFAULT_COLOR
@@ -82,6 +85,16 @@ def get_icon_filepath(self):
             name_with_extension = f"{name_with_extension}.png"
         return os.path.abspath(os.path.join(IMAGE_FOLDER, self.icon_set.name, name_with_extension))
 
+    def get_size(self):
+        """
+        Lazily open image of icon to get the size of the icon from the metadata.
+
+        Returns:
+            A tuple with the size of the specified icon (x,y)
+        """
+        with Image.open(self.get_icon_filepath()) as img:
+            return img.size
+
     def serialize(self):
         """
         As we want to add "url" to the __dict__, we can't really use a json.dumps to generate our
@@ -97,5 +110,7 @@ def serialize(self):
             "anchor": self.anchor,
             "icon_set": self.icon_set.name,
             "url": self.get_icon_url(),
-            "template_url": get_icon_template_url(get_base_url())
+            "template_url": get_icon_template_url(get_base_url()),
+            "description": get_icon_description(self.name, self.icon_set.name),
+            "size": self.get_size()
         }

app/icon_set.py

@@ -2,11 +2,14 @@
 
 from flask import url_for
 
+from app.helpers.description import find_descripton_file
 from app.helpers.icons import get_icon_set_template_url
 from app.helpers.url import get_base_url
 from app.icon import Icon
 from app.settings import COLORABLE_ICON_SETS
+from app.settings import ICON_SET_LANGUAGE
 from app.settings import IMAGE_FOLDER
+from app.settings import UNLISTED_ICON_SETS
 
 
 def get_icon_set(icon_set_name):
@@ -28,7 +31,9 @@ def get_all_icon_sets():
     icon_sets = []
     for root, dirs, files in os.walk(IMAGE_FOLDER):
         for icon_set_name in dirs:
-            icon_sets.append(get_icon_set(icon_set_name))
+            # icons of legacy icon sets are still available, but the icon set will not be listed
+            if icon_set_name not in UNLISTED_ICON_SETS:
+                icon_sets.append(get_icon_set(icon_set_name))
     return icon_sets
 
 
@@ -85,16 +90,6 @@ def get_icon(self, icon_name):
         """
         return Icon(f"{icon_name}", self)
 
-    def get_default_pixel_size(self):
-        """
-        Returns:
-            the size in pixel of this icon set's icon (icons are always square images). This is
-                helpful to calculate if an icon requires a resize before being served to the user.
-        """
-        if self.name == 'default':
-            return 96
-        return 48
-
     def get_all_icons(self):
         """
         Generate a list of all icons belonging to this icon set.
@@ -126,5 +121,7 @@ def serialize(self):
             "name": self.name,
             "colorable": self.colorable,
             "icons_url": self.get_icons_url(),
-            "template_url": get_icon_set_template_url(get_base_url())
+            "template_url": get_icon_set_template_url(get_base_url()),
+            "has_description": bool(find_descripton_file(self.name)),
+            "language": ICON_SET_LANGUAGE[self.name] if self.name in ICON_SET_LANGUAGE else None
         }

app/routes.py

@@ -28,6 +28,12 @@ def make_api_compliant_response(response_object):
     """
     if isinstance(response_object, (Icon, IconSet)):
         return make_response(jsonify({'success': True, **response_object.serialize()}))
+    if all(isinstance(r, (Icon, IconSet)) for r in response_object):
+        return make_response(
+            jsonify({
+                'success': True, "items": [r.serialize() for r in response_object]
+            })
+        )
     if isinstance(response_object, list):
         return make_response(jsonify({'success': True, "items": response_object}))
     return make_response(jsonify({'success': True, **response_object}))
@@ -86,9 +92,9 @@ def colorized_icon(
         image = Image.open(fd)
         if image.mode == 'P':
             image = image.convert('RGBA')
-        new_size = int(48 * scale)
-        if new_size != icon_set.get_default_pixel_size():
-            image = image.resize((new_size, new_size))
+        if scale != 1:
+            new_size = map(lambda s: int(s * scale), icon.get_size())
+            image = image.resize(tuple(new_size))
         if icon_set.colorable:
             image = Image.composite(Image.new("RGB", image.size, (red, green, blue)), image, image)
         output = BytesIO()

app/settings.py

@@ -10,9 +10,15 @@
     load_dotenv(ENV_FILE, override=True, verbose=True)
 
 IMAGE_FOLDER = os.path.abspath(os.path.join(os.path.dirname(__file__), '../static/images/'))
+DESCRIPTION_FOLDER = os.path.abspath(
+    os.path.join(os.path.dirname(__file__), '../metadata/description/')
+)
 
 COLORABLE_ICON_SETS = ['default']
+UNLISTED_ICON_SETS = os.environ.get('UNLISTED_ICON_SETS', 'babs').split(',')
+ICON_SET_LANGUAGE = {'babs-de': 'de', 'babs-fr': 'fr', 'babs-it': 'it'}
 DEFAULT_COLOR = {"r": '255', "g": '0', "b": '0'}
+DEFAULT_ICON_SIZE = 48
 TRAP_HTTP_EXCEPTIONS = True
 LOGS_DIR = os.getenv('LOGS_DIR', str(BASE_DIR / 'logs'))
 os.environ['LOGS_DIR'] = LOGS_DIR  # Set default if not set