Merge branch 'development' of https://github.com/hzi-braunschweig/SORMAS-Project into development

Author: MateStrysewske

SERVER_CUSTOMIZATION.md

@@ -19,7 +19,7 @@ The following properties are currently configurable:
 * **EPID prefix** `country.epidprefix`: SORMAS automatically generates EPID numbers for new cases. This is the prefix your country is using for all of these numbers. Most of the time it will be some sort of country code and should be three characters long.
 * **Country center/zoom** `country.center.latitude`, `country.center.longitude` and `map.zoom`: These are the geo coordinates of the geographical center of the country or region you're using SORMAS in. Used to set the initial location of the maps used in dashboards and statistics.
 * **App URL** `app.url`: The directory on your server where the mobile .apk file is stored that is used to automatically update the Android app after a new release. You should be able to copy the example given in the properties file and only have to replace the SERVER-NAME placeholder.
-* **File paths** `temp.path`, `generated.path` and `custom.path`: The folders that SORMAS stores files in, either temporarily during case export or permanently like import templates. Files in temp.path are automatically deleted at midnight. Files in custom.path can be used to customize the login page, e.g. to provide default logins for demo servers or add additional contributors to the right sidebar.
+* **File paths** `documents.path`, `temp.path`, `generated.path` and `custom.path`: The folders that SORMAS stores files in, either temporarily during case export or permanently like import templates or documents. Files in temp.path are automatically deleted at midnight. Files in custom.path can be used to customize the login page, e.g. to provide default logins for demo servers or add additional contributors to the right sidebar.
 * **Automatic case classification** `feature.automaticcaseclassification`: Determines whether SORMAS automatically classifies cases based on a number of criteria that are defined in the code.
 * **Email settings** `email.sender.address` and `email.sender.name`: The email address and sender name that should be used when SORMAS is sending out emails, e.g. to notify users about specific events.
 * **SMS settings** `sms.sender.name, sms.auth.key and sms.auth.secret`: Besides emails, SORMAS also supports sending automatic SMS to users at the same time (e.g. when a case has been classified as confirmed). The SMS provider SORMAS is using is the Vonage SMS API (https://www.vonage.com/communications-apis/sms/). If you have an account there, you can use your key and secret here to enable sending out SMS. Leaving these properties empty will disable this feature.
@@ -87,3 +87,4 @@ The following features are currently configurable:
 * **Area Infrastructure** `INFRASTRUCTURE_TYPE_AREA`: Enables an additional infrastructure level above region that is called area by default. Currently only used in the campaigns module.
 * **Case Follow-Up** `CASE_FOLLOWUP`: Enables the contact follow-up module for cases as well to allow a more detailed daily documentation of symptoms.
 * **Line Listing** `LINE_LISTING`: Whether or not using line listing for case entry is enabled in the specified jurisdiction for the specified disease. Configurable from the UI, no database interaction needed.
+* **Documents** `DOCUMENTS`: Enables document storage.

sormas-api/src/main/java/de/symeda/sormas/api/ConfigFacade.java

@@ -1,20 +1,17 @@
-/*******************************************************************************
+/*
  * SORMAS® - Surveillance Outbreak Response Management & Analysis System
- * Copyright © 2016-2018 Helmholtz-Zentrum für Infektionsforschung GmbH (HZI)
- *
+ * Copyright © 2016-2020 Helmholtz-Zentrum für Infektionsforschung GmbH (HZI)
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
  * the Free Software Foundation, either version 3 of the License, or
  * (at your option) any later version.
- *
  * This program is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  * GNU General Public License for more details.
- *
  * You should have received a copy of the GNU General Public License
  * along with this program. If not, see <https://www.gnu.org/licenses/>.
- *******************************************************************************/
+ */
 package de.symeda.sormas.api;
 
 import javax.ejb.Remote;
@@ -50,6 +47,8 @@ public interface ConfigFacade {
 
 	String getSmsAuthSecret();
 
+	String getDocumentFilesPath();
+
 	String getTempFilesPath();
 
 	String getGeneratedFilesPath();

sormas-api/src/main/java/de/symeda/sormas/api/FacadeProvider.java

@@ -1,20 +1,17 @@
-/*******************************************************************************
+/*
  * SORMAS® - Surveillance Outbreak Response Management & Analysis System
- * Copyright © 2016-2018 Helmholtz-Zentrum für Infektionsforschung GmbH (HZI)
- *
+ * Copyright © 2016-2020 Helmholtz-Zentrum für Infektionsforschung GmbH (HZI)
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
  * the Free Software Foundation, either version 3 of the License, or
  * (at your option) any later version.
- *
  * This program is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  * GNU General Public License for more details.
- *
  * You should have received a copy of the GNU General Public License
  * along with this program. If not, see <https://www.gnu.org/licenses/>.
- *******************************************************************************/
+ */
 package de.symeda.sormas.api;
 
 import javax.naming.InitialContext;
@@ -37,6 +34,7 @@
 import de.symeda.sormas.api.disease.DiseaseConfigurationFacade;
 import de.symeda.sormas.api.disease.DiseaseFacade;
 import de.symeda.sormas.api.docgeneneration.QuarantineOrderFacade;
+import de.symeda.sormas.api.document.DocumentFacade;
 import de.symeda.sormas.api.epidata.EpiDataFacade;
 import de.symeda.sormas.api.event.EventFacade;
 import de.symeda.sormas.api.event.EventParticipantFacade;
@@ -314,11 +312,15 @@ public static QuarantineOrderFacade getQuarantineOrderFacade() {
 		return get().lookupEjbRemote(QuarantineOrderFacade.class);
 	}
 
-  public static ExternalJournalFacade getExternalJournalFacade() {
+	public static ExternalJournalFacade getExternalJournalFacade() {
 		return get().lookupEjbRemote(ExternalJournalFacade.class);
-  }
+	}
+
+	public static DocumentFacade getDocumentFacade() {
+		return get().lookupEjbRemote(DocumentFacade.class);
+	}
 
-  @SuppressWarnings("unchecked")
+	@SuppressWarnings("unchecked")
 	public <P> P lookupEjbRemote(Class<P> clazz) {
 		try {
 			return (P) get().ic.lookup(buildJndiLookupName(clazz));

sormas-api/src/main/java/de/symeda/sormas/api/document/DocumentDto.java

@@ -0,0 +1,98 @@
+/*
+ * SORMAS® - Surveillance Outbreak Response Management & Analysis System
+ * Copyright © 2016-2020 Helmholtz-Zentrum für Infektionsforschung GmbH (HZI)
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ * You should have received a copy of the GNU General Public License
+ * along with this program. If not, see <https://www.gnu.org/licenses/>.
+ */
+package de.symeda.sormas.api.document;
+
+import de.symeda.sormas.api.user.UserReferenceDto;
+import de.symeda.sormas.api.utils.DataHelper;
+import de.symeda.sormas.api.utils.Required;
+import de.symeda.sormas.api.utils.pseudonymization.PseudonymizableDto;
+
+public class DocumentDto extends PseudonymizableDto {
+
+	public static final String UPLOADING_USER = "uploadingUser";
+	public static final String NAME = "name";
+	public static final String CONTENT_TYPE = "contentType";
+	public static final String SIZE = "size";
+	public static final String RELATED_ENTITY_UUID = "relatedEntityUuid";
+	public static final String RELATED_ENTITY_CLASS = "relatedEntityClass";
+
+	@Required
+	private UserReferenceDto uploadingUser;
+	@Required
+	private String name;
+	@Required
+	private String mimeType;
+	@Required
+	private long size;
+	@Required
+	private String relatedEntityUuid;
+	@Required
+	private DocumentRelatedEntityType relatedEntityType;
+
+	public static DocumentDto build() {
+		DocumentDto document = new DocumentDto();
+		document.setUuid(DataHelper.createUuid());
+
+		return document;
+	}
+
+	public UserReferenceDto getUploadingUser() {
+		return uploadingUser;
+	}
+
+	public void setUploadingUser(UserReferenceDto uploadingUser) {
+		this.uploadingUser = uploadingUser;
+	}
+
+	public String getName() {
+		return name;
+	}
+
+	public void setName(String name) {
+		this.name = name;
+	}
+
+	public String getMimeType() {
+		return mimeType;
+	}
+
+	public void setMimeType(String mimeType) {
+		this.mimeType = mimeType;
+	}
+
+	public long getSize() {
+		return size;
+	}
+
+	public void setSize(long size) {
+		this.size = size;
+	}
+
+	public String getRelatedEntityUuid() {
+		return relatedEntityUuid;
+	}
+
+	public void setRelatedEntityUuid(String relatedEntityUuid) {
+		this.relatedEntityUuid = relatedEntityUuid;
+	}
+
+	public DocumentRelatedEntityType getRelatedEntityType() {
+		return relatedEntityType;
+	}
+
+	public void setRelatedEntityType(DocumentRelatedEntityType relatedEntityType) {
+		this.relatedEntityType = relatedEntityType;
+	}
+}

sormas-api/src/main/java/de/symeda/sormas/api/document/DocumentFacade.java

@@ -0,0 +1,38 @@
+/*
+ * SORMAS® - Surveillance Outbreak Response Management & Analysis System
+ * Copyright © 2016-2020 Helmholtz-Zentrum für Infektionsforschung GmbH (HZI)
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ * You should have received a copy of the GNU General Public License
+ * along with this program. If not, see <https://www.gnu.org/licenses/>.
+ */
+package de.symeda.sormas.api.document;
+
+import java.io.IOException;
+import java.util.List;
+
+import javax.ejb.Remote;
+
+@Remote
+public interface DocumentFacade {
+
+	DocumentDto getDocumentByUuid(String uuid);
+
+	DocumentDto saveDocument(DocumentDto dto, byte[] bytes) throws IOException;
+
+	void deleteDocument(String uuid);
+
+	List<DocumentDto> getDocumentsRelatedToEntity(DocumentRelatedEntityType type, String uuid);
+
+	String isExistingDocument(DocumentRelatedEntityType type, String uuid, String name);
+
+	byte[] read(String uuid) throws IOException;
+
+	void cleanupDeletedDocuments();
+}

sormas-api/src/main/java/de/symeda/sormas/api/document/DocumentRelatedEntityType.java

@@ -0,0 +1,26 @@
+/*
+ * SORMAS® - Surveillance Outbreak Response Management & Analysis System
+ * Copyright © 2016-2020 Helmholtz-Zentrum für Infektionsforschung GmbH (HZI)
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ * You should have received a copy of the GNU General Public License
+ * along with this program. If not, see <https://www.gnu.org/licenses/>.
+ */
+package de.symeda.sormas.api.document;
+
+import de.symeda.sormas.api.i18n.I18nProperties;
+
+public enum DocumentRelatedEntityType {
+
+	EVENT;
+
+	public String toString() {
+		return I18nProperties.getEnumCaption(this);
+	}
+}

sormas-api/src/main/java/de/symeda/sormas/api/feature/FeatureType.java

@@ -35,7 +35,8 @@ public enum FeatureType {
 	INFRASTRUCTURE_TYPE_AREA(true, false, null),
 	CASE_FOLLOWUP(true, false, null),
 	TASK_NOTIFICATIONS(true, true, null),
-	OTHER_NOTIFICATIONS(true, true, null);
+	OTHER_NOTIFICATIONS(true, true, null),
+	DOCUMENTS(true, false, null);
 
 	/**
 	 * Server feature means that the feature only needs to be configured once per server since they define the way the system

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

@@ -716,6 +716,7 @@ public interface Captions {
 	String districtAllDistricts = "districtAllDistricts";
 	String districtArchivedDistricts = "districtArchivedDistricts";
 	String districtName = "districtName";
+	String documentNoDocuments = "documentNoDocuments";
 	String DocumentTemplate = "DocumentTemplate";
 	String DocumentTemplate_documentTemplateGuide = "DocumentTemplate.documentTemplateGuide";
 	String DocumentTemplate_exampleTemplateLibreOffice = "DocumentTemplate.exampleTemplateLibreOffice";
@@ -725,6 +726,7 @@ public interface Captions {
 	String DocumentTemplate_QuarantineOrder_create = "DocumentTemplate.QuarantineOrder.create";
 	String DocumentTemplate_QuarantineOrder_templates = "DocumentTemplate.QuarantineOrder.templates";
 	String DocumentTemplate_uploadTemplate = "DocumentTemplate.uploadTemplate";
+	String documentUploadDocument = "documentUploadDocument";
 	String EpiData = "EpiData";
 	String EpiData_animalCondition = "EpiData.animalCondition";
 	String EpiData_animalVaccinationStatus = "EpiData.animalVaccinationStatus";

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

@@ -143,6 +143,7 @@ public interface Strings {
 	String entityContacts = "entityContacts";
 	String entityDistrict = "entityDistrict";
 	String entityDistricts = "entityDistricts";
+	String entityDocuments = "entityDocuments";
 	String entityEvent = "entityEvent";
 	String entityEventParticipant = "entityEventParticipant";
 	String entityEvents = "entityEvents";
@@ -165,6 +166,7 @@ public interface Strings {
 	String errorCampaignDiagramTotalsCalculationError = "errorCampaignDiagramTotalsCalculationError";
 	String errorCaseDuplicateDeletion = "errorCaseDuplicateDeletion";
 	String errorCaseMerging = "errorCaseMerging";
+	String errorDeletingDocument = "errorDeletingDocument";
 	String errorDeletingDocumentTemplate = "errorDeletingDocumentTemplate";
 	String errorDocumentGeneration = "errorDocumentGeneration";
 	String errorEntityOutdated = "errorEntityOutdated";
@@ -179,6 +181,7 @@ public interface Strings {
 	String errorProblemOccurred = "errorProblemOccurred";
 	String errorProcessingTemplate = "errorProcessingTemplate";
 	String errorQuarantineOnlyCaseAndContacts = "errorQuarantineOnlyCaseAndContacts";
+	String errorReadingDocument = "errorReadingDocument";
 	String errorReadingTemplate = "errorReadingTemplate";
 	String errorSetFeverRequired = "errorSetFeverRequired";
 	String errorSormasToSormasCertNotGenerated = "errorSormasToSormasCertNotGenerated";
@@ -663,6 +666,7 @@ public interface Strings {
 	String messageNoContactsSelected = "messageNoContactsSelected";
 	String messageNoCsvFile = "messageNoCsvFile";
 	String messageNoDocumentTemplateUploadFile = "messageNoDocumentTemplateUploadFile";
+	String messageNoDocumentUploadFile = "messageNoDocumentUploadFile";
 	String messageNoEndDate = "messageNoEndDate";
 	String messageNoEventFound = "messageNoEventFound";
 	String messageNoEventParticipantsSelected = "messageNoEventParticipantsSelected";

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

@@ -858,6 +858,10 @@ EpiData.visitedAnimalMarket=Visited live animal market within the incubation per
 EpiData.camels=Camels
 EpiData.snakes=Snakes
 
+# Documents
+documentUploadDocument=New document
+documentNoDocuments=There are no documents for this %s
+
 # DocumentTemplate
 DocumentTemplate=Document Template
 DocumentTemplate.documentTemplateGuide=Document Template Guide