Warn or straight up refuse to migrate spaces that would overwrite well known spaces #320

application-confluence-migrator-pro-api/src/main/java/com/xwiki/confluencepro/ConfluenceMigrationJobStatus.java

@@ -45,6 +45,8 @@ public class ConfluenceMigrationJobStatus extends DefaultJobStatus<ConfluenceMig
 
     private Collection<String> spaces = Collections.emptyList();
 
+    private Map<String, String> spaceTargets = Map.of();
+
     /**
      * @param request the request provided when started the job
      * @param parentJobStatus the status of the parent job
@@ -105,6 +107,27 @@ public Collection<String> getSpaces()
         return spaces;
     }
 
+    /**
+     * Set the map of spaces that were renamed during the Migration.
+     * @param spaceTargets the map of spaces that were renamed
+     * @since 1.36.0
+     */
+    public void setSpaceTargets(Map<String, String> spaceTargets)
+    {
+        this.spaceTargets = spaceTargets;
+    }
+
+    /**
+     * Get the map of spaces that were renamed during the Migration.
+     *
+     * @return a map where the key is the original space name and the value is the current renamed space name
+     * @since 1.36.0
+     */
+    public Map<String, String> getSpaceTargets()
+    {
+        return spaceTargets;
+    }
+
     @Override
     public void cancel()
     {

application-confluence-migrator-pro-default/src/main/java/com/xwiki/confluencepro/internal/ConfluenceFilteringListener.java

@@ -111,6 +111,9 @@ public void onEvent(Event event, Object source, Object data)
 
         ConfluenceFilteringEvent ev = (ConfluenceFilteringEvent) event;
         Collection<String> spaces = new ArrayList<>(confluencePackage.getSpaceKeys(false));
+
+        status.setSpaceTargets(ev.getSpaceTargets());
+
         for (Long spaceId : ev.getDisabledSpaces()) {
             try {
                 spaces.remove(confluencePackage.getSpaceKey(spaceId));

application-confluence-migrator-pro-default/src/main/java/com/xwiki/confluencepro/internal/DefaultConfluenceMigrationManager.java

@@ -359,6 +359,7 @@ Map<String, Map<String, Integer>> analyseLogs(ConfluenceMigrationJobStatus jobSt
 
         addAttachment("missingUsersGroups.json", getPermissionIssues(root, docs), document);
         addAttachment("collisions.json", collisions, document);
+        addAttachment("spaceTargets.json", jobStatus.getSpaceTargets(), document);
         addAttachment("macroPages.json", macroPages, document);
         addAttachment("docs.json", docs, document);
         object.setLongValue("imported", counts.docCount);

application-confluence-migrator-pro-ui/src/main/resources/ConfluenceMigratorPro/Code/MigrationSheet.xml

@@ -296,7 +296,15 @@
   #set ($space[$docRef.getName()] = $docRef)
 #end
 
-#macro (printDocTree $tree)
+#macro (displayRenaming $name $spaceTargets)
+  #set ($nameEscaped = $escapetool.xml($name))
+  #set ($spaceTarget = $spaceTargets.get($name))
+  #if(!$name.equals($spaceTarget))
+    $services.localization.render('confluencepro.migration.raport.renamingSpace', $escapetool.xml($spaceTarget))
+  #end
+#end
+
+#macro (printDocTree $tree $spaceTargets $isRoot)
   <ul>
     #foreach ($name in $tree.keySet())
       #if ($name != "WebHome")
@@ -305,17 +313,17 @@
         #if ("$!child.getName()" != "")
          <li class="cfm-doc-tree-leaf"><a href="$xwiki.getURL($child)">$nameEscaped</a></li>
         #elseif ($child.containsKey("WebHome") && $child.size() == 1)
-         <li class="cfm-doc-tree-leaf"><a href="$xwiki.getURL($child["WebHome"])">$nameEscaped</a></li>
+         <li class="cfm-doc-tree-leaf"><a href="$xwiki.getURL($child["WebHome"])">$nameEscaped</a>#if($isRoot)#displayRenaming($name, $spaceTargets)#end</li>
         #else
           <li><details>
             <summary>##
               #if ($child.containsKey("WebHome"))
                 <a href="$xwiki.getURL($child["WebHome"])">$nameEscaped</a>
               #else
-                $nameEscaped
+                $nameEscaped#if($isRoot)#displayRenaming($name, $spaceTargets)#end
               #end##
             </summary>
-            #printDocTree($child)
+              #printDocTree($child $spaceTargets, false)
           </details></li>
         #end
       #end
@@ -354,6 +362,7 @@
   #set ($inputProperties = $jsontool.fromString($obj.getProperty('inputProperties').value))
   #computeRootSpace
   #set ($docsAttachment = $doc.getAttachment('docs.json'))
+  #set ($spaceTargetsAttachment = $doc.getAttachment('spaceTargets.json'))
   #if ($objecttool.isNull($docsAttachment))
     {{html wiki=true clean=false}}
     <ul class="imported-spaces">
@@ -381,12 +390,17 @@
   #else
     {{html clean=false}}
     #set ($docTree = {})
+    #set ($spaceTargets = $jsontool.fromString($spaceTargetsAttachment.getContentAsString()))
+    #set ($invertedSpaceTargets = {})
+    #foreach ($entry in $spaceTargets.entrySet())
+      #set ($discard = $invertedSpaceTargets.put($entry.getValue(), $entry.getKey()))
+    #end
     #foreach ($docRefStr in $jsontool.fromString($docsAttachment.getContentAsString()))
       #set($docRef = $services.model.resolveDocument($docRefStr))
       #addDocToDocTree($docTree, $docRef)
     #end
     <div id="cfm-doc-tree">
-      #printDocTree($docTree)
+      #printDocTree($docTree, $invertedSpaceTargets, true)
     </div>
     {{/html}}
   #end

application-confluence-migrator-pro-ui/src/main/resources/ConfluenceMigratorPro/Code/Translations.xml

@@ -113,6 +113,7 @@ confluencepro.migration.raport.problems.unhandledParameters.title=There are {0}
 confluencepro.migration.raport.problems.unhandledParameters.info=Unhandled parameter warnings:
 confluencepro.migration.raport.problems.unhandledParameterValues.info=Unhandled parameter values warnings:
 confluencepro.migration.raport.problems.unhandledParameters.list=The unhandled parameter (values), per macro
+confluencepro.migration.raport.renamingSpace=(original space key: {0})
 confluencepro.migration.raport.macroName=Macro
 confluencepro.migration.raport.parameterName=Parameter
 confluencepro.migration.raport.parameterValues=Value(s)