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

Timestamp:

2019-04-21T17:55:22+02:00 (7 years ago)

Author:

Don-vip

Message:

fix #17634 - Reject uploads that do not follow comment/source upload policy, using the following 4 new properties:

• upload.comment.forbidden-terms
• upload.comment.mandatory-terms
• upload.source.forbidden-terms
• upload.source.mandatory-terms

File:

• trunk/src/org/openstreetmap/josm/gui/io/UploadDialog.java (modified) (8 diffs)

trunk/src/org/openstreetmap/josm/gui/io/UploadDialog.java

@@ -17 +17 @@
 import java.lang.Character.UnicodeBlock;
 import java.util.ArrayList;
+import java.util.Arrays;
 import java.util.Collection;
 import java.util.Collections;
@@ -26 +27 @@
 import java.util.Optional;
 import java.util.concurrent.TimeUnit;
+import java.util.stream.Collectors;
 
 import javax.swing.AbstractAction;
@@ -490 +492 @@
         }
 
+        /**
+         * Displays a warning message indicating that the upload comment is rejected.
+         * @param details details explaining why
+         * @return {@code true}
+         */
+        protected boolean warnRejectedUploadComment(String details) {
+            return warnRejectedUploadTag(
+                    tr("Please revise upload comment"),
+                    tr("Your upload comment is <i>rejected</i>.") + "<br />" + details
+            );
+        }
+
+        /**
+         * Displays a warning message indicating that the changeset source is rejected.
+         * @param details details explaining why
+         * @return {@code true}
+         */
+        protected boolean warnRejectedUploadSource(String details) {
+            return warnRejectedUploadTag(
+                    tr("Please revise changeset source"),
+                    tr("Your changeset source is <i>rejected</i>.") + "<br />" + details
+            );
+        }
+
+        /**
+         * Warn about an upload tag with the possibility of resuming the upload.
+         * @param title dialog title
+         * @param message dialog message
+         * @param togglePref preference entry to offer the user a "Do not show again" checkbox for the dialog
+         * @return {@code true} if the user wants to revise the upload tag
+         */
         protected boolean warnUploadTag(final String title, final String message, final String togglePref) {
-            String[] buttonTexts = new String[] {tr("Revise"), tr("Cancel"), tr("Continue as is")};
-            Icon[] buttonIcons = new Icon[] {
+            return warnUploadTag(title, message, togglePref, true);
+        }
+
+        /**
+         * Warn about an upload tag without the possibility of resuming the upload.
+         * @param title dialog title
+         * @param message dialog message
+         * @return {@code true}
+         */
+        protected boolean warnRejectedUploadTag(final String title, final String message) {
+            return warnUploadTag(title, message, null, false);
+        }
+
+        private boolean warnUploadTag(final String title, final String message, final String togglePref, boolean allowContinue) {
+            List<String> buttonTexts = new ArrayList<>(Arrays.asList(tr("Revise"), tr("Cancel")));
+            List<Icon> buttonIcons = new ArrayList<>(Arrays.asList(
                     new ImageProvider("ok").setMaxSize(ImageSizes.LARGEICON).get(),
-                    new ImageProvider("cancel").setMaxSize(ImageSizes.LARGEICON).get(),
-                    new ImageProvider("upload").setMaxSize(ImageSizes.LARGEICON).addOverlay(
-                            new ImageOverlay(new ImageProvider("warning-small"), 0.5, 0.5, 1.0, 1.0)).get()};
-            String[] tooltips = new String[] {
+                    new ImageProvider("cancel").setMaxSize(ImageSizes.LARGEICON).get()));
+            List<String> tooltips = new ArrayList<>(Arrays.asList(
                     tr("Return to the previous dialog to enter a more descriptive comment"),
-                    tr("Cancel and return to the previous dialog"),
-                    tr("Ignore this hint and upload anyway")};
-
-            ExtendedDialog dlg = new ExtendedDialog((Component) dialog, title, buttonTexts) {
+                    tr("Cancel and return to the previous dialog")));
+            if (allowContinue) {
+                buttonTexts.add(tr("Continue as is"));
+                buttonIcons.add(new ImageProvider("upload").setMaxSize(ImageSizes.LARGEICON).addOverlay(
+                        new ImageOverlay(new ImageProvider("warning-small"), 0.5, 0.5, 1.0, 1.0)).get());
+                tooltips.add(tr("Ignore this hint and upload anyway"));
+            }
+
+            ExtendedDialog dlg = new ExtendedDialog((Component) dialog, title, buttonTexts.toArray(new String[] {})) {
                 @Override
                 public void setupDialog() {
@@ -510 +560 @@
             };
             dlg.setContent("<html>" + message + "</html>");
-            dlg.setButtonIcons(buttonIcons);
-            dlg.setToolTipTexts(tooltips);
+            dlg.setButtonIcons(buttonIcons.toArray(new Icon[] {}));
+            dlg.setToolTipTexts(tooltips.toArray(new String[] {}));
             dlg.setIcon(JOptionPane.WARNING_MESSAGE);
-            dlg.toggleEnable(togglePref);
+            if (allowContinue) {
+                dlg.toggleEnable(togglePref);
+            }
             dlg.setCancelButton(1, 2);
             return dlg.showDialog().getValue() != 3;
@@ -542 +594 @@
         }
 
+        static String validateUploadTag(String uploadValue, String preferencePrefix) {
+            // Check mandatory terms
+            List<String> missingTerms = Config.getPref().getList(preferencePrefix+".mandatory-terms")
+                .stream().filter(x -> !uploadValue.contains(x)).collect(Collectors.toList());
+            if (!missingTerms.isEmpty()) {
+                return tr("The following required terms are missing: {0}", missingTerms);
+            }
+            // Check forbidden terms
+            List<String> forbiddenTerms = Config.getPref().getList(preferencePrefix+".forbidden-terms")
+                    .stream().filter(uploadValue::contains).collect(Collectors.toList());
+            if (!forbiddenTerms.isEmpty()) {
+                return tr("The following forbidden terms have been found: {0}", forbiddenTerms);
+            }
+            return null;
+        }
+
         @Override
         public void actionPerformed(ActionEvent e) {
@@ -547 +615 @@
             dialog.forceUpdateActiveField();
 
-            if (isUploadCommentTooShort(dialog.getUploadComment()) && warnUploadComment()) {
-                // abort for missing comment
+            final String uploadComment = dialog.getUploadComment();
+            final String uploadCommentRejection = validateUploadTag(uploadComment, "upload.comment");
+            if ((isUploadCommentTooShort(uploadComment) && warnUploadComment()) ||
+                (uploadCommentRejection != null && warnRejectedUploadComment(uploadCommentRejection))) {
+                // abort for missing or rejected comment
                 dialog.handleMissingComment();
                 return;
             }
-            if (dialog.getUploadSource().trim().isEmpty() && warnUploadSource()) {
-                // abort for missing changeset source
+            final String uploadSource = dialog.getUploadSource();
+            final String uploadSourceRejection = validateUploadTag(uploadSource, "upload.source");
+            if ((Utils.isStripEmpty(uploadSource) && warnUploadSource()) ||
+                    (uploadSourceRejection != null && warnRejectedUploadSource(uploadSourceRejection))) {
+                // abort for missing or rejected changeset source
                 dialog.handleMissingSource();
                 return;
@@ -562 +636 @@
             List<String> emptyChangesetTags = new ArrayList<>();
             for (final Entry<String, String> i : dialog.getTags(true).entrySet()) {
-                final boolean isKeyEmpty = i.getKey() == null || i.getKey().trim().isEmpty();
-                final boolean isValueEmpty = i.getValue() == null || i.getValue().trim().isEmpty();
+                final boolean isKeyEmpty = Utils.isStripEmpty(i.getKey());
+                final boolean isValueEmpty = Utils.isStripEmpty(i.getValue());
                 final boolean ignoreKey = "comment".equals(i.getKey()) || "source".equals(i.getKey());
                 if ((isKeyEmpty ^ isValueEmpty) && !ignoreKey) {
@@ -648 +722 @@
         if (evt.getPropertyName().equals(ChangesetManagementPanel.SELECTED_CHANGESET_PROP)) {
             Changeset cs = (Changeset) evt.getNewValue();
-            setChangesetTags(dataSet, cs == null); // keep comment/source of first tab for new changesets 
+            setChangesetTags(dataSet, cs == null); // keep comment/source of first tab for new changesets
             if (cs == null) {
                 tpConfigPanels.setTitleAt(1, tr("Tags of new changeset"));