R/extract_workouts.R

In ikosmidis/GoldenCheetahOpenData: R API and Local Database Management for the GoldenCheetah OpenData Project

#' Extract workouts from the workout archives downloaded using [`download_workouts()`].
#'
#' @param object an object of class `gcod_db` as produced from
#'     [`download_workouts()`].
#' @param verbose logical determining whether progress information
#'     should be printed. Default is `FALSE`.
#' @param clean_db logical determining whether the workout directories
#'     should be deleted before extraction, if they already
#'     exist. Default is `TRUE`.
#' @param overwrite logical determining whether the workout
#'     directories should be overwritten, if they already
#'     exist. Default is `TRUE`.
#' @param ... currently not used.
#'
#' @return
#' An object of class `gcod_db` which is the same as `object` except
#' that the elements of `local_perspective(object)$extracted` are set to `TRUE` or
#' `FALSE` depending on whether the corresponding workout archives
#' were extracted successfully or not.
#'
#' @details
#' Athlete IDs are inferred from `local_path(object)`.
#'
#' ' The workouts are extracted and put in sub-directories in the same
#' directory as the workout archives (i.e. where the files
#' `local_path(object)` are). These sub-directories have exactly the
#' same name as the archives (excluding the file extension).
#'
#' @seealso
#' [`download_workouts()`]
#'
#' @export
extract_workouts.gcod_db <- function(object,
                                     verbose = FALSE,
                                     clean_db = TRUE,
                                     overwrite = TRUE,
                                     ...) {
  path <- local_path(object)
  if (length(path) == 0) {
    stop("The are no references to local files in `object`. Run `download_workouts(object)` first.")
  }
  n_paths <- length(path)
  athlete_id <- athlete_id(object, perspective = "local")
  for (j in seq.int(n_paths)) {
    current_path <- path[j]
    current_dir <- dirname(current_path)
    extraction_dir <- paste0(current_dir, "/", athlete_id[j])
    if (verbose) {
      message(paste("Extracting", current_path, "... "), appendLF = FALSE)
    }
    if (!isTRUE(overwrite)) {
      if (file.exists(file.path(extraction_dir, paste0("/{", athlete_id[j], "}.json")))) {
        if (verbose) {
          message("Exists.", appendLF = TRUE)
        }
        object$local_db[athlete_id == athlete_id[j], "extracted"] <- TRUE
        next
      }
    }
    if (isTRUE(clean_db)) {
      unlink(extraction_dir, recursive = TRUE, force = TRUE)
    }
    unzip_attempt <- tryCatch(
      {
        utils::unzip(current_path,
          overwrite = overwrite,
          exdir = extraction_dir
        )
      },
      warning = function(w) {
        w
      }
    )

    if (inherits(unzip_attempt, "warning")) {
      object$local_db[athlete_id == athlete_id[j], "extracted"] <- FALSE
      if (verbose) {
        message("Failed.", appendLF = TRUE)
      }
      warning(unzip_attempt)
      unlink(extraction_dir, recursive = TRUE)
      next
    }
    else {
      object$local_db[athlete_id == athlete_id[j], "extracted"] <- TRUE
      if (verbose) {
        message("Done.", appendLF = TRUE)
      }
    }
  }
  object
}