split up template tag / filter implementations into separate files

Djangos standard templates do not handle upload files that no longer
exist well, and can't catch exceptions on the template level either.

So to be able to handle upload files that have meanwhile been purged
and still being able to print a readable file size for those that
do exist we implement our own file_readable_size filter instead of
using the Django supplied filesizeformat filter

www/maposmatic/templates/maposmatic/maps.html

@@ -88,7 +88,7 @@
 	      {% if map.uploads.all %}
 	      <tr><td><strong>{% trans "Uploaded files" %}</strong></td><td>
 		{% for upload in map.uploads.all %}
- 	        <tt>{{ upload.uploaded_file|file_basename }}</tt> <em>({{ upload.file_type }}, {{ upload.uploaded_file.size|filesizeformat }})</em><br/>
+ 	        <tt>{{ upload.uploaded_file|file_basename }}</tt> <em>({{ upload.file_type }}, {{ upload.uploaded_file|file_readable_size }})</em><br/>
 	        {% endfor %}
 	      </td></tr>
  	      {% endif %}

www/maposmatic/templatetags/bbox_tags.py

@@ -0,0 +1,22 @@
+import www.settings
+
+from .extratags import register
+
+import ocitysmap
+
+@register.filter()
+def bbox_km(value):
+    boundingbox = ocitysmap.coords.BoundingBox(
+        value.lat_upper_left,
+        value.lon_upper_left,
+        value.lat_bottom_right,
+        value.lon_bottom_right)
+
+    (height, width) = boundingbox.spheric_sizes()
+
+    if width >= 1000 and height >= 1000:
+        return "ca. %d x %d km²" % (width/1000, height/1000)
+
+    return "ca. %d x %d m²" % (width, height)
+
+

www/maposmatic/templatetags/extratags.py

@@ -22,7 +22,6 @@
 # You should have received a copy of the GNU Affero General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
-import datetime
 import os
 import re
 
@@ -37,147 +36,14 @@ import ocitysmap
 
 register = template.Library()
 
-_alert_ok   = "<div class='alert alert-success' role='alert'>"
-_alert_info = "<div class='alert alert-info'    role='alert'>"
-_alert_warn = "<div class='alert alert-warning' role='alert'>"
-_alert_err  = "<div class='alert alert-danger'  role='alert'>"
-_alert_end  = "</div>"
+from . import file_tags, geo_tags, l18n_tags, bbox_tags
+from . import paper_tags, rss_feed_tags, job_tags
 
-def _lastline(filename):
-    try:
-        with open(filename, "rb") as file:
-            file.seek(-2, os.SEEK_END)
-            while file.read(1) != b'\n':
-                file.seek(-2, os.SEEK_CUR)
-            return str(file.readline().decode())
-    except:
-        return ""
 
 @register.filter()
-def job_status_to_str(value):
-    if value.status == 0:
-        return mark_safe(_alert_info + str(_("Waiting for rendering to begin...")) + _alert_end)
-    elif value.status == 1:
-        return mark_safe(_alert_info + str(_("The rendering is in progress...")) + _alert_end)
-    elif value.status == 2:
-        if value.resultmsg == 'ok':
-            return mark_safe(_alert_ok + str(_("Rendering was successful.")) + _alert_end)
-        else:
-            # TODO properly templatize this
-            result = _alert_err
-            result+= "<h4><i class='fas fa-triangle-exclamation'></i> <b>%s!</b></h4>" % value.resultmsg # TODO localize the result messages
-
-            if not value.resultmsg.startswith("Not enough memory"):
-                error_log_tail = escape(_lastline(value.get_errorlog_file())).replace(':',':<br/>')
-                if error_log_tail:
-                    result+= _("Check the %(error_log)s for more details<br/>") % {
-                        'error_log': "<a target='_blank' href='%s'><i class='fas fa-file-lines'></i> %s</a>" % (value.get_errorlog(), _("error log")),
-                    }
-                
-                if www.settings.CONTACT_EMAIL:
-                    if error_log_tail:
-                        result+= "or "
-                        result+= _("contact %(email)s for more information.") % {
-                            'email': "<a href='mailto:%(email)s?subject=[MapOSMatic] Error on request %(id)d'><i class='fas fa-envelope'></i> %(email)s</a>" % {
-                                "email": www.settings.CONTACT_EMAIL,
-                                "id":    value.id
-                            }
-                        }
-                    
-                if error_log_tail:
-                    result+= "<hr/><tt>%s</tt>" % error_log_tail
-                    
-            result += _alert_end
-
-            return mark_safe(result)
-    elif value.status == 3:
-        if value.resultmsg == 'ok':
-            return mark_safe(_alert_info + str(_("Rendering is obsolete: the rendering was successful, but the files are no longer available.")) + _alert_end)
-        else:
-            return mark_safe(_alert_warn + str(_("Obsolete failed rendering: the rendering failed, and the incomplete files have been removed.")) + _alert_end)
-    elif value == 4:
-        return mark_safe(_alert_warn + str(_("The rendering was cancelled by the user.")) + _alert_end)
-
-    return ''
-
-def feedparsed(value):
-    return datetime.datetime(*value[:6])
-
-def file_basename(value):
-    try:
-      return os.path.basename(value.name)
-    except:
-      return ""
-
 def add_blank_after_comma(value):
     return value.replace(",",", ")
 
-def _dd2dms(value):
-    abs_value = abs(value)
-    degrees  = int(abs_value)
-    frac     = abs_value - degrees
-    minutes  = int(frac * 60)
-    seconds  = (frac * 3600) % 60
 
-    return (degrees, minutes, seconds)
-
-def latitude(value):
-    latitude = float(value)
-    (degrees, minutes, seconds) = _dd2dms(latitude)
-    hemisphere = 'N' if latitude >= 0 else 'S'
-
-    return "%d°%d'%d\"%s" % (degrees, minutes, seconds, hemisphere)
-
-def longitude(value):
-    latitude = float(value)
-    (degrees, minutes, seconds) = _dd2dms(latitude)
-    hemisphere = 'E' if latitude >= 0 else 'W'
-
-    return "%d°%d'%d\"%s" % (degrees, minutes, seconds, hemisphere)
-
-def bbox_km(value):
-    boundingbox = ocitysmap.coords.BoundingBox(
-        value.lat_upper_left,
-        value.lon_upper_left,
-        value.lat_bottom_right,
-        value.lon_bottom_right)
-
-    (height, width) = boundingbox.spheric_sizes()
-
-    if width >= 1000 and height >= 1000:
-        return "ca. %d x %d km²" % (width/1000, height/1000)
-
-    return "ca. %d x %d m²" % (width, height)
-
-def language_flag(value):
-    if value in www.settings.LANGUAGE_FLAGS:
-        if www.settings.LANGUAGE_FLAGS[value] != None:
-            return ("fi fi-%s" % www.settings.LANGUAGE_FLAGS[value])
-    return "fa fa-flag"
-
-def locale_base(value):
-    return re.sub('\..*', '', value)
-
-def paper_size(value):
-    w = value.paper_width_mm
-    h = value.paper_height_mm
-
-    oc = ocitysmap.OCitySMap(www.settings.OCITYSMAP_CFG_PATH)
-    size_name = oc.get_paper_size_name_by_size(w, h)
-
-    if size_name is None:
-        return "%d×%d mm²" % (w,h)
-    else:
-        return "%s (%d×%d mm²)" % (size_name, w, h)
-
-register.filter('feedparsed', feedparsed)
 register.filter('abs', lambda x: abs(x))
 register.filter('getitem', lambda d,i: d.get(i,''))
-register.filter('file_basename', file_basename)
-register.filter('add_blank_after_comma', add_blank_after_comma)
-register.filter('latitude', latitude)
-register.filter('longitude', longitude)
-register.filter('bbox_km', bbox_km)
-register.filter('language_flag', language_flag)
-register.filter('locale_base', locale_base)
-register.filter('paper_size', paper_size)

www/maposmatic/templatetags/file_tags.py

@@ -0,0 +1,27 @@
+import os
+
+import www.settings
+
+from .extratags import register
+
+@register.filter()
+def file_basename(value):
+    try:
+      return os.path.basename(value.name)
+    except:
+      return ""
+
+@register.filter()
+def file_readable_size(value):
+    path = os.path.join(www.settings.MEDIA_ROOT, value.name)
+    if os.path.isfile(path):
+        stats = os.stat(path)
+        size  = stats.st_size
+
+        for unit in ["B", "KiB", "MiB", "GiB", "TiB"]:
+            if size < 1024.0:
+                return "%.1f%s" % (size, unit)
+            size = size / 1024
+
+    else:
+        return "not found"

www/maposmatic/templatetags/geo_tags.py

@@ -0,0 +1,29 @@
+import www.settings
+
+from .extratags import register
+
+def _dd2dms(value):
+    abs_value = abs(value)
+    degrees  = int(abs_value)
+    frac     = abs_value - degrees
+    minutes  = int(frac * 60)
+    seconds  = (frac * 3600) % 60
+
+    return (degrees, minutes, seconds)
+
+@register.filter()
+def latitude(value):
+    latitude = float(value)
+    (degrees, minutes, seconds) = _dd2dms(latitude)
+    hemisphere = 'N' if latitude >= 0 else 'S'
+
+    return "%d°%d'%d\"%s" % (degrees, minutes, seconds, hemisphere)
+
+@register.filter()
+def longitude(value):
+    latitude = float(value)
+    (degrees, minutes, seconds) = _dd2dms(latitude)
+    hemisphere = 'E' if latitude >= 0 else 'W'
+
+    return "%d°%d'%d\"%s" % (degrees, minutes, seconds, hemisphere)
+

www/maposmatic/templatetags/job_tags.py

@@ -0,0 +1,75 @@
+import www.settings
+
+from .extratags import register
+
+import os
+
+from django import template
+from django.utils.safestring import mark_safe
+from django.utils.translation import gettext_lazy as _
+from django.utils.html import escape
+
+_alert_ok   = "<div class='alert alert-success' role='alert'>"
+_alert_info = "<div class='alert alert-info'    role='alert'>"
+_alert_warn = "<div class='alert alert-warning' role='alert'>"
+_alert_err  = "<div class='alert alert-danger'  role='alert'>"
+_alert_end  = "</div>"
+
+def _lastline(filename):
+    try:
+        with open(filename, "rb") as file:
+            file.seek(-2, os.SEEK_END)
+            while file.read(1) != b'\n':
+                file.seek(-2, os.SEEK_CUR)
+            return str(file.readline().decode())
+    except:
+        return ""
+
+@register.filter()
+def job_status_to_str(value):
+    if value.status == 0:
+        return mark_safe(_alert_info + str(_("Waiting for rendering to begin...")) + _alert_end)
+    elif value.status == 1:
+        return mark_safe(_alert_info + str(_("The rendering is in progress...")) + _alert_end)
+    elif value.status == 2:
+        if value.resultmsg == 'ok':
+            return mark_safe(_alert_ok + str(_("Rendering was successful.")) + _alert_end)
+        else:
+            # TODO properly templatize this
+            result = _alert_err
+            result+= "<h4><i class='fas fa-triangle-exclamation'></i> <b>%s!</b></h4>" % value.resultmsg # TODO localize the result messages
+
+            if not value.resultmsg.startswith("Not enough memory"):
+                error_log_tail = escape(_lastline(value.get_errorlog_file())).replace(':',':<br/>')
+                if error_log_tail:
+                    result+= _("Check the %(error_log)s for more details<br/>") % {
+                        'error_log': "<a target='_blank' href='%s'><i class='fas fa-file-lines'></i> %s</a>" % (value.get_errorlog(), _("error log")),
+                    }
+                
+                if www.settings.CONTACT_EMAIL:
+                    if error_log_tail:
+                        result+= "or "
+                        result+= _("contact %(email)s for more information.") % {
+                            'email': "<a href='mailto:%(email)s?subject=[MapOSMatic] Error on request %(id)d'><i class='fas fa-envelope'></i> %(email)s</a>" % {
+                                "email": www.settings.CONTACT_EMAIL,
+                                "id":    value.id
+                            }
+                        }
+                    
+                if error_log_tail:
+                    result+= "<hr/><tt>%s</tt>" % error_log_tail
+                    
+            result += _alert_end
+
+            return mark_safe(result)
+    elif value.status == 3:
+        if value.resultmsg == 'ok':
+            return mark_safe(_alert_info + str(_("Rendering is obsolete: the rendering was successful, but the files are no longer available.")) + _alert_end)
+        else:
+            return mark_safe(_alert_warn + str(_("Obsolete failed rendering: the rendering failed, and the incomplete files have been removed.")) + _alert_end)
+    elif value == 4:
+        return mark_safe(_alert_warn + str(_("The rendering was cancelled by the user.")) + _alert_end)
+
+    return ''
+
+

www/maposmatic/templatetags/l18n_tags.py

@@ -0,0 +1,16 @@
+import www.settings
+
+from .extratags import register
+
+import re
+
+@register.filter()
+def language_flag(value):
+    if value in www.settings.LANGUAGE_FLAGS:
+        if www.settings.LANGUAGE_FLAGS[value] != None:
+            return ("fi fi-%s" % www.settings.LANGUAGE_FLAGS[value])
+    return "fa fa-flag"
+
+@register.filter()
+def locale_base(value):
+    return re.sub('\..*', '', value)

www/maposmatic/templatetags/paper_tags.py

@@ -0,0 +1,18 @@
+import www.settings
+
+from .extratags import register
+
+import ocitysmap
+
+@register.filter()
+def paper_size(value):
+    w = value.paper_width_mm
+    h = value.paper_height_mm
+
+    oc = ocitysmap.OCitySMap(www.settings.OCITYSMAP_CFG_PATH)
+    size_name = oc.get_paper_size_name_by_size(w, h)
+
+    if size_name is None:
+        return "%d×%d mm²" % (w,h)
+    else:
+        return "%s (%d×%d mm²)" % (size_name, w, h)

www/maposmatic/templatetags/rss_feed_tags.py

@@ -0,0 +1,10 @@
+import www.settings
+
+from .extratags import register
+
+import datetime
+
+@register.filter()
+def feedparsed(value):
+    return datetime.datetime(*value[:6])
+