SAK-48970 gradebook supports removal of data when a site is hard deleted

gradebookng/api/src/main/java/org/sakaiproject/grading/api/GradingPersistenceManager.java

@@ -123,4 +123,5 @@ List<AssignmentGradeRecord> getAssignmentGradeRecordsForAssignmentIdsAndStudentI
 
     Optional<GradebookProperty> getGradebookProperty(String name);
     GradebookProperty saveGradebookProperty(GradebookProperty property);
+    boolean isGradebookDefined(final String gradebookUid);
 }

gradebookng/api/src/main/java/org/sakaiproject/grading/api/GradingService.java

@@ -934,5 +934,6 @@ public void updateExternalAssessmentComments(String gradebookUid, String siteId,
     public Long getMatchingUserGradebookItemId(String siteId, String userId, String gradebookItemIdString);
     public List<String> getGradebookInstancesForUser(String siteId, String userId);
     public void initializeGradebooksForSite(String siteId);
+    public void hardDeleteGradebook(String siteId);
 
 }

gradebookng/api/src/main/java/org/sakaiproject/grading/api/model/Gradebook.java

@@ -78,6 +78,9 @@ public class Gradebook implements PersistableEntity<Long>, Serializable {
     @OneToMany(mappedBy = "gradebook", orphanRemoval = true, cascade = CascadeType.ALL)
     private Set<GradeMapping> gradeMappings = new HashSet<>();
 
+    //@OneToMany(mappedBy = "gradebook", orphanRemoval = true, cascade = CascadeType.REMOVE)
+    //private Set<Spreadsheet> spreadsheets = new HashSet<>();
+
     @Column(name = "ASSIGNMENTS_DISPLAYED", nullable = false)
     private Boolean assignmentsDisplayed = Boolean.FALSE;
 

gradebookng/api/src/main/java/org/sakaiproject/grading/api/repository/GradebookRepository.java

@@ -26,4 +26,7 @@ public interface GradebookRepository extends SpringCrudRepository<Gradebook, Lon
 
     Optional<Gradebook> findByUid(String uid);
     int deleteByUid(String uid);
+
+    public boolean isGradebookDefined(final String gradebookUid);
+    public int deleteSpreadsheetsForGradebook(final Long id);
 }

gradebookng/impl/src/main/java/org/sakaiproject/grading/impl/GradingPersistenceManagerImpl.java

@@ -94,6 +94,10 @@ public void deleteGradebook(String gradebookUid) {
 
         categoryRepository.deleteAll(categoryRepository.findByGradebook_Uid(gradebookUid));
 
+        gradebookRepository.deleteSpreadsheetsForGradebook(gradebook.getId());
+
+        permissionRepository.deleteAll(permissionRepository.findByGradebookId(gradebook.getId()));
+
         gradeMappingRepository.deleteAll(gradeMappingRepository.findByGradebook_Uid(gradebookUid));
 
         gradebookRepository.delete(gradebook);
@@ -389,4 +393,8 @@ public Optional<GradebookProperty> getGradebookProperty(String name) {
     public GradebookProperty saveGradebookProperty(GradebookProperty property) {
         return gradebookPropertyRepository.save(property);
     }
+
+    public boolean isGradebookDefined(final String gradebookUid) {
+        return gradebookRepository.isGradebookDefined(gradebookUid);
+    }
 }

gradebookng/impl/src/main/java/org/sakaiproject/grading/impl/GradingServiceImpl.java

@@ -5422,4 +5422,29 @@ public Long getMatchingUserGradebookItemId(String siteId, String userId, String
 
         return null;
     }
+
+        /*
+        @Override
+    public void hardDelete(String siteId) {
+        if (isGradebookDefined(context)) {
+            log.debug("Site " + context + " has been deleted. Removing associated gradebook data.");
+            try {
+                this.gradebookFrameworkService.deleteGradebook(context);
+            } catch (final GradebookNotFoundException e) {
+                log.debug("Couldnt find gradebook. Nothing to delete.", e);
+            }
+
+
+     */
+
+
+    public void hardDeleteGradebook(String siteId) {
+        try {
+            if (gradingPersistenceManager.isGradebookDefined(siteId)) {
+                deleteGradebook(siteId);
+            }
+        } catch (Exception e) {
+            log.warn("Could not hardDelete gradebook for context {}", siteId);
+        }
+    }
 }

gradebookng/impl/src/main/java/org/sakaiproject/grading/impl/repository/GradebookRepositoryImpl.java

@@ -27,6 +27,7 @@
 import org.springframework.transaction.annotation.Transactional;
 
 import org.sakaiproject.grading.api.model.Gradebook;
+import org.sakaiproject.grading.api.model.Spreadsheet;
 import org.sakaiproject.grading.api.repository.GradebookRepository;
 import org.sakaiproject.springframework.data.SpringCrudRepositoryImpl;
 
@@ -53,4 +54,33 @@ public int deleteByUid(String uid) {
         delete.where(cb.equal(gradebook.get("uid"), uid));
         return session.createQuery(delete).executeUpdate();
     }
+
+    @Transactional(readOnly = true)
+    public boolean isGradebookDefined(final String gradebookUid) {
+        /*
+        return ((Long) sessionFactory.getCurrentSession().createCriteria(Gradebook.class)
+                .add(Restrictions.eq("uid", gradebookUid))
+                .setProjection(Projections.rowCount())
+                .uniqueResult()) == 1L;
+         */
+        Session session = sessionFactory.getCurrentSession();
+        CriteriaBuilder cb = session.getCriteriaBuilder();
+        CriteriaQuery<Gradebook> query = cb.createQuery(Gradebook.class);
+        Root<Gradebook> gradebook = query.from(Gradebook.class);
+        query.where(cb.equal(gradebook.get("uid"), gradebookUid));
+        return session.createQuery(query).uniqueResultOptional().isPresent();
+    }
+
+    @Transactional
+    public int deleteSpreadsheetsForGradebook(final Long id) {
+        Session session = sessionFactory.getCurrentSession();
+        CriteriaBuilder cb = session.getCriteriaBuilder();
+        CriteriaDelete<Spreadsheet> delete = cb.createCriteriaDelete(Spreadsheet.class);
+        Root<Spreadsheet> spreadsheet = delete.from(Spreadsheet.class);
+        delete.where(cb.equal(spreadsheet.get("gradebook").get("id"), id));
+        return session.createQuery(delete).executeUpdate();
+    }
+
+
+
 }

gradebookng/tool/src/java/org/sakaiproject/gradebookng/framework/GradebookNgEntityProducer.java

@@ -34,6 +34,7 @@
 import org.sakaiproject.entity.api.EntityManager;
 import org.sakaiproject.entity.api.EntityProducer;
 import org.sakaiproject.entity.api.EntityTransferrer;
+import org.sakaiproject.entity.api.HardDeleteAware;
 import org.sakaiproject.entity.api.Reference;
 import org.sakaiproject.exception.IdUnusedException;
 import org.sakaiproject.grading.api.GradingConstants;
@@ -61,7 +62,7 @@
  * sites
  */
 @Slf4j
-public class GradebookNgEntityProducer implements EntityProducer, EntityTransferrer {
+public class GradebookNgEntityProducer implements EntityProducer, EntityTransferrer, HardDeleteAware {
 
 	protected static final String[] TOOL_IDS = { "sakai.gradebookng" };
 
@@ -416,4 +417,10 @@ public Map<String, String> transferCopyEntities(String fromContext, String toCon
 		// now migrate
 		return this.transferCopyEntities(fromContext, toContext, ids, null);
 	}
+
+	@Override
+	public void hardDelete(String siteId) {
+		gradingService.hardDeleteGradebook(siteId);
+	}
+
 }