]> git.openstreetmap.org Git - chef.git/blobdiff - cookbooks/tile/templates/default/export.erb
Add copyright/attribution message to downloaded map images
[chef.git] / cookbooks / tile / templates / default / export.erb
index c05083835b43b28a65564001dd97957c39dfe071..eb35b13138c4cc7af4f8c55d9f22e0e36d5b79fc 100644 (file)
@@ -1,15 +1,20 @@
-#!/usr/bin/python -u
+#!/usr/bin/python3 -u
 # -*- coding: utf-8 -*-
 
 import cairo
 import cgi
+import http.cookies
 import mapnik
+import io
 import os
+import pyotp
+import pyproj
+import resource
 import shutil
+import signal
 import sys
 import tempfile
-import resource
-import signal
+from PIL import Image
 
 # Limit maximum CPU time
 # The Postscript output format can sometimes take hours
@@ -21,53 +26,171 @@ resource.setrlimit(resource.RLIMIT_AS,(4000000000, 4000000000))
 
 # Routine to output HTTP headers
 def output_headers(content_type, filename = "", length = 0):
-  print "Content-Type: %s" % content_type
+  print("Content-Type: %s" % content_type)
   if filename:
-    print "Content-Disposition: attachment; filename=\"%s\"" % filename
+    print("Content-Disposition: attachment; filename=\"%s\"" % filename)
   if length:
-    print "Content-Length: %d" % length
-  print ""
+    print("Content-Length: %d" % length)
+  print("")
 
 # Routine to output the contents of a file
 def output_file(file):
   file.seek(0)
-  shutil.copyfileobj(file, sys.stdout)
+  shutil.copyfileobj(file, sys.stdout.buffer)
 
 # Routine to get the size of a file
 def file_size(file):
   return os.fstat(file.fileno()).st_size
 
+# Routine to retrieve BytesIO payload length
+def bytesio_size(bio):
+  return bio.getbuffer().nbytes
+
 # Routine to report an error
 def output_error(message, status = "400 Bad Request"):
-  print "Status: %s" % status
+  print("Status: %s" % status)
   output_headers("text/html")
-  print "<html>"
-  print "<head>"
-  print "<title>Error</title>"
-  print "</head>"
-  print "<body>"
-  print "<h1>Error</h1>"
-  print "<p>%s</p>" % message
-  print "</body>"
-  print "</html>"
+  print("<html>")
+  print("<head>")
+  print("<title>Error</title>")
+  print("</head>")
+  print("<body>")
+  print("<h1>Error</h1>")
+  print("<p>%s</p>" % message)
+  print("</body>")
+  print("</html>")
+
+# Add a copyright notice for raster formats (PNG, JPEG, WEBP)
+def add_copyright_notice_raster(image, map_width, map_height, format):
+  # Convert the Mapnik image to PNG and store it in a BytesIO object
+  png = image.tostring("png")
+  png_io = io.BytesIO(png)
+
+  # Load the PNG data from the BytesIO object into a Cairo ImageSurface
+  surface = cairo.ImageSurface.create_from_png(png_io)
+
+  add_copyright_notice_vector(surface, map_width, map_height)
+
+  # Convert the Cairo surface to PNG in a BytesIO object
+  output_io = io.BytesIO()
+  surface.write_to_png(output_io)
+
+  if format == "png":
+    return output_io
+  else:
+    # Open the output PNG image for conversion to other formats
+    img = Image.open(output_io)
+    img_io = io.BytesIO()
+    img.save(img_io, format=format)
+    return img_io
+
+# Add a copyright notice for vector formats (SVG, PDF, PS)
+def add_copyright_notice_vector(surface, map_width, map_height):
+  context = cairo.Context(surface)
+
+  # Set the font for the copyright notice
+  context.set_font_face(cairo.ToyFontFace("DejaVu"))
+  context.set_font_size(14)
+
+  # Define the copyright text
+  text = "© OpenStreetMap contributors"
+
+  text_extents = context.text_extents(text)
+  text_width = text_extents.width
+  text_height = text_extents.height
+
+  x_margin = 10
+  y_margin = 10
+
+  # Position the text at the bottom-right corner
+  x_position = map_width - text_width - x_margin
+  y_position = map_height - text_height - y_margin
+
+  # Draw a white box just large enough to fit the text
+  context.set_source_rgba(1, 1, 1, 0.5)
+  context.rectangle(x_position - x_margin, y_position - y_margin,
+                    text_width + 2 * x_margin, text_height + 2 * y_margin)
+  context.fill_preserve()
+
+  context.set_source_rgb(0, 0, 0)  # Black color for the text
+  context.move_to(x_position - x_margin / 2, y_position + y_margin)
+  context.show_text(text)
+
+# Render and output map for raster formats (PNG, JPEG, WEBP)
+def render_and_output_image(map, format):
+  image = mapnik.Image(map.width, map.height)
+  mapnik.render(map, image)
+
+  bytes_io = add_copyright_notice_raster(image, map.width, map.height, format)
+
+  if format == "png":
+    output_headers("image/png", "map.png", bytesio_size(bytes_io))
+  elif format == "jpeg":
+    output_headers("image/jpeg", "map.jpg", bytesio_size(bytes_io))
+  elif format == "webp":
+    output_headers("image/webp", "map.webp", bytesio_size(bytes_io))
+
+  output_file(bytes_io)
+
+# Render and output map for vector formats (SVG, PDF, PS)
+def render_and_output_vector(map, format):
+  with tempfile.NamedTemporaryFile(prefix="export") as file:
+    if format == "svg":
+      surface = cairo.SVGSurface(file.name, map.width, map.height)
+      surface.restrict_to_version(cairo.SVG_VERSION_1_2)
+    elif format == "pdf":
+      surface = cairo.PDFSurface(file.name, map.width, map.height)
+    elif format == "ps":
+      surface = cairo.PSSurface(file.name, map.width, map.height)
+
+    mapnik.render(map, surface)
+
+    add_copyright_notice_vector(surface, map.width, map.height)
+
+    surface.finish()
+
+    if format == "svg":
+      output_headers("image/svg+xml", "map.svg", file_size(file))
+    elif format == "pdf":
+      output_headers("application/pdf", "map.pdf", file_size(file))
+    elif format == "ps":
+      output_headers("application/postscript", "map.ps", file_size(file))
+
+    output_file(file)
+
+
+# Create TOTP token validator
+totp = pyotp.TOTP('<%= @totp_key %>', interval = 3600)
 
 # Parse CGI parameters
 form = cgi.FieldStorage()
 
+# Import cookies
+cookies = http.cookies.SimpleCookie(os.environ.get('HTTP_COOKIE'))
+
 # Make sure we have a user agent
-if not os.environ.has_key('HTTP_USER_AGENT'):
+if 'HTTP_USER_AGENT' not in os.environ:
   os.environ['HTTP_USER_AGENT'] = 'NONE'
 
 # Make sure we have a referer
-if not os.environ.has_key('HTTP_REFERER'):
+if 'HTTP_REFERER' not in os.environ:
   os.environ['HTTP_REFERER'] = 'NONE'
 
+# Look for TOTP token
+if '_osm_totp_token' in cookies:
+  token = cookies['_osm_totp_token'].value
+else:
+  token = None
+
 # Get the load average
 cputimes = [float(n) for n in open("/proc/stat").readline().rstrip().split()[1:-1]]
 idletime = cputimes[3] / sum(cputimes)
 
 # Process the request
-if idletime < 0.2:
+if not totp.verify(token, valid_window = 1):
+  # Abort if the request didn't have a valid TOTP token
+  output_error("Missing or invalid token")
+elif idletime < 0.2:
   # Abort if the CPU idle time on the machine is too low
   output_error("The server is too busy at the moment. Please wait a few minutes before trying again.", "503 Service Unavailable")
 <% @blocks["user_agents"].each do |user_agent| -%>
@@ -80,18 +203,18 @@ elif os.environ['HTTP_REFERER'] == '<%= referer %>':
   # Block scraper
   output_error("The server is too busy at the moment. Please wait a few minutes before trying again.", "503 Service Unavailable")
 <% end -%>
-elif not form.has_key("bbox"):
+elif "bbox" not in form:
   # No bounding box specified
   output_error("No bounding box specified")
-elif not form.has_key("scale"):
+elif "scale" not in form:
   # No scale specified
   output_error("No scale specified")
-elif not form.has_key("format"):
+elif "format" not in form:
   # No format specified
   output_error("No format specified")
 else:
   # Create projection object
-  prj = mapnik.Projection("+proj=merc +a=6378137 +b=6378137 +lat_ts=0.0 +lon_0=0.0 +x_0=0.0 +y_0=0 +k=1.0 +units=m +nadgrids=@null +no_defs +over");
+  transformer = pyproj.Transformer.from_crs("EPSG:4326", "EPSG:3857", always_xy=True)
 
   # Get the bounds of the area to render
   bbox = [float(x) for x in form.getvalue("bbox").split(",")]
@@ -101,7 +224,8 @@ else:
     output_error("Invalid bounding box")
   else:
     # Project the bounds to the map projection
-    bbox = mapnik.forward_(mapnik.Box2d(*bbox), prj)
+    bbox = mapnik.Box2d(*transformer.transform(bbox[0], bbox[1]),
+                        *transformer.transform(bbox[2], bbox[3]))
 
     # Get the style to use
     style = form.getvalue("style", "default")
@@ -130,41 +254,13 @@ else:
 
       # Render the map
       if pid == 0:
-        if form.getvalue("format") == "png":
-          image = mapnik.Image(map.width, map.height)
-          mapnik.render(map, image)
-          png = image.tostring("png")
-          output_headers("image/png", "map.png", len(png))
-          sys.stdout.write(png)
-        elif form.getvalue("format") == "jpeg":
-          image = mapnik.Image(map.width, map.height)
-          mapnik.render(map, image)
-          jpeg = image.tostring("jpeg")
-          output_headers("image/jpeg", "map.jpg", len(jpeg))
-          sys.stdout.write(jpeg)
-        elif form.getvalue("format") == "svg":
-          file = tempfile.NamedTemporaryFile(prefix = "export")
-          surface = cairo.SVGSurface(file.name, map.width, map.height)
-          mapnik.render(map, surface)
-          surface.finish()
-          output_headers("image/svg+xml", "map.svg", file_size(file))
-          output_file(file)
-        elif form.getvalue("format") == "pdf":
-          file = tempfile.NamedTemporaryFile(prefix = "export")
-          surface = cairo.PDFSurface(file.name, map.width, map.height)
-          mapnik.render(map, surface)
-          surface.finish()
-          output_headers("application/pdf", "map.pdf", file_size(file))
-          output_file(file)
-        elif form.getvalue("format") == "ps":
-          file = tempfile.NamedTemporaryFile(prefix = "export")
-          surface = cairo.PSSurface(file.name, map.width, map.height)
-          mapnik.render(map, surface)
-          surface.finish()
-          output_headers("application/postscript", "map.ps", file_size(file))
-          output_file(file)
+        format = form.getvalue("format")
+        if format in ["png", "jpeg", "webp"]:
+          render_and_output_image(map, format)
+        elif format in ["svg", "pdf", "ps"]:
+          render_and_output_vector(map, format)
         else:
-          output_error("Unknown format '%s'" % form.getvalue("format"))
+          output_error("Unknown format")
       else:
         pid, status = os.waitpid(pid, 0)
         if status & 0xff == signal.SIGXCPU: