Changeset 30117 in osm for applications/editors/josm/plugins/OpeningHoursEditor

Timestamp:

2013-12-07T22:09:36+01:00 (11 years ago)

Author:

donvip

Message:

[josm_openinghours] fix #7903 - ArrayIndexOutOfBoundsException in unknown conditions. IllegalArgumentException will be thrown earlier if reproduced.

Location:

applications/editors/josm/plugins/OpeningHoursEditor/src/org/openstreetmap/josm/plugins/ohe

Files:

• OpeningTimeUtils.java (modified) (2 diffs)
• gui/OheEditor.java (modified) (1 diff)
• gui/TimeRect.java (modified) (9 diffs)

applications/editors/josm/plugins/OpeningHoursEditor/src/org/openstreetmap/josm/plugins/ohe/OpeningTimeUtils.java

@@ -113 +113 @@
      */
     public static String makeStringFromRects(ArrayList<TimeRect> givenTimeRects) {
-        // create an array of booleans representing every minute on all the days
-        // in a week
+        // create an array of booleans representing every minute on all the days in a week
         boolean[][] minuteArray = new boolean[7][24 * 60 + 2];
         for (int day = 0; day < 7; ++day) {
@@ -259 +258 @@
         return ret;
     }
+    
+    /**
+     * Ensures the given day is comprised between 0 and 6.
+     * @param day The day to check
+     * @param paramName The parameter name, used in error message
+     * @throws IllegalArgumentException if the day is invalid
+     */
+    public static final void ensureValidDay(int day, String paramName) throws IllegalArgumentException {
+        if (day < 0 || day > 6) {
+            throw new IllegalArgumentException(paramName + " is not a valid day (0-6). Given value is " + day);
+        }
+    }
+
+    /**
+     * Ensures the given minute is comprised between 0 and 24*60+1.
+     * @param minute The minute to check
+     * @param paramName The parameter name, used in error message
+     * @throws IllegalArgumentException if the minute is invalid
+     */
+    public static final void ensureValidMinute(int minute, String paramName) throws IllegalArgumentException {
+        if (minute < 0 || minute > 24*60+1) {
+            throw new IllegalArgumentException(paramName + " is not a valid minute (0-1441). Given value is " + minute);
+        }
+    }
 }

applications/editors/josm/plugins/OpeningHoursEditor/src/org/openstreetmap/josm/plugins/ohe/gui/OheEditor.java

@@ -176 +176 @@
     }
 
-    // update all the TimeRects with new Data
+    /**
+     * Updates all the TimeRects with new data.
+     */
     public void initTimeRects() {
         contentPanel.removeAll();

applications/editors/josm/plugins/OpeningHoursEditor/src/org/openstreetmap/josm/plugins/ohe/gui/TimeRect.java

@@ -19 +19 @@
 import javax.swing.JPopupMenu;
 
+import org.openstreetmap.josm.plugins.ohe.OpeningTimeUtils;
+
 public class TimeRect extends JPanel implements MouseListener, MouseMotionListener {
     
@@ -54 +56 @@
 
     public TimeRect(OheEditor editor, int dayStart, int dayEnd, int minutesStart, int minutesEnd) {
+        OpeningTimeUtils.ensureValidDay(dayStart, "dayStart");
+        OpeningTimeUtils.ensureValidDay(dayEnd, "dayEnd");
+        OpeningTimeUtils.ensureValidMinute(minutesStart, "minutesStart");
+        OpeningTimeUtils.ensureValidMinute(minutesEnd, "minutesEnd");
+        
         this.editor = editor;
-
         this.dayStart = dayStart;
         this.dayEnd = dayEnd;
@@ -69 +75 @@
     }
 
+    /**
+     * Returns the starting day, as an index between 0 and 6.
+     * @return the starting day index
+     */
     public int getDayStart() {
         return dayStart;
     }
 
+    /**
+     * Returns the ending day, as an index between 0 and 6.
+     * @return the ending day index
+     */
     public int getDayEnd() {
         return dayEnd;
@@ -86 +100 @@
 
     public void reposition() {
-        setBounds(editor.getPanelBoundsForTimeinterval(dayStart, dayEnd + 1,
-                minuteStart, minuteEnd));
+        setBounds(editor.getPanelBoundsForTimeinterval(dayStart, dayEnd + 1, minuteStart, minuteEnd));
         editor.contentPanel.repaint();
     }
@@ -99 +112 @@
     }
 
-    private void updateTimeInterval(int newDayStart, int newDayEnd,
-            int newMinuteStart, int newMinuteEnd) {
+    private void updateTimeInterval(int newDayStart, int newDayEnd, int newMinuteStart, int newMinuteEnd) {
+        OpeningTimeUtils.ensureValidDay(newDayStart, "newDayStart");
+        OpeningTimeUtils.ensureValidDay(newDayEnd, "newDayEnd");
+        OpeningTimeUtils.ensureValidMinute(newMinuteStart, "newMinuteStart");
+        OpeningTimeUtils.ensureValidMinute(newMinuteEnd, "newMinuteEnd");
+
         dayStart = newDayStart;
         dayEnd = newDayEnd;
@@ -185 +202 @@
     public void showMenu(MouseEvent evt) {
         JPopupMenu menu = new JPopupMenu();
-        final JCheckBoxMenuItem cbMenuItem = new JCheckBoxMenuItem(
-                tr("open end"), isOpenEndInterval());
+        final JCheckBoxMenuItem cbMenuItem = new JCheckBoxMenuItem(tr("open end"), isOpenEndInterval());
         menu.add(cbMenuItem);
         cbMenuItem.addActionListener(new ActionListener() {
@@ -192 +208 @@
             public void actionPerformed(ActionEvent e) {
                 if (cbMenuItem.isSelected())
-                    updateTimeInterval(dayStart, dayEnd, minuteStart,
-                            24 * 60 + 1);
+                    updateTimeInterval(dayStart, dayEnd, minuteStart, 24 * 60 + 1);
                 else
                     updateTimeInterval(dayStart, dayEnd, minuteStart, 24 * 60);
@@ -265 +280 @@
                 } else if (newDayStart >= 0 && newDayEnd <= 6) {
                     actualDayDrag += xDiff;
-                    updateTimeInterval(newDayStart, newDayEnd, minuteStart,
-                            minuteEnd);
+                    updateTimeInterval(newDayStart, newDayEnd, minuteStart, minuteEnd);
                 }
             }
@@ -282 +296 @@
                         && (newMinutesEnd <= 24 * 60 || isOpenEndInterval())) {
                     actualMinuteDrag += yDiff;
-                    updateTimeInterval(dayStart, dayEnd, newMinutesStart,
-                            newMinutesEnd);
+                    updateTimeInterval(dayStart, dayEnd, newMinutesStart, newMinutesEnd);
                 }
             }