R/dropbox_move.r

In karthik/rDrop: Dropbox R interface.

#' Move files within Dropbox
#'
#' Allows users to move files or folders inside the dropbox storage.
#' @param cred Specifies an object of class DropboxCredentials with Dropobox specific credentials.
#' @param from_path Path to file or folder to be copied, relative to root.
#' @param to_path Path to destination, including the new name for the file or folder, relative to root.
#' @param curl If using in a loop, call getCurlHandle() first and pass
#'  the returned value in here (avoids unnecessary footprint)
#' @param ... optional additional curl options (debugging tools mostly).
#' @seealso dropbox_copy dropbox_create_folder
#' @param verbose default is FALSE. Set to true to receive full outcome.
#' @seealso related: \code{\link{dropbox_copy}}
#' @return Message on successful completion or error.
#' @aliases dropbox_mv
#' @export dropbox_move
#' @examples \dontrun{
#' dropbox_move(cred, 'move.txt','test_works')
#' File succcessfully moved to /test_works/move.txt on Thu, 29 Mar 2012 20:41:45 +0000
#'}
dropbox_move <-
function(cred, from_path = NULL, to_path = NULL, 
         verbose = FALSE, curl = getCurlHandle(), ..., .checkIfExists = TRUE)
{
    if (!is(cred, "DropboxCredentials")) 
        stop("Invalid or missing Dropbox credentials. ?dropbox_auth for more information.", 
            call. = FALSE)
                                                                    # Note: to_path needs a leading / because root is 'dropbox'
    if (is.null(from_path)) {
        stop("Did not specify full path for source", call. = F)
    }

    if(is(to_path, "DropboxFolder"))  
       to_path = sprintf("%s/%s", to_path@path, basename(getPath(from_path, cred = cred)))

    check_paths <- sanitize_paths(from_path, to_path, cred)
    from_path <- check_paths[[1]]
    to_path <- check_paths[[2]]
    if (.checkIfExists && !exists.in.dropbox(cred, from_path, ..., curl = getCurlHandle())) 
        stop("Source file or folder does not exist", call. = FALSE)
    if (.checkIfExists && !exists.in.dropbox(cred, dirname(to_path), is_dir = TRUE, 
        ..., curl = getCurlHandle())) 
        stop("Destination is not a valid folder", call. = FALSE)
    
    if (grepl("\\.", to_path)) {
        if (.checkIfExists && exists.in.dropbox(cred, to_path, ..., curl = getCurlHandle())) 
            stop("File already exists in destination", call. = FALSE)
    }
    move <- fromJSON(OAuthRequest(cred, "https://api.dropbox.com/1/fileops/move", 
        list(root = "dropbox", from_path = from_path, to_path = to_path), 
        "POST", ..., curl = curl))
    if (is.character(move)) {
        stop(move[[1]], call. = FALSE)
    }
    if (verbose) {
        return(move)
    } else {
        if (is.list(move)) {
            cat("File succcessfully moved to", move$path, "on", move$modified, 
                "\n")
        }
    }
}
# API documentation:
#
#
#
#   https://www.dropbox.com/developers/reference/api#fileops-move