CONFLUENCE-240: Make AbstractMacroConverter and the Confluence Converter public

Force macro converters to implement toXWikiId, which will likely help avoid bugs

Author: raphj

confluence-xml/src/main/java/org/xwiki/contrib/confluence/filter/AbstractMacroConverter.java

@@ -52,6 +52,13 @@ public abstract class AbstractMacroConverter implements MacroConverter
     @Inject
     private ConfluenceInputContext inputContext;
 
+    // Code editors might suggest that toXWikiId already exists in MacroConverter and can be removed here, but
+    // one should not remove it: we want subclasses to explicitly implement toXWikiId. The default
+    // implementation in the interface is there for backward-compatibility but this stuff should not be implicit.
+    @Override
+    public abstract String toXWikiId(String confluenceId, Map<String, String> confluenceParameters,
+        String confluenceContent, boolean inline);
+
     @Override
     public final void toXWiki(String confluenceId, Map<String, String> confluenceParameters, String confluenceContent,
         boolean inline, Listener listener)
@@ -173,13 +180,6 @@ private void printUnhandledInfo(String confluenceId, TracedMap<String, String> c
         }
     }
 
-    @Override
-    public String toXWikiId(String confluenceId, Map<String, String> confluenceParameters, String confluenceContent,
-        boolean inline)
-    {
-        return confluenceId;
-    }
-
     /**
      * Convert Confluence parameters to XWiki parameters. If you override toXWiki, toXWikiParameters won't be used.
      * You should return something sensible, or an empty Map.
@@ -307,7 +307,7 @@ private void logCantMarkError()
     }
 
     // Code editors might suggest that supportsInlineMode already exists in MacroConverter and can be removed here, but
-    // one should not remove it: we want subclass to explicitly implement supportsInlineMode. The default
+    // one should not remove it: we want subclasses to explicitly implement supportsInlineMode. The default
     // implementation in the interface is there for backward-compatibility but this stuff should not be implicit.
     @Override
     public abstract InlineSupport supportsInlineMode(String id, Map<String, String> parameters, String content);

confluence-xml/src/main/java/org/xwiki/contrib/confluence/filter/MacroConverter.java

@@ -79,8 +79,7 @@ default InlineSupport supportsInlineMode(String id, Map<String, String> paramete
     }
 
     /**
-     * @return the id of the macro after conversion given the parameters, the content and whether the context is inline.
-     *         The default implementation uses toXWiki to return the converted id.
+     * @return the id of the macro after conversion, or null if no macro is produced by this macro converter
      * @param id the Confluence macro id
      * @param parameters the macro parameters
      * @param content the macro content

confluence-xml/src/main/java/org/xwiki/contrib/confluence/filter/internal/macros/AbstractMacroConverter.java

@@ -44,6 +44,13 @@
 @Deprecated (since = "9.89.0")
 public abstract class AbstractMacroConverter extends org.xwiki.contrib.confluence.filter.AbstractMacroConverter
 {
+    @Override
+    public String toXWikiId(String confluenceId, Map<String, String> confluenceParameters, String confluenceContent,
+        boolean inline)
+    {
+        return confluenceId;
+    }
+
     protected Map<String, String> toXWikiParameters(String confluenceId, Map<String, String> confluenceParameters,
         String content) throws ConversionException
     {

confluence-xml/src/main/java/org/xwiki/contrib/confluence/filter/internal/macros/DefaultMacroConverter.java

@@ -114,7 +114,7 @@ public String toXWikiId(String confluenceId, Map<String, String> confluenceParam
             return this.context.getProperties().getUnknownMacroPrefix() + confluenceId;
         }
 
-        // By default macros are not prefixed
+        // By default, macros are not prefixed
         return confluenceId;
     }
 

confluence-xml/src/main/java/org/xwiki/contrib/confluence/filter/internal/macros/ImgMacroConverter.java

@@ -49,6 +49,13 @@ public class ImgMacroConverter extends AbstractMacroConverter
     @Inject
     private ConfluenceURLConverter urlConverter;
 
+    @Override
+    public String toXWikiId(String confluenceId, Map<String, String> confluenceParameters, String confluenceContent,
+        boolean inline)
+    {
+        return null;
+    }
+
     @Override
     public void toXWiki(String confluenceId, Map<String, String> confluenceParameters, boolean inline,
         String confluenceContent, Listener listener)

confluence-xml/src/main/java/org/xwiki/contrib/confluence/filter/internal/macros/MacroToContentConverter.java

@@ -55,6 +55,13 @@ public class MacroToContentConverter extends AbstractParseContentMacroConverter
     @Inject
     protected ConfluenceInputContext context;
 
+    @Override
+    public String toXWikiId(String confluenceId, Map<String, String> confluenceParameters, String confluenceContent,
+        boolean inline)
+    {
+        return confluenceId;
+    }
+
     @Override
     public void toXWiki(String id, Map<String, String> parameters, boolean inline, String content, Listener listener)
         throws ConversionException

confluence-xml/src/main/java/org/xwiki/contrib/confluence/filter/internal/macros/MentionMacroConverter.java

@@ -54,6 +54,13 @@ public class MentionMacroConverter extends AbstractMacroConverter
     @Inject
     private Logger logger;
 
+    @Override
+    public String toXWikiId(String confluenceId, Map<String, String> confluenceParameters, String confluenceContent,
+        boolean inline)
+    {
+        return "mention";
+    }
+
     @Override
     protected Map<String, String> toXWikiParameters(String confluenceId, Map<String, String> confluenceParameters,
         String content) throws ConversionException

confluence-xml/src/test/java/org/xwiki/contrib/confluence/filter/FakeShowIfMacroConverter.java

@@ -39,6 +39,13 @@ public class FakeShowIfMacroConverter extends AbstractMacroConverter
     @Inject
     private ConfluenceFilterReferenceConverter converter;
 
+    @Override
+    public String toXWikiId(String confluenceId, Map<String, String> confluenceParameters, String confluenceContent,
+        boolean inline)
+    {
+        return confluenceId;
+    }
+
     @Override
     protected Map<String, String> toXWikiParameters(String confluenceId, Map<String, String> confluenceParameters,
         String content)