R/push_data.R

In validmeasures/odkr: 'Open Data Kit' ('ODK') R API

################################################################################
#
#' Push ODK forms from local ODK Briefcase Storage folder to remote ODK Aggregate
#' via ODK Briefcase
#'
#' @param target Path to directory of ODK Briefcase \code{.jar} file. Directory
#'   path should match directory path used when calling \code{get_briefcase()}.
#'   If ODK Briefcase \code{.jar} file was downloaded manually from \url{https://opendatakit.org},
#'   \code{target} should match the directory path where \code{.jar} file has
#'   been downloaded into.
#' @param briefcase Filename of the downloaded ODK Briefcase \code{.jar} file.
#'   Default is \code{odkBriefcase_latest} to match the default filename used
#'   by \code{get_briefcase()}. If ODK Briefcase \code{.jar} file was
#'   downloaded manually from \url{https://opendatakit.org}, filename should
#'   match the default filename used by Open Data Kit which is usually
#'   "ODK Briefcase vX.Y.Z Production.jar" where vX.Y.Z is the version number
#' @param id Form ID of form to push ODK forms data into
#' @param from Directory containing ODK forms data to push to remote ODK aggregate
#'   server
#' @param to URL of remote ODK Aggregate server
#' @param force_send_blank Logical. Should blank form be forced into the
#'   Aggregate instance
#' @param max_http_connections Integer value for maximum simultaneous HTTP
#'   connections allowed. Defaults to NULL which will allow for the default 8
#'   simultaneous HTTP connections. Specify this parameter if more simultaneous
#'   connection required
#' @param username Username for account in remote ODK Aggregate server from
#'   which forms are to be pulled
#' @param password Password for account in remote ODK Aggregate server from
#'   which forms are to be pulled
#'
#' @return NULL
#'
#' @examples
#'   # Use latest ODK Briefcase and connect to a test
#'   # remote ODK Aggregate server from ONA (https://ona.io) to push ODK forms
#'   # data into
#'   \dontrun{
#'   dirPath <- tempdir()
#'   get_briefcase(destination = dirPath)
#'   push_data(target = dirPath,
#'             id = "stakeholders",
#'             to = "https://ona.io/validtrial",
#'             from = dirPath,
#'             username = "validtrial",
#'             password = "zEF-STN-5ze-qom")
#'   }
#'
#' @export
#'
#
################################################################################

push_data <- function(target = "",
                      briefcase = "odkBriefcase_latest",
                      id = "",
                      to = "",
                      from = "",
                      force_send_blank = FALSE,
                      max_http_connections = NULL,
                      username,
                      password) {
  ## Check if appropriate Java runtime version is available
  rJava::.jinit()
  jv <- rJava::.jcall("java/lang/System", "S", "getProperty", "java.runtime.version")
  if(substr(jv, 1L, 2L) == "1.") {
    jvn <- as.numeric(paste0(strsplit(jv, "[.]")[[1L]][1:2], collapse = "."))
    if(jvn < 1.8) stop("Java >= 8 is needed for this package but not available")
  }

  ## Check if target is specified
  if(target == "") {
    stop("Cannot locate ODK Briefcase .jar file. Check target location of .jar file is correct.", call. = TRUE)
  }

  ## Check if id is specified
  if(id == "") {
    stop("Form id not specified. Try again.", call. = TRUE)
  }

  ## Check if from is specified
  if(to == "") {
    stop("URL of remote ODK Aggregate not specified. Try again.", call. = TRUE)
  }

  ## Check if to is specified
  if(from == "") {
    stop("Cannot locate source ODK Briefcase Storage folder. Check source location is correct.", call. = TRUE)
  }

  ## Create command line inputs based on required specifications
  z <- paste("java -jar ", target, "/", briefcase, ".jar",
             " --push_aggregate ",
             " --form_id ", id,
             " --storage_directory ", to,
             " --odk_url ", from,
             " --odk_username ", username,
             " --odk_password ", password,
             if(force_send_blank) " --force_send_blank ",
             " --max_http_connections ",
             if(is.null(max_http_connections)) " 8" else paste(" ", max_http_connections, sep = ""),
             sep = "")

  ## Execute inputs on command line
  system(z)
}