R/osrm_find_profile.R

In osrm.backend: Bindings for 'Open Source Routing Machine'

#' Locate an OSRM Lua profile (e.g. car.lua) in a host installation
#'
#' @description
#' `r lifecycle::badge("stable")`
#'
#' By default OSRM ships profiles for "car", "bike" and "foot" in a
#' `profiles/` directory alongside the binaries.  This function will try to
#' locate `osrm-routed` on the `PATH`, resolve symlinks, and look first for a
#' `profiles/` directory next to the binary (as placed there by
#' `osrm_install()`). If that fails, it looks for sibling directories
#' `share/osrm/profiles` and `share/osrm-backend/profiles`. IF that fails, it
#' will try to fall back on `/usr/local/share/osrm/profiles`,
#' `/usr/local/share/osrm-backend/profiles`, `/usr/share/osrm/profiles`, and
#' `/usr/share/osrm-backend/profiles`.
#'
#' @param profile A single string, the name of the Lua profile file
#'   (e.g. \code{"car.lua"}). Defaults to \code{"car.lua"}.
#' @return The normalized filesystem path to the profile.
#'
#' @examples
#' \donttest{
#' if (identical(Sys.getenv("OSRM_EXAMPLES"), "true")) {
#'   install_dir <- osrm_install(
#'     version = "latest",
#'     path_action = "session",
#'     quiet = TRUE
#'   )
#'   osrm_find_profile("car.lua")
#'   osrm_uninstall(
#'     dest_dir = install_dir,
#'     clear_path = TRUE,
#'     force = TRUE,
#'     quiet = TRUE
#'   )
#' }
#' }
#'
#' @export
osrm_find_profile <- function(
  profile = "car.lua"
) {
  # locate and resolve osrm-routed
  osrm_bin <- resolve_osrm_bin("osrm-routed")
  if (!nzchar(osrm_bin) || (!file.exists(osrm_bin) && !nzchar(Sys.which(osrm_bin)))) {
    stop(
      "`osrm-routed` not found in PATH; please install OSRM backend",
      call. = FALSE
    )
  }
  real_bin <- try(normalizePath(osrm_bin), silent = TRUE)
  if (inherits(real_bin, "try-error")) {
    real_bin <- osrm_bin
  }
  bindir <- dirname(real_bin)

  # probe common relative locations
  candidates <- c(
    file.path(bindir, "profiles", profile),
    file.path(bindir, "..", "share", "osrm", "profiles", profile),
    file.path(bindir, "..", "share", "osrm-backend", "profiles", profile),
    file.path(bindir, "..", "lib", "osrm", "profiles", profile),
    file.path(bindir, "..", "lib", "osrm-backend", "profiles", profile)
  )

  if (.Platform$OS.type != "windows") {
    unix_candidates <- c(
      file.path("/", "usr", "local", "share", "osrm", "profiles", profile),
      file.path(
        "/",
        "usr",
        "local",
        "share",
        "osrm-backend",
        "profiles",
        profile
      ),
      file.path("/", "usr", "share", "osrm", "profiles", profile),
      file.path("/", "usr", "share", "osrm-backend", "profiles", profile)
    )
    candidates <- c(candidates, unix_candidates)
  }
  for (p in candidates) {
    if (file.exists(p)) {
      return(normalizePath(p))
    }
  }

  stop(
    sprintf(
      "Could not locate OSRM profile '%s'. Please locate it manually and provide the full path.",
      profile
    ),
    call. = FALSE
  )
}