Ticket #21794: 21794.2.patch

new file src/org/openstreetmap/josm/tools/PatternUtils.java

@@ +1 @@
+// License: GPL. For details, see LICENSE file.
+package org.openstreetmap.josm.tools;
+
+import java.util.concurrent.TimeUnit;
+import java.util.regex.Pattern;
+
+import org.apache.commons.jcs3.access.CacheAccess;
+import org.apache.commons.jcs3.engine.behavior.IElementAttributes;
+import org.openstreetmap.josm.data.cache.JCSCacheManager;
+import org.openstreetmap.josm.spi.preferences.Config;
+
+/**
+ * A class that caches compiled patterns.
+ * @author Taylor Smock
+ * @since xxx
+ */
+public final class PatternUtils {
+    /** A string that is highly unlikely to appear in regexes to split a regex from its flags */
+    private static final String MAGIC_STRING = "========";
+    /** A cache for Java Patterns (no flags) */
+    private static final CacheAccess<String, Pattern> cache = JCSCacheManager.getCache("java:pattern",
+            Config.getPref().getInt("java.pattern.cache", 1024), 0, null);
+
+    static {
+        // We don't want to keep these around forever, so set a reasonablish max idle life.
+        final IElementAttributes defaultAttributes = cache.getDefaultElementAttributes();
+        defaultAttributes.setIdleTime(TimeUnit.HOURS.toSeconds(1));
+        cache.setDefaultElementAttributes(defaultAttributes);
+    }
+
+    private PatternUtils() {
+        // Hide the constructor
+    }
+
+    /**
+     * Compile a regex into a pattern. This may return a {@link Pattern} used elsewhere. This is safe.
+     * @param regex The regex to compile
+     * @return The immutable {@link Pattern}.
+     * @see Pattern#compile(String)
+     */
+    public static Pattern compile(final String regex) {
+        return compile(regex, 0);
+    }
+
+    /**
+     * Compile a regex into a pattern. This may return a {@link Pattern} used elsewhere. This is safe.
+     * @param regex The regex to compile
+     * @param flags The flags from {@link Pattern} to apply
+     * @return The immutable {@link Pattern}.
+     * @see Pattern#compile(String, int)
+     */
+    public static Pattern compile(String regex, int flags) {
+        // Right now, the maximum value of flags is 511 (3 characters). This should avoid unnecessary array copying.
+        final StringBuilder sb = new StringBuilder(3 + MAGIC_STRING.length() + regex.length());
+        return cache.get(sb.append(flags).append(MAGIC_STRING).append(regex).toString(), () -> Pattern.compile(regex, flags));
+    }
+}

src/org/openstreetmap/josm/tools/Tag2Link.java

@@ -10 +10 @@
 import java.net.URL;
 import java.util.Arrays;
 import java.util.Collections;
-import java.util.HashMap;
+import java.util.EnumMap;
 import java.util.List;
 import java.util.Map;
 import java.util.Objects;
 import java.util.Optional;
+import java.util.Set;
 import java.util.function.Supplier;
 import java.util.function.UnaryOperator;
 import java.util.regex.Matcher;
@@ -147 +148 @@
             return;
         }
 
-        final HashMap<OsmPrimitiveType, Optional<ImageResource>> memoize = new HashMap<>();
+        final Map<OsmPrimitiveType, Optional<ImageResource>> memoize = new EnumMap<>(OsmPrimitiveType.class);
         final Supplier<ImageResource> imageResource = () -> memoize
                 .computeIfAbsent(OsmPrimitiveType.NODE, type -> OsmPrimitiveImageProvider.getResource(key, value, type))
                 .orElse(null);
@@ -208 +209 @@
                     tr("View category on Wikimedia Commons"), getWikimediaCommonsUrl(i), imageResource.get()));
         }
 
-        wikidataRules.getValues(key).forEach(urlFormatter -> {
+        final Set<String> formatterUrls = wikidataRules.getValues(key);
+        if (!formatterUrls.isEmpty()) {
             final String formattedValue = valueFormatter.getOrDefault(key, x -> x).apply(value);
-            final String url = urlFormatter.replace("$1", formattedValue);
-            linkConsumer.acceptLink(getLinkName(url, key), url, imageResource.get());
-        });
+            final Pattern dollarOne = PatternUtils.compile("$1", Pattern.LITERAL);
+
+            final String urlKey = formatterUrls.stream().map(urlFormatter -> dollarOne.matcher(urlFormatter)
+                            .replaceAll(Matcher.quoteReplacement("(.*)"))).map(PatternUtils::compile)
+                            .map(pattern -> pattern.matcher(value)).filter(Matcher::matches)
+                            .map(matcher -> matcher.group(1)).findFirst().orElse(formattedValue);
+
+            formatterUrls.forEach(urlFormatter -> {
+                // Check if the current value matches the formatter pattern -- some keys can take a full url or a key for
+                // the formatter. Example: https://wiki.openstreetmap.org/wiki/Key:contact:facebook
+                final String url = urlFormatter.replace("$1", urlKey);
+                linkConsumer.acceptLink(getLinkName(url, key), url, imageResource.get());
+            });
+        }
     }
 
     private static String getWikimediaCommonsUrl(String i) {

test/unit/org/openstreetmap/josm/tools/Tag2LinkTest.java

@@ -1 +1 @@
 // License: GPL. For details, see LICENSE file.
 package org.openstreetmap.josm.tools;
 
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertTrue;
+
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.List;
 
-import org.junit.Assert;
 import org.junit.jupiter.api.Test;
+import org.junit.jupiter.params.ParameterizedTest;
+import org.junit.jupiter.params.provider.ValueSource;
 import org.openstreetmap.josm.testutils.annotations.BasicPreferences;
+import org.openstreetmap.josm.testutils.annotations.StaticClassCleanup;
 
 /**
  * Test {@link Tag2Link}
  */
 @BasicPreferences
+@StaticClassCleanup(Tag2Link.class)
 class Tag2LinkTest {
 
     List<String> links = new ArrayList<>();
@@ -22 +28 @@
     }
 
     void checkLinks(String... expected) {
-        Assert.assertEquals(Arrays.asList(expected), links);
+        assertEquals(Arrays.asList(expected), this.links);
     }
 
     /**
@@ -31 +37 @@
     @Test
     void testInitialize() {
         Tag2Link.initialize();
-        Assert.assertTrue("obtains at least 40 rules", Tag2Link.wikidataRules.size() > 40);
+        assertTrue(Tag2Link.wikidataRules.size() > 40, "obtains at least 40 rules");
+    }
+
+    /**
+     * Unit test for links that may come in multiple forms.
+     * Example: <a href="https://wiki.osm.org/wiki/Key:contact:facebook">https://wiki.openstreetmap.org/wiki/Key:contact:facebook</a>
+     *
+     * See also JOSM #21794
+     * @param value The tag value for "contact:facebook"
+     */
+    @ParameterizedTest
+    @ValueSource(strings = {"https://www.facebook.com/FacebookUserName", "FacebookUserName"})
+    void testUrlKeyMultipleForms(final String value) {
+        // We need the wikidata rules Since testInitialize tests initialization, reuse it.
+        if (!Tag2Link.wikidataRules.containsKey("contact:facebook")) {
+            this.testInitialize();
+        }
+        Tag2Link.getLinksForTag("contact:facebook", value, this::addLink);
+        this.checkLinks("Open unavatar.now.sh // https://unavatar.now.sh/facebook/FacebookUserName",
+                "Open facebook.com // https://www.facebook.com/FacebookUserName",
+                "Open messenger.com // https://www.messenger.com/t/FacebookUserName");
     }
 
     /**