Merge pull request #230 from koumoul-dev/public_url

add public_url option
maptiler · Dec 19, 2018 · cde0233 · cde0233
2 parents 243bdbd + c99a1a5
commit cde0233
Show file tree

Hide file tree

Showing 12 changed files with 110 additions and 53 deletions.
diff --git a/Dockerfile_test b/Dockerfile_test
@@ -0,0 +1,35 @@
+# Run tests inside docker without requiring full installation of dependencies on local machine
+# Simply run "docker build -f Dockerfile_test ."
+# WARNING: sometimes it fails with a core dumped exception
+
+FROM node:6-stretch
+MAINTAINER Petr Sloup <petr.sloup@klokantech.com>
+
+RUN apt-get -qq update \
+&& DEBIAN_FRONTEND=noninteractive apt-get -y install \
+    apt-transport-https \
+    curl \
+    unzip \
+    build-essential \
+    python \
+    libcairo2-dev \
+    libgles2-mesa-dev \
+    libgbm-dev \
+    libllvm3.9 \
+    libprotobuf-dev \
+    libxxf86vm-dev \
+    xvfb \
+&& apt-get clean
+
+RUN mkdir -p /usr/src/app
+WORKDIR /usr/src/app
+
+RUN wget -O test_data.zip https://github.com/klokantech/tileserver-gl/releases/download/v1.3.0/test_data.zip
+RUN unzip -q test_data.zip -d test_data
+
+ENV NODE_ENV="test"
+
+COPY package.json .
+RUN npm install
+COPY / .
+RUN xvfb-run --server-args="-screen 0 1024x768x24" npm test
diff --git a/public/templates/data.tmpl b/public/templates/data.tmpl
@@ -5,10 +5,10 @@
   <meta name="viewport" content="width=device-width, initial-scale=1">
   <title>{{name}} - TileServer GL</title>
   {{#is_vector}}
-  <link rel="stylesheet" type="text/css" href="/mapbox-gl.css{{&key_query}}" />
-  <link rel="stylesheet" type="text/css" href="/mapbox-gl-inspect.css{{&key_query}}" />
-  <script src="/mapbox-gl.js{{&key_query}}"></script>
-  <script src="/mapbox-gl-inspect.min.js{{&key_query}}"></script>
+  <link rel="stylesheet" type="text/css" href="{{public_url}}mapbox-gl.css{{&key_query}}" />
+  <link rel="stylesheet" type="text/css" href="{{public_url}}mapbox-gl-inspect.css{{&key_query}}" />
+  <script src="{{public_url}}mapbox-gl.js{{&key_query}}"></script>
+  <script src="{{public_url}}mapbox-gl-inspect.min.js{{&key_query}}"></script>
   <style>
     body {background:#fff;color:#333;font-family:Arial, sans-serif;}
     #map {position:absolute;top:0;left:0;right:250px;bottom:0;}
@@ -18,9 +18,9 @@
   </style>
   {{/is_vector}}
   {{^is_vector}}
-  <link rel="stylesheet" type="text/css" href="/mapbox.css{{&key_query}}" />
-  <script src="/mapbox.js{{&key_query}}"></script>
-  <script src="/leaflet-hash.js{{&key_query}}"></script>
+  <link rel="stylesheet" type="text/css" href="{{public_url}}mapbox.css{{&key_query}}" />
+  <script src="{{public_url}}mapbox.js{{&key_query}}"></script>
+  <script src="{{public_url}}leaflet-hash.js{{&key_query}}"></script>
   <style>
     body { margin:0; padding:0; }
     #map { position:absolute; top:0; bottom:0; width:100%; }
@@ -42,7 +42,7 @@
       sources: {
         'vector_layer_': {
           type: 'vector',
-          url: '/data/{{id}}.json{{&key_query}}'
+          url: '{{public_url}}data/{{id}}.json{{&key_query}}'
         }
       },
       layers: []
@@ -74,7 +74,7 @@
   <h1 style="display:none;">{{name}}</h1>
   <div id='map'></div>
   <script>
-    var map = L.mapbox.map('map', '/data/{{id}}.json{{&key_query}}', { zoomControl: false });
+    var map = L.mapbox.map('map', '{{public_url}}data/{{id}}.json{{&key_query}}', { zoomControl: false });
     map.eachLayer(function(layer) {
       // do not add scale prefix even if retina display is detected
       layer.scalePrefix = '.';

diff --git a/public/templates/index.tmpl b/public/templates/index.tmpl
@@ -4,7 +4,7 @@
   <meta charset="UTF-8">
   <meta name="viewport" content="width=device-width, initial-scale=1">
   <title>TileServer GL - Server for vector and raster maps with GL styles</title>
-  <link rel="stylesheet" type="text/css" href="/index.css{{&key_query}}" />
+  <link rel="stylesheet" type="text/css" href="{{public_url}}index.css{{&key_query}}" />
   <script>
     function toggle_xyz(id) {
       var el = document.getElementById(id);
@@ -17,28 +17,28 @@
 </head>
 <body>
   <section>
-    <h1 class="title {{#if is_light}}light{{/if}}"><img src="/images/logo.png" alt="TileServer GL" /></h1>
+    <h1 class="title {{#if is_light}}light{{/if}}"><img src="{{public_url}}images/logo.png" alt="TileServer GL" /></h1>
     <h2 class="subtitle">Vector {{#if is_light}}<s>and raster</s>{{else}}and raster{{/if}} maps with GL styles</h2>
     {{#if styles}}
       <h2 class="box-header">Styles</h2>
       <div class="box">
       {{#each styles}}
         <div class="item">
           {{#if thumbnail}}
-            <img src="/styles/{{@key}}/{{thumbnail}}{{&../key_query}}" alt="{{name}} preview" />
+            <img src="{{public_url}}styles/{{@key}}/{{thumbnail}}{{&../key_query}}" alt="{{name}} preview" />
           {{else}}
-            <img src="/images/placeholder.png" alt="{{name}} preview" />
+            <img src="{{public_url}}images/placeholder.png" alt="{{name}} preview" />
           {{/if}}
           <div class="details">
             <h3>{{name}}</h3>
             <p class="identifier">identifier: {{@key}}</p>
             <p class="services">
               services:
               {{#if serving_data}}
-                <a href="/styles/{{@key}}/style.json{{&../key_query}}">GL Style</a>
+                <a href="{{public_url}}styles/{{@key}}/style.json{{&../key_query}}">GL Style</a>
               {{/if}}
               {{#if serving_rendered}}
-                {{#if serving_data}}| {{/if}}<a href="/styles/{{@key}}.json{{&../key_query}}">TileJSON</a>
+                {{#if serving_data}}| {{/if}}<a href="{{public_url}}styles/{{@key}}.json{{&../key_query}}">TileJSON</a>
               {{/if}}
               {{#if serving_rendered}}
                 | <a href="/styles/{{@key}}/wmts.xml{{&../key_query}}">WMTS</a>
@@ -52,14 +52,14 @@
           <div class="viewers">
             {{#if serving_data}}
               {{#if serving_rendered}}
-                <a class="btn" href="/styles/{{@key}}/{{&../key_query}}{{viewer_hash}}">Viewer</a>
+                <a class="btn" href="{{public_url}}styles/{{@key}}/{{&../key_query}}{{viewer_hash}}">Viewer</a>
               {{/if}}
             {{/if}}
             {{#if serving_rendered}}
-              <a class="btn" href="/styles/{{@key}}/?{{&../key_query_part}}raster{{viewer_hash}}">Raster</a>
+              <a class="btn" href="{{public_url}}styles/{{@key}}/?{{&../key_query_part}}raster{{viewer_hash}}">Raster</a>
             {{/if}}
             {{#if serving_data}}
-              <a class="btn" href="/styles/{{@key}}/?{{&../key_query_part}}vector{{viewer_hash}}">Vector</a>
+              <a class="btn" href="{{public_url}}styles/{{@key}}/?{{&../key_query_part}}vector{{viewer_hash}}">Vector</a>
             {{/if}}
           </div>
         </div>
@@ -72,15 +72,15 @@
       {{#each data}}
         <div class="item">
           {{#if thumbnail}}
-            <img src="/data/{{@key}}/{{thumbnail}}{{&../key_query}}" alt="{{name}} preview" />
+            <img src="{{public_url}}data/{{@key}}/{{thumbnail}}{{&../key_query}}" alt="{{name}} preview" />
           {{else}}
-            <img src="/images/placeholder.png" alt="{{name}} preview" />
+            <img src="{{public_url}}images/placeholder.png" 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>
             <p class="services">
-              services: <a href="/data/{{@key}}.json{{&../key_query}}">TileJSON</a>
+              services: <a href="{{public_url}}data/{{@key}}.json{{&../key_query}}">TileJSON</a>
               {{#if wmts_link}}
                 | <a href="{{&wmts_link}}">WMTS</a>
               {{/if}}
@@ -92,10 +92,10 @@
           </div>
           <div class="viewers">
             {{#is_vector}}
-            <a class="btn" href="/data/{{@key}}/{{&../key_query}}{{viewer_hash}}">Inspect</a>
+            <a class="btn" href="{{public_url}}data/{{@key}}/{{&../key_query}}{{viewer_hash}}">Inspect</a>
             {{/is_vector}}
             {{^is_vector}}
-            <a class="btn" href="/data/{{@key}}/{{&../key_query}}{{viewer_hash}}">View</a>
+            <a class="btn" href="{{public_url}}data/{{@key}}/{{&../key_query}}{{viewer_hash}}">View</a>
             {{/is_vector}}
           </div>
         </div>
@@ -104,7 +104,7 @@
     {{/if}}
   </section>
   <footer>
-    <a href="https://www.klokantech.com/" target="_blank"><img src="/images/klokantech.png" /></a>
+    <a href="https://www.klokantech.com/" target="_blank"><img src="{{public_url}}images/klokantech.png" /></a>
     <p>
       <a href="https://github.com/klokantech/tileserver-gl" target="_blank">Powered by TileServer GL ({{server_version}})</a> – <a href="https://www.klokantech.com/" target="_blank">an open-source project from Klokan Technologies GmbH.</a> <img src="https://t.klokantech.com/8073932/19" class="t" />
     </p>

diff --git a/public/templates/viewer.tmpl b/public/templates/viewer.tmpl
@@ -4,11 +4,11 @@
   <meta charset="UTF-8">
   <meta name="viewport" content="width=device-width, initial-scale=1">
   <title>{{name}} - TileServer GL</title>
-  <link rel="stylesheet" type="text/css" href="/mapbox-gl.css{{&key_query}}" />
-  <script src="/mapbox-gl.js{{&key_query}}"></script>
-  <link rel="stylesheet" type="text/css" href="/mapbox.css{{&key_query}}" />
-  <script src="/mapbox.js{{&key_query}}"></script>
-  <script src="/leaflet-hash.js{{&key_query}}"></script>
+  <link rel="stylesheet" type="text/css" href="{{public_url}}mapbox-gl.css{{&key_query}}" />
+  <script src="{{public_url}}mapbox-gl.js{{&key_query}}"></script>
+  <link rel="stylesheet" type="text/css" href="{{public_url}}mapbox.css{{&key_query}}" />
+  <script src="{{public_url}}mapbox.js{{&key_query}}"></script>
+  <script src="{{public_url}}leaflet-hash.js{{&key_query}}"></script>
   <style>
     body { margin:0; padding:0; }
     #map { position:absolute; top:0; bottom:0; width:100%; }
@@ -24,15 +24,15 @@
         (q.indexOf('raster') >= 0 ? 'raster' :
           (mapboxgl.supported() ? 'vector' : 'raster'));
     if (preference == 'vector') {
-      mapboxgl.setRTLTextPlugin('/mapbox-gl-rtl-text.js{{&key_query}}');
+      mapboxgl.setRTLTextPlugin('{{public_url}}mapbox-gl-rtl-text.js{{&key_query}}');
       var map = new mapboxgl.Map({
         container: 'map',
-        style: '/styles/{{id}}/style.json{{&key_query}}',
+        style: '{{public_url}}styles/{{id}}/style.json{{&key_query}}',
         hash: true
       });
       map.addControl(new mapboxgl.NavigationControl());
     } else {
-      var map = L.mapbox.map('map', '/styles/{{id}}.json{{&key_query}}', { zoomControl: false });
+      var map = L.mapbox.map('map', '{{public_url}}styles/{{id}}.json{{&key_query}}', { zoomControl: false });
       new L.Control.Zoom({ position: 'topright' }).addTo(map);
       setTimeout(function() {
         new L.Hash(map);

diff --git a/src/main.js b/src/main.js
@@ -42,6 +42,10 @@ var opts = require('commander')
     '-C|--no-cors',
     'Disable Cross-origin resource sharing headers'
   )
+  .option(
+    '-u|--public_url',
+    'Enable exposing the server on subpaths, not necessarily the root of the domain'
+  )
   .option(
     '-V, --verbose',
     'More verbose output'
@@ -59,13 +63,18 @@ var opts = require('commander')
 console.log('Starting ' + packageJson.name + ' v' + packageJson.version);
 
 var startServer = function(configPath, config) {
+  var publicUrl = opts.public_url;
+  if (publicUrl && publicUrl.lastIndexOf('/') !== publicUrl.length - 1) {
+    publicUrl += '/';
+  }
   return require('./server')({
     configPath: configPath,
     config: config,
     bind: opts.bind,
     port: opts.port,
     cors: opts.cors,
-    silent: opts.silent
+    silent: opts.silent,
+    publicUrl: publicUrl
   });
 };
 

diff --git a/src/serve_data.js b/src/serve_data.js
@@ -18,7 +18,7 @@ try {
 
 var utils = require('./utils');
 
-module.exports = function(options, repo, params, id, styles) {
+module.exports = function(options, repo, params, id, styles, publicUrl) {
   var app = express().disable('x-powered-by');
 
   var mbtilesFile = path.resolve(options.paths.mbtiles, params.mbtiles);
@@ -178,7 +178,7 @@ module.exports = function(options, repo, params, id, styles) {
   app.get('/' + id + '.json', function(req, res, next) {
     var info = clone(tileJSON);
     info.tiles = utils.getTileUrls(req, info.tiles,
-                                   'data/' + id, info.format, {
+                                   'data/' + id, info.format, publicUrl, {
                                      'pbf': options.pbfAlias
                                    });
     return res.send(info);

diff --git a/src/serve_rendered.js b/src/serve_rendered.js
@@ -97,7 +97,7 @@ function createEmptyResponse(format, color, callback) {
   });
 }
 
-module.exports = function(options, repo, params, id, dataResolver) {
+module.exports = function(options, repo, params, id, publicUrl, dataResolver) {
   var app = express().disable('x-powered-by');
 
   var maxScaleFactor = Math.min(Math.floor(options.maxScaleFactor || 3), 9);
@@ -747,7 +747,7 @@ module.exports = function(options, repo, params, id, dataResolver) {
   app.get('/' + id + '.json', function(req, res, next) {
     var info = clone(tileJSON);
     info.tiles = utils.getTileUrls(req, info.tiles,
-                                   'styles/' + id, info.format);
+                                   'styles/' + id, info.format, publicUrl);
     return res.send(info);
   });
 

diff --git a/src/serve_style.js b/src/serve_style.js
@@ -6,8 +6,9 @@ var path = require('path'),
 var clone = require('clone'),
     express = require('express');
 
+var utils = require('./utils');
 
-module.exports = function(options, repo, params, id, reportTiles, reportFont) {
+module.exports = function(options, repo, params, id, publicUrl, reportTiles, reportFont) {
   var app = express().disable('x-powered-by');
 
   var styleFile = path.resolve(options.paths.styles, params.style);
@@ -79,7 +80,7 @@ module.exports = function(options, repo, params, id, reportTiles, reportFont) {
         query = '?' + queryParams.join('&');
       }
       return url.replace(
-          'local://', req.protocol + '://' + req.headers.host + '/') + query;
+          'local://', utils.getPublicUrl(publicUrl, req)) + query;
     };
 
     var styleJSON_ = clone(styleJSON);

diff --git a/src/server.js b/src/server.js
@@ -112,7 +112,7 @@ function start(opts) {
     }
 
     if (item.serve_data !== false) {
-      startupPromises.push(serve_style(options, serving.styles, item, id,
+      startupPromises.push(serve_style(options, serving.styles, item, id, opts.publicUrl,
         function(mbtiles, fromData) {
           var dataItemId;
           Object.keys(data).forEach(function(id) {
@@ -148,7 +148,7 @@ function start(opts) {
     if (item.serve_rendered !== false) {
       if (serve_rendered) {
         startupPromises.push(
-          serve_rendered(options, serving.rendered, item, id,
+          serve_rendered(options, serving.rendered, item, id, opts.publicUrl,
             function(mbtiles) {
               var mbtilesFile;
               Object.keys(data).forEach(function(id) {
@@ -182,7 +182,7 @@ function start(opts) {
     }
 
     startupPromises.push(
-      serve_data(options, serving.data, item, id, serving.styles).then(function(sub) {
+      serve_data(options, serving.data, item, id, serving.styles, opts.publicUrl).then(function(sub) {
         app.use('/data/', sub);
       })
     );
@@ -197,7 +197,7 @@ function start(opts) {
         version: styleJSON.version,
         name: styleJSON.name,
         id: id,
-        url: req.protocol + '://' + req.headers.host +
+        url: utils.getPublicUrl(opts.publicUrl, req) +
              '/styles/' + id + '/style.json' + query
       });
     });
@@ -213,7 +213,7 @@ function start(opts) {
       } else {
         path = type + '/' + id;
       }
-      info.tiles = utils.getTileUrls(req, info.tiles, path, info.format, {
+      info.tiles = utils.getTileUrls(req, info.tiles, path, info.format, opts.publicUrl, {
         'pbf': options.pbfAlias
       });
       arr.push(info);
@@ -264,6 +264,7 @@ function start(opts) {
             }
           }
           data['server_version'] = packageJson.name + ' v' + packageJson.version;
+          data['public_url'] = opts.publicUrl || '/';
           data['is_light'] = isLight;
           data['key_query_part'] =
               req.query.key ? 'key=' + req.query.key + '&amp;' : '';
@@ -295,10 +296,10 @@ function start(opts) {
               Math.floor(centerPx[0] / 256) + '/' +
               Math.floor(centerPx[1] / 256) + '.png';
         }
-        
+
         var tiles = utils.getTileUrls(
             req, style.serving_rendered.tiles,
-            'styles/' + id, style.serving_rendered.format);
+            'styles/' + id, style.serving_rendered.format, opts.publicUrl);
         style.xyz_link = tiles[0];
       }
     });
@@ -321,7 +322,7 @@ function start(opts) {
         }
 
         var tiles = utils.getTileUrls(
-            req, data_.tiles, 'data/' + id, data_.format, {
+            req, data_.tiles, 'data/' + id, data_.format, opts.publicUrl, {
               'pbf': options.pbfAlias
             });
         data_.xyz_link = tiles[0];