Changeset 18839 in josm for trunk/src/org/openstreetmap

Timestamp:

2023-09-21T19:04:05+02:00 (14 months ago)

Author:

taylor.smock

Message:

Fix #23179: Include changeset in note comment if feasible (patch by qeef, modified)

Modifications are as follows:

• Unit tests
• Better note matching
• Find multiple changesets referring the same note

Location:

trunk/src/org/openstreetmap/josm/gui

Files:

• NoteInputDialog.java (modified) (1 diff)
• dialogs/NotesDialog.java (modified) (5 diffs)

trunk/src/org/openstreetmap/josm/gui/NoteInputDialog.java

@@ -45 +45 @@
      */
     public void showNoteDialog(String message, Icon icon) {
+        showNoteDialog(message, icon, "");
+    }
+
+    /**
+     * Displays the dialog to the user
+     * @param message Translated message to display to the user as input prompt
+     * @param icon Icon to display in the action button
+     * @param text Default text of the note's comment
+     * @since xxx
+     */
+    public void showNoteDialog(String message, Icon icon, String text) {
+        textArea.setText(text);
         textArea.setRows(6);
         textArea.setColumns(30);

trunk/src/org/openstreetmap/josm/gui/dialogs/NotesDialog.java

@@ -15 +15 @@
 import java.util.Arrays;
 import java.util.Collection;
+import java.util.Collections;
 import java.util.List;
 import java.util.Objects;
 import java.util.function.Predicate;
+import java.util.regex.Matcher;
 import java.util.regex.Pattern;
 import java.util.stream.Collectors;
@@ -41 +43 @@
 import org.openstreetmap.josm.data.notes.Note.State;
 import org.openstreetmap.josm.data.notes.NoteComment;
+import org.openstreetmap.josm.data.osm.Changeset;
+import org.openstreetmap.josm.data.osm.ChangesetCache;
 import org.openstreetmap.josm.data.osm.NoteData;
 import org.openstreetmap.josm.data.osm.NoteData.NoteDataUpdateListener;
@@ -58 +62 @@
 import org.openstreetmap.josm.gui.widgets.JosmTextField;
 import org.openstreetmap.josm.gui.widgets.PopupMenuLauncher;
+import org.openstreetmap.josm.io.OsmApi;
 import org.openstreetmap.josm.spi.preferences.Config;
 import org.openstreetmap.josm.tools.ImageProvider;
@@ -423 +428 @@
         @Override
         public void actionPerformed(ActionEvent e) {
+            Note note = displayList.getSelectedValue();
+            final List<String> changesetUrls = note == null ? Collections.emptyList() : getRelatedChangesetUrls(note.getId());
             NoteInputDialog dialog = new NoteInputDialog(MainApplication.getMainFrame(), tr("Close note"), tr("Close note"));
-            dialog.showNoteDialog(tr("Close note with message:"), ImageProvider.get("dialogs/notes", "note_closed"));
+            dialog.showNoteDialog(tr("Close note with message:"), ImageProvider.get("dialogs/notes", "note_closed"),
+                    String.join("\n", changesetUrls));
             if (dialog.getValue() != 1) {
                 return;
             }
-            Note note = displayList.getSelectedValue();
             if (note != null) {
                 int selectedIndex = displayList.getSelectedIndex();
@@ -443 +450 @@
 
     /**
+     * Get a list of changeset urls that may have fixed a note
+     * @param noteId The note ID to look for
+     * @return A list of changeset URLs
+     */
+    static List<String> getRelatedChangesetUrls(long noteId) {
+        final List<String> changesetUrls = new ArrayList<>();
+        final int patternFlags = Pattern.CASE_INSENSITIVE | Pattern.UNICODE_CHARACTER_CLASS;
+        final Matcher noteMatcher = Pattern.compile("note " + noteId + "( |$)", patternFlags).matcher("");
+        final Matcher shortOsmMatcher = Pattern.compile("osm.org/note/" + noteId + "( |$)", patternFlags).matcher("");
+        final String hostUrl = Pattern.compile("https?://(www\\.)?")
+                .matcher(Config.getUrls().getBaseBrowseUrl())
+                .replaceFirst("");
+        final Matcher longOsmMatcher = Pattern.compile(hostUrl + "/note/" + noteId + "( |$)", patternFlags).matcher("");
+        final boolean isUsingDefaultOsmApi = Config.getUrls().getDefaultOsmApiUrl().equals(OsmApi.getOsmApi().getServerUrl());
+        for (Changeset cs: ChangesetCache.getInstance().getChangesets()) {
+            final String comment = cs.getComment();
+            if ((isUsingDefaultOsmApi && (shortOsmMatcher.reset(comment).find() || noteMatcher.reset(comment).find()))
+                    || longOsmMatcher.reset(comment).find()) {
+                changesetUrls.add(Config.getUrls().getBaseBrowseUrl() + "/changeset/" + cs.getId());
+            }
+        }
+        return changesetUrls;
+    }
+
+    /**
      * Create a new note
      */