Merge branch 'development' into feature-2528-campaign-diagram-percentages

Author: MateStrysewske

.github/ISSUE_TEMPLATE/bug-report.md

@@ -24,5 +24,7 @@ If you've never submitted an issue to the SORMAS repository before or this is yo
 * Device:
 * SORMAS version:
 * Android version/Browser:
+* Server URL:
+* User Role:
 
 ### Additional Information

SERVER_DEV_SETUP.md

@@ -44,6 +44,12 @@ Other steps :
 * Adjust the logging configuration in ``${HOME}/opt/domains/sormas/config/logback.xml`` based on your needs (e.g. configure and activate email appender)
 * Build and deploy applications (ear and war) with you IDE.
 
+## Keycloak
+
+See [Keycloak](SERVER_SETUP.md#keycloak-server) for how to install Docker locally.
+
+If you are doing active development on Keycloak (themes, authentication mechanisms, translations, etc.) it's recommended to install the standalone variant.
+
 
 ## Other components
 

SERVER_SETUP.md

@@ -8,6 +8,7 @@
   * [Java 11](#java-11)
   * [Postgres Database](#postgres-database)
 * [SORMAS Server](#sormas-server)
+* [Keycloak Server](#keycloak-server)
 * [Web Server Setup](#web-server-setup)
   * [Apache Web Server](#apache-web-server)
   * [Firewall](#firewall)
@@ -18,6 +19,7 @@
 
 ## Related
 * [Creating an App for a Demo Server](DEMO_APP.md)
+* [SORMAS Docker Repository](https://github.com/hzi-braunschweig/SORMAS-Docker)
 
 ## Prerequisites
 
@@ -71,6 +73,62 @@
 * Adjust the logging configuration in ``/opt/domains/sormas/config/logback.xml`` based on your needs (e.g. configure and activate email appender)
 * Linux: [Update the SORMAS domain](SERVER_UPDATE.md)
 
+## Keycloak Server
+
+By default Keycloak is run as a Docker container, which can be set up in two ways:
+* As a Docker container
+* As a Standalone installation
+
+### Keycloak as a Docker container
+*To be done only in the situation when SORMAS is already installed on the machine as a standalone installation.*
+
+*For complete Docker setup see the [SORMAS-Docker](https://github.com/hzi-braunschweig/SORMAS-Docker/tree/keycloak-integration) repository.*
+
+**Prerequisites**
+* SORMAS Server is installed
+* PostgreSQL is installed
+* Docker is installed
+* Open and edit [keycloak-setup.sh](sormas-base/setup/keycloak/keycloak-setup.sh) with your system's actual values
+
+**Setup**
+* Run [keycloak-setup.sh](sormas-base/setup/keycloak/keycloak-setup.sh)
+* Update `sormas.properties` file in the SORMAS domain with the property `authentication.provider=KEYCLOAK`
+
+
+### Keycloak as a standalone installation
+
+**Prerequisites**
+* SORMAS Server is installed
+* PostgreSQL is installed
+
+**Setup**
+
+Setting Keycloak up as a standalone installation [Server Installation and Configuration Guide](https://www.keycloak.org/docs/11.0/server_installation/#installation)
+* Make sure to configure Keycloak with PostgreSQL Database [Relational Database Setup](https://www.keycloak.org/docs/11.0/server_installation/#_database)
+* Setup an Admin User
+* Copy the `themes` folder content to `${KEYCLOAK_HOME}/themes` [Deploying Themes](https://www.keycloak.org/docs/11.0/server_development/#deploying-themes)
+* Create the SORMAS Realm by importing [SORMAS.json](sormas-base/setup/keycloak/SORMAS.json) see [Create a New Realm](https://www.keycloak.org/docs/11.0/server_admin/#_create-realm)
+* Update the `sormas-*` clients by generating new secrets for them
+* Update the realm's email settings to allow sending emails to users
+
+To update the SORMAS Server run the following commands
+```shell script
+${ASADMIN} set-config-property --propertyName=payara.security.openid.clientSecret --propertyValue=${KEYCLOAK_SORMAS_UI_SECRET} --source=domain
+${ASADMIN} set-config-property --propertyName=payara.security.openid.clientId --propertyValue=sormas-ui --source=domain
+${ASADMIN} set-config-property --propertyName=payara.security.openid.scope --propertyValue=openid --source=domain
+${ASADMIN} set-config-property --propertyName=payara.security.openid.providerURI --propertyValue=http://localhost:${KEYCLOAK_PORT}/keycloak/auth/realms/SORMAS --source=domain
+${ASADMIN} set-config-property --propertyName=sormas.rest.security.oidc.json --propertyValue="{\"realm\":\"SORMAS\",\"auth-server-url\":\"http://localhost:${KEYCLOAK_PORT}/auth\",\"ssl-required\":\"external\",\"resource\":\"sormas-rest\",\"credentials\":{\"secret\":\"${KEYCLOAK_SORMAS_REST_SECRET}\"},\"confidential-port\":0,\"principal-attribute\":\"preferred_username\",\"enable-basic-auth\":true}" --source=domain
+${ASADMIN} set-config-property --propertyName=sormas.backend.security.oidc.json --propertyValue="{\"realm\":\"SORMAS\",\"auth-server-url\":\"http://localhost:${KEYCLOAK_PORT}/auth/\",\"ssl-required\":\"external\",\"resource\":\"sormas-backend\",\"credentials\":{\"secret\":\"${KEYCLOAK_SORMAS_BACKEND_SECRET}\"},\"confidential-port\":0}" --source=domain
+```
+where:
+* `${ASADMIN}` - represents the location to `${PAYARA_HOME}\bin\asadmin`
+* `${KEYCLOAK_PORT}` - the port on which keycloak will run
+* `${KEYCLOAK_SORMAS_UI_SECRET}` - is the secret generated in Keycloak for the `sormas-ui` client
+* `${KEYCLOAK_SORMAS_REST_SECRET}` - is the secret generated in Keycloack for the `sormas-rest` client
+* `${KEYCLOAK_SORMAS_BACKEND_SECRET}` - is the secret generated in Keycloack for the `sormas-backend` client
+
+Then update `sormas.properties` file in the SORMAS domain with the property `authentication.provider=KEYCLOAK`
+
 ## Web Server Setup
 
 ### Apache Web Server

sormas-api/pom.xml

@@ -2,7 +2,7 @@
 	<parent>
 		<groupId>de.symeda.sormas</groupId>
 		<artifactId>sormas-base</artifactId>
-		<version>1.49.0-SNAPSHOT</version>
+		<version>1.50.0-SNAPSHOT</version>
 		<relativePath>../sormas-base</relativePath>
 	</parent>
 	<modelVersion>4.0.0</modelVersion>

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

@@ -0,0 +1,33 @@
+/*
+ * 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;
+
+/**
+ * Authentication provider which can be obtained trough the {@link ConfigFacade#getAuthenticationProvider()} property.
+ *
+ * @author Alex Vidrean
+ * @since 13-Aug-20
+ */
+public class AuthProvider {
+
+	public static final String KEYCLOAK = "KEYCLOAK";
+
+	public static final String SORMAS = "SORMAS";
+
+}

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

@@ -103,4 +103,6 @@ public interface ConfigFacade {
 	void validateExternalUrls();
 
 	Sormas2SormasConfig getSormas2SormasConfig();
+
+	String getAuthenticationProvider();
 }

sormas-api/src/main/java/de/symeda/sormas/api/action/ActionDto.java

@@ -29,9 +29,11 @@
 import de.symeda.sormas.api.utils.Required;
 
 public class ActionDto extends EntityDto {
+
 	private static final long serialVersionUID = 2439546041916003652L;
 
 	public static final String I18N_PREFIX = "Action";
+	public static final String TITLE = "title";
 	public static final String DESCRIPTION = "description";
 	public static final String REPLY = "reply";
 	public static final String PRIORITY = "priority";
@@ -51,6 +53,7 @@ public class ActionDto extends EntityDto {
 	private Date statusChangeDate;
 
 	private UserReferenceDto creatorUser;
+	private String title;
 	private String description;
 	private String reply;
 	private UserReferenceDto replyingUser;
@@ -119,6 +122,14 @@ public void setCreatorUser(UserReferenceDto creatorUser) {
 		this.creatorUser = creatorUser;
 	}
 
+	public String getTitle() {
+		return title;
+	}
+
+	public void setTitle(String title) {
+		this.title = title;
+	}
+
 	public String getDescription() {
 		return description;
 	}

sormas-api/src/main/java/de/symeda/sormas/api/action/ActionFacade.java

@@ -22,6 +22,10 @@
 
 import javax.ejb.Remote;
 
+import de.symeda.sormas.api.event.EventActionIndexDto;
+import de.symeda.sormas.api.event.EventCriteria;
+import de.symeda.sormas.api.utils.SortProperty;
+
 @Remote
 public interface ActionFacade {
 
@@ -40,4 +44,8 @@ public interface ActionFacade {
 	List<ActionStatEntry> getActionStats(ActionCriteria actionCriteria);
 
 	List<ActionDto> getActionList(ActionCriteria criteria, Integer first, Integer max);
+
+	List<EventActionIndexDto> getEventActionList(EventCriteria criteria, Integer first, Integer max, List<SortProperty> sortProperties);
+
+	long countEventAction(EventCriteria criteria);
 }

sormas-api/src/main/java/de/symeda/sormas/api/campaign/data/CampaignFormDataDto.java

@@ -20,7 +20,11 @@
 
 package de.symeda.sormas.api.campaign.data;
 
+import java.util.Date;
+import java.util.List;
+
 import de.symeda.sormas.api.EntityDto;
+import de.symeda.sormas.api.ImportIgnore;
 import de.symeda.sormas.api.campaign.CampaignReferenceDto;
 import de.symeda.sormas.api.campaign.form.CampaignFormMetaReferenceDto;
 import de.symeda.sormas.api.region.CommunityReferenceDto;
@@ -29,9 +33,6 @@
 import de.symeda.sormas.api.user.UserReferenceDto;
 import de.symeda.sormas.api.utils.DataHelper;
 
-import java.util.Date;
-import java.util.List;
-
 public class CampaignFormDataDto extends EntityDto {
 
 	private static final long serialVersionUID = -8087195060395038093L;
@@ -71,6 +72,12 @@ public static CampaignFormDataDto build(
 		return campaignFormData;
 	}
 
+	public static CampaignFormDataDto build() {
+		CampaignFormDataDto campaignFormData = new CampaignFormDataDto();
+		campaignFormData.setUuid(DataHelper.createUuid());
+		return campaignFormData;
+	}
+
 	public List<CampaignFormDataEntry> getFormValues() {
 		return formValues;
 	}
@@ -79,6 +86,7 @@ public void setFormValues(List<CampaignFormDataEntry> formValues) {
 		this.formValues = formValues;
 	}
 
+	@ImportIgnore
 	public CampaignFormMetaReferenceDto getCampaignFormMeta() {
 		return campaignFormMeta;
 	}
@@ -87,6 +95,7 @@ public void setCampaignFormMeta(CampaignFormMetaReferenceDto campaignFormMeta) {
 		this.campaignFormMeta = campaignFormMeta;
 	}
 
+	@ImportIgnore
 	public CampaignReferenceDto getCampaign() {
 		return campaign;
 	}

sormas-api/src/main/java/de/symeda/sormas/api/campaign/data/CampaignFormDataEntry.java

@@ -16,6 +16,9 @@
 package de.symeda.sormas.api.campaign.data;
 
 import java.io.Serializable;
+import java.util.Collection;
+import java.util.Iterator;
+import java.util.List;
 
 import de.symeda.sormas.api.i18n.I18nProperties;
 import de.symeda.sormas.api.i18n.Strings;
@@ -83,4 +86,15 @@ public String toString() {
 
 		return value.toString();
 	}
+
+	public static void removeNullValueEntries(Collection<CampaignFormDataEntry> entries) {
+
+		Iterator<CampaignFormDataEntry> iterator = entries.iterator();
+		while (iterator.hasNext()) {
+			CampaignFormDataEntry entry = iterator.next();
+			if (entry.value == null) {
+				iterator.remove();
+			}
+		}
+	}
 }