Handle invalid icon in plugins list and details (qgis#425)

* Handle invalid icon in plugins list and details * Add sentry rate into the environment variable
Xpirix · Jun 17, 2024 · 0635b62 · 0635b62
1 parent 7ffcc82
commit 0635b62
Show file tree

Hide file tree

Showing 6 changed files with 24 additions and 4 deletions.
diff --git a/dockerize/.env.template b/dockerize/.env.template
@@ -36,6 +36,10 @@ ENABLE_LDAP=False
 # SENTRY
 SENTRY_DSN=''
 
+# Set traces_sample_rate to 1.0 to capture 100%
+# of transactions for performance monitoring.
+SENTRY_RATE=1.0
+
 # Download stats URL
 METABASE_DOWNLOAD_STATS_URL='https://plugins.qgis.org/metabase/public/dashboard/<dashboard_id>'
 

diff --git a/dockerize/docker-compose.yml b/dockerize/docker-compose.yml
@@ -52,6 +52,7 @@ services:
       - EMAIL_HOST_PASSWORD=${EMAIL_HOST_PASSWORD}
       - DEFAULT_PLUGINS_SITE=${DEFAULT_PLUGINS_SITE:-https://plugins.qgis.org/}
       - SENTRY_DSN=${SENTRY_DSN}
+      - SENTRY_RATE=${SENTRY_RATE}
     volumes:
       - ../qgis-app:/home/web/django_project
       - ./docker/uwsgi.conf:/uwsgi.conf

diff --git a/qgis-app/plugins/templates/plugins/plugin_detail.html b/qgis-app/plugins/templates/plugins/plugin_detail.html
@@ -144,7 +144,7 @@ <h2>
         <div class="span12">
         {% endif %}
             <h2>{{ object.name }}
-            {% if object.icon and object.icon.file %}
+            {% if object.icon and object.icon.file and object.icon|is_image_valid %}
                 {% with image_extension=object.icon.name|file_extension %}
                     {% if image_extension == 'svg' %}
                         <img class="pull-right plugin-icon" alt="{% trans "Plugin icon" %}" src="{{ object.icon.url }}" width="24" height="24" />
@@ -154,6 +154,8 @@ <h2>{{ object.name }}
                         {% endthumbnail %}
                     {% endif %}
                 {% endwith %}
+            {% else %}
+                <img height="32" width="32" class="pull-right plugin-icon" src="{% static "images/qgis-icon-32x32.png" %}" alt="{% trans "Plugin icon" %}" />
             {% endif %}
             </h2>
             <div>

diff --git a/qgis-app/plugins/templates/plugins/plugin_list.html b/qgis-app/plugins/templates/plugins/plugin_list.html
@@ -80,7 +80,7 @@ <h2>{% if title %}{{title}}{% else %}{% trans "All plugins" %}{% endif %}</h2>
             {% for object in object_list %}
             <tr class="pmain {% if object.deprecated %} error deprecated{% endif %}" id="pmain{{object.pk}}">
                 <td><a title="{% if object.deprecated %} [DEPRECATED] {% endif %}{% trans "Click here for plugin details" %}" href="{% url "plugin_detail" object.package_name %}">
-                {% if object.icon and object.icon.file %}
+                {% if object.icon and object.icon.file and object.icon|is_image_valid %}
                     {% with image_extension=object.icon.name|file_extension %}
                         {% if image_extension == 'svg' %}
                             <img class="pull-right plugin-icon" alt="{% trans "Plugin icon" %}" src="{{ object.icon.url }}" width="24" height="24" />

diff --git a/qgis-app/plugins/templatetags/plugin_utils.py b/qgis-app/plugins/templatetags/plugin_utils.py
@@ -1,4 +1,5 @@
 from django import template
+from PIL import Image, UnidentifiedImageError
 
 register = template.Library()
 
@@ -27,4 +28,15 @@ def plugin_title(context):
 
 @register.filter
 def file_extension(value):
-    return value.split('.')[-1].lower()
+    return value.split('.')[-1].lower()
+
+@register.filter
+def is_image_valid(image):
+    if not image:
+        return False
+    try:
+        img = Image.open(image.path)
+        img.verify()
+        return True
+    except (FileNotFoundError, UnidentifiedImageError):
+        return False
diff --git a/qgis-app/settings_docker.py b/qgis-app/settings_docker.py
@@ -173,6 +173,7 @@
 
 # Sentry
 SENTRY_DSN = os.environ.get("SENTRY_DSN", "")
+SENTRY_RATE = os.environ.get("SENTRY_RATE", 1.0)
 
 if SENTRY_DSN and SENTRY_DSN != "":
     import sentry_sdk
@@ -181,5 +182,5 @@
         dsn=SENTRY_DSN,
         # Set traces_sample_rate to 1.0 to capture 100%
         # of transactions for performance monitoring.
-        traces_sample_rate=1.0,
+        traces_sample_rate=SENTRY_RATE,
     )