Feature 3068 campaign form data columns validation (SORMAS-Foundation#3615)

* SORMAS-Foundation#3068 - validate imported campaign form data column exists in corresponding campaign form meta

* SORMAS-Foundation#3068 - Refactored import error message generation, changed file names

* SORMAS-Foundation#3068 - Refactoring, more validation fixes

Co-authored-by: barnabartha <[email protected]>

Author: MateStrysewske

sormas-api/src/main/java/de/symeda/sormas/api/i18n/Validations.java

@@ -23,6 +23,7 @@ public interface Validations {
 	String campaignFormDependingOnValuesMissing = "campaignFormDependingOnValuesMissing";
 	String campaignFormElementDuplicateId = "campaignFormElementDuplicateId";
 	String campaignFormElementIdRequired = "campaignFormElementIdRequired";
+	String campaignFormElementNotExisting = "campaignFormElementNotExisting";
 	String campaignFormElementTypeRequired = "campaignFormElementTypeRequired";
 	String campaignFormInvalidIdInListElements = "campaignFormInvalidIdInListElements";
 	String campaignFormTranslationCaptionRequired = "campaignFormTranslationCaptionRequired";

sormas-api/src/main/java/de/symeda/sormas/api/utils/DataHelper.java

@@ -387,4 +387,8 @@ public static String valueToString(Object value) {
 			return value.toString();
 		}
 	}
+
+	public static String sanitizeFileName(String fileName) {
+		return fileName.replaceAll("[^a-zA-Z0-9._-]", "");
+	}
 }

sormas-api/src/main/resources/validations.properties

@@ -100,6 +100,7 @@ contactFollowUpUntilDate = The follow-up until date must at least be on the day
 emptyOverwrittenFollowUpUntilDate = The follow-up until date cannot be overwritten with an empty value.
 textTooLong = The text you entered is too long. Maximum allowed length is %d
 contactWithoutInfrastructureData = A contact needs either a source case or a responsible region and district.
+campaignFormElementNotExisting = Column %s does not exist in form meta definition.
 campaignFormUnsupportedType = The type %s of element %s is not supported in campaign forms.
 campaignFormUnsupportedStyle = The style %s of element %s is not supported in campaign forms.
 campaignFormDependingOnNotFound = The campaign form does not contain a field with the ID %s that was specified in the dependingOn attribute of element %s.

sormas-ui/src/main/java/de/symeda/sormas/ui/campaign/campaigndata/CampaignDataView.java

@@ -22,8 +22,6 @@
 import java.util.Objects;
 import java.util.function.Consumer;
 
-import javax.naming.NamingException;
-
 import org.vaadin.hene.popupbutton.PopupButton;
 
 import com.vaadin.icons.VaadinIcons;
@@ -56,7 +54,7 @@
 import de.symeda.sormas.ui.UserProvider;
 import de.symeda.sormas.ui.ViewModelProviders;
 import de.symeda.sormas.ui.campaign.AbstractCampaignView;
-import de.symeda.sormas.ui.campaign.importer.CampaignImportLayout;
+import de.symeda.sormas.ui.campaign.importer.CampaignFormDataImportLayout;
 import de.symeda.sormas.ui.utils.ButtonHelper;
 import de.symeda.sormas.ui.utils.CssStyles;
 import de.symeda.sormas.ui.utils.GridExportStreamResource;
@@ -143,11 +141,8 @@ public CampaignDataView() {
 			addHeaderComponent(exportPopupButton);
 
 			{
-				StreamResource streamResource = new GridExportStreamResource(
-					grid,
-					"sormas_campaign_data",
-					createFileNameWithCurrentDate("sormas_campaign_data_", ".csv"),
-					EDIT_BTN_ID);
+				StreamResource streamResource =
+					new GridExportStreamResource(grid, "campaign_data", createFileNameWithCurrentDate("campaign_data_", ".csv"), EDIT_BTN_ID);
 				addExportButton(streamResource, exportPopupButton, exportLayout, VaadinIcons.TABLE, Captions.export, Strings.infoBasicExport);
 			}
 		}
@@ -197,18 +192,18 @@ public CampaignDataView() {
 	}
 
 	private void createImportLayout(VerticalLayout importFormLayout) {
+
 		for (CampaignFormMetaReferenceDto campaignForm : FacadeProvider.getCampaignFormMetaFacade()
 			.getCampaignFormMetasAsReferencesByCampaign(campaignCombo.getValue().getUuid())) {
 
 			Button campaignFormButton = ButtonHelper.createButton(campaignForm.toString(), e -> {
-				Window popupWindow = null;
 				try {
-					popupWindow = VaadinUiUtil.showPopupWindow(new CampaignImportLayout(campaignForm.getUuid(), filterForm.getValue().getCampaign()));
-				} catch (IOException | NamingException ioException) {
+					Window popupWindow = VaadinUiUtil.showPopupWindow(new CampaignFormDataImportLayout(campaignForm, campaignCombo.getValue()));
+					popupWindow.setCaption(I18nProperties.getString(Strings.headingImportCampaign));
+					popupWindow.addCloseListener(c -> grid.reload());
+				} catch (IOException ioException) {
 					ioException.printStackTrace();
 				}
-				popupWindow.setCaption(I18nProperties.getString(Strings.headingImportCampaign));
-
 			});
 			campaignFormButton.setWidth(100, Unit.PERCENTAGE);
 			importFormLayout.addComponent(campaignFormButton);

sormas-ui/src/main/java/de/symeda/sormas/ui/campaign/importer/CampaignFormDataImportLayout.java

@@ -0,0 +1,54 @@
+package de.symeda.sormas.ui.campaign.importer;
+
+import java.io.IOException;
+
+import com.opencsv.exceptions.CsvValidationException;
+import com.vaadin.server.Page;
+import com.vaadin.ui.Notification;
+
+import de.symeda.sormas.api.FacadeProvider;
+import de.symeda.sormas.api.campaign.CampaignReferenceDto;
+import de.symeda.sormas.api.campaign.form.CampaignFormMetaReferenceDto;
+import de.symeda.sormas.api.i18n.I18nProperties;
+import de.symeda.sormas.api.i18n.Strings;
+import de.symeda.sormas.api.importexport.ImportFacade;
+import de.symeda.sormas.api.utils.DataHelper;
+import de.symeda.sormas.ui.importer.AbstractImportLayout;
+import de.symeda.sormas.ui.importer.ImportReceiver;
+
+public class CampaignFormDataImportLayout extends AbstractImportLayout {
+
+	private static final long serialVersionUID = 4380218570798586587L;
+
+	public CampaignFormDataImportLayout(CampaignFormMetaReferenceDto campaignForm, CampaignReferenceDto campaignReferenceDto) throws IOException {
+		super();
+
+		ImportFacade importFacade = FacadeProvider.getImportFacade();
+		importFacade.generateCampaignFormImportTemplateFile(campaignForm.getUuid());
+
+		String templateFileName = DataHelper.sanitizeFileName(campaignReferenceDto.getCaption().replaceAll(" ", "_")) + "_"
+			+ DataHelper.sanitizeFileName(campaignForm.getCaption().replaceAll(" ", "_")) + ".csv";
+		addDownloadImportTemplateComponent(1, importFacade.getCampaignFormImportTemplateFilePath(), templateFileName);
+		addImportCsvComponent(2, new ImportReceiver("_campaign_data_import_", file -> {
+			resetDownloadErrorReportButton();
+
+			try {
+				CampaignFormDataImporter importer =
+					new CampaignFormDataImporter(file, false, currentUser, campaignForm.getUuid(), campaignReferenceDto);
+				importer.startImport(this::extendDownloadErrorReportButton, currentUI, false);
+			} catch (IOException | CsvValidationException e) {
+				new Notification(
+					I18nProperties.getString(Strings.headingImportFailed),
+					I18nProperties.getString(Strings.messageImportFailed),
+					Notification.Type.ERROR_MESSAGE,
+					false).show(Page.getCurrent());
+			}
+		}));
+		addDownloadErrorReportComponent(3);
+	}
+
+	protected void addDownloadImportTemplateComponent(int step, String templateFilePath, String templateFileName) {
+		super.addDownloadImportTemplateComponent(step, templateFilePath, templateFileName);
+	}
+
+}