Feature #13830 and #13831: improving survey result pages.

* defining result views
* keeping the chosen result view into session
* starting to create some WEB entities which might be used when moving to WEB service architecture
* implementing new VueJS components in order to render the result pages
* adding print action with helping messages about print and export actions

Author: SilverYoCha

survey/survey-configuration/src/main/config/properties/org/silverpeas/survey/multilang/surveyBundle.properties

@@ -82,7 +82,7 @@ PollingStation.revote = Revoter
 Survey.revote = Participer de nouveau \u00e0 l'enqu\u00eate
 SurveyNbParticipations = Nombre de participations
 survey.NoResponse = au moins une r\u00e9ponse doit \u00eatre selectionn\u00e9e.
-custom.st.notification.subject=\u00C0 propos du sondage $surveyName$
+custom.st.notification.subject=\u00c0 propos du sondage $surveyName$
 survey.imageGallery = Image associ\u00e9e
 
 survey.style = Type de r\u00e9ponse
@@ -96,10 +96,17 @@ survey.confirmUpdatePoll = Attention, modifier cette consultation supprimera tou
 survey.surveyAnonymous = Enqu\u00eate anonyme
 survey.pollAnonymous = Vote anonyme
 survey.choice = vue
-survey.C = Classique
-survey.D = D\u00e9taill\u00e9e
+survey.result.seeVoters.help=Voir la liste des votants
+survey.result.seeVoters.clickHelp=(Cliquer pour voir la liste des votants)
+survey.result.suggestion.help = Voir le d\u00e9tail des r\u00e9ponses
+survey.result.view.classic = Classique
+survey.result.view.detail = D\u00e9taill\u00e9e
+survey.result.view.graphical=Graphique
+survey.result.view.horizontal-bar=Barre horizontale
 survey.participationOf = Participation de
 survey.results = R\u00e9sultats
+survey.results.print.help=L'action <span class="survey-help-action">imprimer</span> permet d'ouvrir la bo\u00eete de dialogue d'impression du navigateur et d'imprimer ou enregistrer en PDF les r\u00e9sultats visualis\u00e9s. Pour l'impression de vos graphiques, pensez \u00e0 cocher l'option <span class="survey-help-action">Imprimer les arri\u00e8re-plans</span>
+survey.results.export.help=L'action <span class="survey-help-action">exporter</span> permet d'obtenir les r\u00e9sultats visualis\u00e9s sous la forme d'un fichier CSV \u00e0 t\u00e9l\u00e9charger.
 
 survey.update=Modifier
 survey.update.succeed=Les modifications r\u00e9alis\u00e9es sur les questions ont bien \u00e9t\u00e9 enregistr\u00e9es.
@@ -114,6 +121,7 @@ survey.header.fieldset.answers = R\u00e9ponses
 
 survey.answer.image.select = Choisir une image
 survey.answer.image.delete = Supprimer cette image
+survey.answer.image.open.newTab = Ouvrir l'image dans un nouvel onglet
 
 survey.creation.resultMode = Publication des r\u00e9sultats
 survey.creation.resultMode.1 = Imm\u00e9diate apr\u00e8s participation

survey/survey-configuration/src/main/config/properties/org/silverpeas/survey/multilang/surveyBundle_de.properties

@@ -97,10 +97,17 @@ survey.confirmUpdatePoll = Achtung! \u00c4ndern diese Umfrage l\u00f6scht alle a
 survey.surveyAnonymous = Anonyme Umfrage
 survey.pollAnonymous = Anonyme Abstimmung
 survey.choice = Ansicht
-survey.C = klassich
-survey.D = Detailansicht
+survey.result.seeVoters.help=Siehe die Liste der W\u00e4hler
+survey.result.seeVoters.clickHelp=(Klicken Sie hier, um die Liste der W\u00e4hler zu sehen)
+survey.result.suggestion.help=Siehe Details der Antworten
+survey.result.view.classic = klassich
+survey.result.view.detail = Detailansicht
+survey.result.view.graphical=Grafische Darstellung
+survey.result.view.horizontal-bar=Horizontaler Balken
 survey.participationOf = Teilnahme von
 survey.results = Ergebnisse
+survey.results.print.help=Mit der Aktion <span class="survey-help-action">Drucken</span> k\u00f6nnen Sie das Druckdialogfeld des Browsers \u00f6ffnen und die angezeigten Ergebnisse ausdrucken oder als PDF speichern. Denken Sie beim Drucken Ihrer Grafiken daran, die Option <span class="survey-help-action">Hintergr\u00fcnde drucken</span> anzukreuzen.
+survey.results.export.help=Mit der Aktion <span class="survey-help-action">Exportieren</span> erhalten Sie die visualisierten Ergebnisse in Form einer CSV-Datei zum Herunterladen.
 
 survey.update= \u00c4ndern
 survey.update.succeed=\u00c4nderungen wurden erfolgreich gespeichert.
@@ -115,6 +122,7 @@ survey.header.fieldset.answers = Answers
 
 survey.answer.image.select = Select an image
 survey.answer.image.delete = Remove this image
+survey.answer.image.open.newTab=Das Bild in einem neuen Tab \u00f6ffnen
 
 survey.creation.resultMode = Ver\u00f6ffentlichung der Ergebnisse
 survey.creation.resultMode.1 = Unmittelbar nach der Teilnahme

survey/survey-configuration/src/main/config/properties/org/silverpeas/survey/multilang/surveyBundle_en.properties

@@ -97,10 +97,17 @@ survey.confirmUpdatePoll = Warning! Modifying this poll will delete all recorded
 survey.surveyAnonymous = Anonymous survey
 survey.pollAnonymous = Anonymous vote
 survey.choice = look view
-survey.C = Classic
-survey.D = Detailed
+survey.result.seeVoters.help=See the list of voters
+survey.result.seeVoters.clickHelp=(Click to see the list of voters)
+survey.result.suggestion.help=See details of answers
+survey.result.view.classic = Classic
+survey.result.view.detail = Detailed
+survey.result.view.graphical=Graphical
+survey.result.view.horizontal-bar=Horizontal bar
 survey.participationOf = Participation of
 survey.results = Results
+survey.results.print.help=The <span class="survey-help-action">print</span> action is used to open the browser's print dialog box and print or save as a PDF the results viewed. When printing your graphics, remember to check the <span class="survey-help-action">Print backgrounds</span> option.
+survey.results.export.help=The <span class="survey-help-action">export</span> action is used to obtain the visualised results in the form of a CSV file for downloading.
 
 survey.update=Update
 survey.update.succeed=Changes have been saved successfully.
@@ -115,6 +122,7 @@ survey.header.fieldset.answers = Answers
 
 survey.answer.image.select = Select an image
 survey.answer.image.delete = Remove this image
+survey.answer.image.open.newTab=Open the image in a new tab
 
 survey.creation.resultMode = Publication of results
 survey.creation.resultMode.1 = Immediately after participation

survey/survey-configuration/src/main/config/properties/org/silverpeas/survey/multilang/surveyBundle_fr.properties

@@ -82,7 +82,7 @@ PollingStation.revote = Revoter
 Survey.revote = Participer de nouveau \u00e0 l'enqu\u00eate
 SurveyNbParticipations = Nombre de participations
 survey.NoResponse = au moins une r\u00e9ponse doit \u00eatre selectionn\u00e9e.
-custom.st.notification.subject=\u00C0 propos du sondage $surveyName$
+custom.st.notification.subject=\u00c0 propos du sondage $surveyName$
 # notification
 survey.imageGallery = Image associ\u00e9e
 
@@ -97,10 +97,17 @@ survey.confirmUpdatePoll = Attention, modifier cette consultation supprimera tou
 survey.surveyAnonymous = Enqu\u00eate anonyme
 survey.pollAnonymous = Vote anonyme
 survey.choice = vue
-survey.C = Classique
-survey.D = D\u00e9taill\u00e9e
+survey.result.seeVoters.help=Voir la liste des votants
+survey.result.seeVoters.clickHelp=(Cliquer pour voir la liste des votants)
+survey.result.suggestion.help = Voir le d\u00e9tail des r\u00e9ponses
+survey.result.view.classic = Classique
+survey.result.view.detail = D\u00e9taill\u00e9e
+survey.result.view.graphical = Graphique
+survey.result.view.horizontal-bar=Barre horizontale
 survey.participationOf = Participation(s) de
 survey.results = R\u00e9sultats
+survey.results.print.help=L'action <span class="survey-help-action">Imprimer</span> permet d'ouvrir la bo\u00eete de dialogue d'impression du navigateur et d'imprimer ou enregistrer en PDF les r\u00e9sultats visualis\u00e9s. Pour l'impression de vos graphiques, pensez \u00e0 cocher l'option <span class="survey-help-action">Imprimer les arri\u00e8re-plans</span>
+survey.results.export.help=L'action <span class="survey-help-action">Exporter</span> permet d'obtenir les r\u00e9sultats visualis\u00e9s sous la forme d'un fichier CSV \u00e0 t\u00e9l\u00e9charger.
 
 survey.update=Modifier
 survey.update.succeed=Les modifications r\u00e9alis\u00e9es sur les questions ont bien \u00e9t\u00e9 enregistr\u00e9es.
@@ -115,6 +122,7 @@ survey.header.fieldset.answers = R\u00e9ponses
 
 survey.answer.image.select = Choisir une image
 survey.answer.image.delete = Supprimer cette image
+survey.answer.image.open.newTab = Ouvrir l'image dans un nouvel onglet
 
 survey.creation.resultMode = Publication des r\u00e9sultats
 survey.creation.resultMode.1 = Imm\u00e9diate apr\u00e8s participation

survey/survey-war/pom.xml

@@ -13,6 +13,10 @@
   <name>Survey Web Application</name>
 
   <dependencies>
+    <dependency>
+      <groupId>com.fasterxml.jackson.module</groupId>
+      <artifactId>jackson-module-jaxb-annotations</artifactId>
+    </dependency>
     <dependency>
       <groupId>org.silverpeas.components.survey</groupId>
       <artifactId>silverpeas-survey</artifactId>

survey/survey-war/src/main/java/org/silverpeas/components/survey/control/DisplayResultView.java

@@ -0,0 +1,129 @@
+/*
+ * Copyright (C) 2000 - 2023 Silverpeas
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * As a special exception to the terms and conditions of version 3.0 of
+ * the GPL, you may redistribute this Program in connection with Free/Libre
+ * Open Source Software ("FLOSS") applications as described in Silverpeas's
+ * FLOSS exception.  You should have received a copy of the text describing
+ * the FLOSS exception, and it is also available here:
+ * "https://www.silverpeas.org/legal/floss_exception.html"
+ *
+ * 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 Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
+
+package org.silverpeas.components.survey.control;
+
+import org.silverpeas.core.util.StringUtil;
+
+import java.util.List;
+import java.util.stream.Stream;
+
+import static java.util.stream.Collectors.toList;
+
+/**
+ * Definition of the different views of result page a survey can display.
+ * @author silveryocha
+ */
+public enum DisplayResultView {
+  CLASSIC_GRAPHICAL(Constants.CLASSIC_MAIN_VIEW, Constants.GRAPHICAL_SEC_LEVEL_VIEW),
+  CLASSIC_HORIZONTAL_BAR(Constants.CLASSIC_MAIN_VIEW, Constants.HORIZONTAL_BAR_SEC_LEVEL_VIEW),
+  DETAIL(Constants.DETAIL_MAIN_VIEW, StringUtil.EMPTY);
+
+  private final String mainLevelView;
+  private final String secondaryLevelView;
+
+  DisplayResultView(final String mainView, final String secondaryLevelView) {
+    this.mainLevelView = mainView;
+    this.secondaryLevelView = secondaryLevelView;
+  }
+
+  /**
+   * Gets the {@link DisplayResultView} instance that matches the specified result view name or code.
+   * @param name the enum name or the full name of a predefined result view in survey component.
+   * @return the {@link DisplayResultView} instance having as name the specified role name or
+   * {@link DisplayResultView#DETAIL} if no such role exists.
+   */
+  public static DisplayResultView fromString(String name) {
+    if (StringUtil.isNotDefined(name)) {
+      return DETAIL;
+    }
+    final String trimmedName = name.trim();
+    return Stream.of(values())
+        .filter(r -> r.name().equalsIgnoreCase(trimmedName) || r.getIdentifier().equals(trimmedName))
+        .findFirst()
+        .orElse(DETAIL);
+  }
+
+  /**
+   * Gets a list of {@link DisplayResultView} instance from a main view part of identifier.
+   * @param mainView a main view part of identifier.
+   * @return a list of {@link DisplayResultView} instance.
+   */
+  public static List<DisplayResultView> fromMainViewOnly(String mainView) {
+    final String trimmedMainCode = mainView.trim();
+    return Stream.of(values())
+        .filter(r -> r.mainLevelView.equalsIgnoreCase(trimmedMainCode))
+        .collect(toList());
+  }
+
+  /**
+   * The code of the view is a combination of the main and sub view separated by an underscore.
+   * @return a code as string.
+   */
+  public String getIdentifier() {
+    return mainLevelView + "_" + secondaryLevelView;
+  }
+
+  /**
+   * Gets the main view.
+   * @return a string.
+   */
+  public String getMainView() {
+    return mainLevelView;
+  }
+
+  /**
+   * Gets the secondary level view.
+   * @return a string.
+   */
+  public String getSecondaryLevelView() {
+    return secondaryLevelView;
+  }
+
+  /**
+   * Gets the bundle key of main view.
+   * @return a string representing a bundle key.
+   */
+  public String getMainViewBundleKey() {
+    return String.format("survey.result.view.%s", mainLevelView);
+  }
+
+  /**
+   * Gets the bundle key of secondary level view.
+   * @return a string representing a bundle key.
+   */
+  public String getSecondaryViewBundleKey() {
+    return String.format("survey.result.view.%s", secondaryLevelView);
+  }
+
+  public static class Constants {
+    public static final String CLASSIC_MAIN_VIEW = "classic";
+    public static final String DETAIL_MAIN_VIEW = "detail";
+    public static final String GRAPHICAL_SEC_LEVEL_VIEW = "graphical";
+    public static final String HORIZONTAL_BAR_SEC_LEVEL_VIEW = "horizontal-bar";
+
+    private Constants() {
+    }
+  }
+}

survey/survey-war/src/main/java/org/silverpeas/components/survey/control/SurveySessionController.java

@@ -86,12 +86,14 @@
 import java.util.List;
 import java.util.Map;
 
+import static org.silverpeas.components.survey.control.DisplayResultView.*;
 import static org.silverpeas.core.pdc.pdc.model.PdcClassification.aPdcClassificationOfContent;
 
 /**
  * This class contains business layer of survey component
  */
 public class SurveySessionController extends AbstractComponentSessionController {
+  private static final long serialVersionUID = -8522567628476990017L;
 
   private static final String IMAGES_SUB_DIRECTORY_KEY = "imagesSubDirectory";
   private static final String ACTION_PARAM = "Action";
@@ -118,6 +120,7 @@ public class SurveySessionController extends AbstractComponentSessionController
   private boolean hasAlreadyParticipated = false;
   public static final String COOKIE_NAME = "surpoll";
   private List<PdcPosition> newSurveyPositions = null;
+  private DisplayResultView displayResultView = DisplayResultView.fromString(null);
 
   /**
    * Creates new sessionClientController
@@ -1206,6 +1209,40 @@ public boolean isDisplayCommentsEnabled(String userProfile, String userId) {
             || DISPLAY_COMMENTS_FOR_ALL.equals(value));
   }
 
+  /**
+   * Gets the display result view.
+   * @return the {@link DisplayResultView} instance representing the result vew.
+   */
+  public DisplayResultView getDisplayResultView() {
+    return displayResultView;
+  }
+
+  /**
+   * Sets the display result view according to given identifier or main view.
+   * <p>
+   *   The result view is set into session.
+   * </p>
+   * @param survey the representation of the survey.
+   * @param identifierOrMainView the name (or full name) or the main part of name of a view.
+   * @return the {@link DisplayResultView} instance.
+   */
+  public DisplayResultView setSurveyResultViewFromIdentifierOrMainView(
+      final QuestionContainerDetail survey, final String identifierOrMainView) {
+    final List<DisplayResultView> potentialViews = fromMainViewOnly(identifierOrMainView);
+    if (!potentialViews.isEmpty()) {
+      displayResultView = potentialViews.stream()
+          .filter(displayResultView::equals)
+          .findFirst()
+          .orElseGet(() -> potentialViews.get(0));
+    } else {
+      displayResultView = fromString(identifierOrMainView);
+    }
+    if (DETAIL.equals(displayResultView) && survey.getHeader().getNbVoters() > 50) {
+      displayResultView = CLASSIC_GRAPHICAL;
+    }
+    return displayResultView;
+  }
+
   private static class Parameters {
 
     private String action;

survey/survey-war/src/main/java/org/silverpeas/components/survey/servlets/SurveyRequestRouter.java

@@ -166,9 +166,13 @@ public String getDestination(String function, SurveySessionController surveySC,
         String surveyId = request.getParameter(SURVEY_ID);
         destination = rootDest + "surveyUpdate.jsp?Action=UpdateSurveyHeader&SurveyId=" + surveyId;
       } else if ("ViewListResult".equals(function)) {
+        final QuestionContainerDetail sessionSurvey = surveySC.getSessionSurvey();
+        if (sessionSurvey.getHeader().isAnonymous()) {
+          throwHttpForbiddenError();
+        }
         String answerId = request.getParameter("AnswerId");
         request.setAttribute("Users", surveySC.getUsersByAnswer(answerId));
-        request.setAttribute(SURVEY, surveySC.getSessionSurvey());
+        request.setAttribute(SURVEY, sessionSurvey);
         request.setAttribute(PROFILE, flag);
         destination = rootDest + "answerResult.jsp";
       } else if ("ViewAllUsers".equals(function)) {
@@ -328,16 +332,6 @@ private void setCommonDataToDisplayResult(String surveyId, HttpServletRequest re
       SurveySessionController surveySC) throws SurveyException{
     if (StringUtil.isDefined(surveyId)) {
       request.setAttribute(LIST_DOCUMENT, surveySC.getAllSynthesisFile(surveyId));
-
-      String resultDisplayMode = request.getParameter("Choice");
-      if (StringUtil.isDefined(resultDisplayMode)) {
-        request.setAttribute("ResultDisplayMode", resultDisplayMode);
-      } else {
-        request.setAttribute("ResultDisplayMode", "D");
-        if (surveySC.getSurvey(surveyId).getHeader().getNbVoters() > 50) {
-          request.setAttribute("ResultDisplayMode", "C");
-        }
-      }
     }
   }
 }