Add support for deprecated attribute and update the presets search dialog

resources/data/tagging-preset.xsd

@@ -121,7 +121,7 @@
     <complexType name="item">
         <annotation>
             <documentation>
-                Every item is one annotation set to select from. name is required, type and preset_name_label are recommended, icon and name_template are optional attributes.
+                Every item is one annotation set to select from. name is required, type and preset_name_label are recommended, deprecated, icon, name_template are optional attributes.
             </documentation>
         </annotation>
         <sequence>
@@ -171,6 +171,13 @@
                 </documentation>
             </annotation>
         </attribute>
+        <attribute name="deprecated" type="boolean">
+            <annotation>
+                <documentation>
+                    Whether this preset is deprecated (defaults to "false").
+                </documentation>
+            </annotation>
+        </attribute>
 
         <attribute name="text" use="prohibited" />
         <anyAttribute processContents="skip" />

src/org/openstreetmap/josm/data/validation/tests/TagChecker.java

@@ -131,6 +131,7 @@ public class TagChecker extends TagTest implements TaggingPresetListener {
      * The preference key to check presets
      */
     public static final String PREF_CHECK_PRESETS_TYPES = PREFIX + ".checkPresetsTypes";
+    public static final String PREF_CHECK_DEPRECATED = PREFIX + ".checkDeprecated";
 
     /**
      * The preference key for source files
@@ -159,6 +160,7 @@ public class TagChecker extends TagTest implements TaggingPresetListener {
      * The preference key to search for presets - used before upload
      */
     public static final String PREF_CHECK_PRESETS_TYPES_BEFORE_UPLOAD = PREF_CHECK_PRESETS_TYPES + BEFORE_UPLOAD;
+    public static final String PREF_CHECK_DEPRECATED_BEFORE_UPLOAD = PREF_CHECK_DEPRECATED + BEFORE_UPLOAD;
 
     /**
      * The preference key for the list of tag keys that are allowed to be the same on a multipolygon and an outer way
@@ -175,18 +177,21 @@ public class TagChecker extends TagTest implements TaggingPresetListener {
     protected boolean checkComplex;
     protected boolean checkFixmes;
     protected boolean checkPresetsTypes;
+    protected boolean checkDeprecated;
 
     protected JCheckBox prefCheckKeys;
     protected JCheckBox prefCheckValues;
     protected JCheckBox prefCheckComplex;
     protected JCheckBox prefCheckFixmes;
     protected JCheckBox prefCheckPresetsTypes;
+    protected JCheckBox prefCheckDeprecated;
 
     protected JCheckBox prefCheckKeysBeforeUpload;
     protected JCheckBox prefCheckValuesBeforeUpload;
     protected JCheckBox prefCheckComplexBeforeUpload;
     protected JCheckBox prefCheckFixmesBeforeUpload;
     protected JCheckBox prefCheckPresetsTypesBeforeUpload;
+    protected JCheckBox prefCheckDeprecatedBeforeUpload;
 
     // CHECKSTYLE.OFF: SingleSpaceSeparator
     protected static final int EMPTY_VALUES                     = 1200;
@@ -210,6 +215,7 @@ public class TagChecker extends TagTest implements TaggingPresetListener {
     protected static final int MULTIPOLYGON_INCOMPLETE          = 1219;
     protected static final int MULTIPOLYGON_MAYBE_NO_AREA       = 1220;
     protected static final int MULTIPOLYGON_SAME_TAG_ON_OUTER   = 1221;
+    protected static final int DEPRECATED_TAG = 1223;
     // CHECKSTYLE.ON: SingleSpaceSeparator
 
     protected EditableList sourcesList;
@@ -654,15 +660,22 @@ public void check(OsmPrimitive p) {
         checkMultipolygonTags(p);
         }
 
+        final Collection<TaggingPreset> matchingPresets;
+        TagMap tags = p.getKeys();
+        if (checkPresetsTypes || checkDeprecated) {
+            matchingPresets = presetIndex.entrySet().stream()
+                    .filter(e -> TaggingPresetItem.matches(e.getValue(), tags))
+                    .map(Entry::getKey)
+                    .collect(Collectors.toCollection(LinkedHashSet::new));
+        } else {
+            matchingPresets = null;
+        }
         if (checkPresetsTypes) {
-            TagMap tags = p.getKeys();
+
             TaggingPresetType presetType = TaggingPresetType.forPrimitive(p);
             EnumSet<TaggingPresetType> presetTypes = EnumSet.of(presetType);
 
-            Collection<TaggingPreset> matchingPresets = presetIndex.entrySet().stream()
-                    .filter(e -> TaggingPresetItem.matches(e.getValue(), tags))
-                    .map(Entry::getKey)
-                    .collect(Collectors.toCollection(LinkedHashSet::new));
+
             Collection<TaggingPreset> matchingPresetsOK = matchingPresets.stream().filter(
                     tp -> tp.typeMatches(presetTypes)).collect(Collectors.toList());
             Collection<TaggingPreset> matchingPresetsKO = matchingPresets.stream().filter(
@@ -687,6 +700,18 @@ public void check(OsmPrimitive p) {
                 }
             }
         }
+        if (checkDeprecated) {
+            for (TaggingPreset preset : matchingPresets) {
+                if (preset.deprecated()) {
+                    errors.add(TestError.builder(this, Severity.ERROR, DEPRECATED_TAG)
+                            .message(tr("Preset is deprecated"),
+                                    marktr("Preset {0} should not be used"),
+                                    tr(preset.getName()))
+                            .primitives(p)
+                            .build());
+                }
+            }
+        }
     }
 
     private static final Collection<String> NO_AREA_KEYS = Arrays.asList("name", "area", "ref", "access", "operator");
@@ -1099,6 +1124,11 @@ public void startTest(ProgressMonitor monitor) {
         if (isBeforeUpload) {
             checkPresetsTypes = checkPresetsTypes && Config.getPref().getBoolean(PREF_CHECK_PRESETS_TYPES_BEFORE_UPLOAD, true);
         }
+
+        checkDeprecated = includeOtherSeverity && Config.getPref().getBoolean(PREF_CHECK_DEPRECATED, true);
+        if (isBeforeUpload) {
+            checkDeprecated = checkDeprecated && Config.getPref().getBoolean(PREF_CHECK_DEPRECATED_BEFORE_UPLOAD, true);
+        }
         deprecatedChecker = OsmValidator.getTest(MapCSSTagChecker.class);
         ignoreForOuterMPSameTagCheck.addAll(Config.getPref().getList(PREF_KEYS_IGNORE_OUTER_MP_SAME_TAG, Collections.emptyList()));
     }
@@ -1111,7 +1141,7 @@ public void endTest() {
 
     @Override
     public void visit(Collection<OsmPrimitive> selection) {
-        if (checkKeys || checkValues || checkComplex || checkFixmes || checkPresetsTypes) {
+        if (checkKeys || checkValues || checkComplex || checkFixmes || checkPresetsTypes || checkDeprecated) {
             super.visit(selection);
         }
     }
@@ -1176,6 +1206,14 @@ public void addGui(JPanel testPanel) {
         prefCheckPresetsTypesBeforeUpload = new JCheckBox();
         prefCheckPresetsTypesBeforeUpload.setSelected(Config.getPref().getBoolean(PREF_CHECK_PRESETS_TYPES_BEFORE_UPLOAD, true));
         testPanel.add(prefCheckPresetsTypesBeforeUpload, a);
+
+        prefCheckDeprecated = new JCheckBox(tr("Check for deprecated tags"), Config.getPref().getBoolean(PREF_CHECK_DEPRECATED, true));
+        prefCheckDeprecated.setToolTipText(tr("Check whether the preset is deprecated"));
+        testPanel.add(prefCheckDeprecated, GBC.std().insets(20, 0, 0, 0));
+
+        prefCheckDeprecatedBeforeUpload = new JCheckBox();
+        prefCheckDeprecatedBeforeUpload.setSelected(Config.getPref().getBoolean(PREF_CHECK_DEPRECATED_BEFORE_UPLOAD, true));
+        testPanel.add(prefCheckDeprecatedBeforeUpload, a);
     }
 
     /**
@@ -1198,11 +1236,13 @@ public boolean ok() {
         Config.getPref().putBoolean(PREF_CHECK_KEYS, prefCheckKeys.isSelected());
         Config.getPref().putBoolean(PREF_CHECK_FIXMES, prefCheckFixmes.isSelected());
         Config.getPref().putBoolean(PREF_CHECK_PRESETS_TYPES, prefCheckPresetsTypes.isSelected());
+        Config.getPref().putBoolean(PREF_CHECK_DEPRECATED, prefCheckDeprecated.isSelected());
         Config.getPref().putBoolean(PREF_CHECK_VALUES_BEFORE_UPLOAD, prefCheckValuesBeforeUpload.isSelected());
         Config.getPref().putBoolean(PREF_CHECK_COMPLEX_BEFORE_UPLOAD, prefCheckComplexBeforeUpload.isSelected());
         Config.getPref().putBoolean(PREF_CHECK_KEYS_BEFORE_UPLOAD, prefCheckKeysBeforeUpload.isSelected());
         Config.getPref().putBoolean(PREF_CHECK_FIXMES_BEFORE_UPLOAD, prefCheckFixmesBeforeUpload.isSelected());
         Config.getPref().putBoolean(PREF_CHECK_PRESETS_TYPES_BEFORE_UPLOAD, prefCheckPresetsTypesBeforeUpload.isSelected());
+        Config.getPref().putBoolean(PREF_CHECK_DEPRECATED_BEFORE_UPLOAD, prefCheckDeprecatedBeforeUpload.isSelected());
         return Config.getPref().putList(PREF_SOURCES, sourcesList.getItems());
     }
 

src/org/openstreetmap/josm/gui/dialogs/SearchDialog.java

@@ -231,7 +231,7 @@ public boolean isValid() {
          * selected preset by the user. Every query is of the form ' group/sub-group/.../presetName'
          * if the corresponding group of the preset exists, otherwise it is simply ' presetName'.
          */
-        selector = new TaggingPresetSelector(false, false);
+        selector = new TaggingPresetSelector();
         selector.setBorder(BorderFactory.createTitledBorder(tr("Search by preset")));
         selector.setDblClickListener(ev -> setPresetDblClickListener(selector, editorComponent));
 

src/org/openstreetmap/josm/gui/tagging/presets/PresetSearchFilter.java

@@ -0,0 +1,37 @@
+// License: GPL. For details, see LICENSE file.
+package org.openstreetmap.josm.gui.tagging.presets;
+
+import static org.openstreetmap.josm.tools.I18n.marktr;
+
+/**
+ * This enum defines different filters for searching presets.
+ */
+public enum PresetSearchFilter {
+    ONLY_APPLICABLE(marktr("Show only applicable to selection")),
+    SEARCH_IN_TAGS(marktr("Search in tags")),
+    DEPRECATED_TAGS(marktr("Show deprecated tags"));
+
+    /**
+     * The translated text associated with the enum constant.
+     */
+    private final String textToBeTranslated;
+
+    /**
+     * Constructor for the PresetSearchFilter enum.
+     * Initializes an enum constant with its corresponding translated text.
+     *
+     * @param textToBeTranslated The translated text associated with the enum constant.
+     */
+    PresetSearchFilter(String textToBeTranslated) {
+        this.textToBeTranslated = textToBeTranslated;
+    }
+
+    /**
+     * Returns the text associated with the filter
+     * @return the text marked for translation
+     */
+    public String getText() {
+        return textToBeTranslated;
+    }
+
+}

src/org/openstreetmap/josm/gui/tagging/presets/TaggingPreset.java

@@ -136,6 +136,10 @@ public class TaggingPreset extends AbstractAction implements ActiveLayerChangeLi
      * Show the preset name if true
      */
     public boolean preset_name_label;
+    /**
+     * True if the preset is deprecated
+     */
+    private boolean deprecated;
 
     /**
      * The types as preparsed collection.
@@ -349,6 +353,23 @@ public void setMatch_expression(String filter) throws SAXException {
         }
     }
 
+    /**
+     * @return true if the preset is deprecated
+     * @apiNote this is not {@code isDeprecated} just in case we decide to make {@link TaggingPreset} a record class.
+     * @since xxx
+     */
+    public final boolean deprecated() {
+        return this.deprecated;
+    }
+
+    /**
+     * Set if the preset is deprecated
+     * @param deprecated if true the preset is deprecated
+     */
+    public final void setDeprecated(boolean deprecated) {
+        this.deprecated = deprecated;
+    }
+
     private static class PresetPanel extends JPanel {
         private boolean hasElements;
 

src/org/openstreetmap/josm/gui/tagging/presets/TaggingPresetSearchDialog.java

@@ -34,7 +34,8 @@ private TaggingPresetSearchDialog() {
         super(MainApplication.getMainFrame(), tr("Search presets"), tr("Select"), tr("Cancel"));
         setButtonIcons("dialogs/search", "cancel");
         configureContextsensitiveHelp("/Action/TaggingPresetSearch", true /* show help button */);
-        selector = new TaggingPresetSelector(true, true);
+        selector = new TaggingPresetSelector(PresetSearchFilter.ONLY_APPLICABLE, PresetSearchFilter.SEARCH_IN_TAGS,
+                PresetSearchFilter.DEPRECATED_TAGS);
         setContent(selector, false);
         SelectionEventManager.getInstance().addSelectionListener(selector);
         selector.setDblClickListener(e -> buttonAction(0, null));

src/org/openstreetmap/josm/gui/tagging/presets/TaggingPresetSearchPrimitiveDialog.java

@@ -67,7 +67,7 @@ public static synchronized TaggingPresetSearchPrimitiveDialog getInstance() {
         super(MainApplication.getMainFrame(), tr("Search for objects by preset"), tr("Search"), tr("Cancel"));
         setButtonIcons("dialogs/search", "cancel");
         configureContextsensitiveHelp("/Action/TaggingPresetSearchPrimitive", true /* show help button */);
-        selector = new TaggingPresetSelector(false, false);
+        selector = new TaggingPresetSelector();
         setContent(selector, false);
         selector.setDblClickListener(e -> buttonAction(0, null));
     }