com.onthegomap.planetiler.files.FilesArchiveUtils Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of planetiler-core Show documentation
Planetiler is tool to build planet-scale vector tilesets from OpenStreetMap data fast.
The newest version!
package com.onthegomap.planetiler.files;

import static com.onthegomap.planetiler.files.TileSchemeEncoding.X_TEMPLATE;
import static com.onthegomap.planetiler.files.TileSchemeEncoding.Y_TEMPLATE;
import static com.onthegomap.planetiler.files.TileSchemeEncoding.Z_TEMPLATE;

import com.onthegomap.planetiler.config.Arguments;
import java.nio.file.Path;
import java.nio.file.Paths;
import java.util.Objects;
import java.util.Optional;

public final class FilesArchiveUtils {

  static final String OPTION_METADATA_PATH = "metadata_path";
  static final String OPTION_TILE_SCHEME = "tile_scheme";

  private FilesArchiveUtils() {}

  static Optional metadataPath(Path basePath, Arguments options) {
    final String metadataPathRaw = options.getString(
      OPTION_METADATA_PATH,
      "path to the metadata - use \"none\" to disable",
      "metadata.json"
    );
    if ("none".equals(metadataPathRaw)) {
      return Optional.empty();
    } else {
      final Path p = Paths.get(metadataPathRaw);
      if (p.isAbsolute()) {
        return Optional.of(p);
      }
      return Optional.of(basePath.resolve(p));
    }
  }

  static TileSchemeEncoding tilesSchemeEncoding(Arguments options, Path basePath, String defaultTileScheme) {
    final String tileScheme = options.getString(
      OPTION_TILE_SCHEME,
      "the tile scheme (e.g. {z}/{x}/{y}.pbf, {x}/{y}/{z}.pbf)" +
        " - instead of {x}/{y} {xs}/{ys} can be used which splits the x/y into 2 directories each" +
        " which ensures <1000 files per directory",
      defaultTileScheme
    );
    return new TileSchemeEncoding(tileScheme, basePath);
  }

  static BasePathWithTileSchemeEncoding basePathWithTileSchemeEncoding(Arguments options, Path basePath) {

    final SplitShortcutPath split = SplitShortcutPath.split(basePath);

    final String tileScheme = Objects
      .requireNonNullElse(split.tileSchemePart(), Path.of(Z_TEMPLATE, X_TEMPLATE, Y_TEMPLATE + ".pbf")).toString();

    return new BasePathWithTileSchemeEncoding(
      split.basePart(),
      tilesSchemeEncoding(options, split.basePart(), tileScheme)
    );
  }

  public static Path cleanBasePath(Path basePath) {
    return SplitShortcutPath.split(basePath).basePart();
  }

  record BasePathWithTileSchemeEncoding(Path basePath, TileSchemeEncoding tileSchemeEncoding) {}

  private record SplitShortcutPath(Path basePart, Path tileSchemePart) {
    public static SplitShortcutPath split(Path basePath) {
      Path basePart = Objects.requireNonNullElse(basePath.getRoot(), Paths.get(""));
      Path tileSchemePart = null;

      boolean remainingIsTileScheme = false;
      for (int i = 0; i < basePath.getNameCount(); i++) {
        final Path part = basePath.getName(i);
        if (!remainingIsTileScheme && part.toString().contains("{")) {
          remainingIsTileScheme = true;
        }
        if (remainingIsTileScheme) {
          tileSchemePart = tileSchemePart == null ? part : tileSchemePart.resolve(part);
        } else {
          basePart = basePart.resolve(part);
        }
      }

      if (tileSchemePart == null) {
        // just in case: use the "original" basePath in case no tile scheme is included, but basePart _should_ be identical
        return new SplitShortcutPath(basePath, null);
      } else {
        return new SplitShortcutPath(basePart, tileSchemePart);
      }
    }
  }
}