Merge remote-tracking branch 'origin/develop'

Author: clam2310

README.md

@@ -1,58 +1,54 @@
 # EUSurvey
 EUSurvey is the official online survey management tool of the European Commission. Its development was started in 2013 under the supervision of [DIGIT](https://ec.europa.eu/dgs/informatics/index_en.htm) and is published as open source software under the terms of the EUPL public license. EUSurvey is a servlet based application and can be installed on any servlet container.
-* Travis build on master branch [![Build Status](https://travis-ci.com/EUSurvey/EUSURVEY.svg?branch=master)](https://travis-ci.com/EUSurvey/EUsurvey)
-* [Latest Sonar Cloud analysis](https://sonarcloud.io/dashboard?id=EUSURVEY) ![Bugs](https://sonarcloud.io/api/project_badges/measure?project=EUSURVEY&metric=bugs) ![Code smells](https://sonarcloud.io/api/project_badges/measure?project=EUSURVEY&metric=code_smells) ![Coverage](https://sonarcloud.io/api/project_badges/measure?project=EUSURVEY&metric=coverage)
 
 ## Installation requirements
-1. Tomcat 8
-1. Java 8
-1. MySQL 5.7
+1. Tomcat 9
+1. Java 11
+1. MySQL 8.0
 1. Maven
 
+Make sure to create a JRE_HOME environment variable that points to the Java installation folder.
+Make sure to create a CATALINA_HOME environment variable that points to Tomcat's installation folder.
+Make sure to add Maven's bin folder to the PATH environment variable.
+
 ## Quick start
-Extensive installation guidelines may be found [here](https://joinup.ec.europa.eu/sites/default/files/document/2017-08/eusurvey_oss_installation_guide_v1_4_0_1.pdf). We give a summary of installation guidelines here.
+Extensive installation guidelines may be found in our [installation guide](https://joinup.ec.europa.eu/sites/default/files/document/2017-08/eusurvey_oss_installation_guide_v1_4_0_1.pdf). We give a summary of installation guidelines here.
 
 ### Database initialization
-1. Create eusurvey schemas;
+Connect to the database server using a tool like MySQL Command Line Client to execute the following commands:
+
+1. Create eusurvey schema:
 ``` sql 
-create database eusurveydb character set utf8 COLLATE utf8_general_ci;
-create database eusurveyreportdb character set utf8 COLLATE utf8_general_ci;
+CREATE SCHEMA `eusurveydb` DEFAULT CHARACTER SET utf8mb4;
 ```
 
 2. Create a user which will access this schema;
 ``` sql 
-CREATE USER 'eusurveyuser'@'localhost' IDENTIFIED BY 'eusurveyuser'; 
+CREATE USER 'eusurveyuser'@'localhost' IDENTIFIED BY 'eusurveyuserpassword'; 
 GRANT ALL PRIVILEGES ON eusurveydb.* TO 'eusurveyuser'@'localhost';
 GRANT EVENT ON *.* TO 'eusurveyuser'@'localhost'; 
-
-CREATE USER 'eusurveyruser'@'localhost' IDENTIFIED BY 'eusurveyruser'; 
-GRANT ALL PRIVILEGES ON eusurveyreportdb.* TO 'eusurveyruser'@'localhost';
 ```
 
 3. Set Mysql variables
 ``` sql 
 SET GLOBAL event_scheduler = ON;
-SET GLOBAL log_bin_trust_function_creators = 1;
-SET GLOBAL TRANSACTION ISOLATION LEVEL READ COMMITTED;
 ```
 
+### Download source code
+Either download EUSurvey's source code as a ZIP archive an extract its content or use git to clone the repository.
+
+
 ### Spring properties modification
 Modify the spring properties from src/main/config file to match your requirements.
+For the standard OSS version please modify src/main/config/oss.
+If you want to use docker, please modify src/main/config/ossdocker.
 
 ### Run the application
 Build EUSurvey's war using the following command:
 ``` batch
 mvn clean install -Denvironment=oss
 ```
-
-Build & deploy the application on your tomcat manager using the following command:
-``` batch
-mvn clean tomcat7:deploy 
--Dtomcat.admin.password=your_tomcat_password
--Dtomcat.admin=your_tomcat_username
--Dtomcat.deploy.url=your_tomcat_url
--Denvironment=oss
-```
+Copy the war file from target/eusurvey.war to your Tomcat's webapps folder and restart Tomcat to automatically deploy the application. 
 
 ## Repository conventions
 ### Workflow

clean_labels.ps1

@@ -0,0 +1,41 @@
+ECHO "Clean labels"
+Get-ChildItem ".\src\main\webapp\WEB-INF\classes" -Filter messages_* | Foreach-Object {
+    ECHO $_.Name
+    $data = new-object System.Collections.Hashtable
+    $last_key = ""
+    $include_next_line = $false
+
+    Get-Content -Encoding utf8 -Path $_.FullName | ForEach-Object {
+        if ($_.trim() -ne "")
+        {
+            if ($include_next_line)
+            {
+                if ($_ -match '\\$')
+                {
+                    $include_next_line = $true
+                    $_ = $_.TrimEnd('\')
+                }
+                else
+                {
+                    $include_next_line = $false
+                }
+                $data[$last_key] = $data[$last_key] + $_.Trim()
+            }
+            else
+            {
+                if ($_ -match '\\$')
+                {
+                    $include_next_line = $true
+                    $_ = $_.TrimEnd('\')
+                }
+                $split = $_.split("=")
+                $last_key = $split[0].Trim()
+                $value = ($split | Select-Object -Skip 1) -join '='
+                $data[$last_key] = $value.Trim()
+            }
+        }
+    }
+    $data.GetEnumerator() | sort -Property name | ForEach-Object { "{0} = {1}" -f $_.Name, $_.Value } | Set-Content -Encoding utf8NoBOM -Path $_.FullName
+}
+
+

pom.xml

@@ -7,7 +7,7 @@
 	<artifactId>eusurvey</artifactId>
 	<name>eusurvey</name>
 	<packaging>war</packaging>
-	<version>1.5.3.6</version>
+	<version>1.5.4</version>
 	<properties>
 		<java-version>11</java-version>
 		<org.springframework-version>5.3.20</org.springframework-version>

search_unused_labels.ps1

@@ -0,0 +1,207 @@
+ECHO "Search used labels"
+$used_labels = New-Object Collections.Generic.List[String]
+Get-ChildItem ".\src\main" -Recurse | Foreach-Object {
+    $target = get-item $_.FullName
+    if (!$target.PSIsContainer)
+    {
+        Get-Content -Encoding utf8 -Path $_.FullName | ForEach-Object {
+            if ($_.Contains('getMessage("'))
+            {
+                $line = $_
+                while ($line.IndexOf('getMessage("') -ne -1)
+                {
+                    $line = $line.Substring($line.IndexOf('getMessage("') + 12)
+                    $used_labels.Add($line.split('"')[0])
+                }
+            }
+            if ($_.Contains("getMessage('"))
+            {
+                $line = $_
+                while ($line.IndexOf("getMessage('") -ne -1)
+                {
+                    $line = $line.Substring($line.IndexOf("getMessage('") + 12)
+                    $used_labels.Add($line.split("'")[0])
+                }
+            }
+            if ($_.Contains('getMessage(resource, "'))
+            {
+                $line = $_
+                while ($line.IndexOf('getMessage(resource, "') -ne -1)
+                {
+                    $line = $line.Substring($line.IndexOf('getMessage(resource, "') + 22)
+                    $used_labels.Add($line.split('"')[0])
+                }
+            }
+            if ($_.Contains("getMessage(resource, '"))
+            {
+                $line = $_
+                while ($line.IndexOf("getMessage(resource, '") -ne -1)
+                {
+                    $line = $line.Substring($line.IndexOf("getMessage(resource, '") + 22)
+                    $used_labels.Add($line.split("'")[0])
+                }
+            }
+            if ($_.Contains('<spring:message code="'))
+            {
+                $line = $_
+                while ($line.IndexOf('<spring:message code="') -ne -1)
+                {
+                    $line = $line.Substring($line.IndexOf('<spring:message code="') + 22)
+                    $used_labels.Add($line.split('"')[0])
+                }
+            }
+            if ($_.Contains("<spring:message code='"))
+            {
+                $line = $_
+                while ($line.IndexOf("<spring:message code='") -ne -1)
+                {
+                    $line = $line.Substring($line.IndexOf("<spring:message code='") + 22)
+                    $used_labels.Add($line.split("'")[0])
+                }
+            }
+        }
+    }
+}
+
+$used_labels = $used_labels | Sort-Object | Get-Unique
+
+# Labels always threated as used (check before running)
+$force_used = New-Object Collections.Generic.List[String]
+# Activity object
+$force_used.Add("label.Survey")
+$force_used.Add("label.DraftSurvey")
+$force_used.Add("label.SurveyAndDraft")
+$force_used.Add("label.Activities")
+$force_used.Add("label.Results")
+$force_used.Add("label.Contribution")
+$force_used.Add("label.TestContribution")
+$force_used.Add("label.GuestList")
+$force_used.Add("label.Privileges")
+$force_used.Add("label.Messages")
+$force_used.Add("label.Comment")
+
+# Activity property
+$force_used.Add("label.n/a")
+$force_used.Add("label.State")
+$force_used.Add("label.PendingChanges")
+$force_used.Add("label.Alias")
+$force_used.Add("label.EndNotificationState")
+$force_used.Add("label.EndNotificationValue")
+$force_used.Add("label.EndNotificationReach")
+$force_used.Add("label.ContactCreation")
+$force_used.Add("label.Security")
+$force_used.Add("label.Password")
+$force_used.Add("label.Anonymity")
+$force_used.Add("label.Privacy")
+$force_used.Add("label.Captcha")
+$force_used.Add("label.EditContribution")
+$force_used.Add("label.MultiPaging")
+$force_used.Add("label.PageWiseValidation")
+$force_used.Add("label.WCAGCompliance")
+$force_used.Add("label.Owner")
+$force_used.Add("label.ProgressBar")
+$force_used.Add("label.MotivationPopUp")
+$force_used.Add("label.Properties")
+$force_used.Add("label.UsefulLink")
+$force_used.Add("label.BackgroundDocument")
+$force_used.Add("label.Title")
+$force_used.Add("label.PivotLanguage")
+$force_used.Add("label.Contact")
+$force_used.Add("label.Autopublish")
+$force_used.Add("label.StartDate")
+$force_used.Add("label.EndDate")
+$force_used.Add("label.Logo")
+$force_used.Add("label.Skin")
+$force_used.Add("label.AutoNumberingSections")
+$force_used.Add("label.AutoNumberingQuestions")
+$force_used.Add("label.ElementOrder")
+$force_used.Add("label.SurveyElement")
+$force_used.Add("label.Translation")
+$force_used.Add("label.ConfirmationPage")
+$force_used.Add("label.EscapePage")
+$force_used.Add("label.PublishIndividual")
+$force_used.Add("label.PublishCharts")
+$force_used.Add("label.PublishStatistics")
+$force_used.Add("label.PublicSearch")
+$force_used.Add("label.PublishQuestionSelection")
+$force_used.Add("label.PublishAnswerSelection")
+$force_used.Add("label.ExportStatistics")
+$force_used.Add("label.ExportContent")
+$force_used.Add("label.ExportCharts")
+$force_used.Add("label.ExportActivities")
+$force_used.Add("label.PublishUploadedElements")
+$force_used.Add("label.ExportUploadedElements")
+$force_used.Add("label.DeleteColumn")
+$force_used.Add("label.Export")
+$force_used.Add("label.Token/Contacts/Department/VoterFile")
+$force_used.Add("label.Invitations")
+$force_used.Add("label.EndNotificationMessage")
+$force_used.Add("label.Quorum")
+$force_used.Add("label.EligibleLists")
+$force_used.Add("label.MaximumPreferentialVotes")
+$force_used.Add("label.NumberOfSeatsToAllocate")
+$force_used.Add("label.EnableResultsTestPage")
+
+# Activity Event
+$force_used.Add("label.Added")
+$force_used.Add("label.Applied")
+$force_used.Add("label.Modified")
+$force_used.Add("label.Discarded")
+$force_used.Add("label.Deleted")
+$force_used.Add("label.Saved")
+$force_used.Add("label.Removed")
+$force_used.Add("label.Enabled")
+$force_used.Add("label.Disabled")
+$force_used.Add("label.Requested")
+$force_used.Add("label.Returned")
+$force_used.Add("label.Started")
+$force_used.Add("label.Created")
+$force_used.Add("label.Paused")
+$force_used.Add("label.Sent")
+$force_used.Add("label.Opened")
+$force_used.Add("label.Submitted")
+$force_used.Add("label.Accepted")
+$force_used.Add("label.Rejected")
+$force_used.Add("label.Expired")
+
+# Evote Template Title
+$force_used.Add("label.Brussels")
+$force_used.Add("label.IspraSeville")
+$force_used.Add("label.Luxembourg")
+$force_used.Add("label.OutsideCommunity")
+$force_used.Add("label.Standard")
+
+ECHO "List unused labels"
+$unused_labels = New-Object Collections.Generic.List[String]
+Get-Content -Encoding utf8 -Path ".\src\main\webapp\WEB-INF\classes\messages_en.properties" | ForEach-Object {
+    if ($_.trim() -ne "")
+    {
+        $split = $_.split("=")
+        $last_key = $split[0].Trim()
+        if (!$last_key.StartsWith("logging.") -And !$last_key.StartsWith("label.lang.") -And !$last_key.StartsWith("label.ECF.") -And !$last_key.StartsWith("domain.") -And !$last_key.StartsWith("label.dgnew."))
+        {
+            if (!$used_labels.Contains($last_key) -And !$force_used.Contains($last_key))
+            {
+                $unused_labels.Add($last_key)
+                ECHO $last_key
+            }
+        }
+    }
+}
+
+ECHO "Delete unused labels"
+PAUSE
+$data = New-Object Collections.Generic.List[String]
+Get-Content -Encoding utf8 -Path ".\src\main\webapp\WEB-INF\classes\messages_en.properties" | ForEach-Object {
+    if ($_.trim() -ne "")
+    {
+        $split = $_.split("=")
+        $last_key = $split[0].Trim()
+        if (!$unused_labels.Contains($last_key))
+        {
+            $data.Add($_)
+        }
+    }
+}
+
+$data | Set-Content -Encoding utf8NoBOM -Path ".\src\main\webapp\WEB-INF\classes\messages_en.properties"