Issue 29711 analytics matcher layer

dotCMS/src/main/java/com/dotcms/analytics/track/RequestMatcher.java

@@ -0,0 +1,106 @@
+package com.dotcms.analytics.track;
+
+import com.dotmarketing.util.Config;
+import com.dotmarketing.util.RegEX;
+
+import javax.servlet.http.HttpServletRequest;
+import java.io.UnsupportedEncodingException;
+import java.net.URLDecoder;
+import java.util.Objects;
+import java.util.Set;
+
+/**
+ * Matcher to include the tracking for analytics of some request.
+ *
+ * @author jsanca
+ */
+public interface RequestMatcher {
+
+    String CHARSET = Config.getStringProperty("CHARSET", "UTF-8");
+
+    /**
+     * Return true if match the request with the patterns and methods
+     * @param request {@link HttpServletRequest}
+     * @return boolean true if the request match the patterns and methods
+     */
+    default boolean match(final HttpServletRequest request) {
+
+        final Set<String> patterns = getMatcherPatterns();
+        final Set<String> methods  = getAllowedMethods();
+        return  Objects.nonNull(patterns) && !patterns.isEmpty() &&
+                Objects.nonNull(methods) &&  !methods.isEmpty()  &&
+                isAllowedMethod (methods, request.getMethod())   &&
+                match(request, patterns);
+    }
+
+    /**
+     * Match the request with the patterns
+     * @param request {@link HttpServletRequest}
+     * @param patterns Set of patterns
+     * @return boolean true if any of the patterns match the request
+     */
+    default boolean match(final HttpServletRequest request, final Set<String> patterns) {
+
+        final String requestURI = request.getRequestURI();
+        return patterns.stream().anyMatch(pattern -> match(requestURI, pattern));
+    }
+
+    /**
+     * Match the request URI with the pattern
+     * @param requestURI String
+     * @param pattern String
+     * @return boolean true if the pattern match the request URI
+     */
+    default boolean match (final String requestURI, final String pattern) {
+
+        String uftUri = null;
+
+        try {
+
+            uftUri = URLDecoder.decode(requestURI, CHARSET);
+        } catch (UnsupportedEncodingException e) {
+
+            uftUri = requestURI;
+        }
+
+        return RegEX.containsCaseInsensitive(uftUri, pattern.trim());
+    } // match.
+
+    /**
+     * Determinate if the method is allowed
+     * @param methods Set of methods
+     * @param method String current request method
+     * @return boolean true if the method is allowed
+     */
+    default boolean isAllowedMethod(final Set<String> methods, final String method) {
+
+            return methods.contains(method);
+    }
+
+    /**
+     * Returns a set of patterns for the matcher
+     * @return Set by default empty
+     */
+    default Set<String> getMatcherPatterns() {
+
+        return Set.of();
+    }
+
+    /**
+     * Returns the request methods allowed for this matcher.
+     * @return Set by default empty
+     */
+    default Set<String> getAllowedMethods() {
+
+        return Set.of();
+    }
+
+    /**
+     * Return an id for the Matcher, by default returns the class name.
+     * @return
+     */
+    default String getId() {
+
+        return this.getClass().getName();
+    }
+}

dotCMS/src/main/java/com/dotcms/jitsu/EventLogWebInterceptor.java

@@ -3,6 +3,7 @@
 import static javax.ws.rs.core.HttpHeaders.CONTENT_LENGTH;
 import static javax.ws.rs.core.HttpHeaders.CONTENT_TYPE;
 
+import com.dotcms.analytics.track.RequestMatcher;
 import com.dotcms.experiments.business.ExperimentsAPI;
 import com.dotcms.experiments.model.Experiment;
 import com.dotcms.filters.interceptor.Result;
@@ -32,6 +33,7 @@
 import java.io.InputStream;
 import java.io.InputStreamReader;
 import java.nio.charset.StandardCharsets;
+import java.util.concurrent.ConcurrentHashMap;
 import java.util.stream.Collectors;
 import javax.servlet.http.HttpServletRequest;
 import javax.servlet.http.HttpServletResponse;
@@ -47,6 +49,10 @@
 public class EventLogWebInterceptor implements WebInterceptor {
 
     private static final long serialVersionUID = 1L;
+
+    private final Map<String, RequestMatcher> requestMatchersMap = new ConcurrentHashMap<>();
+
+    // this should be translated to matcher and the rest of the pipeline
     private static final String[] PATHS = new String[] {
         "/s/lib.js",
         "/api/v1/event"
@@ -70,6 +76,16 @@ public EventLogWebInterceptor() {
         });
     }
 
+    /**
+     * Add a request matchers
+     * @param requestMatchers
+     */
+    public void addRequestMatcher(final RequestMatcher... requestMatchers) {
+        for (final RequestMatcher matcher : requestMatchers) {
+            requestMatchersMap.put(matcher.getId(), matcher);
+        }
+    }
+
     @Override
     public String[] getFilters() {
         return PATHS;
@@ -79,6 +95,15 @@ public String[] getFilters() {
     public Result intercept(final HttpServletRequest request, final HttpServletResponse response) throws IOException {
         setHeaders(response);
 
+        final Optional<RequestMatcher> matcherOpt = this.anyMatcher(request);
+        if (matcherOpt.isPresent()) {
+
+            Logger.debug(this, ()-> "Matched: " + matcherOpt.get().getId() + " request: " + request.getRequestURI());
+            //fireNextStep(request, response);
+            return Result.SKIP_NO_CHAIN;
+        }
+
+        // I think we have to migrate this to a matcher later
         if ("GET".equals(request.getMethod())) {
             doGet(request, response);
         }
@@ -94,6 +119,13 @@ public Result intercept(final HttpServletRequest request, final HttpServletRespo
         return Result.SKIP_NO_CHAIN;
     }
 
+    private Optional<RequestMatcher> anyMatcher(final HttpServletRequest request) {
+
+        return requestMatchersMap.values().stream()
+                .filter(matcher -> matcher.match(request))
+                .findFirst();
+    }
+
     public void doGet(final HttpServletRequest request, final HttpServletResponse response) throws IOException {
         Logger.info(getClass(), "doGet");
         response.getWriter().append(jitsuLib.get());
@@ -193,4 +225,4 @@ public void setHeaders(final HttpServletResponse response) {
         response.addHeader("access-control-max-age", "86400");
     }
 
-}
+}