R/init_galacticPubs.R

In galacticpolymath/GPpub: Galactic Polymath Lesson Publishing Tools

#' init_galacticPubs()
#'
#' Set up environmental variables to store local user credentials and paths to resources. Specifically:
#' - the local path to GP-Studio/Edu/Lessons, virtualized by [Google Drive for Desktop](https://www.google.com/drive/download)
#' - the gp-lessons repository
#' - other things
#'
#' @returns table of galacticPubs-related environmental variables, their values, and whether they were successfully set
#' @export

init_galacticPubs <- function() {
  # First check that we're in galacticPubs or gp-lessons project ------------

  curr_proj_dir <- rstudioapi::getActiveProject()
  proj <- basename(curr_proj_dir)
  if (!proj %in% c("galacticPubs", "gp-lessons")) {
    stop("Currently, you can only use galacticPubs from the gp-lessons project.")
  } else{
    test_git_gp_lessons_dir <- TRUE
  }

  if (proj == "gp-lessons") {
    git_gp_lessons_dir <- curr_proj_dir
  } else{
    guess_loc <- "/Users/mattwilkins/R-pkg-dev/gp-lessons"
    message("guessing gp-lessons location")
    git_gp_lessons_dir <- guess_loc
  }

  test_git_gp_lessons_dir <-  checkmate::test_directory_exists(git_gp_lessons_dir)

  if (test_git_gp_lessons_dir) {
    Sys.setenv(galacticPubs_git_gp_lessons_dir = git_gp_lessons_dir)
  }

  gdrive_dir <-  fs::path(fs::path_home(), "Library", "CloudStorage")
  if (!dir.exists(gdrive_dir)) {
    warning("path not found: ", gdrive_dir)
    stop("Google Drive folder not found. You need Google Drive for Desktop to proceed.")
  }
  gdrive_userdir <- Sys.getenv("galacticPubs_gdrive_userdir")

  if (!is_empty(gdrive_userdir)) {
    message("\n\n Gdrive user already set: ",
            gdrive_userdir,
            "\n Do you want to replace this?")
    choice <- readline("Response (y/n) > ")

    if (choice %in% c("N", "n")) {
      stop("Reset Gdrive local credentials CANCELED.")
    }
  }
  #Otherwise proceed.
  gdrive_accounts_dir <- basename(fs::dir_ls(gdrive_dir))
  gdrive_accounts <- gsub(".*-(.*)$", "\\1", gdrive_accounts_dir)
  print(data.frame(
    Account = gdrive_accounts,
    Option = 1:length(gdrive_accounts)
  ))
  message("Set your Google Drive for Desktop user name with access to GP-Studio/Edu/Lessons/:")
  which_user <- as.numeric(readline("CHOICE: "))

  #Test user connection
  gdrive_user <- gdrive_accounts[which_user]
  test_gdrive_user <- checkmate::test_character(
    gdrive_user,
    min.chars = 3,
    all.missing = F,
    pattern = "\\w*@[^.]*\\.\\w*$"
  )
  #Set google-associated email
  Sys.setenv(galacticPubs_gdrive_user = ifelse(test_gdrive_user, gdrive_user, NA))
  #set the google drive subfolder with this email
  Sys.setenv(galacticPubs_gdrive_userdir = gdrive_accounts_dir[which_user])
  message("\nGoogle Drive User saved for next time: ", gdrive_user)


  gdrive_userdir <- Sys.getenv("galacticPubs_gdrive_userdir")
  test_user_dir <- !is_empty(gdrive_userdir)

  #Define paths to look for lessons in different shared folders
  gdrive_root_dir <- fs::path(fs::path_home(),
                              "Library",
                              "CloudStorage",
                              gdrive_userdir,
                              "Shared drives")
  live_lessons_dir <-
    fs::path(gdrive_root_dir, "GP-LIVE", "Edu", "Lessons")

  galacticpolymath_lessons_dir <-
    fs::path(gdrive_root_dir, "GalacticPolymath")


  studio_lessons_dir <-
    fs::path(gdrive_root_dir, "GP-Studio", "Edu", "Lessons")

  dev_dir <-
    fs::path(gdrive_root_dir, "GP-Dev")

  test_root_dir <- dir.exists(gdrive_root_dir)
  test_live_lessons_dir <- dir.exists(live_lessons_dir)
  test_dev_dir <- dir.exists(dev_dir)
  test_galacticpolymath_lessons_dir <- dir.exists(galacticpolymath_lessons_dir)
  test_studio_lessons_dir <- dir.exists(studio_lessons_dir)
  c_dirs <- c(studio_lessons_dir,
              live_lessons_dir,
              galacticpolymath_lessons_dir)

  if (!(
    test_live_lessons_dir |
    test_galacticpolymath_lessons_dir |
    test_studio_lessons_dir
  )) {
    warning(
      "Lessons Path NOT SET. No lessons folders found at:\n -",
      paste0(c_dirs, collapse = "\n -")
    )
    test_live_lessons_dir <-
      test_galacticpolymath_lessons_dir <- test_studio_lessons_dir <- NA

    warning("Make sure you have access privileges and Google Drive for Desktop installed.")
  } else{
    message("\nGoogle Drive For Desktop Virtualized Lessons Path(s) set for next time: \n ")


    if (!test_dev_dir) {
      message(
        "GP-Dev shared drive not found. Make sure you have permissions. (You need to be in the galacticPubs-user group)."
      )
    }


    # Set remaining environmental variables for paths---------------------------------------------
    Sys.setenv(galacticPubs_gdrive_shared_drives_dir = ifelse(!test_root_dir, NA, gdrive_root_dir))
    Sys.setenv(
      galacticPubs_gdrive_studio_lessons_dir = ifelse(!test_studio_lessons_dir, NA, studio_lessons_dir)
    )
    Sys.setenv(
      galacticPubs_gdrive_live_lessons_dir = ifelse(!test_live_lessons_dir, NA, live_lessons_dir)
    )
    Sys.setenv(
      galacticPubs_gdrive_galacticpolymath_lessons_dir = ifelse(
        !test_galacticpolymath_lessons_dir,
        NA,
        galacticpolymath_lessons_dir
      )
    )


    Sys.setenv(galacticPubs_gdrive_dev_dir = ifelse(!test_dev_dir, NA, dev_dir))


    # Set link to Google Cloud Authentication json ----------------------------
    #This is for connecting to the galacticPubs Google Cloud Storage bucket
    #This is where we store images and whatnots for lessons
    if (!test_dev_dir) {
      message(
        "Can't set GCS_AUTH_FILE for google cloud storage b/c you don't have access to GP-Dev shared drive."
      )
      test_auth_file <- FALSE
    } else{
      auth_file <-
        fs::path(dev_dir,
                 "do-not-touch",
                 "galacticpubs-cloudStorage_service-account.json")
      test_auth_file <- file.exists(auth_file)
      if (test_auth_file) {
        Sys.setenv("GCS_AUTH_FILE" = auth_file)
      } else{
        message(
          "Google Cloud authentication file not found. Try reinstalling or updating galacticPubs."
        )
        Sys.setenv("GCS_AUTH_FILE" = NA)
      }
    }

    # Get Google Analytics info ----------------------------
    #This is for connecting to the galacticPubs to Google Analytics
    if (!test_dev_dir) {
      message(
        "Can't set galacticPubs_config.yml for Google Analytics b/c you don't have access to GP-Dev shared drive."
      )
      test_GA_config <- FALSE
    } else{
      GA_config <-
        fs::path(dev_dir, "do-not-touch", "galacticPubs_config.yml")
      test_GA_config <- file.exists(GA_config)
      if (test_GA_config) {
        Sys.setenv("GA_config" = GA_config)
      } else{
        message(
          "galacticPubs_config.yml file not found. Try reinstalling or updating galacticPubs. Or you may not have access to this by design."
        )
        Sys.setenv("GA_config" = NA)
      }


    }
    out <- dplyr::tibble(
      `Set?` = convert_T_to_check(
        c(
          test_git_gp_lessons_dir,
          test_gdrive_user,
          test_user_dir,
          test_root_dir,
          test_studio_lessons_dir,
          test_live_lessons_dir,
          test_galacticpolymath_lessons_dir,
          test_auth_file,
          test_GA_config
        )
      ),
      EnvirVariable = c(
        "galacticPubs_git_gp_lessons_dir",
        "galacticPubs_gdrive_user",
        "galacticPubs_gdrive_userdir",
        "galacticPubs_gdrive_shared_drives_dir",
        "galacticPubs_gdrive_studio_lessons_dir",
        "galacticPubs_gdrive_live_lessons_dir",
        "galacticPubs_gdrive_galacticpolymath_lessons_dir",
        "GCS_AUTH_FILE",
        "GA_config"
      ),
      Value = c(
        git_gp_lessons_dir,
        gdrive_user,
        gdrive_userdir,
        gdrive_root_dir,
        studio_lessons_dir,
        live_lessons_dir,
        galacticpolymath_lessons_dir,
        auth_file,
        GA_config
      )
    )
    message("\nSUMMARY", "\n===========")
    print(out)
  }
  invisible(out)
}