-
Notifications
You must be signed in to change notification settings - Fork 59
/
geo-reverse.js
150 lines (128 loc) · 4.56 KB
/
geo-reverse.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
import request from 'request';
import Logger from '@home-gallery/logger'
import { throttleAsync } from '@home-gallery/stream';
import { toPlugin } from '../pluginUtils.js';
const log = Logger('extractor.geoReverse');
const getAcceptLanguageValue = (languages) => {
if (typeof languages == 'string') {
languages = languages.split(',')
}
const anyLang = '*;q=0.5';
const priorities = languages.map((lang, index, array) => {
const isFirst = index === 0;
if (isFirst) {
return lang;
} else {
const percent = index * (1 / array.length);
const q = (1 - 0.5 * percent).toFixed(1);
return `${lang};q=${q}`;
}
}).concat(anyLang);
return priorities.join(',');
}
const geoReverseSuffix = 'geo-reverse.json';
/**
* @param {import('@home-gallery/types').TStorage} storage
* @param {object} options
* @returns {import('stream').Transform}
*/
async function geoReverse(storage, options) {
let isLimitExceeded = false;
function passThrough(entry) {
if (isLimitExceeded) {
return true;
} else if (storage.hasFile(entry, geoReverseSuffix)) {
return true
} else if (entry.meta.exif?.GPSPosition) {
return false;
} else {
return true;
}
}
function task(entry, cb) {
if (!entry.meta.exif?.GPSPosition) {
return cb();
}
const geoPosition = entry.meta.exif?.GPSPosition;
if (!geoPosition.match(/^[-0-9+.eE]+ [-0-9+.eE]+$/)) {
log.warn(`Invalid geo position of ${entry}: ${geoPosition}. Expecting space separated lat lon values`);
return cb();
}
const latLon = geoPosition.split(' ');
const lat = (+latLon[0]).toFixed(7);
const lon = (+latLon[1]).toFixed(7);
const geo = `${lat}/${lon}`;
if (lat === 'NaN' || lon === 'NaN' || Math.max(Math.abs(lat), Math.abs(lon)) < 0.001) {
log.warn(`Invalid geo position values of ${entry}: ${geoPosition}`);
return cb();
}
const url = `${options.url}/reverse?format=jsonv2&lat=${lat}&lon=${lon}&polygon_geojson=1`;
const req = {
url,
headers: {
'User-Agent': 'home-gallery/1.0.0',
'Accept-Language': `${options.acceptLanguage}`
},
timeout: 4000,
}
const t0 = Date.now();
request(req, (err, res, body) => {
if (err) {
log.error(err, `Could not query geo reverse of ${entry} for ${geo} by URL ${url}: ${err}`);
return cb();
} else if (res.statusCode < 100 || res.statusCode >= 300) {
if (res.statusCode === 429) {
log.warn(`Bandwidth limit exceeded. Stop querying geo data`);
isLimitExceeded = true;
} else {
log.warn({req, res}, `Could not query geo reverse of ${entry} for ${geo} by URL ${url}: response code is ${res.statusCode} with body ${res.body.replace(/\n/g, '\\n')})`);
}
return cb();
}
let data
try {
data = JSON.parse(body)
} catch (err) {
log.warn({req, res}, `Could not parse request body of ${entry} for ${geo} by URL ${url}: ${err}`);
return cb()
}
storage.writeFile(entry, geoReverseSuffix, data)
.then(() => {
let info =`${data.osm_type} at ${[data.address?.city, data.address?.country].filter(v => !!v).join(', ')} (${data.address?.country_code?.toUpperCase()})`;
log.debug(t0, `Successful geo reverse lookup for ${entry} for ${geo}: ${info}`);
})
.catch(err => {
log.error(err, `Could write geo reverse of ${entry} for ${geo}: ${err}`);
})
.finally(cb)
})
}
// 1req/1s should be fine. See https://operations.osmfoundation.org/policies/nominatim/
return throttleAsync({passThrough, task, rateLimitMs: 1000, startLimitAfterTask: true});
}
/**
* @param {import('@home-gallery/types').TPluginManager} manager
* @returns {import('@home-gallery/types').TExtractor}
*/
const geoReversePlugin = manager => ({
name: 'geoReverse',
phase: 'file',
/**
* @param {import('@home-gallery/types').TStorage} storage
*/
async create(storage) {
const config = manager.getConfig()
const configOptions = config?.extractor?.geoReverse || {}
const addressLanguage = configOptions.addressLanguage || ['en', 'de']
const acceptLanguage = getAcceptLanguageValue(addressLanguage)
const options = {
url: 'https://nominatim.openstreetmap.org',
acceptLanguage,
...configOptions
}
log.debug(`Use geo server ${options.url} with languages ${addressLanguage}`)
return geoReverse(storage, options)
},
})
const plugin = toPlugin(geoReversePlugin, 'geoAddressExtractor', ['metaExtractor'])
export default plugin