-
Notifications
You must be signed in to change notification settings - Fork 1.2k
/
background_source.js
608 lines (478 loc) · 20.6 KB
/
background_source.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
import { geoArea as d3_geoArea, geoMercatorRaw as d3_geoMercatorRaw } from 'd3-geo';
import { json as d3_json } from 'd3-fetch';
import { escape } from 'lodash';
import { t, localizer } from '../core/localizer';
import { geoExtent, geoSphericalDistance } from '../geo';
import { utilQsString, utilStringQs } from '../util';
import { utilAesDecrypt } from '../util/aes';
import { IntervalTasksQueue } from '../util/IntervalTasksQueue';
var isRetina = window.devicePixelRatio && window.devicePixelRatio >= 2;
// listen for DPI change, e.g. when dragging a browser window from a retina to non-retina screen
window.matchMedia?.(`
(-webkit-min-device-pixel-ratio: 2), /* Safari */
(min-resolution: 2dppx), /* standard */
(min-resolution: 192dpi) /* fallback */
`).addListener(function() {
isRetina = window.devicePixelRatio && window.devicePixelRatio >= 2;
});
function localeDateString(s) {
if (!s) return null;
var options = { day: 'numeric', month: 'short', year: 'numeric' };
var d = new Date(s);
if (isNaN(d.getTime())) return null;
return d.toLocaleDateString(localizer.localeCode(), options);
}
function vintageRange(vintage) {
var s;
if (vintage.start || vintage.end) {
s = (vintage.start || '?');
if (vintage.start !== vintage.end) {
s += ' - ' + (vintage.end || '?');
}
}
return s;
}
export function rendererBackgroundSource(data) {
var source = Object.assign({}, data); // shallow copy
var _offset = [0, 0];
var _name = source.name;
var _description = source.description;
var _best = !!source.best;
var _template = source.encrypted ? utilAesDecrypt(source.template) : source.template;
source.tileSize = data.tileSize || 256;
source.zoomExtent = data.zoomExtent || [0, 22];
source.overzoom = data.overzoom !== false;
source.offset = function(val) {
if (!arguments.length) return _offset;
_offset = val;
return source;
};
source.nudge = function(val, zoomlevel) {
_offset[0] += val[0] / Math.pow(2, zoomlevel);
_offset[1] += val[1] / Math.pow(2, zoomlevel);
return source;
};
source.name = function() {
var id_safe = source.id.replace(/\./g, '<TX_DOT>');
return t('imagery.' + id_safe + '.name', { default: escape(_name) });
};
source.label = function() {
var id_safe = source.id.replace(/\./g, '<TX_DOT>');
return t.append('imagery.' + id_safe + '.name', { default: escape(_name) });
};
source.hasDescription = function() {
var id_safe = source.id.replace(/\./g, '<TX_DOT>');
var descriptionText = localizer.tInfo('imagery.' + id_safe + '.description', { default: escape(_description) }).text;
return descriptionText !== '';
};
source.description = function() {
var id_safe = source.id.replace(/\./g, '<TX_DOT>');
return t.append('imagery.' + id_safe + '.description', { default: escape(_description) });
};
source.best = function() {
return _best;
};
source.area = function() {
if (!data.polygon) return Number.MAX_VALUE; // worldwide
var area = d3_geoArea({ type: 'MultiPolygon', coordinates: [ data.polygon ] });
return isNaN(area) ? 0 : area;
};
source.imageryUsed = function() {
return _name || source.id;
};
source.template = function(val) {
if (!arguments.length) return _template;
if (source.id === 'custom' || source.id === 'Bing') {
_template = val;
}
return source;
};
source.url = function(coord) {
var result = _template.replace(/#[\s\S]*/u, ''); // strip hash part of URL
if (result === '') return result; // source 'none'
// Guess a type based on the tokens present in the template
// (This is for 'custom' source, where we don't know)
if (!source.type || source.id === 'custom') {
if (/SERVICE=WMS|\{(proj|wkid|bbox)\}/.test(result)) {
source.type = 'wms';
source.projection = 'EPSG:3857'; // guess
} else if (/\{(x|y)\}/.test(result)) {
source.type = 'tms';
} else if (/\{u\}/.test(result)) {
source.type = 'bing';
}
}
if (source.type === 'wms') {
var tileToProjectedCoords = (function(x, y, z) {
var zoomSize = Math.pow(2, z);
var lon = x / zoomSize * Math.PI * 2 - Math.PI;
var lat = Math.atan(Math.sinh(Math.PI * (1 - 2 * y / zoomSize)));
switch (source.projection) {
case 'EPSG:4326':
return {
x: lon * 180 / Math.PI,
y: lat * 180 / Math.PI
};
default: // EPSG:3857 and synonyms
var mercCoords = d3_geoMercatorRaw(lon, lat);
return {
x: 20037508.34 / Math.PI * mercCoords[0],
y: 20037508.34 / Math.PI * mercCoords[1]
};
}
});
var tileSize = source.tileSize;
var projection = source.projection;
var minXmaxY = tileToProjectedCoords(coord[0], coord[1], coord[2]);
var maxXminY = tileToProjectedCoords(coord[0]+1, coord[1]+1, coord[2]);
result = result.replace(/\{(\w+)\}/g, function (token, key) {
switch (key) {
case 'width':
case 'height':
return tileSize;
case 'proj':
return projection;
case 'wkid':
return projection.replace(/^EPSG:/, '');
case 'bbox':
// WMS 1.3 flips x/y for some coordinate systems including EPSG:4326 - #7557
if (projection === 'EPSG:4326' &&
// The CRS parameter implies version 1.3 (prior versions use SRS)
/VERSION=1.3|CRS={proj}/.test(source.template().toUpperCase())) {
return maxXminY.y + ',' + minXmaxY.x + ',' + minXmaxY.y + ',' + maxXminY.x;
} else {
return minXmaxY.x + ',' + maxXminY.y + ',' + maxXminY.x + ',' + minXmaxY.y;
}
case 'w':
return minXmaxY.x;
case 's':
return maxXminY.y;
case 'n':
return maxXminY.x;
case 'e':
return minXmaxY.y;
default:
return token;
}
});
} else if (source.type === 'tms') {
result = result
.replace('{x}', coord[0])
.replace('{y}', coord[1])
// TMS-flipped y coordinate
.replace(/\{[t-]y\}/, Math.pow(2, coord[2]) - coord[1] - 1)
.replace(/\{z(oom)?\}/, coord[2])
// only fetch retina tiles for retina screens
.replace(/\{@2x\}|\{r\}/, isRetina ? '@2x' : '');
} else if (source.type === 'bing') {
result = result
.replace('{u}', function() {
var u = '';
for (var zoom = coord[2]; zoom > 0; zoom--) {
var b = 0;
var mask = 1 << (zoom - 1);
if ((coord[0] & mask) !== 0) b++;
if ((coord[1] & mask) !== 0) b += 2;
u += b.toString();
}
return u;
});
}
// these apply to any type..
result = result.replace(/\{switch:([^}]+)\}/, function(s, r) {
var subdomains = r.split(',');
return subdomains[(coord[0] + coord[1]) % subdomains.length];
});
return result;
};
source.validZoom = function(z) {
return source.zoomExtent[0] <= z &&
(source.overzoom || source.zoomExtent[1] > z);
};
source.isLocatorOverlay = function() {
return source.id === 'mapbox_locator_overlay';
};
/* hides a source from the list, but leaves it available for use */
source.isHidden = function() {
return source.id === 'DigitalGlobe-Premium-vintage' ||
source.id === 'DigitalGlobe-Standard-vintage';
};
source.copyrightNotices = function() {};
source.getMetadata = function(center, tileCoord, callback) {
var vintage = {
start: localeDateString(source.startDate),
end: localeDateString(source.endDate)
};
vintage.range = vintageRange(vintage);
var metadata = { vintage: vintage };
callback(null, metadata);
};
return source;
}
rendererBackgroundSource.Bing = function(data, dispatch) {
// https://docs.microsoft.com/en-us/bingmaps/rest-services/imagery/get-imagery-metadata
// https://docs.microsoft.com/en-us/bingmaps/rest-services/directly-accessing-the-bing-maps-tiles
//fallback url template
data.template = 'https://ecn.t{switch:0,1,2,3}.tiles.virtualearth.net/tiles/a{u}.jpeg?g=1&pr=odbl&n=z';
var bing = rendererBackgroundSource(data);
var key = utilAesDecrypt('5c875730b09c6b422433e807e1ff060b6536c791dbfffcffc4c6b18a1bdba1f14593d151adb50e19e1be1ab19aef813bf135d0f103475e5c724dec94389e45d0');
/*
missing tile image strictness param (n=)
• n=f -> (Fail) returns a 404
• n=z -> (Empty) returns a 200 with 0 bytes (no content)
• n=t -> (Transparent) returns a 200 with a transparent (png) tile
*/
const strictParam = 'n';
var url = 'https://dev.virtualearth.net/REST/v1/Imagery/Metadata/AerialOSM?include=ImageryProviders&uriScheme=https&key=' + key;
var cache = {};
var inflight = {};
var providers = [];
var taskQueue = new IntervalTasksQueue(250);
var metadataLastZoom = -1;
d3_json(url)
.then(function(json) {
let imageryResource = json.resourceSets[0].resources[0];
//retrieve and prepare up to date imagery template
let template = imageryResource.imageUrl; //https://ecn.{subdomain}.tiles.virtualearth.net/tiles/a{quadkey}.jpeg?g=10339
let subDomains = imageryResource.imageUrlSubdomains; //["t0, t1, t2, t3"]
let subDomainNumbers = subDomains.map((subDomain) => {
return subDomain.substring(1);
} ).join(',');
template = template.replace('{subdomain}', `t{switch:${subDomainNumbers}}`).replace('{quadkey}', '{u}');
if (!new URLSearchParams(template).has(strictParam)){
template += `&${strictParam}=z`;
}
bing.template(template);
providers = imageryResource.imageryProviders.map(function(provider) {
return {
attribution: provider.attribution,
areas: provider.coverageAreas.map(function(area) {
return {
zoom: [area.zoomMin, area.zoomMax],
extent: geoExtent([area.bbox[1], area.bbox[0]], [area.bbox[3], area.bbox[2]])
};
})
};
});
dispatch.call('change');
})
.catch(function() {
/* ignore */
});
bing.copyrightNotices = function(zoom, extent) {
zoom = Math.min(zoom, 21);
return providers.filter(function(provider) {
return provider.areas.some(function(area) {
return extent.intersects(area.extent) &&
area.zoom[0] <= zoom &&
area.zoom[1] >= zoom;
});
}).map(function(provider) {
return provider.attribution;
}).join(', ');
};
bing.getMetadata = function(center, tileCoord, callback) {
var tileID = tileCoord.slice(0, 3).join('/');
var zoom = Math.min(tileCoord[2], 21);
var centerPoint = center[1] + ',' + center[0]; // lat,lng
var url = 'https://dev.virtualearth.net/REST/v1/Imagery/BasicMetadata/AerialOSM/' + centerPoint +
'?zl=' + zoom + '&key=' + key;
if (inflight[tileID]) return;
if (!cache[tileID]) {
cache[tileID] = {};
}
if (cache[tileID] && cache[tileID].metadata) {
return callback(null, cache[tileID].metadata);
}
inflight[tileID] = true;
if (metadataLastZoom !== tileCoord[2]){
metadataLastZoom = tileCoord[2];
taskQueue.clear();
}
taskQueue.enqueue(() => {
d3_json(url)
.then(function (result) {
delete inflight[tileID];
if (!result) {
throw new Error('Unknown Error');
}
var vintage = {
start: localeDateString(result.resourceSets[0].resources[0].vintageStart),
end: localeDateString(result.resourceSets[0].resources[0].vintageEnd)
};
vintage.range = vintageRange(vintage);
var metadata = { vintage: vintage };
cache[tileID].metadata = metadata;
if (callback) callback(null, metadata);
})
.catch(function (err) {
delete inflight[tileID];
if (callback) callback(err.message);
});
});
};
bing.terms_url = 'https://blog.openstreetmap.org/2010/11/30/microsoft-imagery-details';
return bing;
};
rendererBackgroundSource.Esri = function(data) {
// in addition to using the tilemap at zoom level 20, overzoom real tiles - #4327 (deprecated technique, but it works)
if (data.template.match(/blankTile/) === null) {
data.template = data.template + '?blankTile=false';
}
var esri = rendererBackgroundSource(data);
var cache = {};
var inflight = {};
var _prevCenter;
// use a tilemap service to set maximum zoom for esri tiles dynamically
// https://developers.arcgis.com/documentation/tiled-elevation-service/
esri.fetchTilemap = function(center) {
// skip if we have already fetched a tilemap within 5km
if (_prevCenter && geoSphericalDistance(center, _prevCenter) < 5000) return;
_prevCenter = center;
// tiles are available globally to zoom level 19, afterward they may or may not be present
var z = 20;
// first generate a random url using the template
var dummyUrl = esri.url([1,2,3]);
// calculate url z/y/x from the lat/long of the center of the map
var x = (Math.floor((center[0] + 180) / 360 * Math.pow(2, z)));
var y = (Math.floor((1 - Math.log(Math.tan(center[1] * Math.PI / 180) + 1 / Math.cos(center[1] * Math.PI / 180)) / Math.PI) / 2 * Math.pow(2, z)));
// fetch an 8x8 grid to leverage cache
var tilemapUrl = dummyUrl.replace(/tile\/[0-9]+\/[0-9]+\/[0-9]+\?blankTile=false/, 'tilemap') + '/' + z + '/' + y + '/' + x + '/8/8';
// make the request and introspect the response from the tilemap server
d3_json(tilemapUrl)
.then(function(tilemap) {
if (!tilemap) {
throw new Error('Unknown Error');
}
var hasTiles = true;
for (var i = 0; i < tilemap.data.length; i++) {
// 0 means an individual tile in the grid doesn't exist
if (!tilemap.data[i]) {
hasTiles = false;
break;
}
}
// if any tiles are missing at level 20 we restrict maxZoom to 19
esri.zoomExtent[1] = (hasTiles ? 22 : 19);
})
.catch(function() {
/* ignore */
});
};
esri.getMetadata = function(center, tileCoord, callback) {
if (esri.id !== 'EsriWorldImagery') {
// rest endpoint is not available for ESRI's "clarity" imagery
return callback(null, {});
}
var tileID = tileCoord.slice(0, 3).join('/');
var zoom = Math.min(tileCoord[2], esri.zoomExtent[1]);
var centerPoint = center[0] + ',' + center[1]; // long, lat (as it should be)
var unknown = t('info_panels.background.unknown');
var vintage = {};
var metadata = {};
if (inflight[tileID]) return;
// build up query using the layer appropriate to the current zoom
var url = 'https://services.arcgisonline.com/arcgis/rest/services/World_Imagery/MapServer/4/query';
url += '?returnGeometry=false&geometry=' + centerPoint + '&inSR=4326&geometryType=esriGeometryPoint&outFields=*&f=json';
if (!cache[tileID]) {
cache[tileID] = {};
}
if (cache[tileID] && cache[tileID].metadata) {
return callback(null, cache[tileID].metadata);
}
inflight[tileID] = true;
d3_json(url)
.then(function(result) {
delete inflight[tileID];
result = result.features.map(f => f.attributes)
.filter(a => a.MinMapLevel <= zoom && a.MaxMapLevel >= zoom)[0];
if (!result) {
throw new Error('Unknown Error');
} else if (result.features && result.features.length < 1) {
throw new Error('No Results');
} else if (result.error && result.error.message) {
throw new Error(result.error.message);
}
// pass through the discrete capture date from metadata
var captureDate = localeDateString(result.SRC_DATE2);
vintage = {
start: captureDate,
end: captureDate,
range: captureDate
};
metadata = {
vintage: vintage,
source: clean(result.NICE_NAME),
description: clean(result.NICE_DESC),
resolution: clean(+Number(result.SRC_RES).toFixed(4)),
accuracy: clean(+Number(result.SRC_ACC).toFixed(4))
};
// append units - meters
if (isFinite(metadata.resolution)) {
metadata.resolution += ' m';
}
if (isFinite(metadata.accuracy)) {
metadata.accuracy += ' m';
}
cache[tileID].metadata = metadata;
if (callback) callback(null, metadata);
})
.catch(function(err) {
delete inflight[tileID];
if (callback) callback(err.message);
});
function clean(val) {
return String(val).trim() || unknown;
}
};
return esri;
};
rendererBackgroundSource.None = function() {
var source = rendererBackgroundSource({ id: 'none', template: '' });
source.name = function() {
return t('background.none');
};
source.label = function() {
return t.append('background.none');
};
source.imageryUsed = function() {
return null;
};
source.area = function() {
return -1; // sources in background pane are sorted by area
};
return source;
};
rendererBackgroundSource.Custom = function(template) {
var source = rendererBackgroundSource({ id: 'custom', template: template });
source.name = function() {
return t('background.custom');
};
source.label = function() {
return t.append('background.custom');
};
source.imageryUsed = function() {
// sanitize personal connection tokens - #6801
var cleaned = source.template();
// from query string parameters
if (cleaned.indexOf('?') !== -1) {
var parts = cleaned.split('?', 2);
var qs = utilStringQs(parts[1]);
['access_token', 'connectId', 'token', 'Signature'].forEach(function(param) {
if (qs[param]) {
qs[param] = '{apikey}';
}
});
cleaned = parts[0] + '?' + utilQsString(qs, true); // true = soft encode
}
// from wms/wmts api path parameters
cleaned = cleaned
.replace(/token\/(\w+)/, 'token/{apikey}')
.replace(/key=(\w+)/, 'key={apikey}');
return 'Custom (' + cleaned + ' )';
};
source.area = function() {
return -2; // sources in background pane are sorted by area
};
return source;
};