Revert "XWIKI-19749: Escape translations when no output syntax is given"

This reverts commit 2fd27f1d.

xwiki-platform-core/xwiki-platform-localization/xwiki-platform-localization-api/src/main/java/org/xwiki/localization/internal/TranslationEscapeTool.java

-/*
- * See the NOTICE file distributed with this work for additional
- * information regarding copyright ownership.
- *
- * This is free software; you can redistribute it and/or modify it
- * under the terms of the GNU Lesser General Public License as
- * published by the Free Software Foundation; either version 2.1 of
- * the License, or (at your option) any later version.
- *
- * This software is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- * Lesser General Public License for more details.
- *
- * You should have received a copy of the GNU Lesser General Public
- * License along with this software; if not, write to the Free
- * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
- * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
- */
-package org.xwiki.localization.internal;
-
-import java.util.regex.Pattern;
-
-/**
- * Tool for escaping translations.
- *
- * @version $Id$
- * @since 13.10.11
- * @since 14.4.8
- * @since 14.10
- */
-public final class TranslationEscapeTool
-{
-    private static final Pattern MACRO_PATTERN = Pattern.compile("\\{(?=[^}\\d]|$)");
-
-    private TranslationEscapeTool()
-    {
-    }
-
-    /**
-     * Escapes the provided translation result such that it cannot contain XWiki macro syntax.
-     * <p>
-     * Normally, this should be handled by specifying the correct target syntax but in many cases it is omitted and in
-     * these cases this escaping makes sure that the translation is safe.
-     *
-     * @param input the input to escape
-     * @return the escaped result
-     */
-    public static String escapeForMacros(String input)
-    {
-        String result;
-
-        if (input != null) {
-            result = MACRO_PATTERN.matcher(input).replaceAll("\u2774");
-        } else {
-            result = null;
-        }
-
-        return result;
-    }
-}

xwiki-platform-core/xwiki-platform-localization/xwiki-platform-localization-api/src/test/java/org/xwiki/localization/internal/TranslationEscapeToolTest.java

-/*
- * See the NOTICE file distributed with this work for additional
- * information regarding copyright ownership.
- *
- * This is free software; you can redistribute it and/or modify it
- * under the terms of the GNU Lesser General Public License as
- * published by the Free Software Foundation; either version 2.1 of
- * the License, or (at your option) any later version.
- *
- * This software is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- * Lesser General Public License for more details.
- *
- * You should have received a copy of the GNU Lesser General Public
- * License along with this software; if not, write to the Free
- * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
- * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
- */
-package org.xwiki.localization.internal;
-
-import org.junit.jupiter.params.ParameterizedTest;
-import org.junit.jupiter.params.provider.CsvSource;
-import org.junit.jupiter.params.provider.ValueSource;
-
-import static org.junit.jupiter.api.Assertions.assertEquals;
-
-/**
- * Unit tests for the {@link TranslationEscapeTool}.
- *
- * @version $Id$
- * @since 13.10.11
- * @since 14.4.8
- * @since 13.10
- */
-class TranslationEscapeToolTest
-{
-    @ParameterizedTest
-    @ValueSource(strings = {
-        "Placeholder {0}",
-        "Another [{}] placeholder",
-        "Updates, {0,choice,0#No|1#One|1<{0}} page{0,choice,0#s|1#|2#s} ha{0,choice,0#ve|1#s|1<ve} since {1}}"
-    })
-    void escapeNoPlaceholder(String input)
-    {
-        assertEquals(input, TranslationEscapeTool.escapeForMacros(input));
-    }
-
-    @ParameterizedTest
-    @CsvSource({
-        "At the end {, At the end \u2774",
-        "~{~{escaped, ~\u2774~\u2774escaped",
-        "{{/html}}, \u2774\u2774/html}}",
-        "{{macro}}, \u2774\u2774macro}}"
-    })
-    void escapeMacros(String input, String expected)
-    {
-        assertEquals(expected, TranslationEscapeTool.escapeForMacros(input));
-    }
-}

xwiki-platform-core/xwiki-platform-localization/xwiki-platform-localization-script/src/main/java/org/xwiki/localization/script/LocalizationScriptService.java

@@ -45,7 +45,6 @@
 import org.xwiki.localization.LocalizationContext;
 import org.xwiki.localization.LocalizationManager;
 import org.xwiki.localization.Translation;
-import org.xwiki.localization.internal.TranslationEscapeTool;
 import org.xwiki.rendering.block.Block;
 import org.xwiki.rendering.renderer.BlockRenderer;
 import org.xwiki.rendering.renderer.printer.DefaultWikiPrinter;
@@ -223,7 +222,7 @@ public String render(Collection<String> keys, Locale locale)
      */
     public String render(String key, Collection<?> parameters)
     {
-        return TranslationEscapeTool.escapeForMacros(render(key, Syntax.PLAIN_1_0, parameters));
+        return render(key, Syntax.PLAIN_1_0, parameters);
     }
 
     /**
@@ -233,7 +232,7 @@ public String render(String key, Collection<?> parameters)
      */
     public String render(Collection<String> keys, Collection<?> parameters)
     {
-        return TranslationEscapeTool.escapeForMacros(render(keys, Syntax.PLAIN_1_0, parameters));
+        return render(keys, Syntax.PLAIN_1_0, parameters);
     }
 
     /**
@@ -247,7 +246,7 @@ public String render(Collection<String> keys, Collection<?> parameters)
      */
     public String render(String key, Collection<?> parameters, Locale locale)
     {
-        return TranslationEscapeTool.escapeForMacros(render(key, Syntax.PLAIN_1_0, parameters, locale));
+        return render(key, Syntax.PLAIN_1_0, parameters, locale);
     }
 
     /**
@@ -261,7 +260,7 @@ public String render(String key, Collection<?> parameters, Locale locale)
      */
     public String render(Collection<String> keys, Collection<?> parameters, Locale locale)
     {
-        return TranslationEscapeTool.escapeForMacros(render(keys, Syntax.PLAIN_1_0, parameters, locale));
+        return render(keys, Syntax.PLAIN_1_0, parameters, locale);
     }
 
     /**

xwiki-platform-core/xwiki-platform-localization/xwiki-platform-localization-script/src/test/java/org/xwiki/localization/script/LocalizationScriptServiceTest.java

@@ -20,7 +20,6 @@
 package org.xwiki.localization.script;
 
 import java.util.Arrays;
-import java.util.Collections;
 import java.util.Locale;
 import java.util.Set;
 
@@ -141,24 +140,6 @@ public void renderWithParameters() throws Exception
             .render(Arrays.asList(null, "not existing key", "key", "another key"), Arrays.asList()));
     }
 
-    @Test
-    public void xWikiEscaping()
-    {
-        String output = "Some placeholders {0} [{}] {{/html}} {{html}} {";
-        WordBlock escaping = new WordBlock("escaping");
-        doAnswer(invocation -> {
-            WikiPrinter printer = (WikiPrinter) invocation.getArguments()[1];
-            printer.print(output);
-            return null;
-        }).when(this.renderer).render(eq(escaping), any(WikiPrinter.class));
-        when(this.translation.render(Locale.ROOT, ArrayUtils.EMPTY_OBJECT_ARRAY)).thenReturn(escaping);
-
-        assertEquals("Some placeholders {0} [{}] \u2774\u2774/html}} \u2774\u2774html}} \u2774",
-            this.localizationScriptService.render("key", Collections.emptyList()));
-        // Make sure that escaping is not used when explicitly specifying the output syntax.
-        assertEquals(output, this.localizationScriptService.render("key", Syntax.PLAIN_1_0, Collections.emptyList()));
-    }
-
     @Test
     public void getCurrentLocale() throws Exception
     {

xwiki-platform-core/xwiki-platform-oldcore/src/main/java/com/xpn/xwiki/web/XWikiMessageTool.java

@@ -38,7 +38,6 @@
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.xwiki.localization.ContextualLocalizationManager;
-import org.xwiki.localization.internal.TranslationEscapeTool;
 
 import com.xpn.xwiki.XWikiContext;
 import com.xpn.xwiki.XWikiException;
@@ -153,10 +152,17 @@ public String get(String key)
         if (this.localization != null) {
             translation = get(key, ArrayUtils.EMPTY_OBJECT_ARRAY);
         } else {
-            translation = getTranslationWithoutLocalizationManager(key);
+            translation = getTranslation(key);
+            if (translation == null) {
+                try {
+                    translation = this.bundle.getString(key);
+                } catch (Exception e) {
+                    translation = key;
+                }
+            }
         }
 
-        return TranslationEscapeTool.escapeForMacros(translation);
+        return translation;
     }
 
     /**
@@ -196,14 +202,14 @@ public String get(String key, Object... params)
                 translation = key;
             }
         } else {
-            translation = getTranslationWithoutLocalizationManager(key);
+            translation = get(key);
 
             if (params != null && translation != null) {
                 translation = MessageFormat.format(translation, params);
             }
         }
 
-        return TranslationEscapeTool.escapeForMacros(translation);
+        return translation;
     }
 
     /**
@@ -401,24 +407,4 @@ protected String getTranslation(String key)
 
         return returnValue;
     }
-
-    /**
-     * Tries getting a translation without using the localization manager.
-     *
-     * @param key the key identifying the translation
-     * @return the translation or the key if there is none
-     */
-    private String getTranslationWithoutLocalizationManager(String key)
-    {
-        String translation = getTranslation(key);
-        if (translation == null) {
-            try {
-                translation = this.bundle.getString(key);
-            } catch (Exception e) {
-                translation = key;
-            }
-        }
-
-        return translation;
-    }
 }

xwiki-platform-core/xwiki-platform-oldcore/src/test/java/com/xpn/xwiki/web/XWikiMessageToolTest.java

@@ -287,19 +287,4 @@ public void testGetWhenWithUTF8Translation() throws XWikiException
         assertEquals("some\u00E9value", this.tool.get("somekey"));
         assertEquals("some\u00E9value2", this.tool.get("somekey2"));
     }
-
-    @Test
-    void testEscaping() throws XWikiException
-    {
-        saveTranslations("somekey=Some placeholders {0} '[{}] {{/html}} {{html}} {'");
-
-        assertEquals(
-            "Some placeholders {0} '[{}] \u2774\u2774/html}} \u2774\u2774html}} \u2774'",
-            this.tool.get("somekey")
-        );
-        assertEquals(
-            "Some placeholders \u2774hi [{}] \u2774\u2774/html}} \u2774\u2774html}} \u2774",
-            this.tool.get("somekey", "{hi")
-        );
-    }
 }