Changeset 32891 in osm for applications/editors

Timestamp:

2016-08-30T13:26:57+02:00 (8 years ago)

Author:

simon04

Message:

JOSM/wikipedia: refactoring (merge WikipediaLangArticle into WikipediaEntry)

Location:

applications/editors/josm/plugins/wikipedia

Files:

• src/org/wikipedia/WikipediaApp.java (modified) (8 diffs)
• src/org/wikipedia/actions/FetchWikidataAction.java (modified) (6 diffs)
• src/org/wikipedia/actions/WikipediaAddNamesAction.java (modified) (3 diffs)
• src/org/wikipedia/data/WikidataEntry.java (modified) (2 diffs)
• src/org/wikipedia/data/WikipediaEntry.java (modified) (3 diffs)
• src/org/wikipedia/data/WikipediaLangArticle.java (deleted)
• src/org/wikipedia/gui/WikipediaToggleDialog.java (modified) (5 diffs)
• test/unit/org/wikipedia/WikipediaAppTest.java (modified) (5 diffs)
• test/unit/org/wikipedia/data/WikipediaEntryTest.java (modified) (1 diff)
• test/unit/org/wikipedia/data/WikipediaLangArticleTest.java (deleted)

applications/editors/josm/plugins/wikipedia/src/org/wikipedia/WikipediaApp.java

@@ -36 +36 @@
 import org.wikipedia.data.WikidataEntry;
 import org.wikipedia.data.WikipediaEntry;
-import org.wikipedia.data.WikipediaLangArticle;
 import org.wikipedia.tools.XPath;
 
@@ -153 +152 @@
             final String url = "https://tools.wmflabs.org/wiwosm/osmjson/getGeoJSON.php?action=check&lang=" + wikipediaLang;
             try {
-                final String articles = entries.stream().map(i -> i.wikipediaArticle).collect(Collectors.joining(","));
+                final String articles = entries.stream().map(i -> i.article).collect(Collectors.joining(","));
                 final String requestBody = "articles=" + Utils.encodeUrl(articles);
                 try (final BufferedReader reader = HttpClient.create(new URL(url), "POST").setReasonForRequest("Wikipedia")
@@ -174 +173 @@
         }
         for (WikipediaEntry i : entries) {
-            i.setWiwosmStatus(status.get(i.wikipediaArticle));
+            i.setWiwosmStatus(status.get(i.article));
         }
     }
@@ -184 +183 @@
         return Stream
                 .of("wikipedia", "wikipedia:" + wikipediaLang)
-                .map(key -> WikipediaLangArticle.parseTag(key, p.get(key)))
+                .map(key -> WikipediaEntry.parseTag(key, p.get(key)))
                 .filter(Objects::nonNull)
                 .filter(wp -> wikipediaLang.equals(wp.lang))
@@ -267 +266 @@
                     "?action=wbgetentities" +
                     "&props=labels|descriptions" +
-                    "&ids=" + entries.stream().map(x -> x.wikipediaArticle).collect(Collectors.joining("|")) +
+                    "&ids=" + entries.stream().map(x -> x.article).collect(Collectors.joining("|")) +
                     "&format=xml";
             final Collection<String> languages = new ArrayList<>();
@@ -281 +280 @@
                 final Document xml = newDocumentBuilder().parse(in);
                 for (final WikipediaEntry entry : entries) {
-                    final Node entity = X_PATH.evaluateNode("//entity[@id='" + entry.wikipediaArticle + "']", xml);
+                    final Node entity = X_PATH.evaluateNode("//entity[@id='" + entry.article + "']", xml);
                     if (entity == null) {
                         continue;
                     }
                     r.add(new WikidataEntry(
-                            entry.wikipediaArticle,
+                            entry.article,
                             getFirstField(languages, "label", entity),
                             entry.coordinate,
@@ -309 +308 @@
     }
 
-    public static Collection<WikipediaLangArticle> getInterwikiArticles(String wikipediaLang, String article) {
+    public static Collection<WikipediaEntry> getInterwikiArticles(String wikipediaLang, String article) {
         try {
             final String url = getSiteUrl(wikipediaLang) + "/w/api.php" +
@@ -323 +322 @@
                             final String lang = X_PATH.evaluateString("@lang", node);
                             final String name = node.getTextContent();
-                            return new WikipediaLangArticle(lang, name);
+                            return new WikipediaEntry(lang, name);
                         }).collect(Collectors.toList());
             }

applications/editors/josm/plugins/wikipedia/src/org/wikipedia/actions/FetchWikidataAction.java

@@ -29 +29 @@
 import org.openstreetmap.josm.tools.Utils;
 import org.wikipedia.WikipediaApp;
-import org.wikipedia.data.WikipediaLangArticle;
+import org.wikipedia.data.WikipediaEntry;
 import org.wikipedia.gui.GuiUtils;
 
@@ -52 +52 @@
         private boolean canceled = false;
         private final List<Command> commands = new ArrayList<>();
-        private final Collection<WikipediaLangArticle> notFound = new ArrayList<>();
+        private final Collection<WikipediaEntry> notFound = new ArrayList<>();
 
         public Fetcher(Collection<? extends OsmPrimitive> selection) {
@@ -85 +85 @@
             final Map<String, PrimitivesWithWikipedia> r = new HashMap<>();
             for (final OsmPrimitive i : selection) {
-                final WikipediaLangArticle tag = WikipediaLangArticle.parseTag("wikipedia", i.get("wikipedia"));
+                final WikipediaEntry tag = WikipediaEntry.parseTag("wikipedia", i.get("wikipedia"));
                 if (tag != null) {
                     if (!r.containsKey(tag.lang)) {
@@ -114 +114 @@
         final MultiMap<String, OsmPrimitive> byArticle = new MultiMap<>();
         final List<Command> commands = new ArrayList<>();
-        final List<WikipediaLangArticle> notFound = new ArrayList<>();
+        final List<WikipediaEntry> notFound = new ArrayList<>();
 
         PrimitivesWithWikipedia(String lang) {
@@ -139 +139 @@
                     }
                 } else {
-                    final WikipediaLangArticle article = new WikipediaLangArticle(lang, wikipedia);
+                    final WikipediaEntry article = new WikipediaEntry(lang, wikipedia);
                     Main.warn(tr("No Wikidata ID found for: {0}", article));
                     notFound.add(article);
@@ -154 +154 @@
         }
 
-        List<WikipediaLangArticle> getNotFound() {
+        List<WikipediaEntry> getNotFound() {
             return notFound;
         }

applications/editors/josm/plugins/wikipedia/src/org/wikipedia/actions/WikipediaAddNamesAction.java

@@ -17 +17 @@
 import org.openstreetmap.josm.io.remotecontrol.AddTagsDialog;
 import org.wikipedia.WikipediaApp;
-import org.wikipedia.data.WikipediaLangArticle;
+import org.wikipedia.data.WikipediaEntry;
 
 public class WikipediaAddNamesAction extends JosmAction {
@@ -29 +29 @@
     @Override
     public void actionPerformed(ActionEvent e) {
-        final WikipediaLangArticle wp = WikipediaLangArticle.parseTag("wikipedia", getWikipediaValue());
+        final WikipediaEntry wp = WikipediaEntry.parseTag("wikipedia", getWikipediaValue());
         List<String[]> tags = new ArrayList<>();
         WikipediaApp.getInterwikiArticles(wp.lang, wp.article).stream()
@@ -41 +41 @@
     }
 
-    private boolean useWikipediaLangArticle(WikipediaLangArticle i) {
+    private boolean useWikipediaLangArticle(WikipediaEntry i) {
         return (!Main.pref.getBoolean("wikipedia.filter-iso-languages", true)
                 || Arrays.asList(Locale.getISOLanguages()).contains(i.lang))

applications/editors/josm/plugins/wikipedia/src/org/wikipedia/data/WikidataEntry.java

@@ -20 +20 @@
     @Override
     public Tag createWikipediaTag() {
-        return new Tag("wikidata", wikipediaArticle);
+        return new Tag("wikidata", article);
     }
 
@@ -26 +26 @@
     public String getLabelText() {
         final String descriptionInParen = description == null ? "" : (" (" + description + ")");
-        return getLabelText(label, wikipediaArticle + descriptionInParen);
+        return getLabelText(label, article + descriptionInParen);
     }
 

applications/editors/josm/plugins/wikipedia/src/org/wikipedia/data/WikipediaEntry.java

@@ -9 +9 @@
 
 import java.util.Comparator;
+import java.util.Objects;
+import java.util.regex.Matcher;
+import java.util.regex.Pattern;
 
 public class WikipediaEntry implements Comparable<WikipediaEntry> {
 
+    public final String lang;
+    public final String article;
     public final String label;
-    public final String wikipediaLang, wikipediaArticle;
     public final LatLon coordinate;
     private Boolean wiwosmStatus;
 
-    public WikipediaEntry(String wikipediaLang, String wikipediaArticle) {
-        this(wikipediaLang, wikipediaArticle, null, null);
+    public WikipediaEntry(String lang, String article) {
+        this(lang, article, null, null);
     }
 
-    public WikipediaEntry(String wikipediaLang, String wikipediaArticle, String label, LatLon coordinate) {
+    public WikipediaEntry(String lang, String article, String label, LatLon coordinate) {
+        this.lang = lang;
+        this.article = article;
         this.label = label;
-        this.wikipediaLang = wikipediaLang;
-        this.wikipediaArticle = wikipediaArticle;
         this.coordinate = coordinate;
     }
 
+    static WikipediaEntry parseFromUrl(String url) {
+        if (url == null) {
+            return null;
+        }
+        // decode URL for nicer value
+        url = Utils.decodeUrl(url);
+        // extract Wikipedia language and
+        final Matcher m = Pattern.compile("(https?:)?//(\\w*)\\.wikipedia\\.org/wiki/(.*)").matcher(url);
+        if (!m.matches()) {
+            return null;
+        }
+        return new WikipediaEntry(m.group(2), m.group(3));
+    }
+
+    public static WikipediaEntry parseTag(String key, String value) {
+        if (value == null) {
+            return null;
+        } else if (value.startsWith("http")) {
+            //wikipedia=http...
+            return WikipediaEntry.parseFromUrl(value);
+        } else if (value.contains(":")) {
+            //wikipedia=[lang]:[article]
+            //wikipedia:[lang]=[lang]:[article]
+            final String[] item = Utils.decodeUrl(value).split(":", 2);
+            final String article = item[1].replace("_", " ");
+            return new WikipediaEntry(item[0], article);
+        } else if (key.startsWith("wikipedia:")) {
+            //wikipedia:[lang]=[lang]:[article]
+            //wikipedia:[lang]=[article]
+            final String lang = key.split(":", 2)[1];
+            final String[] item = Utils.decodeUrl(value).split(":", 2);
+            final String article = item[item.length == 2 ? 1 : 0].replace("_", " ");
+            return new WikipediaEntry(lang, article);
+        } else {
+            return null;
+        }
+    }
+
     public Tag createWikipediaTag() {
-        return new Tag("wikipedia", wikipediaLang + ":" + wikipediaArticle);
+        return new Tag("wikipedia", lang + ":" + article);
     }
 
@@ -41 +83 @@
 
     public String getBrowserUrl() {
-        return WikipediaApp.getSiteUrl(wikipediaLang) + "/wiki/" + Utils.encodeUrl(wikipediaArticle.replace(" ", "_"));
+        return WikipediaApp.getSiteUrl(lang) + "/wiki/" + Utils.encodeUrl(article.replace(" ", "_"));
     }
 
     public String getLabelText() {
-        return wikipediaArticle;
+        return article;
     }
 
     @Override
     public String toString() {
-        return wikipediaArticle;
+        return article;
     }
 
@@ -57 +99 @@
         return Comparator
                 .<WikipediaEntry, String>comparing(x -> x.label, AlphanumComparator.getInstance())
-                .thenComparing(x -> x.wikipediaArticle, AlphanumComparator.getInstance())
+                .thenComparing(x -> x.article, AlphanumComparator.getInstance())
                 .compare(this, o);
     }
+
+    @Override
+    public boolean equals(Object o) {
+        if (this == o) return true;
+        if (o == null || getClass() != o.getClass()) return false;
+        final WikipediaEntry that = (WikipediaEntry) o;
+        return Objects.equals(lang, that.lang) &&
+                Objects.equals(article, that.article);
+    }
+
+    @Override
+    public int hashCode() {
+        return Objects.hash(lang, article);
+    }
 }

applications/editors/josm/plugins/wikipedia/src/org/wikipedia/gui/WikipediaToggleDialog.java

@@ -79 +79 @@
                             Main.map.mapView.zoomTo(bbox);
                         }
-                        final String search = Optional.ofNullable(entry.label).orElse(entry.wikipediaArticle).replaceAll("\\(.*\\)", "");
+                        final String search = Optional.ofNullable(entry.label).orElse(entry.article).replaceAll("\\(.*\\)", "");
                         SearchAction.search(search, SearchAction.SearchMode.replace);
                     }
@@ -95 +95 @@
                         label.setIcon(ImageProvider.getIfAvailable("misc", "grey_check"));
                         label.setToolTipText(/* I18n: WIWOSM server already links Wikipedia article to object/s */ tr("Available via WIWOSM server"));
-                    } else if (articles.contains(entry.wikipediaArticle)) {
+                    } else if (articles.contains(entry.article)) {
                         label.setIcon(ImageProvider.getIfAvailable("misc", "green_check"));
                         label.setToolTipText(/* I18n: object/s from dataset contain link to Wikipedia article */ tr("Available in local dataset"));
@@ -124 +124 @@
     private String getLanguageOfFirstItem() {
         try {
-            return list.getModel().getElementAt(0).wikipediaLang;
+            return list.getModel().getElementAt(0).lang;
         } catch (ArrayIndexOutOfBoundsException ignore) {
             return wikipediaLang.get();
@@ -176 +176 @@
             publish(entries.toArray(new WikipediaEntry[entries.size()]));
             WikipediaApp.partitionList(entries, 20).forEach(chunk -> {
-                WikipediaApp.updateWIWOSMStatus(chunk.get(0).wikipediaLang, chunk);
+                WikipediaApp.updateWIWOSMStatus(chunk.get(0).lang, chunk);
                 list.repaint();
             });
@@ -342 +342 @@
             final LatLon latLon = entry.coordinate != null
                     ? entry.coordinate
-                    : WikipediaApp.getCoordinateForArticle(entry.wikipediaLang, entry.wikipediaArticle);
+                    : WikipediaApp.getCoordinateForArticle(entry.lang, entry.article);
             if (latLon == null) {
                 return;

applications/editors/josm/plugins/wikipedia/test/unit/org/wikipedia/WikipediaAppTest.java

@@ -7 +7 @@
 import org.wikipedia.data.WikidataEntry;
 import org.wikipedia.data.WikipediaEntry;
-import org.wikipedia.data.WikipediaLangArticle;
 
 import java.util.Arrays;
@@ -52 +51 @@
     @Test
     public void testGetInterwikiArticles1() {
-        final Collection<WikipediaLangArticle> iw = WikipediaApp.getInterwikiArticles("de", "Österreich");
-        assertThat(iw, hasItem(new WikipediaLangArticle("en", "Austria")));
-        assertThat(iw, hasItem(new WikipediaLangArticle("no", "Østerrike")));
-        assertThat(iw, hasItem(new WikipediaLangArticle("ko", "오스트리아")));
+        final Collection<WikipediaEntry> iw = WikipediaApp.getInterwikiArticles("de", "Österreich");
+        assertThat(iw, hasItem(new WikipediaEntry("en", "Austria")));
+        assertThat(iw, hasItem(new WikipediaEntry("no", "Østerrike")));
+        assertThat(iw, hasItem(new WikipediaEntry("ko", "오스트리아")));
     }
 
     @Test
     public void testGetInterwikiArticles2() {
-        final Collection<WikipediaLangArticle> iw = WikipediaApp.getInterwikiArticles("en", "Ampersand");
-        assertThat(iw, hasItem(new WikipediaLangArticle("fi", "&")));
+        final Collection<WikipediaEntry> iw = WikipediaApp.getInterwikiArticles("en", "Ampersand");
+        assertThat(iw, hasItem(new WikipediaEntry("fi", "&")));
     }
 
@@ -76 +75 @@
                 new LatLon(52.5179786, 13.3753321), new LatLon(52.5192215, 13.3768705));
         final long c = entries.stream()
-                .filter(entry -> "Reichstagsgebäude".equals(entry.wikipediaArticle) && "de".equals(entry.wikipediaLang))
+                .filter(entry -> "Reichstagsgebäude".equals(entry.article) && "de".equals(entry.lang))
                 .count();
         assertEquals(1, c);
@@ -85 +84 @@
         final List<WikidataEntry> de = WikipediaApp.getWikidataEntriesForQuery("de", "Österreich", Locale.GERMAN);
         final List<WikidataEntry> en = WikipediaApp.getWikidataEntriesForQuery("de", "Österreich", Locale.ENGLISH);
-        assertThat(de.get(0).wikipediaArticle, is("Q40"));
-        assertThat(de.get(0).wikipediaLang, is("wikidata"));
+        assertThat(de.get(0).article, is("Q40"));
+        assertThat(de.get(0).lang, is("wikidata"));
         assertThat(de.get(0).label, is("Österreich"));
         assertThat(de.get(0).description, is("Staat in Mitteleuropa"));
@@ -98 +97 @@
                 new LatLon(47.20, 11.30), new LatLon(47.22, 11.32));
         final long c = entries.stream()
-                .filter(entry -> "Q865406".equals(entry.wikipediaArticle) && "wikidata".equals(entry.wikipediaLang) && "Birgitzer Alm".equals(entry.label))
+                .filter(entry -> "Q865406".equals(entry.article) && "wikidata".equals(entry.lang) && "Birgitzer Alm".equals(entry.label))
                 .count();
         assertEquals(1, c);

applications/editors/josm/plugins/wikipedia/test/unit/org/wikipedia/data/WikipediaEntryTest.java

@@ -5 +5 @@
 
 import static org.hamcrest.CoreMatchers.is;
+import static org.hamcrest.CoreMatchers.nullValue;
 import static org.junit.Assert.*;
 
 public class WikipediaEntryTest {
+
+    @Test
+    public void testParseFromUrl1() {
+        final WikipediaEntry actual = WikipediaEntry.parseFromUrl("https://de.wikipedia.org/wiki/Österreich");
+        assertThat(actual.article, is("Österreich"));
+        assertThat(actual.lang, is("de"));
+    }
+
+    @Test
+    public void testParseFromUrl2() {
+        final WikipediaEntry actual = WikipediaEntry.parseFromUrl("http://de.wikipedia.org/wiki/%C3%96sterreich");
+        assertThat(actual.article, is("Österreich"));
+        assertThat(actual.lang, is("de"));
+    }
+
+    @Test
+    public void testParseFromUrl3() {
+        final WikipediaEntry actual = WikipediaEntry.parseFromUrl("http://de.wikipedia.org/wiki/Sternheim_%26_Emanuel");
+        assertThat(actual.article, is("Sternheim_&_Emanuel"));
+        assertThat(actual.lang, is("de"));
+    }
+
+    @Test
+    public void testParseFromUrl4() {
+        final WikipediaEntry actual = WikipediaEntry.parseFromUrl("//de.wikipedia.org/wiki/Reichstagsgeb%C3%A4ude");
+        assertThat(actual.article, is("Reichstagsgebäude"));
+        assertThat(actual.lang, is("de"));
+    }
+
+    @Test
+    public void testParseFromTag0() {
+        final WikipediaEntry actual = WikipediaEntry.parseTag("wikipedia", "Österreich");
+        assertThat(actual, nullValue());
+    }
+
+    @Test
+    public void testParseFromTag1() {
+        final WikipediaEntry actual = WikipediaEntry.parseTag("wikipedia", "de:Österreich");
+        assertThat(actual.article, is("Österreich"));
+        assertThat(actual.lang, is("de"));
+    }
+
+    @Test
+    public void testParseFromTag2() {
+        final WikipediaEntry actual = WikipediaEntry.parseTag("wikipedia:de", "Österreich");
+        assertThat(actual.article, is("Österreich"));
+        assertThat(actual.lang, is("de"));
+    }
+
+    @Test
+    public void testParseFromTag3() {
+        final WikipediaEntry actual = WikipediaEntry.parseTag("wikipedia:de", "de:Österreich");
+        assertThat(actual.article, is("Österreich"));
+        assertThat(actual.lang, is("de"));
+    }
+
+    @Test
+    public void testParseFromTag4() {
+        final WikipediaEntry actual = WikipediaEntry.parseTag("wikipedia", "https://de.wikipedia.org/wiki/Österreich");
+        assertThat(actual.article, is("Österreich"));
+        assertThat(actual.lang, is("de"));
+    }
 
     @Test