R/add-or-update-attachment.R

In MTES-MCT/didoscalim: Charger des données dans DiDo

#' Ajoute ou modifie un fichier annexe dans un dataset
#'
#' @description
#'
#' met à jour l'attachement avec le même titre s'il existe sinon ajoute un attachement.
#'
#' Si vous devez mettre à jour des attachments, il est conseillé d'utiliser la
#' fonction `didoscalim_update_only()`, cf
#' `vignette("complements-sur-les-mises-a-jour")`
#'
#' @inheritParams add_attachment
#' @param check_file_date TRUE/FALSE, Si TRUE met à jour l'attachment uniquement
#'   si le fichier est plus récent que le last_modified de l'attachment
#'
#' @return un objet `dido_attachment()` ou `NULL` si aucune création/mise à jour
#'   n'a eu lieu
#'
#' @export
#'
#' @family attachment
#'
#' @examples
#' library(dplyr, warn.conflicts = FALSE)
#'
#' dataset <- add_or_update_dataset(
#'   title = "Un dataset pour les attachement",
#'   description = "Description des données statistiques",
#'   topic = "Transports",
#'   frequency = "unknown",
#' )
#'
#' add_or_update_attachment(
#'   dataset = dataset,
#'   title = "title",
#'   description = "description",
#'   file_name = dido_example("attachment.txt")
#' )
#'
#' add_or_update_attachment(
#'   dataset = dataset,
#'   title = "title",
#'   description = "description",
#'   remote_url = "https://www.lemonde.fr"
#' )
add_or_update_attachment <- function(dataset,
                                     title,
                                     description,
                                     file_name = NULL,
                                     remote_url = NULL,
                                     published = format(Sys.time(), "%Y-%m-%d %H:%M:%S"),
                                     check_file_date = FALSE,
                                     type = "documentation") {
  check_mandatory_arguments("dataset", "title", "description")

  if (is.null(remote_url) & is.null(file_name)) {
    rlang::abort("error_bad_argument", message = "un des arguments remote_url ou file_name est obligatoire")
  }

  attachments <- dataset %>%
    list_attachments() %>%
    filter(compare_title(.data$title, .env$title))

  if (nrow(attachments) == 0) {

    if (is_update_only()) {
      abort_update_only(title, "attachment")
    }

    dido_att <- add_attachment(
      dataset = dataset,
      title = title,
      description = description,
      file_name = file_name,
      remote_url = remote_url,
      published = published,
      type = type
    )
    return(invisible(dido_att))
  }

  abort_if_not_one_line("attachments", message = c(x = glue::glue("Il y a plusieurs attachements avec le titre `{title}`.")))

  if (nrow(attachments) == 1) {
    attachment <- get_attachment(attachments[1, ])
    origin <- rlang::duplicate(dataset)

    if (check_file_date) {
      datafile_last_modified <- lubridate::as_datetime(attachment$last_modified)
      file_mtime <- lubridate::as_datetime(file.info(file_name)$mtime)
      if (file_mtime < datafile_last_modified) {
        return(NULL)
      }
    }

    dido_att <- replace_attachment(
      attachments[1, ],
      file_name = file_name,
      remote_url = remote_url
    )

    attachment$title <- toString(title)
    if (!missing(description)) attachment$description <- toString(description)
    if (!missing(published)) attachment$published <- published
    if (!missing(type)) attachment$type <- type
    if (!identical(origin, attachment)) attachment <- update_attachment(attachment)

    return(invisible(attachment))
  }
}