tileserver-gl-light 4.5.1 → 4.6.0

package/.readthedocs.yaml

@@ -0,0 +1,18 @@
+# Read the Docs configuration file for Sphinx projects
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the version of Python and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.11"
+
+# Build documentation in the doc/help/ directory with Sphinx
+sphinx:
+  configuration: docs/conf.py
+
+formats:
+    - pdf

package/LICENSE.md

@@ -1416,6 +1416,38 @@ modification, are permitted provided that the following conditions are met:
    this list of conditions and the following disclaimer in the documentation
    and/or other materials provided with the distribution.
 
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+```
+---
+
+### [PMTiles](https://github.com/protomaps/pmtiles)
+```
+BSD 3-Clause License
+Copyright 2021 Protomaps LLC
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its contributors
+   may be used to endorse or promote products derived from this software 
+   without specific prior written permission.
+
 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE

package/docs/config.rst

@@ -16,7 +16,8 @@ Example:
         "sprites": "sprites",
         "icons": "icons",
         "styles": "styles",
-        "mbtiles": ""
+        "mbtiles": "data",
+        "pmtiles": "data"
       },
       "domains": [
         "localhost:8080",
@@ -33,6 +34,8 @@ Example:
       "serveAllStyles": false,
       "serveStaticMaps": true,
       "allowRemoteMarkerIcons": true,
+      "allowInlineMarkerImages": true,
+      "staticAttributionText": "© OpenMapTiles  © OpenStreetMaps",
       "tileMargin": 0
     },
     "styles": {
@@ -140,7 +143,13 @@ It is recommended to also use the ``serveAllFonts`` option when using this optio
 -----------
 
 Optional string to be rendered into the raster tiles (and static maps) as watermark (bottom-left corner).
-Can be used for hard-coding attributions etc. (can also be specified per-style).
+Not used by default.
+
+``staticAttributionText``
+-----------
+
+Optional string to be rendered in the static images endpoint. Text will be rendered in the bottom-right corner,
+and styled similar to attribution on web-based maps (text only, links not supported).
 Not used by default.
 
 ``allowRemoteMarkerIcons``
@@ -150,6 +159,13 @@ Allows the rendering of marker icons fetched via http(s) hyperlinks.
 For security reasons only allow this if you can control the origins from where the markers are fetched!
 Default is to disallow fetching of icons from remote sources.
 
+``allowInlineMarkerImages``
+--------------
+Allows the rendering of inline marker icons or base64 urls.
+For security reasons only allow this if you can control the origins from where the markers are fetched!
+Not used by default.
+
+
 ``styles``
 ==========
 
@@ -165,11 +181,27 @@ Each item in this object defines one style (map). It can have the following opti
 ``data``
 ========
 
-Each item specifies one data source which should be made accessible by the server. It has the following options:
+Each item specifies one data source which should be made accessible by the server. It has to have one of the following options:
+
+* ``mbtiles`` -- name of the mbtiles file
+* ``pmtiles`` -- name of the pmtiles file or url.
+
+For example::
+
+  "data": {
+    "source1": {
+      "mbtiles": "source1.mbtiles"
+    },
+    "source2": {
+      "pmtiles": "source2.pmtiles"
+    },
+    "source3": {
+      "pmtiles": "https://foo.lan/source3.pmtiles"
+    }
+  }
 
-* ``mbtiles`` -- name of the mbtiles file [required]
 
-The mbtiles file does not need to be specified here unless you explicitly want to serve the raw data.
+The data source does not need to be specified here unless you explicitly want to serve the raw data.
 
 Referencing local files from style JSON
 =======================================
@@ -179,21 +211,46 @@ You can link various data sources from the style JSON (for example even remote T
 MBTiles
 -------
 
-To specify that you want to use local mbtiles, use to following syntax: ``mbtiles://switzerland.mbtiles``.
-The TileServer-GL will try to find the file ``switzerland.mbtiles`` in ``root`` + ``mbtiles`` path.
+To specify that you want to use local mbtiles, use to following syntax: ``mbtiles://source1.mbtiles``.
+TileServer-GL will try to find the file ``source1.mbtiles`` in ``root`` + ``mbtiles`` path.
 
 For example::
 
   "sources": {
     "source1": {
-      "url": "mbtiles://switzerland.mbtiles",
+      "url": "mbtiles://source1.mbtiles",
       "type": "vector"
     }
   }
 
-Alternatively, you can use ``mbtiles://{zurich-vector}`` to reference existing data object from the config.
-In this case, the server will look into the ``config.json`` to determine what mbtiles file to use.
-For the config above, this is equivalent to ``mbtiles://zurich.mbtiles``.
+Alternatively, you can use ``mbtiles://{source1}`` to reference existing data object from the config.
+In this case, the server will look into the ``config.json`` to determine what file to use by data id.
+For the config above, this is equivalent to ``mbtiles://source1.mbtiles``.
+
+PMTiles
+-------
+
+To specify that you want to use local pmtiles, use to following syntax: ``pmtiles://source2.pmtiles``.
+TileServer-GL will try to find the file ``source2.pmtiles`` in ``root`` + ``pmtiles`` path.
+
+To specify that you want to use a url based pmtiles, use to following syntax: ``pmtiles://https://foo.lan/source3.pmtiles``.
+
+For example::
+
+  "sources": {
+    "source2": {
+      "url": "pmtiles://source2.pmtiles",
+      "type": "vector"
+    },
+    "source3": {
+      "url": "pmtiles://https://foo.lan/source3.pmtiles",
+      "type": "vector"
+    },
+  }
+
+Alternatively, you can use ``pmtiles://{source2}`` to reference existing data object from the config.
+In this case, the server will look into the ``config.json`` to determine what file to use by data id.
+For the config above, this is equivalent to ``pmtiles://source2.mbtiles``.
 
 Sprites
 -------

package/docs/endpoints.rst

@@ -35,14 +35,23 @@ Static images
 
 * All the static image endpoints additionally support following query parameters:
 
-  * ``path``
-    * can be provided multiple times  
-    * syntax
-      * comma-separated ``lng,lat``, pipe-separated pairs
-        * e.g. ``path=5.9,45.8|5.9,47.8|10.5,47.8|10.5,45.8|5.9,45.8``
-      *  Match pattern with options ``((fill|stroke|width)\:[^\|]+\|)*((enc:.+)|((-?\d+\.?\d*,-?\d+\.?\d*\|)+(-?\d+\.?\d*,-?\d+\.?\d*)))``
-        * e.g. ``path=stroke:yellow|width:2|fill:green|5.9,45.8|5.9,47.8|10.5,47.8|10.5,45.8|5.9,45.8`` or ``stroke:blue|enc:_p~iF~ps|U_ulLnnqC_mqNvxq`@``
-        * 'enc:' is specified in `Google Encoded Polyline Format <https://developers.google.com/maps/documentation/utilities/polylinealgorithm>`. If used, the rest of the path parameter is considered to be part of the encoded polyline string -- do not specify the coordinate pairs.
+  * ``path`` - ``((fill|stroke|width)\:[^\|]+\|)*(enc:.+|-?\d+(\.\d*)?,-?\d+(\.\d*)?(\|-?\d+(\.\d*)?,-?\d+(\.\d*)?)+)``
+
+    * comma-separated ``lng,lat``, pipe-separated pairs
+
+      * e.g. ``path=5.9,45.8|5.9,47.8|10.5,47.8|10.5,45.8|5.9,45.8``
+
+    * `Google Encoded Polyline Format <https://developers.google.com/maps/documentation/utilities/polylinealgorithm>`_
+
+      * e.g. ``path=enc:_p~iF~ps|U_ulLnnqC_mqNvxq`@``
+      * If 'enc:' is used, the rest of the path parameter is considered to be part of the encoded polyline string -- do not specify the coordinate pairs.
+
+    * With options (fill|stroke|width)
+
+      * e.g. ``path=stroke:yellow|width:2|fill:green|5.9,45.8|5.9,47.8|10.5,47.8|10.5,45.8|5.9,45.8`` or ``path=stroke:blue|width:1|fill:yellow|enc:_p~iF~ps|U_ulLnnqC_mqNvxq`@``
+
+    * can be provided multiple times
+
   * ``latlng`` - indicates coordinates are in ``lat,lng`` order rather than the usual ``lng,lat``
   * ``fill`` - color to use as the fill (e.g. ``red``, ``rgba(255,255,255,0.5)``, ``#0000ff``)
   * ``stroke`` - color of the path stroke

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "tileserver-gl-light",
-  "version": "4.5.1",
+  "version": "4.6.0",
   "description": "Map tile server for JSON GL styles - serving vector tiles",
   "main": "src/main.js",
   "bin": "src/main.js",
@@ -23,18 +23,20 @@
     "@mapbox/sphericalmercator": "1.2.0",
     "@mapbox/vector-tile": "1.3.1",
     "@maplibre/maplibre-gl-style-spec": "18.0.0",
+    "@sindresorhus/fnv1a": "3.0.0",
     "advanced-pool": "0.3.3",
     "chokidar": "3.5.3",
     "clone": "2.1.2",
     "color": "4.2.3",
-    "commander": "11.0.0",
+    "commander": "11.1.0",
     "cors": "2.8.5",
     "express": "4.18.2",
     "handlebars": "4.7.8",
     "http-shutdown": "1.2.2",
     "morgan": "1.10.0",
     "pbf": "3.2.1",
-    "proj4": "2.9.0",
+    "pmtiles": "2.11.0",
+    "proj4": "2.9.1",
     "request": "2.88.2",
     "sanitize-filename": "1.6.3",
     "tileserver-gl-styles": "2.0.0"

package/public/templates/index.tmpl

@@ -77,8 +77,9 @@
             <img src="{{public_url}}images/placeholder.png{{&key_query}}" alt="{{name}} preview" />
           {{/if}}
           <div class="details">
-            <h3>{{name}}</h3>
-            <p class="identifier">identifier: {{@key}}{{#if formatted_filesize}} | size: {{formatted_filesize}}{{/if}} | type: {{#is_vector}}vector{{/is_vector}}{{^is_vector}}raster{{/is_vector}} data</p>
+            <h3>{{tileJSON.name}}</h3>
+            <div class="identifier">identifier: {{@key}}{{#if formatted_filesize}} | size: {{formatted_filesize}}{{/if}}</div>
+            <div class="identifier">type: {{#is_vector}}vector{{/is_vector}}{{^is_vector}}raster{{/is_vector}} data {{#if source_type}} | ext: {{source_type}}{{/if}}</div>
             <p class="services">
               services: <a href="{{public_url}}data/{{@key}}.json{{&../key_query}}">TileJSON</a>
               {{#if wmts_link}}

package/src/main.js

@@ -7,8 +7,9 @@ import path from 'path';
 import { fileURLToPath } from 'url';
 import request from 'request';
 import { server } from './server.js';
-
 import MBTiles from '@mapbox/mbtiles';
+import { isValidHttpUrl } from './utils.js';
+import { PMtilesOpen, GetPMtilesInfo } from './pmtiles_adapter.js';
 
 const __filename = fileURLToPath(import.meta.url);
 const __dirname = path.dirname(__filename);
@@ -25,9 +26,15 @@ import { program } from 'commander';
 program
   .description('tileserver-gl startup options')
   .usage('tileserver-gl [mbtiles] [options]')
+  .option(
+    '--file <file>',
+    'MBTiles or PMTiles file\n' +
+      '\t                  ignored if the configuration file is also specified',
+  )
   .option(
     '--mbtiles <file>',
-    'MBTiles file (uses demo configuration);\n' +
+    '(DEPRECIATED) MBTiles file\n' +
+      '\t                  ignored if file is also specified' +
       '\t                  ignored if the configuration file is also specified',
   )
   .option(
@@ -55,7 +62,7 @@ const opts = program.opts();
 
 console.log(`Starting ${packageJson.name} v${packageJson.version}`);
 
-const startServer = (configPath, config) => {
+const StartServer = (configPath, config) => {
   let publicUrl = opts.public_url;
   if (publicUrl && publicUrl.lastIndexOf('/') !== publicUrl.length - 1) {
     publicUrl += '/';
@@ -74,135 +81,205 @@ const startServer = (configPath, config) => {
   });
 };
 
-const startWithMBTiles = (mbtilesFile) => {
-  console.log(`[INFO] Automatically creating config file for ${mbtilesFile}`);
+const StartWithInputFile = async (inputFile) => {
+  console.log(`[INFO] Automatically creating config file for ${inputFile}`);
   console.log(`[INFO] Only a basic preview style will be used.`);
   console.log(
     `[INFO] See documentation to learn how to create config.json file.`,
   );
 
-  mbtilesFile = path.resolve(process.cwd(), mbtilesFile);
+  let inputFilePath;
+  if (isValidHttpUrl(inputFile)) {
+    inputFilePath = process.cwd();
+  } else {
+    inputFile = path.resolve(process.cwd(), inputFile);
+    inputFilePath = path.dirname(inputFile);
 
-  const mbtilesStats = fs.statSync(mbtilesFile);
-  if (!mbtilesStats.isFile() || mbtilesStats.size === 0) {
-    console.log(`ERROR: Not valid MBTiles file: ${mbtilesFile}`);
-    process.exit(1);
-  }
-  const instance = new MBTiles(mbtilesFile + '?mode=ro', (err) => {
-    if (err) {
-      console.log('ERROR: Unable to open MBTiles.');
-      console.log(`Make sure ${path.basename(mbtilesFile)} is valid MBTiles.`);
+    const inputFileStats = fs.statSync(inputFile);
+    if (!inputFileStats.isFile() || inputFileStats.size === 0) {
+      console.log(`ERROR: Not a valid input file: `);
       process.exit(1);
     }
+  }
 
-    instance.getInfo((err, info) => {
-      if (err || !info) {
-        console.log('ERROR: Metadata missing in the MBTiles.');
-        console.log(
-          `Make sure ${path.basename(mbtilesFile)} is valid MBTiles.`,
-        );
-        process.exit(1);
-      }
-      const bounds = info.bounds;
+  const styleDir = path.resolve(
+    __dirname,
+    '../node_modules/tileserver-gl-styles/',
+  );
 
-      const styleDir = path.resolve(
-        __dirname,
-        '../node_modules/tileserver-gl-styles/',
-      );
+  const config = {
+    options: {
+      paths: {
+        root: styleDir,
+        fonts: 'fonts',
+        styles: 'styles',
+        mbtiles: inputFilePath,
+        pmtiles: inputFilePath,
+      },
+    },
+    styles: {},
+    data: {},
+  };
 
-      const config = {
-        options: {
-          paths: {
-            root: styleDir,
-            fonts: 'fonts',
-            styles: 'styles',
-            mbtiles: path.dirname(mbtilesFile),
-          },
-        },
-        styles: {},
-        data: {},
-      };
-
-      if (
-        info.format === 'pbf' &&
-        info.name.toLowerCase().indexOf('openmaptiles') > -1
-      ) {
+  const extension = inputFile.split('.').pop().toLowerCase();
+  if (extension === 'pmtiles') {
+    let FileOpenInfo = PMtilesOpen(inputFile);
+    const metadata = await GetPMtilesInfo(FileOpenInfo);
+
+    if (
+      metadata.format === 'pbf' &&
+      metadata.name.toLowerCase().indexOf('openmaptiles') > -1
+    ) {
+      if (isValidHttpUrl(inputFile)) {
         config['data'][`v3`] = {
-          mbtiles: path.basename(mbtilesFile),
+          pmtiles: inputFile,
         };
+      } else {
+        config['data'][`v3`] = {
+          pmtiles: path.basename(inputFile),
+        };
+      }
 
-        const styles = fs.readdirSync(path.resolve(styleDir, 'styles'));
-        for (const styleName of styles) {
-          const styleFileRel = styleName + '/style.json';
-          const styleFile = path.resolve(styleDir, 'styles', styleFileRel);
-          if (fs.existsSync(styleFile)) {
-            config['styles'][styleName] = {
-              style: styleFileRel,
-              tilejson: {
-                bounds: bounds,
-              },
-            };
-          }
+      const styles = fs.readdirSync(path.resolve(styleDir, 'styles'));
+      for (const styleName of styles) {
+        const styleFileRel = styleName + '/style.json';
+        const styleFile = path.resolve(styleDir, 'styles', styleFileRel);
+        if (fs.existsSync(styleFile)) {
+          config['styles'][styleName] = {
+            style: styleFileRel,
+            tilejson: {
+              bounds: metadata.bounds,
+            },
+          };
         }
+      }
+    } else {
+      console.log(
+        `WARN: PMTiles not in "openmaptiles" format. Serving raw data only...`,
+      );
+      if (isValidHttpUrl(inputFile)) {
+        config['data'][(metadata.id || 'pmtiles').replace(/[?/:]/g, '_')] = {
+          pmtiles: inputFile,
+        };
       } else {
-        console.log(
-          `WARN: MBTiles not in "openmaptiles" format. Serving raw data only...`,
-        );
-        config['data'][
-          (info.id || 'mbtiles')
-            .replace(/\//g, '_')
-            .replace(/:/g, '_')
-            .replace(/\?/g, '_')
-        ] = {
-          mbtiles: path.basename(mbtilesFile),
+        config['data'][(metadata.id || 'pmtiles').replace(/[?/:]/g, '_')] = {
+          pmtiles: path.basename(inputFile),
         };
       }
+    }
 
-      if (opts.verbose) {
-        console.log(JSON.stringify(config, undefined, 2));
-      } else {
-        console.log('Run with --verbose to see the config file here.');
+    if (opts.verbose) {
+      console.log(JSON.stringify(config, undefined, 2));
+    } else {
+      console.log('Run with --verbose to see the config file here.');
+    }
+
+    return StartServer(null, config);
+  } else {
+    if (isValidHttpUrl(inputFile)) {
+      console.log(
+        `ERROR: MBTiles does not support web based files. "${inputFile}" is not a valid data file.`,
+      );
+      process.exit(1);
+    }
+    const instance = new MBTiles(inputFile + '?mode=ro', (err) => {
+      if (err) {
+        console.log('ERROR: Unable to open MBTiles.');
+        console.log(`Make sure ${path.basename(inputFile)} is valid MBTiles.`);
+        process.exit(1);
       }
 
-      return startServer(null, config);
+      instance.getInfo((err, info) => {
+        if (err || !info) {
+          console.log('ERROR: Metadata missing in the MBTiles.');
+          console.log(
+            `Make sure ${path.basename(inputFile)} is valid MBTiles.`,
+          );
+          process.exit(1);
+        }
+        const bounds = info.bounds;
+
+        if (
+          info.format === 'pbf' &&
+          info.name.toLowerCase().indexOf('openmaptiles') > -1
+        ) {
+          config['data'][`v3`] = {
+            mbtiles: path.basename(inputFile),
+          };
+
+          const styles = fs.readdirSync(path.resolve(styleDir, 'styles'));
+          for (const styleName of styles) {
+            const styleFileRel = styleName + '/style.json';
+            const styleFile = path.resolve(styleDir, 'styles', styleFileRel);
+            if (fs.existsSync(styleFile)) {
+              config['styles'][styleName] = {
+                style: styleFileRel,
+                tilejson: {
+                  bounds: bounds,
+                },
+              };
+            }
+          }
+        } else {
+          console.log(
+            `WARN: MBTiles not in "openmaptiles" format. Serving raw data only...`,
+          );
+          config['data'][(info.id || 'mbtiles').replace(/[?/:]/g, '_')] = {
+            mbtiles: path.basename(inputFile),
+          };
+        }
+
+        if (opts.verbose) {
+          console.log(JSON.stringify(config, undefined, 2));
+        } else {
+          console.log('Run with --verbose to see the config file here.');
+        }
+
+        return StartServer(null, config);
+      });
     });
-  });
+  }
 };
 
 fs.stat(path.resolve(opts.config), (err, stats) => {
   if (err || !stats.isFile() || stats.size === 0) {
-    let mbtiles = opts.mbtiles;
-    if (!mbtiles) {
+    let inputFile;
+    if (opts.file) {
+      inputFile = opts.file;
+    } else if (opts.mbtiles) {
+      inputFile = opts.mbtiles;
+    }
+
+    if (inputFile) {
+      return StartWithInputFile(inputFile);
+    } else {
       // try to find in the cwd
       const files = fs.readdirSync(process.cwd());
       for (const filename of files) {
-        if (filename.endsWith('.mbtiles')) {
-          const mbTilesStats = fs.statSync(filename);
-          if (mbTilesStats.isFile() && mbTilesStats.size > 0) {
-            mbtiles = filename;
+        if (filename.endsWith('.mbtiles') || filename.endsWith('.pmtiles')) {
+          const inputFilesStats = fs.statSync(filename);
+          if (inputFilesStats.isFile() && inputFilesStats.size > 0) {
+            inputFile = filename;
             break;
           }
         }
       }
-      if (mbtiles) {
-        console.log(`No MBTiles specified, using ${mbtiles}`);
-        return startWithMBTiles(mbtiles);
+      if (inputFile) {
+        console.log(`No input file specified, using ${inputFile}`);
+        return StartWithInputFile(inputFile);
       } else {
         const url =
           'https://github.com/maptiler/tileserver-gl/releases/download/v1.3.0/zurich_switzerland.mbtiles';
         const filename = 'zurich_switzerland.mbtiles';
         const stream = fs.createWriteStream(filename);
-        console.log(`No MBTiles found`);
+        console.log(`No input file found`);
         console.log(`[DEMO] Downloading sample data (${filename}) from ${url}`);
-        stream.on('finish', () => startWithMBTiles(filename));
+        stream.on('finish', () => StartWithInputFile(filename));
         return request.get(url).pipe(stream);
       }
     }
-    if (mbtiles) {
-      return startWithMBTiles(mbtiles);
-    }
   } else {
     console.log(`Using specified config file from ${opts.config}`);
-    return startServer(opts.config, null);
+    return StartServer(opts.config, null);
   }
 });