R/interlibrary.functions.R

In groundhog: Version-Control for CRAN, GitHub, and GitLab Packages

#Function 1 - Fed the subset of an IP that needs to be purged, and based on a loans[] dataframe it returns loans or backups the pkgs

purge.local <- function (ip.purge , loans)
  {
   

  #1 Allocate to be purged packages to return to groundhog vs to back up 
  #   If MD5 matches loan, return it, else goes to backup
      ip.return <- ip.purge[ip.purge$md5 %in% loans$md5,] 
      ip.backup <- ip.purge[!ip.purge$md5 %in% loans$md5,] 
      
      
  #2 Carry out returns, if any
      if (nrow(ip.return)>0)
      {
      #2.0 Save pkg_vrs before merge (merge may rename columns)
        ip.return_pkg_vrs <- ip.return$pkg_vrs
       
      #2.1 Merge IP with loans() to get  groundhog location for pkgs in IP
        ip.return <- merge(ip.return, loans, by='md5')
        
      #2.3 FROM/TO paths
        from.local_to_groundhog <- paste0(ip.return$LibPath, "/",ip.return$Package)
        to.local_to_groundhog   <- paste0(ip.return$groundhog_location, "/", ip.return$Package)
        
        
    #2.5 Execute 
		      file.rename.robust2(from.local_to_groundhog, to.local_to_groundhog)  #file.rename.robust2.R

           
      #2.6 remove returned packages from loans
        loans<-loans[!loans$md5 %in% ip.return$md5,]  
        save.loans(loans)  #update .rds (Utils #60.2)
        
      } #End of 2
      
  #----------------------------------------------------------------------------------
      
  #3 Carry out backups, if any
      if (nrow(ip.backup)>0)
      {
       
      #3.1 Directory for backups  
        backup.dir <- paste0(get.groundhog.folder(),"/restore_library/",get.r.majmin(),"/")
        dir.create(backup.dir, showWarnings = FALSE, recursive = TRUE)
      
      #3.2 From and To for backups
        from.local_to_backup <- paste0(ip.backup$LibPath,"/",ip.backup$Package)
        to.local_to_backup   <- paste0(backup.dir,ip.backup$pkg_vrs,"/",ip.backup$Package)
      
         
      #3.3 Subset that are new
        new <- !file.exists(to.local_to_backup)    #are they new to the backup? (do not replace existing files)
        
      #3.4 Move new backup files
          if (sum(new)>0) file.rename.robust2(from=from.local_to_backup[new], to= to.local_to_backup[new])

          
      #3.5 Delete local files that already are backed up
         if (sum(!new)>0) {
           from_to_purge <- from.local_to_backup[!new]
           for (fk in from_to_purge)
           {
             purge.pkg_path(fk) #utils #65
           }
           }
         #Not clear a scenario exists that creates this, but just in case.
         #If a pkg is local, and we need to remove it, and we did not move it to backup, then
         #we just delete it from here via purge
         
    } #End 3
    
    #4 Update caches incrementally after purging (packages moved from local to groundhog/backup)
      #Remove all purged packages from local cache
      if (nrow(ip.purge) > 0) {
        remove.packages.from.ip.cache('local', ip.purge$pkg_vrs)
      }
      
      #Add returned packages to groundhog cache
      if (nrow(ip.return) > 0) {
        #Use the package-version directories directly; they contain the pkg folder (e.g., .../curl_7.0.0/curl/DESCRIPTION)
        return_pkg_paths <- unique(ip.return$groundhog_location)

        #Use pkg_vrs from before merge (or from loans if available). Merge may rename columns.
        return_pkg_vrs <- if ("pkg_vrs.y" %in% names(ip.return)) {
          ip.return$pkg_vrs.y
        } else if ("pkg_vrs" %in% names(ip.return)) {
          ip.return$pkg_vrs
        } else {
          ip.return_pkg_vrs  # Fallback to saved value
        }

        #Compute IP for the package-version directories
        all_return_ip <- compute.ip.for.paths(return_pkg_paths)
        new_groundhog_ip <- all_return_ip[all_return_ip$pkg_vrs %in% return_pkg_vrs, ]

        if (nrow(new_groundhog_ip) > 0) {
          add.packages.to.ip.cache('groundhog', new_groundhog_ip)
        }
      }
      
      #Add backed up packages to backup cache
      if (nrow(ip.backup) > 0 && sum(new) > 0) {
        #Get unique backup directory
        backup.dir <- paste0(get.groundhog.folder(),"/restore_library/",get.r.majmin(),"/")
        #Compute IP for backup directory, then filter to just backed up packages
        all_backup_ip <- compute.ip.for.paths(backup.dir)
        new_backup_ip <- all_backup_ip[all_backup_ip$pkg_vrs %in% ip.backup$pkg_vrs[new], ]
        add.packages.to.ip.cache('backup', new_backup_ip)
      }
        
  }