From d0d9783b78fe86a9422622f1ae10f2a530e37924 Mon Sep 17 00:00:00 2001
From: Thibault Deckers <thibault.deckers@gmail.com>
Date: Wed, 25 Sep 2024 23:23:05 +0200
Subject: [PATCH] americana / osm liberty merge

---
 lib/l10n/app_en.arb                           |   4 +-
 lib/model/app/dependencies.dart               |  10 ++
 lib/view/src/settings/enums.dart              |   2 +-
 lib/widgets/common/map/attribution.dart       |   4 +-
 lib/widgets/common/map/geo_map.dart           |   2 +-
 lib/widgets/common/map/leaflet/map.dart       |   4 +-
 .../common/map/leaflet/tile_layers.dart       |  57 ++++++---
 .../leaflet/vector_style_reader_extra.dart    | 113 ++++++++++++++++++
 plugins/aves_map/lib/src/style.dart           |   2 +-
 pubspec.lock                                  |  11 +-
 pubspec.yaml                                  |   4 +-
 11 files changed, 180 insertions(+), 33 deletions(-)
 create mode 100644 lib/widgets/common/map/leaflet/vector_style_reader_extra.dart

diff --git a/lib/l10n/app_en.arb b/lib/l10n/app_en.arb
index 9850e3b03..94dc5179e 100644
--- a/lib/l10n/app_en.arb
+++ b/lib/l10n/app_en.arb
@@ -238,7 +238,7 @@
   "mapStyleGoogleNormal": "Google Maps",
   "mapStyleGoogleHybrid": "Google Maps (Hybrid)",
   "mapStyleGoogleTerrain": "Google Maps (Terrain)",
-  "mapStyleOsmAmericana": "OSM Americana",
+  "mapStyleOsmLiberty": "OSM Liberty",
   "mapStyleOpenTopoMap": "OpenTopoMap",
   "mapStyleOsmHot": "Humanitarian OSM",
   "mapStyleStamenWatercolor": "Stamen Watercolor",
@@ -1034,7 +1034,7 @@
   "mapZoomInTooltip": "Zoom in",
   "mapZoomOutTooltip": "Zoom out",
   "mapPointNorthUpTooltip": "Point north up",
-  "mapAttributionOsmAmericana": "Map data © [OpenStreetMap](https://www.openstreetmap.org/copyright) contributors • Tiles by [OpenMapTiles](https://www.openmaptiles.org/), [CC BY](http://creativecommons.org/licenses/by/4.0)",
+  "mapAttributionOsmLiberty": "Map data © [OpenStreetMap](https://www.openstreetmap.org/copyright) contributors • Tiles by [OpenMapTiles](https://www.openmaptiles.org/), [CC BY](http://creativecommons.org/licenses/by/4.0) • Hosted by [OSM Americana](https://tile.ourmap.us)",
   "mapAttributionOpenTopoMap": "Map data © [OpenStreetMap](https://www.openstreetmap.org/copyright) contributors • [SRTM](https://www.earthdata.nasa.gov/sensors/srtm) | Tiles by [OpenTopoMap](https://opentopomap.org/), [CC BY-SA](https://creativecommons.org/licenses/by-sa/3.0/)",
   "mapAttributionOsmHot": "Map data © [OpenStreetMap](https://www.openstreetmap.org/copyright) contributors • Tiles by [HOT](https://www.hotosm.org/) • Hosted by [OSM France](https://openstreetmap.fr/)",
   "mapAttributionStamen": "Map data © [OpenStreetMap](https://www.openstreetmap.org/copyright) contributors • Tiles by [Stamen Design](https://stamen.com), [CC BY 3.0](https://creativecommons.org/licenses/by/3.0)",
diff --git a/lib/model/app/dependencies.dart b/lib/model/app/dependencies.dart
index 613cb940b..d09b2b933 100644
--- a/lib/model/app/dependencies.dart
+++ b/lib/model/app/dependencies.dart
@@ -289,6 +289,11 @@ class Dependencies {
       license: bsd3,
       sourceUrl: 'https://github.com/greensopinion/flutter-vector-map-tiles',
     ),
+    Dependency(
+      name: 'Vector Tile Renderer',
+      license: bsd3,
+      sourceUrl: 'https://github.com/greensopinion/dart-vector-tile-renderer',
+    ),
   ];
 
   static const List<Dependency> dartPackages = [
@@ -333,6 +338,11 @@ class Dependencies {
       license: mit,
       sourceUrl: 'https://github.com/fluttercommunity/get_it',
     ),
+    Dependency(
+      name: 'HTTP',
+      license: bsd3,
+      sourceUrl: 'https://github.com/dart-lang/http',
+    ),
     Dependency(
       name: 'Intl',
       license: bsd3,
diff --git a/lib/view/src/settings/enums.dart b/lib/view/src/settings/enums.dart
index 485142707..64c41c1d5 100644
--- a/lib/view/src/settings/enums.dart
+++ b/lib/view/src/settings/enums.dart
@@ -68,7 +68,7 @@ extension ExtraEntryMapStyleView on EntryMapStyle {
       EntryMapStyle.googleNormal => l10n.mapStyleGoogleNormal,
       EntryMapStyle.googleHybrid => l10n.mapStyleGoogleHybrid,
       EntryMapStyle.googleTerrain => l10n.mapStyleGoogleTerrain,
-      EntryMapStyle.osmAmericana => l10n.mapStyleOsmAmericana,
+      EntryMapStyle.osmLiberty => l10n.mapStyleOsmLiberty,
       EntryMapStyle.openTopoMap => l10n.mapStyleOpenTopoMap,
       EntryMapStyle.osmHot => l10n.mapStyleOsmHot,
       EntryMapStyle.stamenWatercolor => l10n.mapStyleStamenWatercolor,
diff --git a/lib/widgets/common/map/attribution.dart b/lib/widgets/common/map/attribution.dart
index 3628c7044..80f6bb07a 100644
--- a/lib/widgets/common/map/attribution.dart
+++ b/lib/widgets/common/map/attribution.dart
@@ -16,8 +16,8 @@ class Attribution extends StatelessWidget {
   @override
   Widget build(BuildContext context) {
     switch (style) {
-      case EntryMapStyle.osmAmericana:
-        return _buildAttributionMarkdown(context, context.l10n.mapAttributionOsmAmericana);
+      case EntryMapStyle.osmLiberty:
+        return _buildAttributionMarkdown(context, context.l10n.mapAttributionOsmLiberty);
       case EntryMapStyle.openTopoMap:
         return _buildAttributionMarkdown(context, context.l10n.mapAttributionOpenTopoMap);
       case EntryMapStyle.osmHot:
diff --git a/lib/widgets/common/map/geo_map.dart b/lib/widgets/common/map/geo_map.dart
index 477e19dc8..28bdc0089 100644
--- a/lib/widgets/common/map/geo_map.dart
+++ b/lib/widgets/common/map/geo_map.dart
@@ -185,7 +185,7 @@ class _GeoMapState extends State<GeoMap> {
                 onMarkerTap: _onMarkerTap,
                 onMarkerLongPress: onMarkerLongPress,
               );
-            case EntryMapStyle.osmAmericana:
+            case EntryMapStyle.osmLiberty:
             case EntryMapStyle.openTopoMap:
             case EntryMapStyle.osmHot:
             case EntryMapStyle.stamenWatercolor:
diff --git a/lib/widgets/common/map/leaflet/map.dart b/lib/widgets/common/map/leaflet/map.dart
index cd83263f5..96f775e2b 100644
--- a/lib/widgets/common/map/leaflet/map.dart
+++ b/lib/widgets/common/map/leaflet/map.dart
@@ -198,8 +198,8 @@ class _EntryLeafletMapState<T> extends State<EntryLeafletMap<T>> with TickerProv
 
   Widget _buildMapLayer() {
     switch (widget.style) {
-      case EntryMapStyle.osmAmericana:
-        return const OsmAmericanaLayer();
+      case EntryMapStyle.osmLiberty:
+        return const OsmLibertyLayer();
       case EntryMapStyle.openTopoMap:
         return const OpenTopoMapLayer();
       case EntryMapStyle.osmHot:
diff --git a/lib/widgets/common/map/leaflet/tile_layers.dart b/lib/widgets/common/map/leaflet/tile_layers.dart
index 19fe35472..ac184c02d 100644
--- a/lib/widgets/common/map/leaflet/tile_layers.dart
+++ b/lib/widgets/common/map/leaflet/tile_layers.dart
@@ -1,4 +1,5 @@
 import 'package:aves/model/device.dart';
+import 'package:aves/widgets/common/map/leaflet/vector_style_reader_extra.dart';
 import 'package:flutter/material.dart';
 import 'package:flutter_map/flutter_map.dart';
 import 'package:vector_map_tiles/vector_map_tiles.dart';
@@ -45,39 +46,61 @@ class StamenWatercolorLayer extends StatelessWidget {
   }
 }
 
-class OsmAmericanaLayer extends StatefulWidget {
-  const OsmAmericanaLayer({super.key});
+class OsmLibertyLayer extends StatefulWidget {
+  const OsmLibertyLayer({super.key});
 
   @override
-  State<OsmAmericanaLayer> createState() => _OsmAmericanaLayerState();
+  State<OsmLibertyLayer> createState() => _OsmLibertyLayerState();
 }
 
-class _OsmAmericanaLayerState extends State<OsmAmericanaLayer> {
-  late final Future<Style> _styleFuture;
+class _OsmLibertyLayerState extends State<OsmLibertyLayer> {
+  late final Future<Style> _americanaStyleFuture;
+  late final Future<Style> _osmLibertyStyleFuture;
+
+  static const _openMapTileProviderSource = 'openmaptiles';
+
+  // `Americana` provides tiles, but it uses layer syntax that is not supported by the vector tile renderer
+  static const _americanaStyle = 'https://americanamap.org/style.json';
+
+  // `OSM Liberty` is well supported by the vector tile renderer, but it requires an API key for the tiles
+  static const _osmLiberty = 'https://maputnik.github.io/osm-liberty/style.json';
 
   @override
   void initState() {
     super.initState();
-    _styleFuture = StyleReader(
-      uri: 'https://americanamap.org/style.json',
+
+    _americanaStyleFuture = StyleReader(
+      uri: _americanaStyle,
+    ).readExtra(skippedSources: {});
+
+    _osmLibertyStyleFuture = StyleReader(
+      uri: _osmLiberty,
       logger: const vtr.Logger.console(),
-    ).read();
+    ).readExtra(skippedSources: {_openMapTileProviderSource});
   }
 
   @override
   Widget build(BuildContext context) {
     return FutureBuilder<Style>(
-      future: _styleFuture,
-      builder: (context, snapshot) {
-        if (snapshot.hasError) return Text(snapshot.error.toString());
+      future: _americanaStyleFuture,
+      builder: (context, americanaStyleSnapshot) {
+        return FutureBuilder<Style>(
+          future: _osmLibertyStyleFuture,
+          builder: (context, osmLibertyStyleSnapshot) {
+            if (americanaStyleSnapshot.hasError) return Text(americanaStyleSnapshot.error.toString());
+            if (osmLibertyStyleSnapshot.hasError) return Text(osmLibertyStyleSnapshot.error.toString());
 
-        final style = snapshot.data;
-        if (style == null) return const SizedBox();
+            final americanaStyle = americanaStyleSnapshot.data;
+            final osmLibertyStyle = osmLibertyStyleSnapshot.data;
+            if (americanaStyle == null || osmLibertyStyle == null) return const SizedBox();
 
-        return VectorTileLayer(
-          tileProviders: style.providers,
-          theme: style.theme,
-          sprites: style.sprites,
+            return VectorTileLayer(
+              tileProviders: americanaStyle.providers,
+              theme: osmLibertyStyle.theme,
+              sprites: osmLibertyStyle.sprites,
+              layerMode: VectorTileLayerMode.raster,
+            );
+          },
         );
       },
     );
diff --git a/lib/widgets/common/map/leaflet/vector_style_reader_extra.dart b/lib/widgets/common/map/leaflet/vector_style_reader_extra.dart
new file mode 100644
index 000000000..3e693d1b3
--- /dev/null
+++ b/lib/widgets/common/map/leaflet/vector_style_reader_extra.dart
@@ -0,0 +1,113 @@
+import 'dart:convert';
+
+import 'package:flutter/foundation.dart';
+import 'package:http/http.dart';
+import 'package:latlong2/latlong.dart';
+import 'package:vector_map_tiles/vector_map_tiles.dart';
+import 'package:vector_tile_renderer/vector_tile_renderer.dart';
+
+extension StyleReaderExtra on StyleReader {
+  Future<Style> readExtra({required Set<String> skippedSources}) async {
+    final styleText = await _httpGet(uri);
+    final style = await compute(jsonDecode, styleText);
+    if (style is! Map<String, dynamic>) {
+      throw _invalidStyle(uri);
+    }
+    final sources = style['sources'] as Map<String, dynamic>;
+    final providerByName = await _readProviderByName(Map.fromEntries(sources.entries.where((kv) => !skippedSources.contains(kv.key))));
+    final name = style['name'] as String?;
+
+    final center = style['center'];
+    LatLng? centerPoint;
+    if (center is List && center.length == 2) {
+      centerPoint = LatLng((center[1] as num).toDouble(), (center[0] as num).toDouble());
+    }
+
+    double? zoom = (style['zoom'] as num?)?.toDouble();
+    if (zoom != null && zoom < 2) {
+      zoom = null;
+      centerPoint = null;
+    }
+
+    final spriteUri = style['sprite'];
+    SpriteStyle? sprites;
+    if (spriteUri is String && spriteUri.trim().isNotEmpty) {
+      final spriteUris = [
+        _SpriteUri(json: '$spriteUri@2x.json?secure', image: '$spriteUri@2x.png?secure'),
+        _SpriteUri(json: '$spriteUri.json?secure', image: '$spriteUri.png?secure'),
+      ];
+      for (final spriteUri in spriteUris) {
+        dynamic spritesJson;
+        try {
+          final spritesJsonText = await _httpGet(spriteUri.json);
+          spritesJson = await compute(jsonDecode, spritesJsonText);
+        } catch (e) {
+          logger.log(() => 'error reading sprite uri: ${spriteUri.json}');
+          continue;
+        }
+        sprites = SpriteStyle(atlasProvider: () => _loadBinary(spriteUri.image), index: SpriteIndexReader(logger: logger).read(spritesJson));
+        break;
+      }
+    }
+    return Style(theme: ThemeReader(logger: logger).read(style), providers: TileProviders(providerByName), sprites: sprites, name: name, center: centerPoint, zoom: zoom);
+  }
+
+  Future<Map<String, VectorTileProvider>> _readProviderByName(Map<String, dynamic> sources) async {
+    final providers = <String, VectorTileProvider>{};
+    final sourceEntries = sources.entries.toList();
+    for (final entry in sourceEntries) {
+      final type = TileProviderType.values.where((e) => e.name == entry.value['type']).firstOrNull;
+      if (type == null) continue;
+      dynamic source;
+      var entryUrl = entry.value['url'] as String?;
+      if (entryUrl != null) {
+        final sourceUrl = entryUrl;
+        source = await compute(jsonDecode, await _httpGet(sourceUrl));
+        if (source is! Map) {
+          throw _invalidStyle(sourceUrl);
+        }
+      } else {
+        source = entry.value;
+      }
+      final entryTiles = source['tiles'];
+      final maxzoom = source['maxzoom'] as int? ?? 14;
+      final minzoom = source['minzoom'] as int? ?? 1;
+      if (entryTiles is List && entryTiles.isNotEmpty) {
+        final tileUri = entryTiles[0] as String;
+        final tileUrl = tileUri;
+        providers[entry.key] = NetworkVectorTileProvider(type: type, urlTemplate: tileUrl, maximumZoom: maxzoom, minimumZoom: minzoom);
+      }
+    }
+    if (providers.isEmpty) {
+      throw 'Unexpected response';
+    }
+    return providers;
+  }
+
+  String _invalidStyle(String url) => 'Uri does not appear to be a valid style: $url';
+
+  Future<String> _httpGet(String url) async {
+    final response = await get(Uri.parse(url));
+    if (response.statusCode == 200) {
+      return response.body;
+    } else {
+      throw 'HTTP ${response.statusCode}: ${response.body}';
+    }
+  }
+
+  Future<Uint8List> _loadBinary(String url) async {
+    final response = await get(Uri.parse(url));
+    if (response.statusCode == 200) {
+      return response.bodyBytes;
+    } else {
+      throw 'HTTP ${response.statusCode}: ${response.body}';
+    }
+  }
+}
+
+class _SpriteUri {
+  final String json;
+  final String image;
+
+  const _SpriteUri({required this.json, required this.image});
+}
diff --git a/plugins/aves_map/lib/src/style.dart b/plugins/aves_map/lib/src/style.dart
index 366c26c47..3732592a9 100644
--- a/plugins/aves_map/lib/src/style.dart
+++ b/plugins/aves_map/lib/src/style.dart
@@ -8,7 +8,7 @@ enum EntryMapStyle {
   googleHybrid,
   googleTerrain,
   // Vector (OpenMapTiles)
-  osmAmericana,
+  osmLiberty,
   // Raster (Leaflet)
   openTopoMap,
   osmHot,
diff --git a/pubspec.lock b/pubspec.lock
index 1c880627d..0a06bfdbb 100644
--- a/pubspec.lock
+++ b/pubspec.lock
@@ -701,7 +701,7 @@ packages:
     source: hosted
     version: "0.15.4"
   http:
-    dependency: transitive
+    dependency: "direct main"
     description:
       name: http
       sha256: b9c29a161230ee03d3ccf545097fccd9b87a5264228c5d348202e0f0c28f9010
@@ -1741,11 +1741,12 @@ packages:
     source: hosted
     version: "2.0.0"
   vector_tile_renderer:
-    dependency: "direct overridden"
+    dependency: "direct main"
     description:
-      path: "../dart-vector-tile-renderer"
-      relative: true
-    source: path
+      name: vector_tile_renderer
+      sha256: b58fa02b472ced87de00de2b4d5837576239bddb21b562481f25bde39bd117ae
+      url: "https://pub.dev"
+    source: hosted
     version: "5.2.0"
   vm_service:
     dependency: transitive
diff --git a/pubspec.yaml b/pubspec.yaml
index 58b120133..97c2cb492 100644
--- a/pubspec.yaml
+++ b/pubspec.yaml
@@ -78,6 +78,7 @@ dependencies:
   flutter_markdown:
   flutter_staggered_animations:
   get_it:
+  http:
   intl:
   latlong2:
   leak_tracker:
@@ -113,6 +114,7 @@ dependencies:
   url_launcher:
   vector_map_tiles:
   vector_math:
+  vector_tile_renderer:
   volume_controller:
   xml:
 
@@ -120,8 +122,6 @@ dependency_overrides:
   # media_kit_video v1.2.4 depends on a specific old version of screen_brightness
   media_kit_video: ^1.0.0
   screen_brightness: ^1.0.0
-  vector_tile_renderer:
-    path: ../dart-vector-tile-renderer
 
 dev_dependencies:
   flutter_test: