Changeset 6117

Timestamp:

14/12/09 12:40:11 (10 years ago)

Author:

astephen

Message:

more fixes

Location:

cows_wps/trunk/cows_wps

Files:

• lib/ui/proc_config.py (modified) (1 diff)
• process_handler/validate_arguments.py (modified) (5 diffs)
• public/js/ui/validate.js (modified) (4 diffs)
• public/style/wps_ui.css (modified) (1 diff)
• renderer/form_renderer.py (modified) (2 diffs)

cows_wps/trunk/cows_wps/lib/ui/proc_config.py

@@ -143 +143 @@
 
         # Now render the inputs dict as a form
-        
+        count = 0 
         for (name, input) in inputs:
-            resp += """<tr><td width="25%%"><b>%s</b></td><td width="60%%">\n""" % name
+
+            # Set colour style for row
+            count += 1
+            row_style = ("even_row", "odd_row")[count % 2]
+
+            # Start HTML for row
+            resp += """<tr class="%s"><td width="25%%"><b>%s</b></td><td width="30%%">\n""" % (row_style, name)
+
+            # Parse arguments from config
             al = input["allowed_length"]
             pv = input["possible_values"]
+            default = input.get("default", None)
+            opt = input.get("optional", False)
             array_or_item = input["item_type"]
+
+            multiple = False
+            if array_or_item == "list":
+                multiple = True
+
             tp = input["type"]
 
+            # Add a default instruction for this input type
+            instruction = ""
+            if opt == True:
+                instruction = "This input is optional."
+
+            # Now render them according to data type etc
             if pv != None:
-                resp += fm.renderSelectList(name, values=pv)
+                resp += fm.renderSelectList(name, values=pv, optional=opt, multiple=multiple)
+                n_items = "an item"
+                if multiple == True: n_items = "one or more items"
+                instruction += " Please select %s from the list." % n_items
 
             elif tp == "bool":
                 resp += fm.renderRadioButton(name, is_boolean=True)
+                instruction += " Please select either true or false."
             
-            elif tp in ("float", "int", "string"):
-                resp += fm.renderTextInput(name, dtype=tp) 
+            elif tp in ("float", "int", "string", "datetime"):
+                if tp == "datetime":
+                    if default:
+                        # Ensure time formatted correctly
+                        default = str(default).replace(" ", "T")
+        
+                    instruction += " Please insert a date/time field in the format <kbd><B>YYYY-MM-DDThh:mm:ss</B></kbd> such as <kbd>2009-01-01T00:00:00</kbd>."
+                else:
+                    instruction += " Please insert a value of type: %s." % tp
+
+                resp += fm.renderTextInput(name, dtype=tp, optional=opt, default=default)
            
             elif tp == "filepath":
                 base_dir = input["basedir"] 
                 resp += fm.renderTypeAheadDirList(name, base_dir)
-
-            resp += "</td><td>%s</td></tr>\n" % "Eventually we'll put some useful advice here."
+                instruction += " Please type a file path on the CEDA file system. Click down to auto-fill with one of the options on the drop-down list."
+
+            elif tp == "bbox":
+                extent = input.get("extent", False)
+                resp += fm.renderBBox(name, extent)
+                csv_extent = extent.replace("|", ", ")
+                instruction += " Please select a valid bounding box with the following geographical extent: %s" % csv_extent 
+
+            resp += "</td><td>%s</td></tr>\n" % instruction
       
         resp += '<tr><td></td><td><input type="submit" value="Submit" /></td><td></td></table>\n</form>\n'

cows_wps/trunk/cows_wps/process_handler/validate_arguments.py

@@ -46 +46 @@
         return parseDateTime(item)
     elif dtype in ("bbox",):
-        dtype = "float"
+        return parseBBox(item)
 
     transformer = dtype
@@ -147 +147 @@
     date_time_value = dateutil.parser.parse("2008-02-23T12:12:12")
     return date_time_value
+
+
+def parseBBox(item):
+    """
+    Checks bbox is valid floats.
+    """
+    err_msg = "Invalid bounding box supplied: '%s'." % item
+
+    if not len(item) == 4:
+        raise Exception(err_msg)
+
+    try:
+        # can we convert all to floats
+        bbox_floats = [float(i) for i in item]
+    except:
+        raise Exception(err_msg)
+
+    # Must be physically valid
+    phys_err = "Value of '%s' (%s) is out of range in bounding box supplied: '%s'." 
+    directions = ("north", "west", "south", "east")
+    ranges = [(-90, 90), (-360, 360), (-90, 90), (-360, 360)]
+   
+    for i in range(4):
+        low, high = ranges[i]
+        value = bbox_floats[i]
+        direction = directions[i]
+
+        if value > high or value < low:
+            raise Exception(phys_err % (direction, value, bbox_floats))
+         
+    return bbox_floats
 
 
@@ -171 +202 @@
         new_dict = {}
 
-#        log.info("running validation")
-
         # Step through each arg testing for validity
         arg_names = self.valids["DataInputs"].keys()
@@ -197 +226 @@
                         
                     elif d.has_key('optional'):
-    
                         if not d['optional']:
                             raise Exception("key %s does not exist in args (%s)" % (name, self.args.keys()))
-        
                     else:
                         raise Exception("key %s does not exist in args (%s)" % (name, self.args.keys()))
@@ -208 +235 @@
                 # Test the value provided
                 value_given = self.args[name]
-             
                 new_dict[name] = parseValue(value_given, d)
                 

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

@@ -19 +19 @@
 }
 
-/* function: validateString():
+/* 
+function: validateTextInput():
    Validates a string input checking it conforms to a regext pattern.
    Inputs:
@@ -38 +39 @@
 var validators = new Array();
 /* Validator is a pseudo-class */
-function Validator(name, validation_type, regex_match, msg) {
+function Validator(name, validation_type, regex_match, msg, optional) {
     this.name = name;
     this.validation_type = validation_type;
     this.regex_match = regex_match;
     this.msg = msg;
+    this.optional = optional;
 }
 
@@ -62 +64 @@
 }
 
-function addValidator(name, validation_type, regex_match, msg) {
-    var vdr = new Validator(name, validation_type, regex_match, msg);
+/*
+ function addValidator
+  Inputs:
+    * name - in form
+    * which validation method
+    * regex_match - regex to test against
+    * msg - message to show if error
+    * optional - boolean to say that arg is optional or not
+*/
+function addValidator(name, validation_type, regex_match, msg, optional) {
+    var vdr = new Validator(name, validation_type, regex_match, msg, optional);
     var this_arr = new Array(vdr);
     validators = validators.concat(this_arr);
@@ -82 +93 @@
         var regex_match = vdr.regex_match;
         var msg = vdr.msg; 
+        var optional = vdr.optional;
 
         var fnc = vm.getFunction(validation_type);
         
         var value = document.getElementById(name).value;
-        var res = fnc.call(this, value, regex_match, msg);
+
+        // If optional then we can return true if empty
+        var res = false;
+        if (optional == true) {
+            if (value == "") {
+                res = true;
+            }
+        } else {
+            res = fnc.call(this, value, regex_match, msg);
+        }
 
         if (res == false) {

cows_wps/trunk/cows_wps/public/style/wps_ui.css

@@ -115 +115 @@
         height: 50px;
 }
+
+.odd_row {
+        background-color: #eeeeff;
+}
+
+.even_row {
+        background-color: #eeccff;
+}

cows_wps/trunk/cows_wps/renderer/form_renderer.py

@@ -33 +33 @@
         return html
 
-    def renderTextInput(self, name, dtype):
+    def renderTextInput(self, name, dtype, optional=False, default=None):
         """
         Returns HTML for text input including onChange validator.
+        optional is a boolean.
+
+        Populates with default value if not None.
         """
+        if default == None: default = ""
+
         allowed_dtypes = ("float", "int", "string", "datetime")
+        js_opt = str(optional).lower()
 
         if dtype not in allowed_dtypes:
@@ -49 +55 @@
         (regex, msg) = validators[dtype]
  
-        html = """<input type="text" name="%s" id="%s" value="" onChange="validateTextInput(this.value, %s, '%s');" /><br />\n""" % (name, name, regex, msg)
-        html += """<script type="text/javascript">addValidator('%s', 'text', %s, '%s');</script>\n""" % (name, regex, msg)
+        html = """<input type="text" name="%s" id="%s" value="%s" onChange="validateTextInput(this.value, %s, '%s', %s);" /><br />\n""" % (name, name, default, regex, msg, js_opt)
+        html += """<script type="text/javascript">addValidator('%s', 'text', %s, '%s', %s);</script>\n""" % (name, regex, msg, js_opt)
         return html
 
-    def renderSelectList(self, name, values):
+    def renderSelectList(self, name, values, optional=False, multiple=False):
         """
         Returns HTML for select list.
+
+        If optional is True then add an extra option called "-- Please select --".
         """
-        html = """<select name="%s" id="%s">\n""" % (name, name)
-        
+        if optional == True:
+            values.insert(0, "-- Please select --")
+
+        multiple_string = ""
+        if multiple == True:
+            multiple_string = 'multiple="multiple"'
+
+        html = """<select %s name="%s" id="%s">\n""" % (multiple_string, name, name)
+       
+        selected = 'selected="selected"' 
         for value in values:
-            html += """ <option value="%s">%s</option>\n""" % (value, value)
+            html += """ <option %s value="%s">%s</option>\n""" % (selected, value, value)
+            selected = ""
 
         return html
 
-    def renderBBox(self, name, extent):
+    def renderBBox(self, name, extent="90|-180|-90|180"):
+        """
+        Renders a bounding box and N/W/S/E/ selectors.
+        """
+        if extent == False: extent = "90|-180|-90|180"
+
+        (n, w, s, e) = extent.split("|")
+
+        html = """      <label for="_north">North:</label> <input type="text" id="_north" name="_north" value="%s" onChange="updateBBox('%s');" /><br>
+        <label for="_west">West:</label> <input type="text" id="_west" name="_west" value="%s" onChange="updateBBox('%s');" /><br>
+        <label for="_south">South:</label> <input type="text" id="_south" name="_south" value="%s" onChange="updateBBox('%s');" /><br>
+        <label for="_east">East:</label> <input type="text" id="_east" name="_east" value="%s" onChange="updateBBox('%s');" /><br>
+        <input type="hidden" id="%s" name="%s" value="%s" />
+        """ % (n, name, w, name, s, name, e, name, name, name, extent)
+
+        return html
+
+
+    def renderBBoxOLD(self, name, extent):
         """
         Renders a bounding box and N/W/S/E selectors.