Merge pull request #360 from icatproject/move-checkjpql

Move checkJPQL out of GateKeeper

Author: ajkyffin

src/main/java/org/icatproject/core/entity/Rule.java

@@ -27,6 +27,7 @@
 import org.icatproject.core.oldparser.OldTokenizer;
 import org.icatproject.core.parser.ParserException;
 import org.icatproject.core.parser.RuleWhat;
+import org.icatproject.core.utils.JpqlChecker;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
@@ -146,7 +147,7 @@ private void fixup(EntityManager manager, GateKeeper gateKeeper) throws IcatExce
 			logger.debug("New style rule: " + query);
 		} else {
 			/* This should be pure JPQL so can check it */
-			gateKeeper.checkJPQL(query);
+			JpqlChecker.checkJPQL(query, manager);
 		}
 
 		RuleWhat rw;

src/main/java/org/icatproject/core/manager/EntityBeanManager.java

@@ -89,6 +89,7 @@
 import org.icatproject.core.parser.SearchQuery;
 import org.icatproject.core.parser.Token;
 import org.icatproject.core.parser.Tokenizer;
+import org.icatproject.core.utils.JpqlChecker;
 import org.icatproject.utils.IcatSecurity;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
@@ -1023,7 +1024,7 @@ private EntitySetResult getEntitySet(String userId, String query, EntityManager
 					sb.append(token.getValue());
 					token = input.consume();
 				}
-				gateKeeper.checkJPQL(sb.toString());
+				JpqlChecker.checkJPQL(sb.toString(), manager);
 
 			} catch (ParserException e1) {
 				throw new IcatException(IcatException.IcatExceptionType.INTERNAL,

src/main/java/org/icatproject/core/manager/GateKeeper.java

@@ -15,8 +15,6 @@
 import java.util.concurrent.Executors;
 import java.util.concurrent.Future;
 import java.util.concurrent.TimeUnit;
-import java.util.regex.Matcher;
-import java.util.regex.Pattern;
 
 import jakarta.annotation.PostConstruct;
 import jakarta.annotation.PreDestroy;
@@ -27,7 +25,6 @@
 import jakarta.json.JsonObject;
 import jakarta.json.JsonValue;
 import jakarta.persistence.EntityManager;
-import jakarta.persistence.PersistenceContext;
 import jakarta.persistence.TypedQuery;
 
 import org.apache.http.client.methods.CloseableHttpResponse;
@@ -65,12 +62,6 @@ public int compare(String o1, String o2) {
 		}
 	};
 
-	private final static Pattern tsRegExp = Pattern
-			.compile("\\{\\s*ts\\s+\\d{4}-\\d{2}-\\d{2}\\s+\\d{2}:\\d{2}:\\d{2}\\s*\\}");
-
-	@PersistenceContext(unitName = "icat")
-	private EntityManager gateKeeperManager;
-
 	private final Logger logger = LoggerFactory.getLogger(GateKeeper.class);
 	Marker fatal = MarkerFactory.getMarker("FATAL");
 
@@ -121,26 +112,6 @@ public boolean allowed(Relationship r) {
 		return false;
 	}
 
-	public void checkJPQL(String query) throws IcatException {
-
-		Matcher m = tsRegExp.matcher(query);
-
-		query = m.replaceAll(" CURRENT_TIMESTAMP ");
-		try {
-			gateKeeperManager.createQuery(query);
-		} catch (Exception e) {
-			m.reset();
-			if (m.find()) {
-				throw new IcatException(IcatExceptionType.BAD_PARAMETER,
-						"Timestamp literals have been replaced... " + e.getMessage());
-			} else {
-				throw new IcatException(IcatExceptionType.BAD_PARAMETER, e.getMessage());
-			}
-
-		}
-
-	}
-
 	@PreDestroy()
 	private void exit() {
 		logger.info("GateKeeper closing down");

src/main/java/org/icatproject/core/utils/JpqlChecker.java

@@ -0,0 +1,35 @@
+package org.icatproject.core.utils;
+
+import java.util.regex.Matcher;
+import java.util.regex.Pattern;
+
+import jakarta.persistence.EntityManager;
+
+import org.icatproject.core.IcatException;
+import org.icatproject.core.IcatException.IcatExceptionType;
+
+public class JpqlChecker {
+
+	// Pattern that matches the timestamp format accepted by Icat
+	private static final Pattern TS_PATTERN = Pattern.compile("\\{\\s*ts\\s+\\d{4}-\\d{2}-\\d{2}\\s+\\d{2}:\\d{2}:\\d{2}\\s*\\}");
+
+	public static void checkJPQL(String query, EntityManager entityManager) throws IcatException {
+
+		// Icat does not accept the JDBC standard timestamp format (Icat's format is without quotes). Therefore, we
+		// must replace any timestamps before checking whether the query is valid JPQL, because the timestamps will not
+		// be valid JPQL.
+		Matcher m = TS_PATTERN.matcher(query);
+		query = m.replaceAll(" CURRENT_TIMESTAMP ");
+
+		try {
+			entityManager.createQuery(query);
+		} catch (IllegalArgumentException e) {
+			m.reset();
+			if (m.find()) {
+				throw new IcatException(IcatExceptionType.BAD_PARAMETER, "Timestamp literals have been replaced... " + e.getMessage());
+			} else {
+				throw new IcatException(IcatExceptionType.BAD_PARAMETER, e.getMessage());
+			}
+		}
+	}
+}