feat(core): support gpx in reearth/core (#423)

Co-authored-by: rot1024 <aayhrot@gmail.com>
reearth · Feb 7, 2023 · b4b04bc · b4b04bc
1 parent 595c66a
commit b4b04bc
Show file tree

Hide file tree

Showing 6 changed files with 138 additions and 1 deletion.
diff --git a/package.json b/package.json
@@ -119,6 +119,7 @@
         "date-fns": "2.29.3",
         "dayjs": "1.11.7",
         "detect-browser": "5.3.0",
+        "fast-xml-parser": "4.1.1",
         "formik": "2.2.9",
         "github-markdown-css": "5.1.0",
         "graphiql": "2.2.0",

diff --git a/src/core/engines/Cesium/Feature/index.tsx b/src/core/engines/Cesium/Feature/index.tsx
@@ -42,6 +42,7 @@ const displayConfig: Record<DataType, (keyof typeof components)[] | "auto"> = {
   mvt: ["raster"],
   "3dtiles": ["3dtiles"],
   "osm-buildings": ["3dtiles"],
+  gpx: "auto",
 };
 
 // Some layer that is delegated data is not computed when layer is updated.

diff --git a/src/core/mantle/data/gpx.ts b/src/core/mantle/data/gpx.ts
@@ -0,0 +1,120 @@
+import { XMLParser, X2jOptionsOptional } from "fast-xml-parser";
+import type { LineString, Position, GeoJsonProperties } from "geojson";
+
+import type { Data, DataRange, Feature } from "../types";
+
+import { f } from "./utils";
+
+export async function fetchGPXfile(data: Data, _range?: DataRange): Promise<Feature[] | void> {
+  const xmlDataStr = data.url ? await (await f(data.url)).text() : data.value;
+  return handler(xmlDataStr);
+}
+
+function handler(xmlDataStr: string) {
+  const gpxData = parseBuffer(xmlDataStr);
+  return transform(gpxData);
+}
+
+function parseBuffer(xmlDataStr: string) {
+  const options: X2jOptionsOptional = {
+    ignoreAttributes: false,
+    attributeNamePrefix: "@_",
+  };
+  const parser = new XMLParser(options);
+  return parser.parse(xmlDataStr) as GPX;
+}
+
+function transform(gpxFile: GPX) {
+  const trackPoints = makeTrackPoints(gpxFile.gpx.trk);
+  const lineStringFeatures = trackPoints.reduce(makeLineStringFeature, []);
+  return lineStringFeatures;
+}
+
+type TrackPoint = {
+  "@_lat": string;
+  "@_lon": string;
+  ele: number;
+  time: string;
+  // course: 23.26,
+  // speed: 0.63,
+  // fix: '3d',
+  // sat: 5,
+  // hdop: 1.4
+};
+
+type Track = {
+  trkseg: {
+    trkpt: TrackPoint[];
+  };
+};
+
+type GPX = {
+  gpx: {
+    trk: Track;
+  };
+};
+
+function makeTrackPoints(trk: GPX["gpx"]["trk"]) {
+  const trkData = [trk];
+  return trkData.reduce((trackPoints: any[], { trkseg: { trkpt } }: any) => {
+    if (Array.isArray(trkpt)) {
+      trackPoints.push(...trkpt);
+    } else {
+      trackPoints.push(trkpt);
+    }
+    return trackPoints;
+  }, [] as TrackPoint[]);
+}
+
+function feature(geom: LineString | null, properties?: GeoJsonProperties): Feature {
+  const feat: any = { type: "Feature" };
+  feat.properties = properties || {};
+  feat.geometry = geom;
+  return feat;
+}
+
+function lineString(coordinates: Position[], properties?: GeoJsonProperties): Feature {
+  if (coordinates.length < 2) {
+    throw new Error("coordinates must be an array of two or more positions");
+  }
+  const geom: LineString = {
+    type: "LineString",
+    coordinates,
+  };
+  return feature(geom, properties);
+}
+
+function makeLineStringFeature(
+  accumulator: Feature[],
+  currentValue: TrackPoint,
+  index: number,
+  trackPoints: TrackPoint[],
+) {
+  accumulator.push(
+    lineString(getRecords(trackPoints, index).map(getPosition), mapProperties(currentValue)),
+  );
+  return accumulator;
+}
+
+function getPosition({ "@_lon": lon, "@_lat": lat, ele }: TrackPoint): Position {
+  const position = [Number(lon), Number(lat)];
+  if (ele !== undefined) position.push(Number(ele));
+  return position;
+}
+
+function getRecords(trackPoints: TrackPoint[], index: number) {
+  if (index > 0) {
+    return [trackPoints[index - 1], trackPoints[index]];
+  }
+  if (trackPoints.length === 1) {
+    return [trackPoints[index], trackPoints[index]];
+  }
+  return [trackPoints[index], trackPoints[index + 1]];
+}
+
+function mapProperties(trackPoint: GeoJsonProperties) {
+  return {
+    ...trackPoint,
+    timestamp: trackPoint?.time as string,
+  };
+}
diff --git a/src/core/mantle/data/index.ts b/src/core/mantle/data/index.ts
@@ -4,12 +4,14 @@ import type { Data, DataRange, Feature } from "../types";
 
 import { fetchCSV } from "./csv";
 import { fetchGeoJSON } from "./geojson";
+import { fetchGPXfile } from "./gpx";
 
 export type DataFetcher = (data: Data, range?: DataRange) => Promise<Feature[] | void>;
 
 const registry: Record<string, DataFetcher> = {
   geojson: fetchGeoJSON,
   csv: fetchCSV,
+  gpx: fetchGPXfile,
 };
 
 export async function fetchData(data: Data, range?: DataRange): Promise<Feature[] | void> {

diff --git a/src/core/mantle/types/index.ts b/src/core/mantle/types/index.ts
@@ -86,7 +86,8 @@ export type DataType =
   | "csv"
   | "wms"
   | "mvt"
-  | "kml";
+  | "kml"
+  | "gpx";
 
 // Feature
 export type CommonFeature<T extends "feature" | "computedFeature"> = {

diff --git a/yarn.lock b/yarn.lock
@@ -10511,6 +10511,13 @@ fast-text-encoding@^1.0.6:
   resolved "https://registry.yarnpkg.com/fast-text-encoding/-/fast-text-encoding-1.0.6.tgz#0aa25f7f638222e3396d72bf936afcf1d42d6867"
   integrity sha512-VhXlQgj9ioXCqGstD37E/HBeqEGV/qOD/kmbVG8h5xKBYvM1L3lR1Zn4555cQ8GkYbJa8aJSipLPndE1k6zK2w==
 
+fast-xml-parser@4.1.1:
+  version "4.1.1"
+  resolved "https://registry.yarnpkg.com/fast-xml-parser/-/fast-xml-parser-4.1.1.tgz#28c878b7f1eb4555fa898f1c715adf9d4007306e"
+  integrity sha512-4gAP5PvNyrqePBOIIcpaEeE+nKBry1n6qTQiJsE59sLP0OC+YwhU7/XVmLLEMexbiluFQX1yEYm82Pk9B7xEiw==
+  dependencies:
+    strnum "^1.0.5"
+
 fastest-stable-stringify@^2.0.2:
   version "2.0.2"
   resolved "https://registry.yarnpkg.com/fastest-stable-stringify/-/fastest-stable-stringify-2.0.2.tgz#3757a6774f6ec8de40c4e86ec28ea02417214c76"
@@ -17636,6 +17643,11 @@ strip-literal@^1.0.0:
   dependencies:
     acorn "^8.8.1"
 
+strnum@^1.0.5:
+  version "1.0.5"
+  resolved "https://registry.yarnpkg.com/strnum/-/strnum-1.0.5.tgz#5c4e829fe15ad4ff0d20c3db5ac97b73c9b072db"
+  integrity sha512-J8bbNyKKXl5qYcR36TIO8W3mVGVHrmmxsd5PAItGkmyzwJvybiw2IVq5nqd0i4LSNSkB/sx9VHllbfFdr9k1JA==
+
 style-loader@^1.3.0:
   version "1.3.0"
   resolved "https://registry.yarnpkg.com/style-loader/-/style-loader-1.3.0.tgz#828b4a3b3b7e7aa5847ce7bae9e874512114249e"