Fixed issue with case sensitive choices for filters

	modified:   eodms_cli.py
	modified:   scripts/config_util.py
	modified:   scripts/csv_util.py
	modified:   scripts/field.py
	modified:   scripts/spatial.py
	modified:   scripts/utils.py

Author: keballantyne

eodms_cli.py

@@ -174,6 +174,7 @@ def ask_aoi(self, input_fn):
                         err_msg = "Cannot open a Shapefile without GDAL. " \
                                   "Please install the GDAL Python package if " \
                                   "you'd like to use a Shapefile for your AOI."
+                        self.eod.print_msg(err_msg, heading='warning')
                         self.logger.warning(err_msg)
                         return None
 
@@ -193,13 +194,15 @@ def ask_aoi(self, input_fn):
         elif any(s in input_fn for s in self.eod.aoi_extensions):
             err_msg = f"Input file {os.path.abspath(input_fn)} does not exist."
             # self.eod.print_support(err_msg)
+            self.eod.print_msg(err_msg, heading="warning")
             self.logger.warning(err_msg)
             return None
 
         else:
             if not self.eod.eodms_geo.is_wkt(input_fn):
                 err_msg = "Input feature is not a valid WKT."
                 # self.eod.print_support(err_msg)
+                self.eod.print_msg(err_msg, heading="warning")
                 self.logger.warning(err_msg)
                 return None
 
@@ -422,8 +425,11 @@ def ask_filter(self, filters):
                         # field_map = self.eod.get_fieldMap()[coll_id]
 
                         print(f"\nAvailable fields for '{coll}':")
-                        for f in coll_fields.get_eod_fieldnames():
-                            print(f"  {f}")
+                        # for f in coll_fields.get_eod_fieldnames():
+                        #     print(f"  {f}")
+                        avail_fields = coll_fields.get_eod_fieldnames(True)
+                        fields_str = ', '.join(avail_fields)
+                        print(self.wrap_text(fields_str, init_indent='  '))
 
                         print(self.wrap_text(f"\nFilters must be entered in " \
                               f"the format of {self.eod.var_colour}" \
@@ -537,6 +543,8 @@ def ask_filter(self, filters):
                         coll_filters.append(f)
                         filt_dict[coll_id] = coll_filters
 
+        # print(f"filt_dict: {filt_dict}")
+
         return filt_dict
 
     def ask_input_file(self, input_fn, msg):
@@ -888,14 +896,24 @@ def ask_record_ids(self, ids):
         if ids is None or ids == '':
 
             if not self.eod.silent:
-                self.print_header("Enter Record ID(s)")
+                self.print_header("Enter Record Id(s)")
 
                 msg = "\nEnter a single or set of Record IDs. Include the " \
                       "Collection ID next to each ID separated by a " \
                       "colon. Separate each ID with a comma. " \
-                      "(Ex: RCMImageProducts:7625368,NAPL:3736869)\n"
+                      f"(Ex: {self.eod.var_colour}RCMImageProducts:7625368" \
+                      f",NAPL:3736869{self.eod.reset_colour})\n"
                 ids = self.get_input(msg, required=False)
 
+                process = self.eod.validate_record_ids(ids)
+
+                if not process:
+                    err_msg = "Invalid entry for the Record Ids."
+                    # self.eod.print_support(True, err_msg)
+                    self.eod.print_msg(err_msg, heading='error')
+                    self.logger.error(err_msg)
+                    self.eod.exit_cli(1)
+
         return ids
 
     def build_syntax(self):
@@ -1054,7 +1072,7 @@ def add_arrow(self):
 
         return arrow
 
-    def wrap_text(self, in_str, width=105, sub_indent='  '):
+    def wrap_text(self, in_str, width=105, sub_indent='  ', init_indent=''):
         """
         Wraps a given text to a certain width.
 
@@ -1069,6 +1087,7 @@ def wrap_text(self, in_str, width=105, sub_indent='  '):
 
         out_str = textwrap.fill(in_str, width=width, 
                                 replace_whitespace=False, 
+                                initial_indent=init_indent,
                                 subsequent_indent=sub_indent)
         return out_str
 

scripts/config_util.py

@@ -192,7 +192,7 @@ def ask_user(self, in_sect='all'):
                 if sect_title not in self.config_dict.keys():
                     err = f"The section '{sect_title}' does not exist in the " \
                           f"configuration file."
-                    print(f"WARNING: {err}")
+                    self.eod.print_msg(err, heading="warning")
                     self.logger.warning(err)
                     return None
 
@@ -214,7 +214,7 @@ def ask_user(self, in_sect='all'):
                 if sect_opts is None:
                     err = f"The section '{in_sect}' does not exist in the " \
                           f"configuration file."
-                    print(f"WARNING: {err}")
+                    self.eod.print_msg(err, heading="warning")
                     self.logger.warning(err)
                     return None
 

scripts/csv_util.py

@@ -84,7 +84,7 @@ def determine_collection(self, rec):
                     self.coll_id = self.eod.get_collid_by_name(satellite)
                     msg = f"The satellite/collection '{self.coll_id}'' is " \
                           f"not supported with this script at this time."
-                    print(f"\n{msg}")
+                    self.eod.print_msg(msg, heading="warning")
                     self.logger.warning(msg)
                     return None
 

scripts/field.py

@@ -22,6 +22,9 @@ class Field:
     - rapi_id: The field ID used in the RAPI (ex: RSAT2.IMAGE_ID)
     - rapi_title: The English title of the field in the RAPI.
     - ui_label: The label of the field used on the EODMS UI.
+    - choices: The list of available choices for the field.
+    - datatype: The data type of the field.
+    - description: The description (or English title) of the field.
     """
 
     def __init__(self, **kwargs):
@@ -38,11 +41,20 @@ def __init__(self, **kwargs):
               The field name in the RAPI.
             * *ui_label* (``str``) --
               The field name found on the EODMS UI.
+            * *choices* (``list`` or None) --
+              The list of available choices for the field.
+            * *datatype* (``str``) --
+              The data type of the field.
+            * *description* (``str``) --
+              The description (or English title) of the field.
         """
         self.eod_name = kwargs.get('eod_name')
         self.rapi_id = kwargs.get('rapi_id')
         self.rapi_title = kwargs.get('rapi_title')
         self.ui_label = kwargs.get('ui_label')
+        self.choices = kwargs.get('choices')
+        self.datatype = kwargs.get('datatype')
+        self.description = kwargs.get('description')
 
     def get_eod_name(self):
         """
@@ -79,6 +91,54 @@ def get_ui_label(self):
         :rtype:  str
         """
         return self.ui_label
+    
+    def get_choices(self, values_only=False):
+        """
+        Gets the available choices for the field.
+
+        :return: A list of choices.
+        :rtype:  list or None
+        """
+        if values_only:
+            return [c.get('value') for c in self.choices]
+        
+        return self.choices
+    
+    def get_datatype(self):
+        """
+        Gets the data type for the field.
+
+        :return: A list of choices.
+        :rtype:  str
+        """
+        return self.datatype
+    
+    def get_description(self):
+        """
+        Gets the description for the field.
+
+        :return: A list of choices.
+        :rtype:  str
+        """
+        return self.description
+    
+    def verify_choices(self, in_val):
+        """
+        Verifies a value based on the field's choices.
+
+        :param in_val: The value to check against the choices.
+        :type  in_val: str
+
+        :return: Either the proper choice or None.
+        :rtype:  str or None
+        """
+
+        choices_lw = [c.lower() for c in self.get_choices(True)]
+        try:
+            idx = choices_lw.index(in_val.lower())
+            return self.get_choices(True)[idx]
+        except ValueError:
+            return None
 
 
 class CollFields:
@@ -102,12 +162,20 @@ def add_field(self, **kwargs):
               The field name in the RAPI.
             * *ui_label* (``str``) --
               The field name found on the EODMS UI.
+            * *choices* (``list`` or None) --
+              The list of available choices for the field.
+            * *datatype* (``str``) --
+              The data type of the field.
+            * *description* (``str``) --
+              The description (or English title) of the field.
         """
 
-        self.fields.append(Field(eod_name=kwargs.get('eod_name'),
-                                 rapi_id=kwargs.get('rapi_id'),
-                                 rapi_title=kwargs.get('rapi_title'),
-                                 ui_label=kwargs.get('ui_label')))
+        # self.fields.append(Field(eod_name=kwargs.get('eod_name'),
+        #                          rapi_id=kwargs.get('rapi_id'),
+        #                          rapi_title=kwargs.get('rapi_title'),
+        #                          ui_label=kwargs.get('ui_label'), 
+        #                          choices=kwargs.get('choices')))
+        self.fields.append(Field(**kwargs))
 
     # def add_general_fields(self):
     #     """
@@ -139,14 +207,18 @@ def add_field(self, **kwargs):
     #                        rapi_title='Spatial Resolution',
     #                        ui_label='Pixel Spacing (Metres)')
 
-    def get_eod_fieldnames(self):
+    def get_eod_fieldnames(self, sort=False):
         """
         Gets the list of EOD fieldnames.
 
         :return: A list of EOD filenames.
         :rtype: list
         """
-        return [f.get_eod_name() for f in self.fields]
+
+        if sort:
+            return sorted([f.get_eod_name() for f in self.fields])
+        else:
+            return [f.get_eod_name() for f in self.fields]
 
     def get_field(self, eod_name):
         """
@@ -190,6 +262,10 @@ def map_fields(self):
 
                 if not vals.get('displayed'): continue
 
+                choices = vals.get('choices')
+                datatype = vals.get('datatype')
+                description = vals.get('description')
+
                 rapi_id = vals['id']
                 rapi_title = key
                 ui_label = rapi_title
@@ -241,7 +317,9 @@ def map_fields(self):
                 eod_name = eod_name.strip().upper().replace(' ', '_')
 
                 coll_fields.add_field(eod_name=eod_name, rapi_id=rapi_id,
-                                      rapi_title=rapi_title, ui_label=ui_label)
+                                      rapi_title=rapi_title, ui_label=ui_label, 
+                                      choices=choices, datatype=datatype, 
+                                      description=description)
 
                 if coll_id == 'Radarsat1':
                     for key in ['Radarsat1', 'R1', 'RS1']:

scripts/spatial.py

@@ -65,7 +65,8 @@ def _check_ogr(self):
         if ogr.__doc__ is not None and \
                 ogr.__doc__.find("Module providing one api for multiple git "
                                  "services") > -1:
-            print("Another package named 'ogr' is installed.")
+            self.eod.print_msg("Another package named 'ogr' is installed.", 
+                               heading='warning')
             return False
 
         return True
@@ -189,7 +190,7 @@ def export_results(self, img_lst, out_fn='results.geojson'):
                 warn_msg = "The format type for the output geospatial file " \
                                    "could not be determined. No geospatial " \
                                    "output will be created."
-                print(f"\n{warn_msg}")
+                self.eod.print_msg(warn_msg, heading='warning')
                 return None
 
             # Create the output Driver
@@ -246,7 +247,8 @@ def export_results(self, img_lst, out_fn='results.geojson'):
                             f"'{ext_str}' format. Exporting results as a " \
                             f"GeoJSON."
 
-                print(f"\n{warn_msg}")
+                # print(f"\n{warn_msg}")
+                self.eod.print_msg(warn_msg, heading='warning')
                 self.logger.warning(warn_msg)
 
                 out_fn = out_fn.replace(ext, '.geojson')