'use strict'; import fsp from 'node:fs/promises'; import path from 'path'; 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, 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 = { /** * 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'); /** * 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} */ 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} */ app.get('/:id/elevation/:z/:x/:y', async (req, res, next) => { try { if (verbose) { console.log( `Handling elevation request for: /data/${req.params.id}/elevation/${req.params.z}/${req.params.x}/${req.params.y}`, ); } 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.'); } 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.'); } 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.'); } 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 = 256; let tileCenter; let xy; if (Number.isInteger(x) && Number.isInteger(y)) { const intX = parseInt(req.params.x, 10); const intY = parseInt(req.params.y, 10); if ( z < tileJSON.minzoom || z > tileJSON.maxzoom || intX < 0 || intY < 0 || intX >= Math.pow(2, z) || intY >= Math.pow(2, z) ) { return res.status(404).send('Out of bounds'); } xy = [intX, intY]; tileCenter = new SphericalMercator().bbox(intX, intY, z); } else { if ( z < tileJSON.minzoom || z > tileJSON.maxzoom || x < -180 || y < -90 || x > 180 || y > 90 ) { return res.status(404).send('Out of bounds'); } tileCenter = [y, x, y + 0.1, x + 0.1]; const { minX, minY } = new SphericalMercator().xyz(tileCenter, z); xy = [minX, minY]; } const fetchTile = await fetchTileData(source, sourceType, z, x, y); 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 imgdata = context.getImageData(0, 0, TILE_SIZE, TILE_SIZE); const arrayWidth = imgdata.width; const arrayHeight = imgdata.height; const bytesPerPixel = 4; const xPixel = Math.floor(xy[0]); const yPixel = Math.floor(xy[1]); if ( xPixel < 0 || yPixel < 0 || xPixel >= arrayWidth || yPixel >= arrayHeight ) { return reject('Out of bounds Pixel'); } const index = (yPixel * arrayWidth + xPixel) * bytesPerPixel; const red = imgdata.data[index]; const green = imgdata.data[index + 1]; const blue = imgdata.data[index + 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 { elevation = 'invalid encoding'; } resolve( res.status(200).send({ z, x: xy[0], y: xy[1], red, green, blue, latitude: tileCenter[0], longitude: tileCenter[1], 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); } }); /** * 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} */ app.get('/:id.json', (req, res) => { if (verbose) { console.log( `Handling tilejson request for: /data/${req.params.id}.json`, ); } const item = repo[req.params.id]; if (!item) { return res.sendStatus(404); } const tileSize = undefined; const info = clone(item.tileJSON); info.tiles = getTileUrls( req, info.tiles, `data/${req.params.id}`, tileSize, info.format, item.publicUrl, { pbf: options.pbfAlias, }, ); return res.send(info); }); return app; }, /** * 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} */ add: async function (options, repo, params, id, programOpts) { const { publicUrl } = programOpts; let inputFile; let inputType; if (params.pmtiles) { inputType = 'pmtiles'; if (isValidHttpUrl(params.pmtiles)) { inputFile = params.pmtiles; } else { inputFile = path.resolve(options.paths.pmtiles, params.pmtiles); } } else if (params.mbtiles) { inputType = 'mbtiles'; if (isValidHttpUrl(params.mbtiles)) { console.log( `ERROR: MBTiles does not support web based files. "${params.mbtiles}" is not a valid data file.`, ); process.exit(1); } else { inputFile = path.resolve(options.paths.mbtiles, params.mbtiles); } } let tileJSON = { tiles: params.domains || options.domains, }; if (!isValidHttpUrl(inputFile)) { const inputFileStats = await fsp.stat(inputFile); if (!inputFileStats.isFile() || inputFileStats.size === 0) { throw Error(`Not valid input file: "${inputFile}"`); } } let source; let sourceType; if (inputType === 'pmtiles') { source = openPMtiles(inputFile); sourceType = 'pmtiles'; const metadata = await getPMtilesInfo(source); tileJSON['encoding'] = params['encoding']; tileJSON['name'] = id; tileJSON['format'] = 'pbf'; Object.assign(tileJSON, metadata); tileJSON['tilejson'] = '2.0.0'; delete tileJSON['filesize']; delete tileJSON['mtime']; delete tileJSON['scheme']; Object.assign(tileJSON, params.tilejson || {}); fixTileJSONCenter(tileJSON); if (options.dataDecoratorFunc) { tileJSON = options.dataDecoratorFunc(id, 'tilejson', tileJSON); } } else if (inputType === 'mbtiles') { sourceType = 'mbtiles'; const mbw = await openMbTilesWrapper(inputFile); const info = await mbw.getInfo(); source = mbw.getMbTiles(); tileJSON['encoding'] = params['encoding']; tileJSON['name'] = id; tileJSON['format'] = 'pbf'; Object.assign(tileJSON, info); tileJSON['tilejson'] = '2.0.0'; delete tileJSON['filesize']; delete tileJSON['mtime']; delete tileJSON['scheme']; Object.assign(tileJSON, params.tilejson || {}); fixTileJSONCenter(tileJSON); if (options.dataDecoratorFunc) { tileJSON = options.dataDecoratorFunc(id, 'tilejson', tileJSON); } } repo[id] = { tileJSON, publicUrl, source, sourceType, }; }, };