SAK-33335 When importing from site, treat Gradebook and GradebookNG as synonyms (sakaiproject#5237)

If the target site has GradebookNG while the source site Gradebook
Classic (or vice versa) we'll still import one into the other.

Author: marktriggs

site-manage/site-manage-tool/tool/pom.xml

@@ -101,6 +101,10 @@
             <groupId>commons-io</groupId>
             <artifactId>commons-io</artifactId>
         </dependency>
+        <dependency>
+            <groupId>org.apache.commons</groupId>
+            <artifactId>commons-lang3</artifactId>
+        </dependency>
         <dependency>
             <groupId>org.jmock</groupId>
             <artifactId>jmock-legacy</artifactId>

site-manage/site-manage-tool/tool/src/java/org/sakaiproject/site/tool/SiteAction.java

@@ -2893,6 +2893,36 @@ public int compare(String s1, String s2) {
 				context.put("selectedTools", selectedTools);
 			}
 
+			// SAK-33335
+			//
+			// If the old site has either Gradebook or GradebookNG,
+			// and the new site has either Gradebook or GradebookNG,
+			// we should allow the gradebook to import (even if the
+			// old site used Gradebook and the new site uses
+			// GradebookNG, or vice versa).
+			List<String> targetSiteToolIds = selectedTools;
+			List<String> sourceSiteToolIds = allImportableToolIdsInOriginalSites;
+
+			List<String> gradebooksInTargetSite = new ArrayList<String>();
+			for (String toolId : targetSiteToolIds) {
+				if (org.apache.commons.lang3.StringUtils.equalsAny(toolId, "sakai.gradebook.tool", "sakai.gradebookng")) {
+					gradebooksInTargetSite.add(toolId);
+				}
+			}
+
+			if (gradebooksInTargetSite.size() == 1) {
+				// If we only have one of the Gradebooks, we
+				// need to make sure that it's represented in
+				// the source site (so we get the option to
+				// import)
+				String targetSiteGradebook = gradebooksInTargetSite.get(0);
+
+				if (!sourceSiteToolIds.contains(targetSiteGradebook)) {
+					sourceSiteToolIds.add(targetSiteGradebook);
+				}
+			}
+
+
 			//get all known tool names from the sites selected to import from (importSites) and the selectedTools list
 			Map<String,Set<String>> toolNames = this.getToolNames(selectedTools, importSites);
 
@@ -15479,11 +15509,18 @@ private Map<String, Set<String>> getSiteImportToolsWithContent(List<Site> sites,
 			Set<String> toolsWithContent = new HashSet<>();
 
 			for(String toolId: toolIds) {
-				if(site.getToolForCommonId(toolId) != null) {
-					
+				if(site.getToolForCommonId(toolId) != null ||
+						(org.apache.commons.lang3.StringUtils.equalsAny(toolId, "sakai.gradebook.tool", "sakai.gradebookng") &&
+							(site.getToolForCommonId("sakai.gradebook.tool") != null || site.getToolForCommonId("sakai.gradebookng") != null)))
+				{
 					//check the tool has content
 					if(hasContent(toolId, site.getId())) {
 						toolsWithContent.add(toolId);
+					} else {
+						if (org.apache.commons.lang3.StringUtils.equalsAny(toolId, "sakai.gradebook.tool", "sakai.gradebookng") &&
+								hasContent("sakai.gradebook.tool", site.getId()) || hasContent("sakai.gradebookng", site.getId())) {
+							toolsWithContent.add(toolId);
+						}
 					}
 				}
 			}

site-manage/site-manage-tool/tool/src/webapp/vm/sitesetup/chef_site-importSites.vm

@@ -108,15 +108,19 @@
 												#foreach ($pageTool in $pageTools)
 													#if ($pageTool.getTool().getId() == $toolId)
 														#set($toolFound = true)
+													#elseif (($toolId == "sakai.gradebook.tool" || $toolId == "sakai.gradebookng") && ($pageTool.getTool().getId() == "sakai.gradebook.tool" || $pageTool.getTool().getId() == "sakai.gradebookng"))
+														#set($toolFound = true)
 													#end
 												#end
 											#end
 
 											#set ($toolsWithContent = $!siteToolsWithContent.get($site.getId()))
-											#if(!$toolsWithContent.contains($toolId))
+											#if(($toolId == "sakai.gradebook.tool" || $toolId == "sakai.gradebookng") && ($toolsWithContent.contains("sakai.gradebook.tool") || $toolsWithContent.contains("sakai.gradebookng")))
+												## Take the default
+											#elseif(!$toolsWithContent.contains($toolId))
 												#set($toolFound = false)
-    										#end
-										
+    											#end
+
 											#if ($toolFound)
 												<input type="checkbox" id="toolSite$toolCount$siteCount" name="$toolId" value="$site.Id" #if($!selectedSites.contains($site.Id))checked="checked"#end />
 												<label  class="skip" for="toolSite$toolCount$siteCount">$tlang.getString('import.choose.label1')  $toolTitle $tlang.getString('import.choose.label2') $validator.escapeHtml($site.getTitle())</label>