Changeset 6977

Timestamp:

10/06/10 23:04:13 (9 years ago)

Author:

astephen

Message:

Added checker for bbox selection.

Location:

cows_wps/trunk/cows_wps

Files:

• public/js/ui/init_bbox_input.js (modified) (1 diff)
• public/js/ui/submit_utils.js (modified) (1 diff)
• public/js/ui/validate.js (modified) (7 diffs)
• renderer/form_renderer.py (modified) (3 diffs)

cows_wps/trunk/cows_wps/public/js/ui/init_bbox_input.js

@@ -55 +55 @@
                         var bbox_visible = ext.toString();
                         $("#bbox_show_val").html(bbox_visible);
-                        var bbox_to_send = bbox_visible.replace(/,/g, "|");
+            var bbox_to_send = bbox_visible.replace(/,/g, "|");
                         $("#bbox_hidden_input").val(bbox_to_send);
                 }

cows_wps/trunk/cows_wps/public/js/ui/submit_utils.js

@@ -1 @@
-/* submit_utils.js
+/* 
+
+submit_utils.js
+=============
 
 A set of functions and classes related to submission forms.

cows_wps/trunk/cows_wps/public/js/ui/validate.js

@@ -5 +5 @@
    Validation of forms in the UI.
 */
+
+// Define validation globals
+var invalid_input_msg = "You have submitted an invalid input, please try again. ";
 
 /* function: validate():
@@ -15 +18 @@
      * allowed length - relevant to arrays
 */
-function validate(name, value, data_type, multiple, possible_values, allowed_length) {
-
+function OLDOLDvalidate(name, value, data_type, multiple, possible_values, allowed_length) {
 }
 
@@ -32 +34 @@
         return true;
     } else {
-        alert("You have submitted an invalid input, please try again. " + msg) 
+        alert(invalid_input_msg + msg) 
         return false;
     }
@@ -54 +56 @@
 
         if (item.match(regex_match) == null) {
-            alert("You have submitted an invalid input, please try again. " + msg)
+            alert(invalid_input_msg + msg)
             return false;
         }
     }
     return true;
+}
+
+/*
+ function: checkValidBBox(bbox1);
+    Inputs:
+      * bbox
+    Returns:
+      * true OR false depending if bbox is valid.
+*/
+function checkValidBBox(bbox) {
+        // Assume bbox defined as (north, west, south, east)
+        if (bbox[0] < bbox[2]) {
+                return false;
+        } else if ((bbox[0] > 90) || (bbox[2] < -90)) {
+                return false;
+        } else if ((bbox[1] < -360) || (bbox[1] > 360)) {
+                return false;
+        } else if ((bbox[3] < -360) || (bbox[3] > 360)) {
+                return false;
+        }
+
+        return true;
+}
+
+/* 
+ function: bboxesOverlap():
+    Checks if two bboxes overlap.
+    Inputs:
+      * bbox1
+      * bbox2
+    Returns:
+      * true OR false
+*/
+function bboxesOverlap(bbox1, bbox2) {
+        var bboxes = [bbox1, bbox2];
+        for (var i = 0; i < 2; i++) {
+                if (checkValidBBox(bboxes[i]) == false) {
+                        alert("BBox is invalid: " + (bboxes[i]).join("|") + ".");
+                        return false;
+                }
+        }
+
+        // If we get here then bbox definitions are valid
+        if ((bbox1[2] >= bbox2[0]) || (bbox1[0] >= bbox2[2])) {
+                return false;
+        } else if ((bbox1[3] >= bbox2[1]) || (bbox1[1] >= bbox2[3])) {
+                return false;
+        }
+        return true;
+}
+
+/*
+ function: parseBBoxString():
+    Takes in string version of bounding box and returns array version.
+    Inputs:
+      * bbox_string
+    Returns:
+      * bbox_array
+*/
+function parseBBoxString(bbox_string) {
+        var input_as_strings = bbox_string.split("|");
+        var bbox_array = new Array(4);
+
+        for (var i = 0; i < 4; i++) {
+                bbox_array[i] = parseInt(input_as_strings[i], 10);
+        }
+
+        return bbox_array;
+}
+
+/*
+ function: validateBoundingBoxInput():
+    Validates a bounding box input by checking the selected extent overlaps with 
+    the prescribed extent.
+    Inputs:
+      * input
+      * allowed_extent
+      * msg
+    Returns:
+      * true OR false: if valid or not.
+*/
+function validateBoundingBoxInput(input, valid_bbox, msg) {
+        // Takes in input which comes as 'bbox_hidden_input' string delmited by '|'
+        // which represents (west|east|south|north)
+        // Checks domain is within spec_arg domain
+        var selected_bbox = parseBBoxString(input);
+        var valid_bbox = parseBBoxString(valid_bbox);
+
+        if (bboxesOverlap(selected_bbox, valid_bbox)) {
+                return true;
+        }
+        alert(invalid_input_msg + msg)
+        return false;
 }
 
@@ -74 +169 @@
 /* ValidatorMappings is a pseudo-class */
 function ValidatorMappings() {
-    this.ids = new Array("text", "textarea");
-    this.values = new Array(validateTextInput, validateTextAreaInput);
+    this.ids = new Array("text", "textarea", "bounding_box");
+    this.values = new Array(validateTextInput, validateTextAreaInput, validateBoundingBoxInput);
 
     function getFunction(id) {
@@ -116 +211 @@
         var name = vdr.name;
         var validation_type = vdr.validation_type;
-        var regex_match = vdr.regex_match;
+        
+                // spec_arg can be a regex_match or any other object you want the validator to work with
+        var spec_arg = vdr.spec_arg;
         var msg = vdr.msg; 
         var optional = vdr.optional;
@@ -129 +226 @@
             res = true;
         } else {
-            res = fnc.call(this, value, regex_match, msg);
+            res = fnc.call(this, value, spec_arg, msg);
         }
 

cows_wps/trunk/cows_wps/renderer/form_renderer.py

@@ -99 +99 @@
         return html
 
-    def renderBBox(self, name, extent="90|-180|-90|180"):
+    def OLDrenderBBox(self, name, extent="90|-180|-90|180"):
         """
         Renders a bounding box and N/W/S/E/ selectors.
@@ -120 +120 @@
         """
         Renders a bounding box and N/W/S/E selectors.
+        ``extent`` is received as a string of "north|west|south|east".
         """
         if extent == False: extent = "90|-180|-90|180"
@@ -130 +131 @@
             <div id='map'></div>
         </div>
-        <input type="hidden" name="%s" id="bbox_hidden_input" />
-        <script type="text/javascript">var initial_extent = [%s, %s, %s, %s];</script>
-    </div>
-    """ % (name, n, w, s, e)
+            <input type="hidden" name="%s" id="bbox_hidden_input" />
+            <script type="text/javascript">
+                var initial_extent = [%s, %s, %s, %s];
+                addValidator('%s', 'bounding_box', extent, 'Your selected spatial bounding box must overlap with the available extent of: (%s) as ("north|west|south|east").', false);
+            </script>
+        </div>
+        """ % (name, n, w, s, e, name, extent)
+
         return html