Update feedback v4 (#36)

* Updating static fallback files

* Updating version to v5_0_0

* Feedback tool update

* Updating test version, fixing test

* Updating feedback tool with new changes

* minor fixes

* PR fixes

* Fixing French accent

* Fixing test French character

* Update FeedbackAndShareThisPageSample.html

Author: ahmad-shahid

CHANGELOG.md

@@ -5,6 +5,9 @@
 ## v4.0.0
 
 - **SECURITY FIX** Removal of default redirect handlers for "leaving secure site" feature. Leaving secure site feature now relies solely on WET functionality. Unless these redirect handlers were explicitely referenced by client application there should be no impact. (Spring version: removal of endpoint "/gocwebtemplate_leavesecuresiteredirect"; JSP version: removal of action "leavesecuresiteredirect.action")
+- Replacing the 'Report a problem button' with the new Page Feedback tool. The Page Feedback tool is optional and will be hidden unless explicitly enabled and other conditions are met. Please visit the sample pages for more information.
+- [CDTS](https://github.com/wet-boew/cdts-sgdc/) v5.0.0 & [wet-boew](https://github.com/wet-boew/wet-boew) v4.0.70.1
+- Updated static fallback files
 - Bug fixes
 
 ## v3.0.0

gocwebtemplate-core/gocwebtemplate-core-base/src/main/java/goc/webtemplate/Constants.java

@@ -15,7 +15,7 @@ public abstract class Constants {
 
     public static final String WEB_TEMPLATE_DISTRIBUTION_VERSION = "4.0.0";
 
-    public static final String CDTS_DEFAULT_VERSION = "v4_1_0";
+    public static final String CDTS_DEFAULT_VERSION = "v5_0_0";
 
     public static final String STATIC_FALLBACK_FILES_INTERNAL_PATH = "/goc/webtemplate/StaticFallbackFiles";
 

gocwebtemplate-core/gocwebtemplate-core-base/src/main/java/goc/webtemplate/FeedbackLink.java

@@ -0,0 +1,84 @@
+package goc.webtemplate;
+
+import java.io.Serializable;
+
+public class FeedbackLink implements Serializable {
+    private static final long serialVersionUID = 1L;
+
+    private boolean enabled;
+    private String  url;
+    private String  urlFr;
+    private String  text;
+    private String  textFr;
+    private String  theme;
+    private String  section;
+    
+    public FeedbackLink() {
+    }
+    
+    public FeedbackLink(boolean enabled, String url, String urlFr, String text, String textFr, String theme, String section) {
+        this.enabled = enabled;
+        this.url = url;
+        this.urlFr = urlFr;
+        this.text = text;
+        this.textFr = textFr;
+        this.theme = theme;
+        this.section = section;
+    }
+
+    public boolean isEnabled() {
+        return enabled;
+    }
+
+    public void setEnabled(boolean enabled) {
+        this.enabled = enabled;
+    }
+
+    public String getUrl() {
+        return url;
+    }
+
+    public void setUrl(String url) {
+        this.url = url;
+    }
+
+    public String getUrlFr() {
+        return urlFr;
+    }
+
+    public void setUrlFr(String urlFr) {
+        this.urlFr = urlFr;
+    }
+
+    public String getText() {
+        return text;
+    }
+
+    public void setText(String text) {
+        this.text = text;
+    }
+
+    public String getTextFr() {
+        return textFr;
+    }
+
+    public void setTextFr(String textFr) {
+        this.textFr = textFr;
+    }
+
+    public String getTheme() {
+        return theme;
+    }
+
+    public void setTheme(String theme) {
+        this.theme = theme;
+    }
+
+    public String getSection() {
+        return section;
+    }
+
+    public void setSection(String section) {
+        this.section = section;
+    }
+}

gocwebtemplate-core/gocwebtemplate-core-base/src/main/java/goc/webtemplate/component/AbstractCoreBean.java

@@ -15,6 +15,7 @@
 import goc.webtemplate.Constants;
 import goc.webtemplate.ContextualFooter;
 import goc.webtemplate.CustomSearch;
+import goc.webtemplate.FeedbackLink;
 import goc.webtemplate.FooterLink;
 import goc.webtemplate.FooterSection;
 import goc.webtemplate.HeaderMenu;
@@ -37,7 +38,7 @@
 import goc.webtemplate.component.jsonentities.AppTop;
 import goc.webtemplate.component.jsonentities.CDTSEnvironment;
 import goc.webtemplate.component.jsonentities.CDTSEnvironmentList;
-import goc.webtemplate.component.jsonentities.FeedbackLink;
+import goc.webtemplate.component.jsonentities.Feedback;
 import goc.webtemplate.component.jsonentities.Footer;
 import goc.webtemplate.component.jsonentities.IPreFooter;
 import goc.webtemplate.component.jsonentities.PreFooter;
@@ -104,8 +105,13 @@ private enum Themes { GCWEB, GCINTRANET }
     private Link applicationTitle = new Link();
     private IntranetTitle intranetTitle = null;
     private String languageLinkUrl = "";
-    private String feedbackUrl = this.getResourceBundleString("cdn", "goc.webtemplate.feedbackurl");
-    private String feedbackUrlFr = this.getResourceBundleString("cdn", "goc.webtemplate.feedbackurl_fr");
+    private FeedbackLink feedbackLink = new FeedbackLink(Boolean.parseBoolean(this.getResourceBundleString("cdn", "goc.webtemplate.showfeedbacklink")),
+                                            this.getResourceBundleString("cdn", "goc.webtemplate.feedbackurl"),
+                                            this.getResourceBundleString("cdn", "goc.webtemplate.feedbackurl_fr"),
+                                            this.getResourceBundleString("cdn", "goc.webtemplate.feedbacktext"),
+                                            this.getResourceBundleString("cdn", "goc.webtemplate.feedbacktext_fr"),
+                                            this.getResourceBundleString("cdn", "goc.webtemplate.feedbacktheme"),
+                                            this.getResourceBundleString("cdn", "goc.webtemplate.feedbacksection"));
     private List<Link> contactLinks = null;
     private LeavingSecureSiteWarning leavingSecureSiteWarning = new LeavingSecureSiteWarning(
                                             Boolean.parseBoolean(this.getResourceBundleString("cdn", "leavingsecuresitewarning.enabled")),
@@ -120,7 +126,6 @@ private enum Themes { GCWEB, GCINTRANET }
     private boolean showPreContent = Boolean.parseBoolean(this.getResourceBundleString("cdn", "goc.webtemplate.showprecontent"));
     private boolean showPostContent = Boolean.parseBoolean(this.getResourceBundleString("cdn", "goc.webtemplate.showpostcontent"));
     private boolean showLanguageLink = Boolean.parseBoolean(this.getResourceBundleString("cdn", "goc.webtemplate.showlanguagelink"));
-    private boolean showFeedbackLink = Boolean.parseBoolean(this.getResourceBundleString("cdn", "goc.webtemplate.showfeedbacklink"));
     private boolean showSharePageLink = Boolean.parseBoolean(this.getResourceBundleString("cdn", "goc.webtemplate.showsharepagelink"));
     private boolean showFeatures = Boolean.parseBoolean(this.getResourceBundleString("cdn", "goc.webtemplate.showfeatures"));
     private List<Constants.SocialMediaSites> sharePageMediaSites = new ArrayList<Constants.SocialMediaSites>();
@@ -503,7 +508,7 @@ public void setUseSRI(boolean value) {
     }
 
     /**
-     * Returns the version of the CDN files to use to build the page. (e.g v4_1_0)
+     * Returns the version of the CDN files to use to build the page. (e.g v5_0_0)
      *
      * Set at application level via "wettemplate_version" property in cdn.properties,
      * can be overriden programatically.
@@ -524,7 +529,7 @@ public String getTemplateVersion() {
     }
 
     /**
-     * Sets the version of the CDN files to use to build the page. (e.g v4_1_0)
+     * Sets the version of the CDN files to use to build the page. (e.g v5_0_0)
      *
      * Set at application level via "wettemplate_version" property in cdn.properties,
      * can be overriden programatically.
@@ -1043,64 +1048,100 @@ public void setSharePageMediaSites(List<Constants.SocialMediaSites> value) {
      *
      * Set at application level via "goc.webtemplate.showfeedbacklink" property in cdn.properties,
      * can be overriden programatically.
+     * 
+     * * @Depracted Starting with version v4.0.0, use get/setFeedbackLink instead
      */
+    @Deprecated
     public boolean getShowFeedbackLink() {
         this.initializeOnce();
-        return this.showFeedbackLink;
+        return this.feedbackLink.isEnabled();
     }
 
     /**
      * Sets whether the FeedBack link of the footer is to be displayed.
      *
      * Set at application level via "goc.webtemplate.showfeedbacklink" property in cdn.properties,
      * can be overriden programatically.
+     * 
+     * @Depracted Starting with version v4.0.0, use get/setFeedbackLink instead
      */
+    @Deprecated
     public void setShowFeedbackLink(boolean value) {
-        this.showFeedbackLink = value;
+        this.feedbackLink.setEnabled(value);
     }
 
     /**
      * Returns the FeedBack link URL.
      *
      * Set at application level via "goc.webtemplate.feedbackurl" property in cdn.properties,
      * can be overriden programatically.
+     * 
+     * * @Depracted Starting with version v4.0.0, use get/setFeedbackLink instead
      */
+    @Deprecated
     public String getFeedbackUrl() {
         this.initializeOnce();
-        return this.feedbackUrl;
+        return this.feedbackLink.getUrl();
     }
 
     /**
      * Sets the FeedBack link URL.
      *
      * Set at application level via "goc.webtemplate.feedbackurl" property in cdn.properties,
      * can be overriden programatically.
+     * 
+     * * @Depracted Starting with version v4.0.0, use get/setFeedbackLink instead
      */
+    @Deprecated
     public void setFeedbackUrl(String value) {
-        this.feedbackUrl = value;
+        this.feedbackLink.setUrl(value);
     }
 
     /**
      * Returns the french FeedBack link URL.
      *
      * Set at application level via "goc.webtemplate.feedbackurl_fr" property in cdn.properties,
      * can be overriden programatically.
+     * 
+     * * @Depracted Starting with version v4.0.0, use get/setFeedbackLink instead
      */
+    @Deprecated
     public String getFeedbackUrlFr() {
         this.initializeOnce();
-        return this.feedbackUrlFr;
+        return this.feedbackLink.getUrlFr();
     }
 
     /**
      * Sets the french FeedBack link URL.
      *
      * Set at application level via "goc.webtemplate.feedbackurl_fr" property in cdn.properties,
-     * can be overriden programatically.
+     * can be overriden programmatically.
+     * 
+     * * @Depracted Starting with version v4.0.0, use get/setFeedbackLink instead
      */
+    @Deprecated
     public void setFeedbackUrlFr(String value) {
-        this.feedbackUrlFr = value;
+        this.feedbackLink.setUrlFr(value);
+    }
+    
+    /**
+     * Returns the FeedbackLink object used as configuration 
+     *
+     * Configuration can be set at application level in cdn.properties, or set programmatically at runtime.
+     */
+    public FeedbackLink getFeedbackLink() {
+        this.initializeOnce();
+        return this.feedbackLink;
     }
 
+    /**
+     * Sets the FeedbackLink object used as configuration
+     *
+     * Configuration can be set at application level in cdn.properties, or set programattically at runtime.
+     */
+    public void setFeedbackLink(FeedbackLink value) {
+        this.feedbackLink = value;
+    }
 
     /**
      * Returns a unique string to identify a web page. Used by user to identify the screen where an issue occured.
@@ -2013,22 +2054,44 @@ private AppTop buildAppTop() {
         return appTop;
     }
 
+    /**
+     * Builds the Feedback object
+     */
+    private Feedback buildFeedback(FeedbackLink feedbackLink) 
+    {
+        Feedback feedback = new Feedback();
+        feedback.setEnabled(this.feedbackLink.isEnabled());
+
+        Boolean isFrenchCulture = this.getTwoLetterCultureLanguage().toUpperCase().equals(Constants.FRENCH_ACCRONYM.toUpperCase());
+
+        if (!Utility.isNullOrEmpty(this.feedbackLink.getText()) || !Utility.isNullOrEmpty(this.feedbackLink.getSection()) || !Utility.isNullOrEmpty(this.feedbackLink.getTheme()))
+        {
+            feedback.setSection(feedbackLink.getSection());
+            feedback.setTheme(feedbackLink.getTheme());
+            feedback.setText((isFrenchCulture && !Utility.isNullOrEmpty(this.feedbackLink.getTextFr())) ? feedbackLink.getTextFr() : feedbackLink.getText());
+            feedback.setHref((isFrenchCulture && !Utility.isNullOrEmpty(this.feedbackLink.getUrlFr())) ? feedbackLink.getUrlFr() : feedbackLink.getUrl());
+        }
+        else if (!Utility.isNullOrEmpty(this.feedbackLink.getUrl())) 
+        {
+            feedback.setLegacyBtnUrl((isFrenchCulture && !Utility.isNullOrEmpty(this.feedbackLink.getUrlFr())) ? this.feedbackLink.getUrlFr() : this.feedbackLink.getUrl());
+        }
+
+        return feedback;
+    }
+
     /**
      * Builds the "PreFooter" object needed in rendering the CDTS setup JSON
      * (assumes initializeOnce() was called)
      */
     private IPreFooter buildPreFooter(boolean isTransactional, boolean isUnilingualError) {
         if (!isTransactional) {
             if (!isUnilingualError) {
-                return new PreFooter(
+            	return new PreFooter(
                         null, //no need for cdnEnv now that we're using CDTS setup function
                         JsonValueUtils.getNonEmptyString(this.getVersionIdentifier()),
                         this.buildDateModified(),
                         this.showPostContent,
-                        new FeedbackLink(this.showFeedbackLink,
-                                (this.getTwoLetterCultureLanguage().toUpperCase().equals(Constants.ENGLISH_ACCRONYM.toUpperCase()) || Utility.isNullOrEmpty(this.getFeedbackUrlFr()) ?
-                                        this.feedbackUrl:
-                                        this.feedbackUrlFr) ),
+                        buildFeedback(this.getFeedbackLink()),
                         new ShareList(this.showSharePageLink, this.sharePageMediaSites),
                         JsonValueUtils.getNonEmptyString(this.getScreenIdentifier())
                       );
@@ -2042,7 +2105,7 @@ private IPreFooter buildPreFooter(boolean isTransactional, boolean isUnilingualE
                     JsonValueUtils.getNonEmptyString(this.getVersionIdentifier()),
                     this.buildDateModified(),
                     false, //showPostContent,
-                    new FeedbackLink(false, null),
+                    new Feedback(false, null, null, null, null, null),
                     new ShareList(false, null),
                     JsonValueUtils.getNonEmptyString(this.getScreenIdentifier())
                   );