Add include files pop up

Author: LaSi5002

src/fourc_webviewer/fourc_webserver.py

@@ -68,6 +68,10 @@ def __init__(
 
         self.server = get_server()
 
+        # initialize include upload value: False (bottom sheet with include upload is not displayed until there is a fourcyaml file uploaded)
+        self.state.include_upload_open = False
+        self.state.included_files = []
+
         # declare server-side variable dict: variables which should not
         # be exposed to the client-side
         self._server_vars = {}
@@ -120,18 +124,11 @@ def __init__(
         # initialize state object
         self.init_state_and_server_vars()
 
-        # convert file to vtu and create dedicated render objects
-        fourc_geometry = FourCGeometry(
-            fourc_yaml_file=fourc_yaml_file,
-            temp_dir=Path(self._server_vars["temp_dir_object"].name),
-        )
-        self.state.vtu_path = fourc_geometry.vtu_file_path
+        if "render_window" not in self._actors:
+            self._server_vars["render_window"] = pv.Plotter()
+        self.state.vtu_path = ""
 
-        if self.state.vtu_path == "":
-            self.state.read_in_status = self.state.all_read_in_statuses[
-                "vtu_conversion_error"
-            ]
-        self.init_pyvista_render_objects()
+        self._server_vars["fourc_yaml_file_dir"] = Path(fourc_yaml_file).parent
 
         # create ui
         create_gui(self.server, self._server_vars["render_window"])
@@ -267,11 +264,57 @@ def init_pyvista_render_objects(self):
 
         The saved vtu file path is hereby utilized.
         """
-        if "render_window" not in self._actors:
-            self._server_vars["render_window"] = pv.Plotter()
+        # convert file to vtu and create dedicated render objects
+        if not Path(
+            self._server_vars["temp_dir_object"].name
+            + "\\"
+            + self._server_vars["fourc_yaml_name"]
+        ).exists():
+            raise Exception(
+                "File does not exist: "
+                + self._server_vars["temp_dir_object"].name
+                + "\\"
+                + self._server_vars["fourc_yaml_name"]
+            )
+        geometry_file_name = (
+            self._server_vars["fourc_yaml_content"]
+            .sections.get("STRUCTURE GEOMETRY", {})
+            .get("FILE")
+        )
+        if geometry_file_name:
+            if not Path(
+                self._server_vars["temp_dir_object"].name
+                + "\\"
+                + Path(
+                    self._server_vars["fourc_yaml_content"]
+                    .sections.get("STRUCTURE GEOMETRY", {})
+                    .get("FILE")
+                ).name
+            ).exists():
+                raise Exception(
+                    "File does not exist: "
+                    + self._server_vars["temp_dir_object"].name
+                    + "\\"
+                    + Path(
+                        self._server_vars["fourc_yaml_content"]["STRUCTURE GEOMETRY"][
+                            "FILE"
+                        ]
+                    ).name
+                )
+        fourc_geometry = FourCGeometry(
+            fourc_yaml_file=self._server_vars["temp_dir_object"].name
+            + "\\"
+            + self._server_vars["fourc_yaml_name"],
+            temp_dir=Path(self._server_vars["temp_dir_object"].name),
+        )
+        self.state.vtu_path = fourc_geometry.vtu_file_path
 
-        self._server_vars["render_window"].clear_actors()
+        if self.state.vtu_path == "":
+            self.state.read_in_status = self.state.all_read_in_statuses[
+                "vtu_conversion_error"
+            ]
 
+        self._server_vars["render_window"].clear_actors()
         problem_mesh = pv.read(self.state.vtu_path)
         # get problem mesh
         self._actors["problem_mesh"] = self._server_vars["render_window"].add_mesh(
@@ -334,6 +377,12 @@ def init_pyvista_render_objects(self):
         all_result_descriptions = self.state.result_description_section.keys()
 
         for dc in all_result_descriptions:
+            if (
+                not self.state.result_description_section[dc]
+                .get("PARAMETERS", {})
+                .get("NODE")
+            ):
+                continue
             node_coords = problem_mesh.points[
                 self.state.result_description_section[dc]["PARAMETERS"]["NODE"] - 1,
                 :,
@@ -351,6 +400,8 @@ def init_pyvista_render_objects(self):
             )
         self.update_pyvista_render_objects()
 
+        self._server_vars["render_window"].reset_camera()
+
     def update_pyvista_render_objects(self):
         """Update/ initialize pyvista view objects (reader, thresholds, global
         COS, ...) for the rendered window.
@@ -359,7 +410,7 @@ def update_pyvista_render_objects(self):
         """
         legend_items = []
 
-        for dc in self._actors["result_description_nodes"].values():
+        for dc in self._actors.get("result_description_nodes", {}).values():
             dc.SetVisibility(False)
         if (
             self.state.selected_main_section_name == "RESULT DESCRIPTION"
@@ -372,7 +423,7 @@ def update_pyvista_render_objects(self):
             ].SetVisibility(True)
             legend_items.append(("Selected result description", "deepskyblue"))
 
-        for rd in self._actors["dc_geometry_entities"].values():
+        for rd in self._actors.get("dc_geometry_entities", {}).values():
             rd.SetVisibility(False)
         if (
             self.state.selected_main_section_name == "DESIGN CONDITIONS"
@@ -384,7 +435,7 @@ def update_pyvista_render_objects(self):
             ].SetVisibility(True)
             legend_items.append(("Selected design condition", "navy"))
 
-        for mat in self._actors["material_meshes"].values():
+        for mat in self._actors.get("material_meshes", {}).values():
             mat.SetVisibility(False)
         if (
             self.state.selected_material
@@ -743,7 +794,9 @@ def init_result_description_state_and_server_vars(self):
 
         # get result description section
         result_description_section = copy.deepcopy(
-            self._server_vars["fourc_yaml_content"]["RESULT DESCRIPTION"]
+            self._server_vars["fourc_yaml_content"].sections.get(
+                "RESULT DESCRIPTION", {}
+            )
         )
 
         # initialize empty dict as the result description section
@@ -913,6 +966,10 @@ def init_funct_state_and_server_vars(self):
                     all_contained_var_names = get_variable_names_in_funct_expression(
                         item_data["SYMBOLIC_FUNCTION_OF_SPACE_TIME"]
                     )
+                    if "e" in all_contained_var_names:
+                        all_contained_var_names.remove("e")
+                    if "E" in all_contained_var_names:
+                        all_contained_var_names.remove("E")
 
                     # loop through contained variables and see whether they are evaluable
                     for contained_var_name in all_contained_var_names:
@@ -954,6 +1011,46 @@ def init_funct_state_and_server_vars(self):
             6  # precision for the user input of the values defined above: x, y, z and t_max
         )
 
+    def request_included_files(self):
+        """Requests the included files from the user by opening a the include
+        files dialog and setting up the state variable accordingly."""
+        included_files = []
+
+        exo_file_name = Path(
+            self._server_vars.get("fourc_yaml_content")
+            .sections.get("STRUCTURE GEOMETRY", {})
+            .get("FILE")
+            or ""
+        ).name
+        if exo_file_name:
+            exo_file_server = Path(
+                self._server_vars["fourc_yaml_file_dir"],
+                exo_file_name,
+            )
+            exo_temp_path = Path(
+                self._server_vars["temp_dir_object"].name,
+                exo_file_name,
+            )
+            if exo_file_server.is_file():
+                with open(exo_file_server, "rb") as fr:
+                    with open(exo_temp_path, "wb") as fw:
+                        fw.write(fr.read())
+            elif not exo_temp_path.is_file():
+                included_files.append(
+                    {
+                        "name": exo_file_name,
+                        "uploaded": False,
+                        "error": None,
+                        "content": None,
+                    }
+                )
+
+        self.state.included_files = included_files
+        if self.state.included_files:
+            self.state.include_upload_open = True
+        else:
+            self.confirm_included_files()
+
     def sync_funct_section_from_state(self):
         """Syncs the server-side functions section based on the current values
         of the dedicated state variables."""
@@ -1025,12 +1122,22 @@ def init_mode_state_vars(self):
     def change_fourc_yaml_file(self, fourc_yaml_file, **kwargs):
         """Reaction to change of state.fourc_yaml_file."""
 
+        if not fourc_yaml_file or fourc_yaml_file["name"].split(".")[-1] not in [
+            "yaml",
+            "yml",
+            "DAT",
+            "dat",
+        ]:
+            print(
+                "Warning: File does not have a .yml / .yaml / .dat / .DAT ending or is empty. Try opening another file."
+            )
+            return
         # create temporary fourc yaml file from the content of the given file
         temp_fourc_yaml_file = Path(
             self._server_vars["temp_dir_object"].name, fourc_yaml_file["name"]
         )
-        with open(temp_fourc_yaml_file, "w") as f:
-            f.writelines(fourc_yaml_file["content"].decode("utf-8"))
+        with open(temp_fourc_yaml_file, "wb") as f:
+            f.write(fourc_yaml_file["content"])
 
         # read content, lines and other details of the given file
         (
@@ -1042,12 +1149,63 @@ def change_fourc_yaml_file(self, fourc_yaml_file, **kwargs):
         ) = read_fourc_yaml_file(temp_fourc_yaml_file)
         self._server_vars["fourc_yaml_name"] = Path(temp_fourc_yaml_file).name
 
-        # set vtu file path empty to make the convert button visible
-        # (only if the function was not run yet, i.e., after the
-        # initial rendering)
-        self._server_vars["render_count"]["change_fourc_yaml_file"] += 1
-        if self._server_vars["render_count"]["change_fourc_yaml_file"] > 1:
-            self.state.vtu_path = ""
+        if self._server_vars["fourc_yaml_read_in_status"]:
+            self.state.read_in_status = self.state.all_read_in_statuses["success"]
+        else:
+            self.state.read_in_status = self.state.all_read_in_statuses[
+                "validation_error"
+            ]
+
+        self._server_vars["fourc_yaml_name"] = temp_fourc_yaml_file.name
+
+        self.request_included_files()
+
+    @controller.set("on_upload_include_file")
+    def on_upload_include_file(self, uploaded_file, index, **kwargs):
+        """Gets called when an included file is uploaded.
+
+        Saves the uploaded file into the state variable.
+        """
+        self.state.included_files[index]["content"] = uploaded_file
+
+        try:
+            if self.state.included_files[index]["name"] != uploaded_file["name"]:
+                self.state.included_files[index]["error"] = (
+                    "File name mismatch. Expected: "
+                    + self.state.included_files[index]["name"]
+                )
+            elif self.state.included_files[index]["content"]["size"] == 0:
+                self.state.included_files[index]["error"] = "File is empty."
+            else:
+                self.state.included_files[index]["error"] = None
+            self.state.included_files[index]["uploaded"] = True
+        except Exception:
+            self.state.included_files[index]["error"] = "Please upload a file."
+            self.state.included_files[index]["uploaded"] = False
+        self.state.dirty("included_files")
+        self.state.flush()
+
+    @controller.set("confirm_included_files")
+    def confirm_included_files(self, **kwargs):
+        """Gets called when the Accept button in the included files dialog is
+        pressed.
+
+        Saves all files into the temporary directory.
+        """
+        self.state.include_upload_open = False
+
+        for included_file in self.state.included_files:
+            # create file in temp directory
+            included_file_path = Path(
+                self._server_vars["temp_dir_object"].name,
+                included_file["content"]["name"],
+            )
+            with open(included_file_path, "wb") as f:
+                f.write(included_file["content"]["content"])
+
+        self.init_state_and_server_vars()
+
+        self.init_pyvista_render_objects()
 
     @change("export_fourc_yaml_path")
     def change_export_fourc_yaml_path(self, export_fourc_yaml_path, **kwargs):
@@ -1082,7 +1240,6 @@ def change_selected_material(self, selected_material, **kwargs):
         # material (if we are not in an initial rendering scenario)
         if self._server_vars["render_count"]["change_selected_material"] > 0:
             # first get the master material id
-            master_mat_id = self.determine_master_mat_ind_for_current_selection()
 
             # update plotter / render objects
             self.update_pyvista_render_objects()
@@ -1158,7 +1315,7 @@ def change_selected_funct(self, selected_funct, **kwargs):
         # set the selected funct item to the first within the newly
         # selected funct
         self.state.selected_funct_item = next(
-            iter(self.state.funct_section[selected_funct])
+            iter(self.state.funct_section.get(selected_funct, {}))
         )
 
         # update plotly figure
@@ -1183,18 +1340,22 @@ def change_selected_funct_item(self, selected_funct_item, **kwargs):
     def change_funct_plot(self, funct_plot, **kwargs):
         """Reaction to change of state.funct_plot."""
         # update plotly figure
-        if self.state.funct_section[self.state.selected_funct][
-            self.state.selected_funct_item
-        ]["VISUALIZATION"]:
+        if (
+            self.state.funct_section.get(self.state.selected_funct, {})
+            .get(self.state.selected_funct_item, {})
+            .get("VISUALIZATION")
+        ):
             self.server.controller.figure_update(function_plot_figure(self.state))
 
     @change("funct_section")
     def change_funct_section(self, funct_section, **kwargs):
         """Reaction to change of state.funct_section."""
         # update plotly figure
-        if self.state.funct_section[self.state.selected_funct][
-            self.state.selected_funct_item
-        ]["VISUALIZATION"]:
+        if (
+            self.state.funct_section.get(self.state.selected_funct, {})
+            .get(self.state.selected_funct_item, {})
+            .get("VISUALIZATION")
+        ):
             self.server.controller.figure_update(function_plot_figure(self.state))
 
     #################################################
@@ -1281,12 +1442,7 @@ def click_convert_button(self, **kwargs):
             # initialize state object
             self.init_state_and_server_vars()
 
-            # convert to vtu
-            fourc_geometry = FourCGeometry(
-                fourc_yaml_file=temp_fourc_yaml_file,
-                temp_dir=Path(self._server_vars["temp_dir_object"].name),
-            )
-            self.state.vtu_path = fourc_geometry.vtu_file_path
+            self.init_pyvista_render_objects()
 
             # catch eventual conversion error
             if self.state.vtu_path == "":