Changeset 3399 in josm

Timestamp:

Jul 31, 2010 9:22:49 PM (3 years ago)

Author:

framm

Message:

Modify behaviour regarding the changeset comment. It is now allowed to upload changes
with an empty changeset comment but everything with less than 10 characters prompts
a dialog that explains the importance of changesets and suggests to reconsider.

Also, the last recently used changeset comment is only used as a default if it was used
less than 4 hours ago, to avoid people automatically using the same stuff all the time.

Location:

trunk/src/org/openstreetmap/josm/gui/io

Files:

• BasicUploadSettingsPanel.java (modified) (4 diffs)
• UploadDialog.java (modified) (6 diffs)

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

@@ -35 +35 @@
 public class BasicUploadSettingsPanel extends JPanel {
     public static final String HISTORY_KEY = "upload.comment.history";
+    public static final String HISTORY_LAST_USED_KEY = "upload.comment.last-used";
 
     /** the history combo box for the upload comment */
@@ -48 +49 @@
         pnl.add(new JLabel(tr("Provide a brief comment for the changes you are uploading:")), GBC.eol().insets(0, 5, 10, 3));
         hcbUploadComment = new HistoryComboBox();
-        hcbUploadComment.setToolTipText(tr("Enter an upload comment (min. 3 characters)"));
+        hcbUploadComment.setToolTipText(tr("Enter an upload comment"));
         List<String> cmtHistory = new LinkedList<String>(Main.pref.getCollection(HISTORY_KEY, new LinkedList<String>()));
         // we have to reverse the history, because ComboBoxHistory will reverse it again
@@ -117 +118 @@
         hcbUploadComment.addCurrentItemToHistory();
         Main.pref.putCollection(HISTORY_KEY, hcbUploadComment.getHistory());
+        Main.pref.putInteger(HISTORY_LAST_USED_KEY, (int) (System.currentTimeMillis() / 1000));
     }
 
@@ -124 +126 @@
     public void startUserInput() {
         List<String> history = hcbUploadComment.getHistory();
-        if (history != null && !history.isEmpty()) {
+        int age = (int) (System.currentTimeMillis()/1000 - Main.pref.getInteger(HISTORY_LAST_USED_KEY, 0));
+        // only pre-select latest entry if used less than 4 hours ago.
+        if (age < 4 * 3600 * 1000 && history != null && !history.isEmpty()) {
             hcbUploadComment.setText(history.get(0));
         }

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

@@ -38 +38 @@
 import org.openstreetmap.josm.gui.help.ContextSensitiveHelpAction;
 import org.openstreetmap.josm.gui.help.HelpUtil;
+import org.openstreetmap.josm.gui.HelpAwareOptionPane.ButtonSpec;
 import org.openstreetmap.josm.io.OsmApi;
 import org.openstreetmap.josm.tools.ImageProvider;
@@ -304 +305 @@
 
     /**
-     * Replies the current value for the upload comment
+     * Returns the current value for the upload comment
      *
      * @return the current value for the upload comment
@@ -313 +314 @@
 
     /**
-     * Replies true, if the dialog was canceled
-     *
-     * @return true, if the dialog was canceled
+     * Returns true if the dialog was canceled
+     *
+     * @return true if the dialog was canceled
      */
     public boolean isCanceled() {
@@ -324 +325 @@
      * Sets whether the dialog was canceled
      *
-     * @param canceled true, if the dialog is canceled
+     * @param canceled true if the dialog is canceled
      */
     protected void setCanceled(boolean canceled) {
@@ -358 +359 @@
         }
 
-        protected void warnIllegalUploadComment() {
-            HelpAwareOptionPane.showOptionDialog(
+        /**
+         * returns true if the user wants to revisit, false if they
+         * want to continue 
+         */
+        protected boolean warnUploadComment() {
+
+            ButtonSpec[] options = new ButtonSpec[] {
+                    new ButtonSpec(
+                            tr("Yes, revise"),
+                            ImageProvider.get("ok"),
+                            tr("Go back to the changeset comment and enter a better description"),
+                            null
+                    ),
+                    new ButtonSpec(
+                            tr("No, continue as is"),
+                            ImageProvider.get("cancel"),
+                            tr("Continue without improving the changeset comment"),
+                            null
+                    )
+            };
+
+            return 0 == HelpAwareOptionPane.showOptionDialog(
                     UploadDialog.this,
-                    tr("Please enter a comment for this upload changeset (min. 3 characters)"),
-                    tr("Illegal upload comment"),
-                    JOptionPane.ERROR_MESSAGE,
-                    ht("/Dialog/UploadDialog#IllegalUploadComment")
+                    "<html>" + 
+                    tr("Your upload comment is empty, or very short.<br /><br />" + 
+                       "This is technically allowed, but please consider that many users who are<br />" +
+                       "watching changes in their area depend on meaningful changeset comments<br />" +
+                       "to understand what is going on!<br /><br />" +
+                       "If you spend a minute now to explain your change, you will make life<br />" +
+                       "easier for many other mappers.") + 
+                    "</html>",
+                    tr("Please revise upload comment"),
+                    JOptionPane.WARNING_MESSAGE,
+                    null,
+                    options,
+                    options[0],
+                    ht("/Dialog/UploadDialog#ReviseUploadComment")
             );
         }
@@ -379 +410 @@
 
         public void actionPerformed(ActionEvent e) {
-            if (getUploadComment().trim().length() < 3) {
-                warnIllegalUploadComment();
-                tpConfigPanels.setSelectedIndex(0);
-                pnlBasicUploadSettings.initEditingOfUploadComment();
-                return;
+            if (getUploadComment().trim().length() < 10) {
+                if (warnUploadComment())
+                {
+                    tpConfigPanels.setSelectedIndex(0);
+                    pnlBasicUploadSettings.initEditingOfUploadComment();
+                    return;
+                }
             }
             UploadStrategySpecification strategy = getUploadStrategySpecification();