tileserver-gl-light 5.0.0 → 5.1.0-pre.1

package/src/serve_data.js

@@ -7,162 +7,340 @@ import clone from 'clone';
 import express from 'express';
 import Pbf from 'pbf';
 import { VectorTile } from '@mapbox/vector-tile';
+import SphericalMercator from '@mapbox/sphericalmercator';
+import { Image, createCanvas } from 'canvas';
+import sharp from 'sharp';
 
-import { fixTileJSONCenter, getTileUrls, isValidHttpUrl } from './utils.js';
 import {
-  getPMtilesInfo,
-  getPMtilesTile,
-  openPMtiles,
-} from './pmtiles_adapter.js';
+  fixTileJSONCenter,
+  getTileUrls,
+  isValidHttpUrl,
+  fetchTileData,
+} from './utils.js';
+import { getPMtilesInfo, openPMtiles } from './pmtiles_adapter.js';
 import { gunzipP, gzipP } from './promises.js';
 import { openMbTilesWrapper } from './mbtiles_wrapper.js';
 
 export const serve_data = {
-  init: (options, repo) => {
+  /**
+   * Initializes the serve_data module.
+   * @param {object} options Configuration options.
+   * @param {object} repo Repository object.
+   * @param {object} programOpts - An object containing the program options
+   * @returns {express.Application} The initialized Express application.
+   */
+  init: function (options, repo, programOpts) {
+    const { verbose } = programOpts;
     const app = express().disable('x-powered-by');
 
-    app.get(
-      '/:id/:z(\\d+)/:x(\\d+)/:y(\\d+).:format([\\w.]+)',
-      async (req, res, next) => {
-        const item = repo[req.params.id];
-        if (!item) {
-          return res.sendStatus(404);
+    /**
+     * Handles requests for tile data, responding with the tile image.
+     * @param {object} req - Express request object.
+     * @param {object} res - Express response object.
+     * @param {string} req.params.id - ID of the tile.
+     * @param {string} req.params.z - Z coordinate of the tile.
+     * @param {string} req.params.x - X coordinate of the tile.
+     * @param {string} req.params.y - Y coordinate of the tile.
+     * @param {string} req.params.format - Format of the tile.
+     * @returns {Promise<void>}
+     */
+    app.get('/:id/:z/:x/:y.:format', async (req, res) => {
+      if (verbose) {
+        console.log(
+          `Handling tile request for: /data/%s/%s/%s/%s.%s`,
+          String(req.params.id).replace(/\n|\r/g, ''),
+          String(req.params.z).replace(/\n|\r/g, ''),
+          String(req.params.x).replace(/\n|\r/g, ''),
+          String(req.params.y).replace(/\n|\r/g, ''),
+          String(req.params.format).replace(/\n|\r/g, ''),
+        );
+      }
+      const item = repo[req.params.id];
+      if (!item) {
+        return res.sendStatus(404);
+      }
+      const tileJSONFormat = item.tileJSON.format;
+      const z = parseInt(req.params.z, 10);
+      const x = parseInt(req.params.x, 10);
+      const y = parseInt(req.params.y, 10);
+      if (isNaN(z) || isNaN(x) || isNaN(y)) {
+        return res.status(404).send('Invalid Tile');
+      }
+
+      let format = req.params.format;
+      if (format === options.pbfAlias) {
+        format = 'pbf';
+      }
+      if (
+        format !== tileJSONFormat &&
+        !(format === 'geojson' && tileJSONFormat === 'pbf')
+      ) {
+        return res.status(404).send('Invalid format');
+      }
+      if (
+        z < item.tileJSON.minzoom ||
+        x < 0 ||
+        y < 0 ||
+        z > item.tileJSON.maxzoom ||
+        x >= Math.pow(2, z) ||
+        y >= Math.pow(2, z)
+      ) {
+        return res.status(404).send('Out of bounds');
+      }
+
+      const fetchTile = await fetchTileData(
+        item.source,
+        item.sourceType,
+        z,
+        x,
+        y,
+      );
+      if (fetchTile == null) return res.status(204).send();
+
+      let data = fetchTile.data;
+      let headers = fetchTile.headers;
+      let isGzipped = data.slice(0, 2).indexOf(Buffer.from([0x1f, 0x8b])) === 0;
+
+      if (tileJSONFormat === 'pbf') {
+        if (options.dataDecoratorFunc) {
+          if (isGzipped) {
+            data = await gunzipP(data);
+            isGzipped = false;
+          }
+          data = options.dataDecoratorFunc(
+            req.params.id,
+            'data',
+            data,
+            z,
+            x,
+            y,
+          );
+        }
+      }
+
+      if (format === 'pbf') {
+        headers['Content-Type'] = 'application/x-protobuf';
+      } else if (format === 'geojson') {
+        headers['Content-Type'] = 'application/json';
+        const tile = new VectorTile(new Pbf(data));
+        const geojson = {
+          type: 'FeatureCollection',
+          features: [],
+        };
+        for (const layerName in tile.layers) {
+          const layer = tile.layers[layerName];
+          for (let i = 0; i < layer.length; i++) {
+            const feature = layer.feature(i);
+            const featureGeoJSON = feature.toGeoJSON(x, y, z);
+            featureGeoJSON.properties.layer = layerName;
+            geojson.features.push(featureGeoJSON);
+          }
+        }
+        data = JSON.stringify(geojson);
+      }
+      if (headers) {
+        delete headers['ETag'];
+      }
+      headers['Content-Encoding'] = 'gzip';
+      res.set(headers);
+
+      if (!isGzipped) {
+        data = await gzipP(data);
+      }
+
+      return res.status(200).send(data);
+    });
+
+    /**
+     * Handles requests for elevation data.
+     * @param {object} req - Express request object.
+     * @param {object} res - Express response object.
+     * @param {string} req.params.id - ID of the elevation data.
+     * @param {string} req.params.z - Z coordinate of the tile.
+     * @param {string} req.params.x - X coordinate of the tile (either integer or float).
+     * @param {string} req.params.y - Y coordinate of the tile (either integer or float).
+     * @returns {Promise<void>}
+     */
+    app.get('/:id/elevation/:z/:x/:y', async (req, res, next) => {
+      try {
+        if (verbose) {
+          console.log(
+            `Handling elevation request for: /data/%s/elevation/%s/%s/%s`,
+            String(req.params.id).replace(/\n|\r/g, ''),
+            String(req.params.z).replace(/\n|\r/g, ''),
+            String(req.params.x).replace(/\n|\r/g, ''),
+            String(req.params.y).replace(/\n|\r/g, ''),
+          );
         }
-        const tileJSONFormat = item.tileJSON.format;
-        const z = req.params.z | 0;
-        const x = req.params.x | 0;
-        const y = req.params.y | 0;
-        let format = req.params.format;
-        if (format === options.pbfAlias) {
-          format = 'pbf';
+        const item = repo?.[req.params.id];
+        if (!item) return res.sendStatus(404);
+        if (!item.source) return res.status(404).send('Missing source');
+        if (!item.tileJSON) return res.status(404).send('Missing tileJSON');
+        if (!item.sourceType) return res.status(404).send('Missing sourceType');
+        const { source, tileJSON, sourceType } = item;
+        if (sourceType !== 'pmtiles' && sourceType !== 'mbtiles') {
+          return res
+            .status(400)
+            .send('Invalid sourceType. Must be pmtiles or mbtiles.');
         }
-        if (
-          format !== tileJSONFormat &&
-          !(format === 'geojson' && tileJSONFormat === 'pbf')
-        ) {
-          return res.status(404).send('Invalid format');
+        const encoding = tileJSON?.encoding;
+        if (encoding == null) {
+          return res.status(400).send('Missing tileJSON.encoding');
+        } else if (encoding !== 'terrarium' && encoding !== 'mapbox') {
+          return res
+            .status(400)
+            .send('Invalid encoding. Must be terrarium or mapbox.');
         }
-        if (
-          z < item.tileJSON.minzoom ||
-          0 ||
-          x < 0 ||
-          y < 0 ||
-          z > item.tileJSON.maxzoom ||
-          x >= Math.pow(2, z) ||
-          y >= Math.pow(2, z)
-        ) {
-          return res.status(404).send('Out of bounds');
+        const format = tileJSON?.format;
+        if (format == null) {
+          return res.status(400).send('Missing tileJSON.format');
+        } else if (format !== 'webp' && format !== 'png') {
+          return res.status(400).send('Invalid format. Must be webp or png.');
         }
-        if (item.sourceType === 'pmtiles') {
-          let tileinfo = await getPMtilesTile(item.source, z, x, y);
-          if (tileinfo == undefined || tileinfo.data == undefined) {
-            return res.status(404).send('Not found');
-          } else {
-            let data = tileinfo.data;
-            let headers = tileinfo.header;
-            if (tileJSONFormat === 'pbf') {
-              if (options.dataDecoratorFunc) {
-                data = options.dataDecoratorFunc(id, 'data', data, z, x, y);
-              }
-            }
-            if (format === 'pbf') {
-              headers['Content-Type'] = 'application/x-protobuf';
-            } else if (format === 'geojson') {
-              headers['Content-Type'] = 'application/json';
-              const tile = new VectorTile(new Pbf(data));
-              const geojson = {
-                type: 'FeatureCollection',
-                features: [],
-              };
-              for (const layerName in tile.layers) {
-                const layer = tile.layers[layerName];
-                for (let i = 0; i < layer.length; i++) {
-                  const feature = layer.feature(i);
-                  const featureGeoJSON = feature.toGeoJSON(x, y, z);
-                  featureGeoJSON.properties.layer = layerName;
-                  geojson.features.push(featureGeoJSON);
-                }
-              }
-              data = JSON.stringify(geojson);
-            }
-            delete headers['ETag']; // do not trust the tile ETag -- regenerate
-            headers['Content-Encoding'] = 'gzip';
-            res.set(headers);
-
-            data = await gzipP(data);
+        const z = parseInt(req.params.z, 10);
+        const x = parseFloat(req.params.x);
+        const y = parseFloat(req.params.y);
+        if (tileJSON.minzoom == null || tileJSON.maxzoom == null) {
+          return res.status(404).send(JSON.stringify(tileJSON));
+        }
+        const TILE_SIZE = tileJSON.tileSize || 512;
+        let bbox;
+        let xy;
+        var zoom = z;
 
-            return res.status(200).send(data);
+        if (Number.isInteger(x) && Number.isInteger(y)) {
+          const intX = parseInt(req.params.x, 10);
+          const intY = parseInt(req.params.y, 10);
+          if (
+            zoom < tileJSON.minzoom ||
+            zoom > tileJSON.maxzoom ||
+            intX < 0 ||
+            intY < 0 ||
+            intX >= Math.pow(2, zoom) ||
+            intY >= Math.pow(2, zoom)
+          ) {
+            return res.status(404).send('Out of bounds');
           }
-        } else if (item.sourceType === 'mbtiles') {
-          item.source.getTile(z, x, y, async (err, data, headers) => {
-            let isGzipped;
-            if (err) {
-              if (/does not exist/.test(err.message)) {
-                return res.status(204).send();
-              } else {
-                return res
-                  .status(500)
-                  .header('Content-Type', 'text/plain')
-                  .send(err.message);
-              }
+          xy = [intX, intY];
+          bbox = new SphericalMercator().bbox(intX, intY, zoom);
+        } else {
+          //no zoom limit with coordinates
+          if (zoom < tileJSON.minzoom) {
+            zoom = tileJSON.minzoom;
+          }
+          if (zoom > tileJSON.maxzoom) {
+            zoom = tileJSON.maxzoom;
+          }
+          bbox = [x, y, x + 0.1, y + 0.1];
+          const { minX, minY } = new SphericalMercator().xyz(bbox, zoom);
+          xy = [minX, minY];
+        }
+
+        const fetchTile = await fetchTileData(
+          source,
+          sourceType,
+          zoom,
+          xy[0],
+          xy[1],
+        );
+        if (fetchTile == null) return res.status(204).send();
+
+        let data = fetchTile.data;
+        const image = new Image();
+        await new Promise(async (resolve, reject) => {
+          image.onload = async () => {
+            const canvas = createCanvas(TILE_SIZE, TILE_SIZE);
+            const context = canvas.getContext('2d');
+            context.drawImage(image, 0, 0);
+            const long = bbox[0];
+            const lat = bbox[1];
+
+            // calculate pixel coordinate of tile,
+            // see https://developers.google.com/maps/documentation/javascript/examples/map-coordinates
+            let siny = Math.sin((lat * Math.PI) / 180);
+            // Truncating to 0.9999 effectively limits latitude to 89.189. This is
+            // about a third of a tile past the edge of the world tile.
+            siny = Math.min(Math.max(siny, -0.9999), 0.9999);
+            const xWorld = TILE_SIZE * (0.5 + long / 360);
+            const yWorld =
+              TILE_SIZE *
+              (0.5 - Math.log((1 + siny) / (1 - siny)) / (4 * Math.PI));
+
+            const scale = 1 << zoom;
+
+            const xTile = Math.floor((xWorld * scale) / TILE_SIZE);
+            const yTile = Math.floor((yWorld * scale) / TILE_SIZE);
+
+            const xPixel = Math.floor(xWorld * scale) - xTile * TILE_SIZE;
+            const yPixel = Math.floor(yWorld * scale) - yTile * TILE_SIZE;
+            if (
+              xPixel < 0 ||
+              yPixel < 0 ||
+              xPixel >= TILE_SIZE ||
+              yPixel >= TILE_SIZE
+            ) {
+              return reject('Out of bounds Pixel');
+            }
+            const imgdata = context.getImageData(xPixel, yPixel, 1, 1);
+            const red = imgdata.data[0];
+            const green = imgdata.data[1];
+            const blue = imgdata.data[2];
+            let elevation;
+            if (encoding === 'mapbox') {
+              elevation = -10000 + (red * 256 * 256 + green * 256 + blue) * 0.1;
+            } else if (encoding === 'terrarium') {
+              elevation = red * 256 + green + blue / 256 - 32768;
             } else {
-              if (data == null) {
-                return res.status(404).send('Not found');
-              } else {
-                if (tileJSONFormat === 'pbf') {
-                  isGzipped =
-                    data.slice(0, 2).indexOf(Buffer.from([0x1f, 0x8b])) === 0;
-                  if (options.dataDecoratorFunc) {
-                    if (isGzipped) {
-                      data = await gunzipP(data);
-                      isGzipped = false;
-                    }
-                    data = options.dataDecoratorFunc(id, 'data', data, z, x, y);
-                  }
-                }
-                if (format === 'pbf') {
-                  headers['Content-Type'] = 'application/x-protobuf';
-                } else if (format === 'geojson') {
-                  headers['Content-Type'] = 'application/json';
-
-                  if (isGzipped) {
-                    data = await gunzipP(data);
-                    isGzipped = false;
-                  }
-
-                  const tile = new VectorTile(new Pbf(data));
-                  const geojson = {
-                    type: 'FeatureCollection',
-                    features: [],
-                  };
-                  for (const layerName in tile.layers) {
-                    const layer = tile.layers[layerName];
-                    for (let i = 0; i < layer.length; i++) {
-                      const feature = layer.feature(i);
-                      const featureGeoJSON = feature.toGeoJSON(x, y, z);
-                      featureGeoJSON.properties.layer = layerName;
-                      geojson.features.push(featureGeoJSON);
-                    }
-                  }
-                  data = JSON.stringify(geojson);
-                }
-                delete headers['ETag']; // do not trust the tile ETag -- regenerate
-                headers['Content-Encoding'] = 'gzip';
-                res.set(headers);
-
-                if (!isGzipped) {
-                  data = await gzipP(data);
-                }
-
-                return res.status(200).send(data);
-              }
+              elevation = 'invalid encoding';
             }
-          });
-        }
-      },
-    );
+            resolve(
+              res.status(200).send({
+                z: zoom,
+                x: xy[0],
+                y: xy[1],
+                red,
+                green,
+                blue,
+                latitude: lat,
+                longitude: long,
+                elevation,
+              }),
+            );
+          };
+          image.onerror = (err) => reject(err);
+          if (format === 'webp') {
+            try {
+              const img = await sharp(data).toFormat('png').toBuffer();
+              image.src = img;
+            } catch (err) {
+              reject(err);
+            }
+          } else {
+            image.src = data;
+          }
+        });
+      } catch (err) {
+        return res
+          .status(500)
+          .header('Content-Type', 'text/plain')
+          .send(err.message);
+      }
+    });
 
-    app.get('/:id.json', (req, res, next) => {
+    /**
+     * Handles requests for tilejson for the data tiles.
+     * @param {object} req - Express request object.
+     * @param {object} res - Express response object.
+     * @param {string} req.params.id - ID of the data source.
+     * @returns {Promise<void>}
+     */
+    app.get('/:id.json', (req, res) => {
+      if (verbose) {
+        console.log(
+          `Handling tilejson request for: /data/%s.json`,
+          String(req.params.id).replace(/\n|\r/g, ''),
+        );
+      }
       const item = repo[req.params.id];
       if (!item) {
         return res.sendStatus(404);
@@ -185,7 +363,20 @@ export const serve_data = {
 
     return app;
   },
-  add: async (options, repo, params, id, publicUrl) => {
+  /**
+   * Adds a new data source to the repository.
+   * @param {object} options Configuration options.
+   * @param {object} repo Repository object.
+   * @param {object} params Parameters object.
+   * @param {string} id ID of the data source.
+   * @param {object} programOpts - An object containing the program options
+   * @param {string} programOpts.publicUrl Public URL for the data.
+   * @param {boolean} programOpts.verbose Whether verbose logging should be used.
+   * @param {Function} dataResolver Function to resolve data.
+   * @returns {Promise<void>}
+   */
+  add: async function (options, repo, params, id, programOpts) {
+    const { publicUrl } = programOpts;
     let inputFile;
     let inputType;
     if (params.pmtiles) {
@@ -225,6 +416,8 @@ export const serve_data = {
       sourceType = 'pmtiles';
       const metadata = await getPMtilesInfo(source);
 
+      tileJSON['encoding'] = params['encoding'];
+      tileJSON['tileSize'] = params['tileSize'];
       tileJSON['name'] = id;
       tileJSON['format'] = 'pbf';
       Object.assign(tileJSON, metadata);
@@ -245,6 +438,8 @@ export const serve_data = {
       const mbw = await openMbTilesWrapper(inputFile);
       const info = await mbw.getInfo();
       source = mbw.getMbTiles();
+      tileJSON['encoding'] = params['encoding'];
+      tileJSON['tileSize'] = params['tileSize'];
       tileJSON['name'] = id;
       tileJSON['format'] = 'pbf';
 

package/src/serve_font.js

@@ -4,7 +4,15 @@ import express from 'express';
 
 import { getFontsPbf, listFonts } from './utils.js';
 
-export const serve_font = async (options, allowedFonts) => {
+/**
+ * Initializes and returns an Express app that serves font files.
+ * @param {object} options - Configuration options for the server.
+ * @param {object} allowedFonts - An object containing allowed fonts.
+ * @param {object} programOpts - An object containing the program options.
+ * @returns {Promise<express.Application>} - A promise that resolves to the Express app.
+ */
+export async function serve_font(options, allowedFonts, programOpts) {
+  const { verbose } = programOpts;
   const app = express().disable('x-powered-by');
 
   const lastModified = new Date().toUTCString();
@@ -13,31 +21,74 @@ export const serve_font = async (options, allowedFonts) => {
 
   const existingFonts = {};
 
-  app.get(
-    '/fonts/:fontstack/:range([\\d]+-[\\d]+).pbf',
-    async (req, res, next) => {
-      const fontstack = decodeURI(req.params.fontstack);
-      const range = req.params.range;
-
-      try {
-        const concatenated = await getFontsPbf(
-          options.serveAllFonts ? null : allowedFonts,
-          fontPath,
-          fontstack,
-          range,
-          existingFonts,
-        );
-
-        res.header('Content-type', 'application/x-protobuf');
-        res.header('Last-Modified', lastModified);
-        return res.send(concatenated);
-      } catch (err) {
-        res.status(400).header('Content-Type', 'text/plain').send(err);
+  /**
+   * Handles requests for a font file.
+   * @param {object} req - Express request object.
+   * @param {object} res - Express response object.
+   * @param {string} req.params.fontstack - Name of the font stack.
+   * @param {string} req.params.range - The range of the font (e.g. 0-255).
+   * @returns {Promise<void>}
+   */
+  app.get('/fonts/:fontstack/:range.pbf', async (req, res) => {
+    const sRange = String(req.params.range).replace(/\n|\r/g, '');
+    const sFontStack = String(decodeURI(req.params.fontstack)).replace(
+      /\n|\r/g,
+      '',
+    );
+
+    if (verbose) {
+      console.log(
+        `Handling font request for: /fonts/%s/%s.pbf`,
+        sFontStack,
+        sRange,
+      );
+    }
+
+    const modifiedSince = req.get('if-modified-since');
+    const cc = req.get('cache-control');
+    if (modifiedSince && (!cc || cc.indexOf('no-cache') === -1)) {
+      if (
+        new Date(lastModified).getTime() === new Date(modifiedSince).getTime()
+      ) {
+        return res.sendStatus(304);
       }
-    },
-  );
+    }
+
+    try {
+      const concatenated = await getFontsPbf(
+        options.serveAllFonts ? null : allowedFonts,
+        fontPath,
+        sFontStack,
+        sRange,
+        existingFonts,
+      );
+      res.header('Content-type', 'application/x-protobuf');
+      res.header('Last-Modified', lastModified);
+      return res.send(concatenated);
+    } catch (err) {
+      console.error(
+        `Error serving font: %s/%s.pbf, Error: %s`,
+        sFontStack,
+        sRange,
+        String(err),
+      );
+      return res
+        .status(400)
+        .header('Content-Type', 'text/plain')
+        .send('Error serving font');
+    }
+  });
 
-  app.get('/fonts.json', (req, res, next) => {
+  /**
+   * Handles requests for a list of all available fonts.
+   * @param {object} req - Express request object.
+   * @param {object} res - Express response object.
+   * @returns {void}
+   */
+  app.get('/fonts.json', (req, res) => {
+    if (verbose) {
+      console.log('Handling list font request for /fonts.json');
+    }
     res.header('Content-type', 'application/json');
     return res.send(
       Object.keys(options.serveAllFonts ? existingFonts : allowedFonts).sort(),
@@ -47,4 +98,4 @@ export const serve_font = async (options, allowedFonts) => {
   const fonts = await listFonts(options.paths.fonts);
   Object.assign(existingFonts, fonts);
   return app;
-};
+}

package/src/serve_light.js

@@ -3,7 +3,7 @@
 'use strict';
 
 export const serve_rendered = {
-  init: (options, repo) => {},
-  add: (options, repo, params, id, publicUrl, dataResolver) => {},
+  init: (options, repo, programOpts) => {},
+  add: (options, repo, params, id, programOpts, dataResolver) => {},
   remove: (repo, id) => {},
 };