SystemMessage.java

  1. package org.heigit.ors.api.util;

  3. import org.apache.log4j.Logger;
  4. import org.heigit.ors.api.SystemMessageProperties;
  5. import org.heigit.ors.api.requests.isochrones.IsochronesRequest;
  6. import org.heigit.ors.api.requests.matrix.MatrixRequest;
  7. import org.heigit.ors.api.requests.routing.RouteRequest;
  8. import org.heigit.ors.matrix.MatrixMetricsType;
  9. import org.heigit.ors.routing.RoutingProfileType;
  10. import org.heigit.ors.routing.RoutingRequest;
  11. import org.heigit.ors.routing.WeightingMethod;

  13. import java.sql.Timestamp;
  14. import java.time.Instant;
  15. import java.util.*;

  17. public class SystemMessage {
  18.     private static final Logger LOGGER = Logger.getLogger(SystemMessage.class.getName());
  19.     private static List<Message> messages;

  21.     private SystemMessage() {
  22.     }

  24.     public static String getSystemMessage(Object requestObj, SystemMessageProperties messageProperties) {
  25.         if (messages == null) {
  26.             loadMessages(messageProperties);
  27.         }
  28.         if (messages.isEmpty()) {
  29.             return "";
  30.         }
  31.         if (requestObj == null) {
  32.             requestObj = "";
  33.         }
  34.         RequestParams params = new RequestParams();
  35.         // V1
  36.         if (requestObj.getClass() == RoutingRequest.class) {
  37.             extractParams((RoutingRequest) requestObj, params);
  38.         } else if (requestObj.getClass() == org.heigit.ors.matrix.MatrixRequest.class) {
  39.             extractParams((org.heigit.ors.matrix.MatrixRequest) requestObj, params);
  40.         } else if (requestObj.getClass() == org.heigit.ors.isochrones.IsochroneRequest.class) {
  41.             extractParams((org.heigit.ors.isochrones.IsochroneRequest) requestObj, params);
  42.         }
  43.         // V2
  44.         else if (requestObj.getClass() == RouteRequest.class) {
  45.             extractParams((RouteRequest) requestObj, params);
  46.         } else if (requestObj.getClass() == MatrixRequest.class) {
  47.             extractParams((MatrixRequest) requestObj, params);
  48.         } else if (requestObj.getClass() == IsochronesRequest.class) {
  49.             extractParams((IsochronesRequest) requestObj, params);
  50.         }
  51.         return selectMessage(params);
  52.     }

  54.     private static void extractParams(RoutingRequest req, RequestParams params) {
  55.         params.setApiVersion("1");
  56.         params.setApiFormat(req.getResponseFormat());
  57.         params.setRequestService("routing");
  58.         params.setRequestProfiles(RoutingProfileType.getName(req.getSearchParameters().getProfileType()));
  59.         params.setRequestPreferences(WeightingMethod.getName(req.getSearchParameters().getWeightingMethod()));
  60.     }

  62.     private static void extractParams(org.heigit.ors.matrix.MatrixRequest req, RequestParams params) {
  63.         params.setApiVersion("1");
  64.         params.setApiFormat("json");
  65.         params.setRequestService("matrix");
  66.         params.setRequestProfiles(RoutingProfileType.getName(req.getProfileType()));
  67.         params.setRequestPreference(MatrixMetricsType.getMetricsNamesFromInt(req.getMetrics()));
  68.     }

  70.     private static void extractParams(org.heigit.ors.isochrones.IsochroneRequest req, RequestParams params) {
  71.         params.setApiVersion("1");
  72.         params.setApiFormat("geojson");
  73.         params.setRequestService("isochrones");
  74.         params.setRequestProfile(req.getProfilesForAllTravellers());
  75.         params.setRequestPreference(req.getWeightingsForAllTravellers());
  76.     }

  78.     private static void extractParams(RouteRequest req, RequestParams params) {
  79.         params.setApiVersion("2");
  80.         params.setApiFormat(req.getResponseType().toString());
  81.         params.setRequestService("routing");
  82.         params.setRequestProfiles(req.getProfile().toString());
  83.         params.setRequestPreferences(req.hasRoutePreference() ? req.getRoutePreference().toString() : "");
  84.     }

  86.     private static void extractParams(MatrixRequest req, RequestParams params) {
  87.         params.setApiVersion("2");
  88.         params.setApiFormat("json");
  89.         params.setRequestService("matrix");
  90.         params.setRequestProfiles(req.getProfile() != null ? req.getProfile().toString() : "driving-car");
  91.         params.setRequestPreference(req.getMetricsStrings().isEmpty() ? new HashSet<>(List.of("duration")) : req.getMetricsStrings());
  92.     }

  94.     private static void extractParams(IsochronesRequest req, RequestParams params) {
  95.         params.setApiVersion("2");
  96.         params.setApiFormat("geojson");
  97.         params.setRequestService("isochrones");
  98.         params.setRequestProfiles(req.getProfile() != null ? req.getProfile().toString() : "driving-car");
  99.         params.setRequestPreferences(req.hasRangeType() ? req.getRangeType().name() : "TIME");
  100.     }

  102.     private static String selectMessage(RequestParams params) {
  103.         for (Message message : messages) {
  104.             if (message.applicableForRequest(params)) {
  105.                 return message.getText();
  106.             }
  107.         }
  108.         return "";
  109.     }

  111.     private static void loadMessages(SystemMessageProperties messageProperties) {
  112.         messages = new ArrayList<>();

  114.         for (SystemMessageProperties.MessageObject message : messageProperties.getMessages()) {
  115.             try {
  116.                 if (message.isActive()) {
  117.                     List<SystemMessage.Condition> conditions = new ArrayList<>();
  118.                     loadConditionsForMessage(message, conditions);
  119.                     messages.add(new SystemMessage.Message(message.getText(), conditions));
  120.                 }
  121.             } catch (Exception e) {
  122.                 // ignore otherwise incomplete messages entirely
  123.                 LOGGER.warn("Invalid SystemMessage object in ors config %s.".formatted(message.toString().substring(18)));
  124.             }
  125.         }
  126.         AppConfigMigration.loadSystemMessagesfromAppConfig(messages);
  127.         if (!messages.isEmpty())
  128.             LOGGER.info("SystemMessage loaded %s messages.".formatted(messages.size()));
  129.     }

  131.     private static void loadConditionsForMessage(SystemMessageProperties.MessageObject message, List<Condition> conditions) {
  132.         try {
  133.             for (Map<String, String> conditionMap : message.getCondition()) {
  134.                 for (Map.Entry<String, String> condition : conditionMap.entrySet()) {
  135.                     conditions.add(new Condition(condition.getKey(), condition.getValue()));
  136.                 }
  137.             }
  138.         } catch (Exception e) {
  139.             // ignore missing condition block and keep message
  140.             LOGGER.info("Invalid or missing condition in message object.");
  141.         }
  142.     }

  144.     static class Message {
  145.         private final String text;
  146.         private final List<Condition> conditions;

  148.         public Message(String text, List<Condition> conditions) {
  149.             this.text = text;
  150.             this.conditions = conditions;
  151.         }

  153.         public String getText() {
  154.             return text;
  155.         }

  157.         public boolean applicableForRequest(RequestParams params) {
  158.             for (Condition condition : conditions) {
  159.                 if (!condition.fulfilledBy(params)) {
  160.                     return false;
  161.                 }
  162.             }
  163.             return true;
  164.         }
  165.     }

  167.     static class Condition {
  168.         private final String type;
  169.         private final String[] values;

  171.         public Condition(String type, String valuesCSV) {
  172.             this.type = type;
  173.             this.values = valuesCSV.split(",");
  174.         }

  176.         public boolean fulfilledBy(RequestParams params) {
  177.             switch (type) {
  178.                 case "time_before" -> {
  179.                     return new Timestamp(System.currentTimeMillis()).getTime() < Date.from(Instant.parse(this.values[0])).getTime();
  180.                 }
  181.                 case "time_after" -> {
  182.                     return new Timestamp(System.currentTimeMillis()).getTime() > Date.from(Instant.parse(this.values[0])).getTime();
  183.                 }
  184.                 case "api_version" -> {
  185.                     return matchApiVersion(params);
  186.                 }
  187.                 case "api_format" -> {
  188.                     return matchApiFormat(params);
  189.                 }
  190.                 case "request_service" -> {
  191.                     return matchRequestService(params);
  192.                 }
  193.                 case "request_profile" -> {
  194.                     return matchRequestProfiles(params);
  195.                 }
  196.                 case "request_preference" -> {
  197.                     return matchRequestPreferences(params);
  198.                 }
  199.                 default -> // unknown rule
  200.                         LOGGER.warn("Invalid condition set in system_message.");
  201.             }
  202.             return false;
  203.         }

  205.         private boolean matchApiVersion(RequestParams params) {
  206.             for (String val : this.values) {
  207.                 if (params.getApiVersion().equalsIgnoreCase(val)) return true;
  208.             }
  209.             return false;
  210.         }

  212.         private boolean matchApiFormat(RequestParams params) {
  213.             for (String val : this.values) {
  214.                 if (params.getApiFormat().equalsIgnoreCase(val)) return true;
  215.             }
  216.             return false;
  217.         }

  219.         private boolean matchRequestService(RequestParams params) {
  220.             for (String val : this.values) {
  221.                 if (params.getRequestService().equalsIgnoreCase(val)) return true;
  222.             }
  223.             return false;
  224.         }

  226.         private boolean matchRequestProfiles(RequestParams params) {
  227.             for (String val : this.values) {
  228.                 for (String param : params.getRequestProfiles()) {
  229.                     if (param.equalsIgnoreCase(val)) return true;
  230.                 }
  231.             }
  232.             return false;
  233.         }

  235.         private boolean matchRequestPreferences(RequestParams params) {
  236.             for (String val : this.values) {
  237.                 for (String param : params.getRequestPreferences()) {
  238.                     if (param.equalsIgnoreCase(val)) return true;
  239.                 }
  240.             }
  241.             return false;
  242.         }
  243.     }

  245.     private static class RequestParams {
  246.         private String apiVersion = "";
  247.         private String apiFormat = "";
  248.         private String requestService = "";
  249.         private final Set<String> requestProfiles = new HashSet<>();
  250.         private final Set<String> requestPreferences = new HashSet<>();

  252.         public String getApiVersion() {
  253.             return apiVersion;
  254.         }

  256.         public void setApiVersion(String apiVersion) {
  257.             this.apiVersion = apiVersion;
  258.         }

  260.         public String getApiFormat() {
  261.             return apiFormat;
  262.         }

  264.         public void setApiFormat(String apiFormat) {
  265.             this.apiFormat = apiFormat;
  266.         }

  268.         public String getRequestService() {
  269.             return requestService;
  270.         }

  272.         public void setRequestService(String requestService) {
  273.             this.requestService = requestService;
  274.         }

  276.         public Set<String> getRequestProfiles() {
  277.             return requestProfiles;
  278.         }

  280.         public void setRequestProfiles(String requestProfiles) {
  281.             this.requestProfiles.add(requestProfiles);
  282.         }

  284.         public void setRequestProfile(Set<String> requestProfile) {
  285.             this.requestProfiles.addAll(requestProfile);
  286.         }

  288.         public Set<String> getRequestPreferences() {
  289.             return requestPreferences;
  290.         }

  292.         public void setRequestPreferences(String requestPreferences) {
  293.             this.requestPreferences.add(requestPreferences);
  294.         }

  296.         public void setRequestPreference(Set<String> requestPreference) {
  297.             this.requestPreferences.addAll(requestPreference);
  298.         }
  299.     }
  300. }
Created with JaCoCo 0.8.10.202304240956