From 95ceb82eed82bcb379917c113714c633b5fb102a Mon Sep 17 00:00:00 2001
From: tim holloway <timh@mousetech.com>
Date: Sat, 3 Feb 2024 20:58:59 -0500
Subject: [PATCH] Better session timeout handling for detail edit.

---
 pom.xml                                       | 12 +--
 .../com/mousetech/gourmetj/CookieBean.java    | 11 +++
 .../java/com/mousetech/gourmetj/JSFUtils.java | 16 ++++
 .../gourmetj/SpringPrimeFacesApplication.java |  4 +-
 .../com/mousetech/gourmetj/UserSession.java   | 14 ----
 .../META-INF/resources/detailEdit.xhtml       | 78 +++++++++++--------
 6 files changed, 82 insertions(+), 53 deletions(-)

diff --git a/pom.xml b/pom.xml
index ea79cd7..5fa77c8 100644
--- a/pom.xml
+++ b/pom.xml
@@ -122,12 +122,14 @@
             <artifactId>spring-boot-starter-web</artifactId>
         </dependency>
 
-        <!--        <dependency>
-            <groupId>jakarta.servlet.jsp</groupId>
-            <artifactId>jakarta.servlet.jsp-api</artifactId>
-            <version>2.3.3</version>
+        <!-- https://mvnrepository.com/artifact/jakarta.servlet/jakarta.servlet-api -->
+        <dependency>
+            <groupId>jakarta.servlet</groupId>
+            <artifactId>jakarta.servlet-api</artifactId>
+            <version>6.0.0</version>
             <scope>provided</scope>
-        </dependency>-->
+        </dependency>
+
         <!--        <dependency>
             <groupId>jakarta.servlet</groupId>
             <artifactId>jstl</artifactId>
diff --git a/src/main/java/com/mousetech/gourmetj/CookieBean.java b/src/main/java/com/mousetech/gourmetj/CookieBean.java
index 33e92d7..2f29af4 100644
--- a/src/main/java/com/mousetech/gourmetj/CookieBean.java
+++ b/src/main/java/com/mousetech/gourmetj/CookieBean.java
@@ -124,4 +124,15 @@ public class CookieBean {
 	public void setDisplayListSize(Integer value) {
 		cookieMap.put(KEY_DISPLAY_ROWS, String.valueOf(value));
 	}
+	
+	public void sessionIdleListener() {
+		log.warn("Session Idle Listener fired.");
+		JSFUtils.addWarningMessage("Timeout approaching. Save your work!");
+	}
+
+	public void sessionTimeout() {
+		log.warn("Session Timeout Listener fired.");
+		JSFUtils.logout();
+	}
+
 }
diff --git a/src/main/java/com/mousetech/gourmetj/JSFUtils.java b/src/main/java/com/mousetech/gourmetj/JSFUtils.java
index 1618107..de3d819 100644
--- a/src/main/java/com/mousetech/gourmetj/JSFUtils.java
+++ b/src/main/java/com/mousetech/gourmetj/JSFUtils.java
@@ -12,6 +12,7 @@ import jakarta.faces.context.ExternalContext;
 import jakarta.faces.context.FacesContext;
 import jakarta.faces.context.Flash;
 import jakarta.servlet.http.Cookie;
+import jakarta.servlet.http.HttpSession;
 
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
@@ -148,5 +149,20 @@ public class JSFUtils {
 		getExternalContext().addResponseCookie(name,
 			URLEncoder.encode(value, "UTF-8"),			
 			properties);
+	}
+
+	/**
+	 * Destroy current session, logging user out.
+	 */
+	public static void logout() {
+		log.warn("Logging out session");
+		jakarta.servlet.http.HttpSession session =
+				(HttpSession) getExternalContext().getSession(false);
+		if ( session != null ) {
+			session.invalidate();
+		} else {
+			log.warn("Session did not exist.");
+		}
+		
 	}		
 }
diff --git a/src/main/java/com/mousetech/gourmetj/SpringPrimeFacesApplication.java b/src/main/java/com/mousetech/gourmetj/SpringPrimeFacesApplication.java
index 5d5535c..41e72e0 100644
--- a/src/main/java/com/mousetech/gourmetj/SpringPrimeFacesApplication.java
+++ b/src/main/java/com/mousetech/gourmetj/SpringPrimeFacesApplication.java
@@ -10,18 +10,20 @@ import org.springframework.boot.autoconfigure.domain.EntityScan;
 import org.springframework.boot.web.server.ErrorPage;
 import org.springframework.boot.web.server.ErrorPageRegistrar;
 import org.springframework.boot.web.server.ErrorPageRegistry;
+import org.springframework.boot.web.servlet.ServletComponentScan;
 import org.springframework.boot.web.servlet.ServletContextInitializer;
 import org.springframework.context.annotation.Bean;
 import org.springframework.http.HttpStatus;
 
 @SpringBootApplication
+@ServletComponentScan
 @EntityScan(value = {
 		"com.mousetech.gourmetj.persistence.model" })
 public class SpringPrimeFacesApplication {
 
 	final String errorPage = "/error/error.html";
 	final String error404Page = "/error/error404.html";
-	final String expiredPage = "/error/viewExpired.xhtml";
+	final String expiredPage = "/main.xhtml";
 
 	public static void main(String[] args) {
 		SpringApplication.run(SpringPrimeFacesApplication.class,
diff --git a/src/main/java/com/mousetech/gourmetj/UserSession.java b/src/main/java/com/mousetech/gourmetj/UserSession.java
index ac35ffb..3a3fd45 100644
--- a/src/main/java/com/mousetech/gourmetj/UserSession.java
+++ b/src/main/java/com/mousetech/gourmetj/UserSession.java
@@ -164,20 +164,6 @@ public class UserSession implements Serializable {
 	 */
 	private List<Recipe> shoppingList = new ArrayList<Recipe>();
 
-	/**
-	 * @return the sessionTimeoutInterval, msec
-	 */
-	public long getSessionTimeoutInterval() {
-		return 5000L; //sessionTimeoutInterval;
-	}
-
-	public void sessionIdleListener() {
-		log.warn("Session Idle Listener fired.");
-		JSFUtils.addWarningMessage("Timeout approaching. Save your work!");
-//		PrimeFaces.current()
-//			.executeScript("sessionExpiredConfirmation.show()");
-	}
-
 	public String logoutAction() {
 		log.warn("Session Idle listener logout");
 		return goHome();
diff --git a/src/main/resources/META-INF/resources/detailEdit.xhtml b/src/main/resources/META-INF/resources/detailEdit.xhtml
index 45e9501..d62e415 100644
--- a/src/main/resources/META-INF/resources/detailEdit.xhtml
+++ b/src/main/resources/META-INF/resources/detailEdit.xhtml
@@ -15,13 +15,14 @@
             <h:outputScript name="js/scrolltable.js" />
             <style>
 .deDescl {
-    width: 15em;
-    text-align: left;
-
+	width: 15em;
+	text-align: left;
 }
+
 .deDescr {
-    text-align: left;
+	text-align: left;
 }
+
 .ingSel {
 	width: 3em;
 	text-align: center;
@@ -54,7 +55,9 @@
                         <p:tab id="overviewTab"
                             title="Description"
                         >
-                            <p:panelGrid columns="2" columnClasses="deDescl, deDescr">
+                            <p:panelGrid columns="2"
+                                columnClasses="deDescl, deDescr"
+                            >
                                 <f:facet name="header">Description</f:facet>
                                 <p:outputLabel for="@next"
                                     value="Title"
@@ -149,13 +152,15 @@
                                     rows="10" cols="45"
                                     value="#{recipeDetailBean.recipe.description}"
                                 />
-                                </p:panelGrid>
-                                <p:panel id="picPanel">
-                                    <img id="bigPix"
-                                        src="/img/picture/?dt=#{recipeDetailBean.currentTime}"
-                                    />
-                                </p:panel>
-                                <p:panelGrid id="picButtonPanel" columns="2">
+                            </p:panelGrid>
+                            <p:panel id="picPanel">
+                                <img id="bigPix"
+                                    src="/img/picture/?dt=#{recipeDetailBean.currentTime}"
+                                />
+                            </p:panel>
+                            <p:panelGrid id="picButtonPanel"
+                                columns="2"
+                            >
                                 <p:fileUpload id="ctlUpload"
                                     label="Upload Image"
                                     listener="#{recipeDetailBean.ajaxUploadImage}"
@@ -165,14 +170,14 @@
                                     auto="true"
                                     sizeLimit="1000000"
                                     allowTypes="/(\.|\/)(gif|jpe?g|png|webp)$/"
-                                    />
+                                />
                                 <p:commandButton id="ctlDelImg"
                                     value="Delete Image"
-                                        action="#{recipeDetailBean.ajaxDeleteImage}"
-                                        update="picPanel"
-                                        immediate="true"
-                                    />
-                                </p:panelGrid>
+                                    action="#{recipeDetailBean.ajaxDeleteImage}"
+                                    update="picPanel"
+                                    immediate="true"
+                                />
+                            </p:panelGrid>
                         </p:tab>
                         <p:tab id="ingredientsTab"
                             title="Ingredients"
@@ -396,23 +401,28 @@
                         action="recipeDetails.jsf"
                     />
                     <p:commandButton id="doHome" value="Home"
-                        icon="ui-icon-home"
-                        ajax="false" immediate="true"
-                        action="main.jsf"
-                    />                    
+                        icon="ui-icon-home" ajax="false"
+                        immediate="true" action="main.jsf"
+                    />
                 </h:form>
             </p:panel>
-            <!--  -->
-            <p:growl id="growl" showDetail="true" />
+            <!--  Note timeouts  must be less than
+                     session timeout in application properties-->
+            <p:growl id="growl" showDetail="true" sticky="true" />
             <h:form id="frmTimeout">
-               <p:idleMonitor
-                  timeout="#{userSession.sessionTimeoutInterval}"
-               >
-                  <p:ajax id="ajaxIdle" event="idle"
-                    listener="#{userSession.sessionIdleListener}"
-                    update="growl"
-                  />
-               </p:idleMonitor>
+                <p:idleMonitor timeout="1500000">
+                    <p:ajax id="ajaxIdle" event="idle"
+                        listener="#{cookieBean.sessionIdleListener}"
+                        update="growl"
+                    />
+                </p:idleMonitor>
+                <p:idleMonitor timeout="1900000">
+                    <p:ajax id="ajaxIdle" event="idle"
+                        listener="#{cookieBean.sessionTimeout}"
+                        update="growl"
+                        oncomplete="window.location='#{request.contextPath}/main.jsf'"
+                    />
+                </p:idleMonitor>
             </h:form>
             <!--  -->
             <p:dialog id="addGroupDlg" widgetVar="addGroupDlg">
@@ -444,7 +454,9 @@
             <p:dialog id="editShopcatDlg"
                 widgetVar="editShopcatDlg"
             >
-                <ui:include src="/WEB-INF/layout/dialog/editShopcat.xhtml" />
+                <ui:include
+                    src="/WEB-INF/layout/dialog/editShopcat.xhtml"
+                />
             </p:dialog>
         </ui:define>
     </ui:composition>