geolite 0.0.18

open source geocode solution
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
use rusqlite::Connection;

use crate::database::table;

const SQL_CREATE: &str = "
  CREATE TABLE IF NOT EXISTS osm_pbf_files (
    id INTEGER PRIMARY KEY AUTOINCREMENT,
    origin INTEGER NOT NULL,
    origin_id VARCHAR(128),
    origin_name VARCHAR(128),
    url VARCHAR(512),
    origin_wkt BLOB,
    path VARCHAR(1024) UNIQUE,
    size_bytes INTEGER,
    md5 VARCHAR(32),
    downloaded_at INTEGER,
    osm_header_bbox_wkt BLOB,
    osm_header_required_features BLOB,
    osm_header_optional_features BLOB,
    osm_header_writingprogram VARCHAR(128),
    osm_header_source VARCHAR(512),
    osm_header_osmosis_replication_timestamp INTEGER,
    osm_header_osmosis_replication_sequence_number INTEGER,
    osm_header_osmosis_replication_base_url VARCHAR(512),
    osm_data_extracted_at INTEGER,
    node_count INTEGER,
    way_count INTEGER,
    relation_count INTEGER,
    admin_levels_count INTEGER,
    house_numbers_count INTEGER,
    created_at INTEGER NOT NULL DEFAULT (unixepoch()),
    updated_at INTEGER NOT NULL DEFAULT (unixepoch()),
    UNIQUE (origin, origin_id)
  );
  CREATE TRIGGER IF NOT EXISTS osm_pbf_files_updated_at
    AFTER UPDATE ON osm_pbf_files
    FOR EACH ROW
    BEGIN
      UPDATE osm_pbf_files SET updated_at = unixepoch() WHERE id = OLD.id;
    END;
";

const SQL_CREATE_INDEXES: &str = "
  CREATE INDEX IF NOT EXISTS osm_pbf_files_search_by_url
    ON osm_pbf_files(url);
";

pub struct osm_pbf_files;

impl table for osm_pbf_files {
  const CREATE: &str = SQL_CREATE;
  const INDEXES: &str = SQL_CREATE_INDEXES;
}

pub enum origin {
  local_path(String),
  geofabrik { id: String, url: String },
  url(String),
}

impl origin {
  pub fn code(&self) -> u8 {
    match self {
      origin::local_path(_) => 0,
      origin::geofabrik { .. } => 1,
      origin::url(_) => 2,
    }
  }

  pub fn download_url(&self) -> Option<&str> {
    match self {
      origin::local_path(_) => None,
      origin::geofabrik { url, .. } => Some(url),
      origin::url(url) => Some(url),
    }
  }

  pub fn file_name(&self) -> &str {
    match self {
      origin::local_path(path) => file_name_of(path),
      origin::geofabrik { url, .. } | origin::url(url) => file_name_of(url),
    }
  }
}

pub(super) fn file_name_of(path_or_url: &str) -> &str {
  std::path::Path::new(path_or_url)
    .file_name()
    .and_then(|name| name.to_str())
    .unwrap_or(path_or_url)
}

pub fn upsert_geofabrik_index_item(
  conn: &Connection,
  geofabrik_id: &str,
  name: &str,
  url: &str,
  wkt: Option<&str>,
) {
  const SQL_PROMOTE_URL_TO_GEOFABRIK: &str = "
    UPDATE OR IGNORE osm_pbf_files SET
      origin = 1,
      origin_id = ?1,
      origin_name = ?2,
      origin_wkt = ?4
    WHERE url = ?3
      AND origin = 2
  ";

  const SQL_UPSERT_GEOFABRIK: &str = "
    INSERT INTO osm_pbf_files (
      origin,
      origin_id,
      origin_name,
      url,
      origin_wkt
    ) VALUES (
      1,
      ?1,
      ?2,
      ?3,
      ?4
    )
    ON CONFLICT(origin, origin_id) DO UPDATE SET
      origin_name = excluded.origin_name,
      url = excluded.url,
      origin_wkt = excluded.origin_wkt
  ";

  let coverage = wkt.map(str::as_bytes);
  let promoted = conn
    .execute(
      SQL_PROMOTE_URL_TO_GEOFABRIK,
      rusqlite::params![geofabrik_id, name, url, coverage],
    )
    .expect("failed to promote url row to geofabrik");
  if promoted == 0 {
    conn
      .execute(
        SQL_UPSERT_GEOFABRIK,
        rusqlite::params![geofabrik_id, name, url, coverage],
      )
      .expect("failed to upsert geofabrik index item");
  }
}

pub fn list_geofabrik_index(conn: &Connection) -> Vec<(String, String, String)> {
  const SQL_LIST_GEOFABRIK_INDEX: &str = "
    SELECT
      origin_id,
      origin_name,
      url
    FROM osm_pbf_files
    WHERE origin = 1
    ORDER BY origin_id
  ";

  conn
    .prepare(SQL_LIST_GEOFABRIK_INDEX)
    .expect("failed to prepare list_geofabrik_index")
    .query_map([], |row| {
      Ok((
        row.get::<_, String>(0)?,
        row.get::<_, Option<String>>(1)?.unwrap_or_default(),
        row.get::<_, Option<String>>(2)?.unwrap_or_default(),
      ))
    })
    .expect("failed to query geofabrik index")
    .collect::<Result<Vec<_>, _>>()
    .expect("failed to collect geofabrik index rows")
}

pub fn get_geofabrik_url(conn: &Connection, geofabrik_id: &str) -> Option<String> {
  const SQL_GET_GEOFABRIK_URL_BY_ID: &str = "
    SELECT url
    FROM osm_pbf_files
    WHERE origin = 1
      AND origin_id = ?1
    LIMIT 1
  ";

  conn
    .query_row(
      SQL_GET_GEOFABRIK_URL_BY_ID,
      rusqlite::params![geofabrik_id],
      |row| row.get::<_, Option<String>>(0),
    )
    .ok()
    .flatten()
}

const SQL_GET_ID_BY_PATH: &str = "SELECT id FROM osm_pbf_files WHERE path = ?1";

pub fn get_id_by_path(conn: &Connection, file_path: &str) -> Option<u32> {
  conn
    .query_row(SQL_GET_ID_BY_PATH, rusqlite::params![file_path], |row| {
      row.get(0)
    })
    .ok()
}

pub fn ensure_by_file_path(conn: &Connection, file_path: &str) -> u32 {
  const SQL_ENSURE_LOCAL_PATH: &str = "
    INSERT OR IGNORE INTO osm_pbf_files (
      origin,
      origin_name,
      path
    ) VALUES (
      ?1,
      ?2,
      ?3
    )
  ";

  let from = origin::local_path(file_path.to_string());
  conn
    .execute(
      SQL_ENSURE_LOCAL_PATH,
      rusqlite::params![from.code(), file_name_of(file_path), file_path],
    )
    .expect("failed to ensure osm_pbf_files row");
  conn
    .query_row(SQL_GET_ID_BY_PATH, rusqlite::params![file_path], |row| {
      row.get(0)
    })
    .expect("failed to get id after ensure")
}

pub fn clear_download(conn: &Connection, file_path: &str) {
  const SQL_CLEAR_DOWNLOAD: &str = "
    UPDATE osm_pbf_files SET
      path = NULL,
      size_bytes = NULL,
      md5 = NULL,
      downloaded_at = NULL
    WHERE path = ?1
  ";

  conn
    .execute(SQL_CLEAR_DOWNLOAD, rusqlite::params![file_path])
    .expect("failed to clear download");
}

pub fn get_file_path(conn: &Connection, id_or_geofabrik_id: &str) -> Option<String> {
  const SQL_GET_FILE_PATH: &str = "
    SELECT path
    FROM osm_pbf_files
    WHERE (origin_id = ?1 OR url = ?1 OR CAST(id AS TEXT) = ?1)
      AND path IS NOT NULL
    LIMIT 1
  ";

  conn
    .query_row(
      SQL_GET_FILE_PATH,
      rusqlite::params![id_or_geofabrik_id],
      |row| row.get(0),
    )
    .ok()
    .flatten()
}

#[allow(clippy::too_many_arguments)]
pub fn update_osm_header(
  conn: &Connection,
  osm_pbf_file_path: &str,
  bbox_wkt: Option<Vec<u8>>,
  required_features: Option<Vec<u8>>,
  optional_features: Option<Vec<u8>>,
  writingprogram: Option<&str>,
  source: Option<&str>,
  osmosis_replication_timestamp: Option<i64>,
  osmosis_replication_sequence_number: Option<u32>,
  osmosis_replication_base_url: Option<&str>,
) {
  const SQL_UPDATE_OSM_HEADER: &str = "
    UPDATE osm_pbf_files SET
      osm_header_bbox_wkt = ?1,
      osm_header_required_features = ?2,
      osm_header_optional_features = ?3,
      osm_header_writingprogram = ?4,
      osm_header_source = ?5,
      osm_header_osmosis_replication_timestamp = ?6,
      osm_header_osmosis_replication_sequence_number = ?7,
      osm_header_osmosis_replication_base_url = ?8
    WHERE path = ?9
  ";

  ensure_by_file_path(conn, osm_pbf_file_path);
  conn
    .execute(
      SQL_UPDATE_OSM_HEADER,
      rusqlite::params![
        bbox_wkt,
        required_features,
        optional_features,
        writingprogram,
        source,
        osmosis_replication_timestamp,
        osmosis_replication_sequence_number,
        osmosis_replication_base_url,
        osm_pbf_file_path,
      ],
    )
    .expect("failed to update osm header");
}

pub fn update_counts(
  conn: &Connection,
  file_id: u32,
  node_count: u64,
  way_count: u64,
  relation_count: u64,
) {
  const SQL_UPDATE_COUNTS: &str = "
    UPDATE osm_pbf_files SET
      node_count = ?1,
      way_count = ?2,
      relation_count = ?3,
      osm_data_extracted_at = UNIXEPOCH()
    WHERE id = ?4
  ";

  conn
    .execute(
      SQL_UPDATE_COUNTS,
      rusqlite::params![node_count, way_count, relation_count, file_id],
    )
    .expect("failed to update osm_pbf_files counts");
}

pub fn update_downloaded(
  conn: &Connection,
  from: &origin,
  file_path: &str,
  size_bytes: u64,
  md5: &str,
) {
  const SQL_UPDATE_DOWNLOADED_GEOFABRIK: &str = "
    UPDATE osm_pbf_files SET
      path = ?1,
      size_bytes = ?2,
      md5 = ?3,
      downloaded_at = UNIXEPOCH()
    WHERE origin = 1
      AND origin_id = ?4
  ";

  const SQL_UPDATE_DOWNLOADED_URL: &str = "
    UPDATE osm_pbf_files SET
      path = ?1,
      size_bytes = ?2,
      md5 = ?3,
      downloaded_at = UNIXEPOCH()
    WHERE url = ?4
  ";

  const SQL_INSERT_DOWNLOADED: &str = "
    INSERT INTO osm_pbf_files (
      origin,
      origin_id,
      origin_name,
      url,
      path,
      size_bytes,
      md5,
      downloaded_at
    ) VALUES (
      ?1,
      ?2,
      ?3,
      ?4,
      ?5,
      ?6,
      ?7,
      UNIXEPOCH()
    )
    ON CONFLICT(path) DO UPDATE SET
      origin = excluded.origin,
      origin_id = excluded.origin_id,
      origin_name = excluded.origin_name,
      url = excluded.url,
      size_bytes = excluded.size_bytes,
      md5 = excluded.md5,
      downloaded_at = excluded.downloaded_at
  ";

  let (update, key, origin_id, url) = match from {
    origin::geofabrik { id, url } => (SQL_UPDATE_DOWNLOADED_GEOFABRIK, id.as_str(), Some(id.as_str()), url.as_str()),
    origin::url(url) => (SQL_UPDATE_DOWNLOADED_URL, url.as_str(), None, url.as_str()),
    origin::local_path(path) => panic!("a local file is never recorded as downloaded: {path}"),
  };
  let affected = conn
    .execute(update, rusqlite::params![file_path, size_bytes, md5, key])
    .expect("failed to update downloaded");
  if affected == 0 {
    conn
      .execute(
        SQL_INSERT_DOWNLOADED,
        rusqlite::params![from.code(), origin_id, file_name_of(url), url, file_path, size_bytes, md5],
      )
      .expect("failed to insert downloaded");
  }
}

pub fn known_paths(conn: &Connection) -> Vec<String> {
  const SQL_KNOWN_PATHS: &str = "
    SELECT path
    FROM osm_pbf_files
    WHERE path IS NOT NULL
    ORDER BY id
  ";

  let mut stmt = conn
    .prepare(SQL_KNOWN_PATHS)
    .expect("failed to prepare the known paths");
  stmt
    .query_map([], |row| row.get(0))
    .expect("failed to list the known paths")
    .map(|row| row.expect("failed to read a path"))
    .collect()
}

// the rows of every file in the base attached as `base`, traced through the chunks of the
// osm_data; one pass per base, because each pass materialises a join over every way
pub fn count_admin_levels_per_file(conn: &Connection) -> Vec<(u32, i64)> {
  const SQL_COUNT_ADMIN_LEVELS_PER_FILE: &str = "
    WITH way_to_file AS (
      SELECT
        osm_ways.id AS osm_id,
        osm_pbf_blob_chunks.file_id AS file_id
      FROM osm_ways
      JOIN osm_pbf_blob_chunks
        ON osm_pbf_blob_chunks.id = osm_ways.osm_pbf_chunk_id
    ),
    relation_to_file AS (
      SELECT
        osm_relations.id AS osm_id,
        osm_pbf_blob_chunks.file_id AS file_id
      FROM osm_relations
      JOIN osm_pbf_blob_chunks
        ON osm_pbf_blob_chunks.id = osm_relations.osm_pbf_chunk_id
    )
    SELECT
      COALESCE(way_to_file.file_id, relation_to_file.file_id) AS file_id,
      COUNT(*)
    FROM base.admin_levels
    LEFT JOIN way_to_file ON way_to_file.osm_id = base.admin_levels.way_id
    LEFT JOIN relation_to_file ON relation_to_file.osm_id = base.admin_levels.relation_id
    WHERE base.admin_levels.wkb IS NOT NULL
      AND COALESCE(way_to_file.file_id, relation_to_file.file_id) IS NOT NULL
    GROUP BY 1
  ";

  counts_per_file(conn, SQL_COUNT_ADMIN_LEVELS_PER_FILE)
}

pub fn count_house_numbers_per_file(conn: &Connection) -> Vec<(u32, i64)> {
  const SQL_COUNT_HOUSE_NUMBERS_PER_FILE: &str = "
    WITH way_to_file AS (
      SELECT
        osm_ways.id AS osm_id,
        osm_pbf_blob_chunks.file_id AS file_id
      FROM osm_ways
      JOIN osm_pbf_blob_chunks
        ON osm_pbf_blob_chunks.id = osm_ways.osm_pbf_chunk_id
    ),
    relation_to_file AS (
      SELECT
        osm_relations.id AS osm_id,
        osm_pbf_blob_chunks.file_id AS file_id
      FROM osm_relations
      JOIN osm_pbf_blob_chunks
        ON osm_pbf_blob_chunks.id = osm_relations.osm_pbf_chunk_id
    ),
    admin_to_file AS (
      SELECT
        base.admin_levels.id AS admin_id,
        COALESCE(way_to_file.file_id, relation_to_file.file_id) AS file_id
      FROM base.admin_levels
      LEFT JOIN way_to_file ON way_to_file.osm_id = base.admin_levels.way_id
      LEFT JOIN relation_to_file ON relation_to_file.osm_id = base.admin_levels.relation_id
    )
    SELECT
      admin_to_file.file_id,
      COUNT(*)
    FROM base.house_numbers
    JOIN admin_to_file ON admin_to_file.admin_id = base.house_numbers.admin_level_id
    WHERE admin_to_file.file_id IS NOT NULL
    GROUP BY admin_to_file.file_id
  ";

  counts_per_file(conn, SQL_COUNT_HOUSE_NUMBERS_PER_FILE)
}

fn counts_per_file(conn: &Connection, sql: &str) -> Vec<(u32, i64)> {
  let mut stmt = conn
    .prepare(sql)
    .expect("failed to prepare the counts per file");
  stmt
    .query_map([], |row| Ok((row.get(0)?, row.get(1)?)))
    .expect("failed to count the rows per file")
    .map(|row| row.expect("failed to read a count per file"))
    .collect()
}

pub fn set_admin_levels_count(conn: &Connection, file_id: u32, total: i64) {
  const SQL_SET_ADMIN_LEVELS_COUNT: &str = "
    UPDATE osm_pbf_files SET
      admin_levels_count = ?1
    WHERE id = ?2
  ";

  conn
    .execute(SQL_SET_ADMIN_LEVELS_COUNT, rusqlite::params![total, file_id])
    .expect("failed to set the admin levels count of a file");
}

pub fn set_house_numbers_count(conn: &Connection, file_id: u32, total: i64) {
  const SQL_SET_HOUSE_NUMBERS_COUNT: &str = "
    UPDATE osm_pbf_files SET
      house_numbers_count = ?1
    WHERE id = ?2
  ";

  conn
    .execute(SQL_SET_HOUSE_NUMBERS_COUNT, rusqlite::params![total, file_id])
    .expect("failed to set the house numbers count of a file");
}

pub fn osm_data_extracted(conn: &Connection, file_id: u32) -> bool {
  const SQL_OSM_DATA_EXTRACTED: &str = "
    SELECT osm_data_extracted_at IS NOT NULL
    FROM osm_pbf_files
    WHERE id = ?1
  ";

  conn
    .query_row(SQL_OSM_DATA_EXTRACTED, [file_id], |row| row.get::<_, bool>(0))
    .unwrap_or(false)
}

pub fn any_osm_data_extracted(conn: &Connection) -> bool {
  const SQL_ANY_OSM_DATA_EXTRACTED: &str = "
    SELECT EXISTS (
      SELECT 1
      FROM osm_pbf_files
      JOIN osm_pbf_blob_chunks
        ON osm_pbf_blob_chunks.file_id = osm_pbf_files.id
      WHERE osm_pbf_files.osm_data_extracted_at IS NOT NULL
    )
  ";

  conn
    .query_row(SQL_ANY_OSM_DATA_EXTRACTED, [], |row| row.get::<_, bool>(0))
    .expect("failed to query osm_pbf_files for an extracted file")
}

pub fn any_house_numbers_counted(conn: &Connection) -> bool {
  const SQL_ANY_HOUSE_NUMBERS_COUNTED: &str = "
    SELECT EXISTS (
      SELECT 1
      FROM osm_pbf_files
      WHERE house_numbers_count IS NOT NULL
    )
  ";

  conn
    .query_row(SQL_ANY_HOUSE_NUMBERS_COUNTED, [], |row| row.get::<_, bool>(0))
    .expect("failed to query osm_pbf_files for a house numbers count")
}