@basemaps/lambda-tiler 6.29.0 → 6.32.0

package/src/util/swapping.lru.ts

@@ -0,0 +1,63 @@
+export class SwappingLru<T extends { size: number }> {
+  cacheA: Map<string, T> = new Map();
+  cacheB: Map<string, T> = new Map();
+  maxSize: number;
+
+  hits = 0;
+  misses = 0;
+  resets = 0;
+
+  _lastCheckedAt = -1;
+
+  constructor(maxSize: number) {
+    this.maxSize = maxSize;
+  }
+
+  get(id: string): T | null {
+    const cacheA = this.cacheA.get(id);
+    if (cacheA) {
+      this.hits++;
+      return cacheA;
+    }
+
+    const cacheB = this.cacheB.get(id);
+    if (cacheB == null) {
+      this.misses++;
+      return null;
+    }
+
+    this.hits++;
+    // If a object is still useful move it into the main cache
+    this.cacheA.set(id, cacheB);
+    this.cacheB.delete(id);
+    return cacheB;
+  }
+
+  /** Reset the cache */
+  clear(): void {
+    this.cacheA.clear();
+    this.cacheB.clear();
+  }
+
+  set(id: string, tiff: T): void {
+    this.cacheA.set(id, tiff);
+    this.check();
+  }
+
+  /** Validate the size of the cache has not exploded */
+  check(): void {
+    this._lastCheckedAt = Date.now();
+    if (this.maxSize <= 0) return;
+    if (this.currentSize <= this.maxSize) return;
+    this.resets++;
+    this.cacheB = this.cacheA;
+    this.cacheA = new Map();
+  }
+
+  /** Calculate the total number of bytes used by this cache */
+  get currentSize(): number {
+    let size = 0;
+    for (const value of this.cacheA.values()) size += value.size;
+    return size;
+  }
+}

package/src/util/validate.ts

@@ -0,0 +1,126 @@
+import { ImageFormat, TileMatrixSet, TileMatrixSets, VectorFormat } from '@basemaps/geo';
+import { Const, Projection } from '@basemaps/shared';
+import { getImageFormat } from '@basemaps/tiler';
+import { LambdaHttpRequest, LambdaHttpResponse } from '@linzjs/lambda';
+import * as ulid from 'ulid';
+import { TileXyzGet } from '../routes/tile.xyz';
+
+export interface TileXyz {
+  tile: { x: number; y: number; z: number };
+  tileSet: string;
+  tileMatrix: TileMatrixSet;
+  tileType: VectorFormat | ImageFormat;
+}
+
+export interface TileMatrixRequest {
+  Params: { tileMatrix?: string };
+}
+
+const OneHourMs = 60 * 60 * 1000;
+const OneDayMs = 24 * OneHourMs;
+const MaxApiAgeMs = 91 * OneDayMs;
+
+export interface ApiKeyStatus {
+  valid: boolean;
+  message: 'ok' | 'malformed' | 'missing' | 'expired';
+}
+
+export function isValidApiKey(apiKey?: string | null): ApiKeyStatus {
+  if (apiKey == null) return { valid: false, message: 'missing' };
+  if (!apiKey.startsWith('c') && !apiKey.startsWith('d')) return { valid: false, message: 'malformed' };
+  const ulidId = apiKey.slice(1).toUpperCase();
+  try {
+    const ulidTime = ulid.decodeTime(ulidId);
+    if (apiKey.startsWith('d')) return { valid: true, message: 'ok' };
+
+    if (Date.now() - ulidTime > MaxApiAgeMs) return { valid: false, message: 'expired' };
+  } catch (e) {
+    return { valid: false, message: 'malformed' };
+  }
+
+  return { valid: true, message: 'ok' };
+}
+
+export const Validate = {
+  /**
+   * Validate that the api key exists and is valid
+   * @throws if api key is not valid
+   */
+  apiKey(req: LambdaHttpRequest): string {
+    const apiKey = req.query.get(Const.ApiKey.QueryString) ?? req.header('X-LINZ-Api-Key');
+    const valid = isValidApiKey(apiKey);
+
+    if (!valid.valid) throw new LambdaHttpResponse(400, 'API Key Invalid: ' + valid.message);
+    req.set('api', apiKey);
+    return apiKey as string;
+  },
+
+  getTileMatrixSet(str?: string): TileMatrixSet | null {
+    return TileMatrixSets.find(str);
+  },
+
+  /** Read in all image formats specified in the query parameters "format" or "tileFormat" */
+  getRequestedFormats(req: LambdaHttpRequest): ImageFormat[] | null {
+    const formats = [...req.query.getAll('format'), ...req.query.getAll('tileFormat')];
+    if (formats.length === 0) return null;
+
+    const output: Set<ImageFormat> = new Set();
+    for (const fmt of formats) {
+      const parsed = getImageFormat(fmt);
+      if (parsed == null) continue;
+      output.add(parsed);
+    }
+    if (output.size === 0) return null;
+    return [...output.values()];
+  },
+
+  getTileFormat(tileType: string): ImageFormat | VectorFormat | null {
+    const ext = getImageFormat(tileType);
+    if (ext) return ext;
+    if (tileType === VectorFormat.MapboxVectorTiles) return VectorFormat.MapboxVectorTiles;
+    return null;
+  },
+  /**
+   * Validate that the tile request is somewhat valid
+   * - Valid projection
+   * - Valid range
+   *
+   * @throws LambdaHttpResponse for tile requests that are not valid
+   *
+   * @param req request to validate
+   * @param xyzData
+   */
+  xyz(req: LambdaHttpRequest<TileXyzGet>): TileXyz {
+    Validate.apiKey(req);
+
+    req.set('tileSet', req.params.tileSet);
+
+    const x = parseInt(req.params.x, 10);
+    const y = parseInt(req.params.y, 10);
+    const z = parseInt(req.params.z, 10);
+
+    const tileMatrix = Validate.getTileMatrixSet(req.params.tileMatrix);
+    if (tileMatrix == null) throw new LambdaHttpResponse(404, 'Tile Matrix not found');
+
+    req.set('tileMatrix', tileMatrix.identifier);
+    req.set('projection', tileMatrix.projection.code);
+
+    const tileType = Validate.getTileFormat(req.params.tileType);
+    if (tileType == null) throw new LambdaHttpResponse(404, 'Tile extension not found');
+    req.set('extension', tileType);
+
+    if (isNaN(z) || z > tileMatrix.maxZoom || z < 0) throw new LambdaHttpResponse(404, `Zoom not found: ${z}`);
+
+    const zoom = tileMatrix.zooms[z];
+    if (isNaN(x) || x < 0 || x > zoom.matrixWidth) throw new LambdaHttpResponse(404, `X not found: ${x}`);
+    if (isNaN(y) || y < 0 || y > zoom.matrixHeight) throw new LambdaHttpResponse(404, `Y not found: ${y}`);
+
+    const xyzData = { tile: { x, y, z }, tileSet: req.params.tileSet, tileMatrix, tileType };
+    req.set('xyz', xyzData.tile);
+
+    const latLon = Projection.tileCenterToLatLon(tileMatrix, xyzData.tile);
+    req.set('location', latLon);
+
+    return xyzData;
+  },
+};

package/src/wmts.capability.ts

@@ -1,8 +1,9 @@
-import { Bounds, ImageFormat, Nztm2000QuadTms, TileMatrixSet, WmtsProvider } from '@basemaps/geo';
+import { Config, ConfigImagery, ConfigLayer, ConfigTileSet, standardizeLayerName } from '@basemaps/config';
+import { Bounds, GoogleTms, ImageFormat, TileMatrixSet, WmtsProvider } from '@basemaps/geo';
 import { Projection, V, VNodeElement } from '@basemaps/shared';
 import { ImageFormatOrder } from '@basemaps/tiler';
-import { BBox, Wgs84 } from '@linzjs/geojson';
-import { TileSetRaster } from './tile.set.raster.js';
+import { BoundingBox } from '@cogeotiff/core';
+import { BBox } from '@linzjs/geojson';
 
 const CapabilitiesAttrs = {
   xmlns: 'http://www.opengis.net/wmts/1.0',
@@ -15,77 +16,115 @@ const CapabilitiesAttrs = {
   version: '1.0.0',
 };
 
-function wgs84Extent(layer: TileSetRaster): BBox {
-  return Projection.get(layer.tileMatrix).boundsToWgs84BoundingBox(layer.extent);
-}
-
-/**
- * Default the tile matrix id to the projection of the TileMatrixSet
- */
-export function getTileMatrixId(tileMatrix: TileMatrixSet): string {
-  // TODO this should really change everything to identifier
-  if (tileMatrix.identifier === Nztm2000QuadTms.identifier) return Nztm2000QuadTms.identifier;
-  return tileMatrix.projection.toEpsgString();
+function wgs84Extent(tileMatrix: TileMatrixSet, bbox: BoundingBox): BBox {
+  return Projection.get(tileMatrix).boundsToWgs84BoundingBox(bbox);
 }
 
 export interface WmtsCapabilitiesParams {
+  /** Base URL for tile server */
   httpBase: string;
   provider?: WmtsProvider;
-  layers: TileSetRaster[];
+  /** Tileset to export into WMTS */
+  tileSet: ConfigTileSet;
+  /** List of tile matrixes to output */
+  tileMatrix: TileMatrixSet[];
+  /** Should WMTS Layers be created for each imagery set inside this tileSet */
+  isIndividualLayers: boolean;
+  /** All the imagery used by the tileSet and tileMatrixes */
+  imagery: Map<string, ConfigImagery>;
+  /** API key to append to all resource urls */
   apiKey?: string;
-  formats?: ImageFormat[];
+  /** Limit the output to the following image formats other wise @see ImageFormatOrder */
+  formats?: ImageFormat[] | null;
+}
+
+/** Number of decimal places to use in lat lng */
+const LngLatPrecision = 6;
+const MeterPrecision = 4;
+
+function formatCoords(x: number, precision: number): string {
+  return Number(x.toFixed(precision)).toString();
+}
+
+/** Format a bounding box XY as `${x} ${y}` while restricting to precision decimal places */
+function formatBbox(x: number, y: number, precision: number): string {
+  return `${formatCoords(x, precision)} ${formatCoords(y, precision)}`;
 }
 
 export class WmtsCapabilities {
   httpBase: string;
   provider?: WmtsProvider;
-
-  layers: Map<string, TileSetRaster[]> = new Map();
-
+  tileSet: ConfigTileSet;
   apiKey?: string;
   tileMatrixSets = new Map<string, TileMatrixSet>();
+  imagery: Map<string, ConfigImagery>;
   formats: ImageFormat[];
+  isIndividualLayers = false;
 
   constructor(params: WmtsCapabilitiesParams) {
     this.httpBase = params.httpBase;
     this.provider = params.provider;
+    this.tileSet = params.tileSet;
+    this.isIndividualLayers = params.isIndividualLayers;
+    for (const tms of params.tileMatrix) this.tileMatrixSets.set(tms.identifier, tms);
+    this.apiKey = params.apiKey;
+    this.formats = params.formats ?? ImageFormatOrder;
+    this.imagery = params.imagery;
+  }
 
-    for (const layer of params.layers) {
-      // TODO is grouping by name the best option
-      let existing = this.layers.get(layer.fullName);
-      if (existing == null) {
-        existing = [];
-        this.layers.set(layer.fullName, existing);
+  async loadImagery(): Promise<void> {
+    const ids = new Set<string>();
+    for (const tms of this.tileMatrixSets.values()) {
+      for (const layer of this.tileSet.layers) {
+        const layerId = layer[tms.projection.code];
+        if (layerId != null) ids.add(layerId);
       }
-      // TODO should a error be thrown here if the projection is invalid
-      existing.push(layer);
-
-      this.tileMatrixSets.set(layer.tileMatrix.identifier, layer.tileMatrix);
     }
-    this.apiKey = params.apiKey;
-    this.formats = params.formats ?? ImageFormatOrder;
+    this.imagery = await Config.Imagery.getAll(ids);
   }
 
-  buildWgs84BoundingBox(layers: TileSetRaster[], tagName = 'ows:WGS84BoundingBox'): VNodeElement {
-    let bbox = wgs84Extent(layers[0]);
-    for (let i = 1; i < layers.length; ++i) {
-      bbox = Wgs84.union(bbox, wgs84Extent(layers[i]));
+  buildWgs84BoundingBox(tms: TileMatrixSet, layers: Bounds[]): VNodeElement {
+    let bbox: BBox;
+    if (layers.length > 0) {
+      let bounds = layers[0];
+      for (let i = 1; i < layers.length; i++) {
+        bounds = bounds.union(layers[i]);
+      }
+      bbox = wgs84Extent(tms, bounds.toJson());
+    } else {
+      // No layers provided assume extent is the size of the tile matrix set :shrug: ?
+      bbox = wgs84Extent(tms, tms.extent);
+    }
+
+    // If east is less than west, then this has crossed the anti meridian, so cover the entire globe
+    if (bbox[2] < bbox[0]) {
+      bbox[0] = -180;
+      bbox[2] = 180;
     }
 
-    return V(
-      tagName,
-      { crs: 'urn:ogc:def:crs:OGC:2:84' },
-      bbox[2] > 180
-        ? [V('ows:LowerCorner', `-180 -90`), V('ows:UpperCorner', `180 90`)]
-        : [V('ows:LowerCorner', `${bbox[0]} ${bbox[1]}`), V('ows:UpperCorner', `${bbox[2]} ${bbox[3]}`)],
-    );
+    return V('ows:WGS84BoundingBox', { crs: 'urn:ogc:def:crs:OGC:2:84' }, [
+      V('ows:LowerCorner', formatBbox(bbox[0], bbox[1], LngLatPrecision)),
+      V('ows:UpperCorner', formatBbox(bbox[2], bbox[3], LngLatPrecision)),
+    ]);
   }
 
-  buildBoundingBox(tms: TileMatrixSet, extent: Bounds): VNodeElement {
-    const bbox = extent.toBbox();
+  /** Combine all the bounds of the imagery inside the layers into a extent for the imagery set */
+  buildBoundingBoxFromImagery(tms: TileMatrixSet, layers: ConfigLayer[]): VNodeElement | null {
+    let bounds;
+    for (const layer of layers) {
+      const imgId = layer[tms.projection.code];
+      if (imgId == null) continue;
+      const img = this.imagery.get(imgId);
+      if (img == null) continue;
+      if (bounds == null) bounds = Bounds.fromJson(img.bounds);
+      else bounds = bounds.union(Bounds.fromJson(img.bounds));
+    }
+    if (bounds == null) return null;
+
+    const bbox = bounds.toBbox();
     return V('ows:BoundingBox', { crs: tms.projection.toUrn() }, [
-      V('ows:LowerCorner', `${bbox[tms.indexX]} ${bbox[tms.indexY]}`),
-      V('ows:UpperCorner', `${bbox[tms.indexX + 2]} ${bbox[tms.indexY + 2]}`),
+      V('ows:LowerCorner', formatBbox(bbox[tms.indexX], bbox[tms.indexY], MeterPrecision)),
+      V('ows:UpperCorner', formatBbox(bbox[tms.indexX + 2], bbox[tms.indexY + 2], MeterPrecision)),
     ]);
   }
 
@@ -124,13 +163,13 @@ export class WmtsCapabilities {
     ];
   }
 
-  buildTileUrl(tileSet: TileSetRaster, suffix: string): string {
+  buildTileUrl(tileSetId: string, suffix: string): string {
     const apiSuffix = this.apiKey ? `?api=${this.apiKey}` : '';
     return [
       this.httpBase,
       'v1',
       'tiles',
-      tileSet.fullName,
+      tileSetId,
       '{TileMatrixSet}',
       '{TileMatrix}',
       '{TileCol}',
@@ -138,37 +177,91 @@ export class WmtsCapabilities {
     ].join('/');
   }
 
-  buildResourceUrl(tileSet: TileSetRaster, suffix: string): VNodeElement {
+  buildResourceUrl(tileSetId: string, suffix: string): VNodeElement {
     return V('ResourceURL', {
       format: 'image/' + suffix,
       resourceType: 'tile',
-      template: this.buildTileUrl(tileSet, suffix),
+      template: this.buildTileUrl(tileSetId, suffix),
     });
   }
 
-  buildLayer(layers: TileSetRaster[]): VNodeElement {
-    const matrixSets = new Set<string>();
+  buildLayerFromImagery(layer: ConfigLayer): VNodeElement | null {
+    const matrixSets = new Set<TileMatrixSet>();
     const matrixSetNodes: VNodeElement[] = [];
-    for (const layer of layers) {
-      if (matrixSets.has(layer.tileMatrix.identifier)) continue;
-      matrixSets.add(layer.tileMatrix.identifier);
-      matrixSetNodes.push(V('TileMatrixSetLink', [V('TileMatrixSet', getTileMatrixId(layer.tileMatrix))]));
+    for (const tms of this.tileMatrixSets.values()) {
+      const imdIg = layer[tms.projection.code];
+      if (imdIg == null) continue;
+      const img = this.imagery.get(imdIg);
+      if (img == null) continue;
+      matrixSetNodes.push(V('TileMatrixSetLink', [V('TileMatrixSet', tms.identifier)]));
+      matrixSets.add(tms);
     }
 
-    const [firstLayer] = layers;
+    const layerNameId = standardizeLayerName(layer.name);
+    const matrixSetList = [...matrixSets.values()];
+    const firstMatrix = matrixSetList[0];
+    if (firstMatrix == null) return null;
+    const firstImg = this.imagery.get(layer[firstMatrix.projection.code] ?? '');
+    if (firstImg == null) return null;
+
     return V('Layer', [
-      V('ows:Title', firstLayer.title),
-      V('ows:Abstract', firstLayer.description),
-      V('ows:Identifier', firstLayer.fullName),
-      ...layers.map((layer) => this.buildBoundingBox(layer.tileMatrix, layer.extent)),
-      this.buildWgs84BoundingBox(layers),
+      V('ows:Title', layer.title ?? layerNameId),
+      V('ows:Abstract', ''),
+      V('ows:Identifier', layerNameId),
+      this.buildKeywords(firstImg),
+      ...matrixSetList.map((tms) => {
+        return this.buildBoundingBoxFromImagery(tms, [layer]);
+      }),
+      this.buildWgs84BoundingBox(firstMatrix, [Bounds.fromJson(firstImg.bounds)]),
       this.buildStyle(),
       ...this.formats.map((fmt) => V('Format', 'image/' + fmt)),
       ...matrixSetNodes,
-      ...this.formats.map((fmt) => this.buildResourceUrl(firstLayer, fmt)),
+      ...this.formats.map((fmt) => this.buildResourceUrl(layerNameId, fmt)),
     ]);
   }
 
+  buildLayer(layer: ConfigTileSet): VNodeElement {
+    const matrixSets = new Set<TileMatrixSet>();
+    const matrixSetNodes: VNodeElement[] = [];
+    for (const tms of this.tileMatrixSets.values()) {
+      if (layer.layers.find((f) => f[tms.projection.code] != null)) {
+        matrixSetNodes.push(V('TileMatrixSetLink', [V('TileMatrixSet', tms.identifier)]));
+        matrixSets.add(tms);
+      }
+    }
+    const layerNameId = standardizeLayerName(layer.name);
+    const matrixSetList = [...matrixSets.values()];
+    const firstMatrix = matrixSetList[0];
+    if (firstMatrix == null) throw new Error('No matrix sets found for layer ' + layer.name);
+
+    // Prefer using the web mercator tms for bounds
+    const webMercatorOrFirst = matrixSetList.find((f) => f.identifier === GoogleTms.identifier) ?? firstMatrix;
+    const bounds: Bounds[] = [];
+    for (const l of layer.layers) {
+      const img = this.imagery.get(l[webMercatorOrFirst.projection.code] ?? '');
+      if (img == null) continue;
+      bounds.push(Bounds.fromJson(img.bounds));
+    }
+
+    return V('Layer', [
+      V('ows:Title', layer.title ?? layerNameId),
+      V('ows:Abstract', layer.description ?? ''),
+      V('ows:Identifier', layerNameId),
+      this.buildKeywords(layer),
+      ...[...matrixSets.values()].map((tms) => this.buildBoundingBoxFromImagery(tms, layer.layers)),
+      this.buildWgs84BoundingBox(webMercatorOrFirst, bounds),
+      this.buildStyle(),
+      ...this.formats.map((fmt) => V('Format', 'image/' + fmt)),
+      ...matrixSetNodes,
+      ...this.formats.map((fmt) => this.buildResourceUrl(layerNameId, fmt)),
+    ]);
+  }
+
+  buildKeywords(tileSet: { category?: string }): VNodeElement {
+    if (tileSet.category == null) return V('ows:Keywords');
+    return V('ows:Keywords', [V('ows:Keyword', tileSet.category)]);
+  }
+
   buildStyle(): VNodeElement {
     return V('Style', { isDefault: 'true' }, [V('ows:Title', 'Default Style'), V('ows:Identifier', 'default')]);
   }
@@ -177,7 +270,7 @@ export class WmtsCapabilities {
     return V('TileMatrixSet', [
       V('ows:Title', tms.def.title),
       tms.def.abstract ? V('ows:Abstract', tms.def.abstract) : null,
-      V('ows:Identifier', getTileMatrixId(tms)),
+      V('ows:Identifier', tms.identifier),
       V('ows:SupportedCRS', tms.projection.toUrn()),
       tms.def.wellKnownScaleSet ? V('WellKnownScaleSet', tms.def.wellKnownScaleSet) : null,
       ...tms.def.tileMatrix.map((c) => {
@@ -194,16 +287,25 @@ export class WmtsCapabilities {
     ]);
   }
   toVNode(): VNodeElement {
-    const layers: VNodeElement[] = [];
-    for (const tileSets of this.layers.values()) {
-      layers.push(this.buildLayer(tileSets));
+    const layers: (VNodeElement | null)[] = [];
+    layers.push(this.buildLayer(this.tileSet));
+
+    if (this.isIndividualLayers) {
+      const layerByName = new Map<string, ConfigLayer>();
+      // Dedupe the layers by unique name
+      for (const img of this.tileSet.layers) layerByName.set(standardizeLayerName(img.name), img);
+      const orderedLayers = Array.from(layerByName.values()).sort((a, b) =>
+        (a.title ?? a.name).localeCompare(b.title ?? b.name),
+      );
+      for (const img of orderedLayers) layers.push(this.buildLayerFromImagery(img));
     }
+
     for (const tms of this.tileMatrixSets.values()) layers.push(this.buildTileMatrixSet(tms));
 
     return V('Capabilities', CapabilitiesAttrs, [...this.buildProvider(), V('Contents', layers)]);
   }
 
   toXml(): string {
-    return '<?xml version="1.0"?>\n' + this.toVNode().toString();
+    return '<?xml version="1.0" encoding="utf-8"?>\n' + this.toVNode().toString();
   }
 }