Add compatibility mode warnings for legacy servlet configurations

lucee · Mar 5, 2025 · fac351e · fac351e
1 parent f8a4be9
commit fac351e
Show file tree

Hide file tree

Showing 7 changed files with 57 additions and 8 deletions.
diff --git a/core/src/main/cfml/context/admin/overview.cfm b/core/src/main/cfml/context/admin/overview.cfm
@@ -49,14 +49,31 @@ Redirect to entry --->
 <cfif cgi.request_method EQ "POST" and error.message EQ "" and form.mainAction NEQ "none">
 	<cflocation url="#request.self#" addtoken="no">
 </cfif>
-
+<cfscript>
+function checkServletEnv() {
+	var pc=getPageContext();
+	var factory=pc.getCFMLFactory();
+	var servlet=factory.getServlet();
+	var servletName=servlet.getClass().getName();
+	
+	if("lucee.loader.servlet.javax.HttpServletJakarta" == servletName) {
+		return "Lucee is running in Java EE/javax compatibility mode. For optimal performance, consider upgrading your server to a Jakarta EE environment (Tomcat 10, Jetty 11, Undertow 3.0, Payara 6, WildFly 30). While compatibility mode works, native Jakarta EE support offers better performance and future compatibility.";
+	}
+	
+	if("lucee.loader.servlet.CFMLServlet" == servletName) {
+		return "The deprecated [lucee.loader.servlet.CFMLServlet] is being used. Please configure your web server to use [lucee.loader.servlet.javax.CFMLServlet] for Java EE/javax environments or [lucee.loader.servlet.jakarta.CFMLServlet] for Jakarta EE environments instead.";
+	}
+}
+msg=checkServletEnv();
+</cfscript>
+<cfif not isNull(msg)>
+<div class="warning nofocus">
+	<cfoutput>#msg#</cfoutput>
+</div>
+</cfif>
 <cfset lucee_version = "UNKNOWN">
 <cfinclude template="version.cfm">
-<!--- <cfif lucee_version neq server.lucee.version && lucee_version neq "UNKNOWN">
-	<cfoutput>
-		<div class="error">Warning Lucee Admin was compiled with version #lucee_version#?</div>
-	</cfoutput>
-</cfif>--->
+
 
 <!---
 Error Output --->

diff --git a/loader/build.xml b/loader/build.xml
@@ -2,7 +2,7 @@
 <project default="core" basedir="." name="Lucee" 
   xmlns:resolver="antlib:org.apache.maven.resolver.ant">
 
-  <property name="version" value="7.0.0.117-SNAPSHOT"/>
+  <property name="version" value="7.0.0.118-SNAPSHOT"/>
 
   <taskdef uri="antlib:org.apache.maven.resolver.ant" resource="org/apache/maven/resolver/ant/antlib.xml">
     <classpath>

diff --git a/loader/pom.xml b/loader/pom.xml
@@ -3,7 +3,7 @@
 
   <groupId>org.lucee</groupId>
   <artifactId>lucee</artifactId>
-  <version>7.0.0.117-SNAPSHOT</version>
+  <version>7.0.0.118-SNAPSHOT</version>
   <packaging>jar</packaging>
 
   <name>Lucee Loader Build</name>

diff --git a/loader/src/main/java/lucee/loader/servlet/CFMLServlet.java b/loader/src/main/java/lucee/loader/servlet/CFMLServlet.java
@@ -18,8 +18,28 @@
  **/
 package lucee.loader.servlet;
 
+import javax.servlet.ServletConfig;
+import javax.servlet.ServletException;
+
+import lucee.loader.util.Util;
+
+@Deprecated
 public class CFMLServlet extends lucee.loader.servlet.javax.CFMLServlet {
 
 	private static final long serialVersionUID = 1389465039826124601L;
 
+	static final String ERROR_MESSAGE = "The Servlet [lucee.loader.servlet.CFMLServlet] is deprecated. "
+			+ "Please use [lucee.loader.servlet.javax.CFMLServlet] for Java EE/javax environments (Tomcat 9, Jetty 9, Undertow 2.0, JBoss 7, WebSphere Liberty 19) "
+			+ "or [lucee.loader.servlet.jakarta.CFMLServlet] for Jakarta EE environments (Tomcat 10, Jetty 11, Undertow 3.0, Payara 6, WildFly 30).";
+
+	@Override
+	@Deprecated
+	public void init(final ServletConfig sg) throws ServletException {
+		super.init(sg);
+		if (!engine.getCastUtil().toBooleanValue(Util.getSystemPropOrEnvVar("lucee.suppress.servlet.warning", null), false)) {
+			engine.getCFMLEngineFactory().log(org.apache.felix.resolver.Logger.LOG_WARNING, ERROR_MESSAGE);
+			System.err.println(ERROR_MESSAGE);
+		}
+	}
+
 }
diff --git a/loader/src/main/java/lucee/loader/servlet/FileServlet.java b/loader/src/main/java/lucee/loader/servlet/FileServlet.java
@@ -18,6 +18,7 @@
  **/
 package lucee.loader.servlet;
 
+@Deprecated
 public class FileServlet extends lucee.loader.servlet.javax.FileServlet {
 
 	private static final long serialVersionUID = 8145868472337105470L;

diff --git a/loader/src/main/java/lucee/loader/servlet/RestServlet.java b/loader/src/main/java/lucee/loader/servlet/RestServlet.java
@@ -18,6 +18,7 @@
  **/
 package lucee.loader.servlet;
 
+@Deprecated
 public class RestServlet extends lucee.loader.servlet.javax.RestServlet {
 
 	private static final long serialVersionUID = 6675880638570226829L;

diff --git a/loader/src/main/java/lucee/loader/servlet/javax/CFMLServlet.java b/loader/src/main/java/lucee/loader/servlet/javax/CFMLServlet.java
@@ -24,13 +24,19 @@
 import javax.servlet.ServletException;
 import javax.servlet.http.HttpServletRequest;
 import javax.servlet.http.HttpServletResponse;
+
 import lucee.loader.engine.CFMLEngineFactory;
+import lucee.loader.util.Util;
 
 public class CFMLServlet extends AbsServlet {
 
 	private static final long serialVersionUID = -1878214660283329587L;
 	private HttpServletJakarta myself;
 
+	private static final String EMULATION_MESSAGE = "Lucee is running in Java EE/javax compatibility mode. "
+			+ "For optimal performance, consider upgrading your server to a Jakarta EE environment (Tomcat 10, Jetty 11, Undertow 3.0, Payara 6, WildFly 30). "
+			+ "While compatibility mode works, native Jakarta EE support offers better performance and future compatibility.";
+
 	@Override
 	public void init(final ServletConfig sg) throws ServletException {
 		super.init(sg);
@@ -44,6 +50,10 @@ public void init(final ServletConfig sg) throws ServletException {
 		catch (jakarta.servlet.ServletException e) {
 			throw new ServletException(e);
 		}
+		if (!engine.getCastUtil().toBooleanValue(Util.getSystemPropOrEnvVar("lucee.suppress.servlet.warning", null), false)) {
+			engine.getCFMLEngineFactory().log(org.apache.felix.resolver.Logger.LOG_WARNING, EMULATION_MESSAGE);
+			System.err.println(EMULATION_MESSAGE);
+		}
 	}
 
 	@Override