Add LBS location caching (fix #3790)

7 files changed, 106 insertions, 20 deletions

diff --git a/src/main/java/org/traccar/MainModule.java b/src/main/java/org/traccar/MainModule.java
index f60d41d62..b9543af25 100644
--- a/src/main/java/org/traccar/MainModule.java
+++ b/src/main/java/org/traccar/MainModule.java
@@ -256,9 +256,10 @@ public class MainModule extends AbstractModule {
 
     @Provides
     public static GeolocationHandler provideGeolocationHandler(
-            Config config, @Nullable GeolocationProvider geolocationProvider, StatisticsManager statisticsManager) {
+            Config config, @Nullable GeolocationProvider geolocationProvider, CacheManager cacheManager,
+            StatisticsManager statisticsManager) {
         if (geolocationProvider != null) {
-            return new GeolocationHandler(config, geolocationProvider, statisticsManager);
+            return new GeolocationHandler(config, geolocationProvider, cacheManager, statisticsManager);
         }
         return null;
     }
diff --git a/src/main/java/org/traccar/config/Keys.java b/src/main/java/org/traccar/config/Keys.java
index 6f19ee863..2e1a14eaf 100644
--- a/src/main/java/org/traccar/config/Keys.java
+++ b/src/main/java/org/traccar/config/Keys.java
@@ -1294,6 +1294,13 @@ public final class Keys {
             List.of(KeyType.CONFIG));
 
     /**
+     * Reuse last geolocation result if network details have not changed.
+     */
+    public static final ConfigKey<Boolean> GEOLOCATION_REUSE = new BooleanConfigKey(
+            "geolocation.reuse",
+            List.of(KeyType.CONFIG));
+
+    /**
      * Default MCC value to use if device doesn't report MCC.
      */
     public static final ConfigKey<Integer> GEOLOCATION_MCC = new IntegerConfigKey(
diff --git a/src/main/java/org/traccar/handler/GeocoderHandler.java b/src/main/java/org/traccar/handler/GeocoderHandler.java
index 0248fca05..e4f240a90 100644
--- a/src/main/java/org/traccar/handler/GeocoderHandler.java
+++ b/src/main/java/org/traccar/handler/GeocoderHandler.java
@@ -35,14 +35,14 @@ public class GeocoderHandler extends ChannelInboundHandlerAdapter {
     private final CacheManager cacheManager;
     private final boolean ignorePositions;
     private final boolean processInvalidPositions;
-    private final int geocoderReuseDistance;
+    private final int reuseDistance;
 
     public GeocoderHandler(Config config, Geocoder geocoder, CacheManager cacheManager) {
         this.geocoder = geocoder;
         this.cacheManager = cacheManager;
         ignorePositions = config.getBoolean(Keys.GEOCODER_IGNORE_POSITIONS);
         processInvalidPositions = config.getBoolean(Keys.GEOCODER_PROCESS_INVALID_POSITIONS);
-        geocoderReuseDistance = config.getInteger(Keys.GEOCODER_REUSE_DISTANCE, 0);
+        reuseDistance = config.getInteger(Keys.GEOCODER_REUSE_DISTANCE, 0);
     }
 
     @Override
@@ -50,10 +50,10 @@ public class GeocoderHandler extends ChannelInboundHandlerAdapter {
         if (message instanceof Position && !ignorePositions) {
             final Position position = (Position) message;
             if (processInvalidPositions || position.getValid()) {
-                if (geocoderReuseDistance != 0) {
+                if (reuseDistance != 0) {
                     Position lastPosition = cacheManager.getPosition(position.getDeviceId());
                     if (lastPosition != null && lastPosition.getAddress() != null
-                            && position.getDouble(Position.KEY_DISTANCE) <= geocoderReuseDistance) {
+                            && position.getDouble(Position.KEY_DISTANCE) <= reuseDistance) {
                         position.setAddress(lastPosition.getAddress());
                         ctx.fireChannelRead(position);
                         return;
diff --git a/src/main/java/org/traccar/handler/GeolocationHandler.java b/src/main/java/org/traccar/handler/GeolocationHandler.java
index 0e78322c8..e7389f22d 100644
--- a/src/main/java/org/traccar/handler/GeolocationHandler.java
+++ b/src/main/java/org/traccar/handler/GeolocationHandler.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2015 - 2018 Anton Tananaev (anton@traccar.org)
+ * Copyright 2015 - 2022 Anton Tananaev (anton@traccar.org)
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -25,6 +25,7 @@ import org.traccar.config.Keys;
 import org.traccar.database.StatisticsManager;
 import org.traccar.geolocation.GeolocationProvider;
 import org.traccar.model.Position;
+import org.traccar.session.cache.CacheManager;
 
 @ChannelHandler.Sharable
 public class GeolocationHandler extends ChannelInboundHandlerAdapter {
@@ -32,14 +33,19 @@ public class GeolocationHandler extends ChannelInboundHandlerAdapter {
     private static final Logger LOGGER = LoggerFactory.getLogger(GeolocationHandler.class);
 
     private final GeolocationProvider geolocationProvider;
+    private final CacheManager cacheManager;
     private final StatisticsManager statisticsManager;
     private final boolean processInvalidPositions;
+    private final boolean reuse;
 
     public GeolocationHandler(
-            Config config, GeolocationProvider geolocationProvider, StatisticsManager statisticsManager) {
+            Config config, GeolocationProvider geolocationProvider, CacheManager cacheManager,
+            StatisticsManager statisticsManager) {
         this.geolocationProvider = geolocationProvider;
+        this.cacheManager = cacheManager;
         this.statisticsManager = statisticsManager;
-        this.processInvalidPositions = config.getBoolean(Keys.GEOLOCATION_PROCESS_INVALID_POSITIONS);
+        processInvalidPositions = config.getBoolean(Keys.GEOLOCATION_PROCESS_INVALID_POSITIONS);
+        reuse = config.getBoolean(Keys.GEOLOCATION_REUSE);
     }
 
     @Override
@@ -48,6 +54,17 @@ public class GeolocationHandler extends ChannelInboundHandlerAdapter {
             final Position position = (Position) message;
             if ((position.getOutdated() || processInvalidPositions && !position.getValid())
                     && position.getNetwork() != null) {
+                if (reuse) {
+                    Position lastPosition = cacheManager.getPosition(position.getDeviceId());
+                    if (lastPosition != null && position.getNetwork().equals(lastPosition.getNetwork())) {
+                        updatePosition(
+                                position, lastPosition.getLatitude(), lastPosition.getLongitude(),
+                                lastPosition.getAccuracy());
+                        ctx.fireChannelRead(position);
+                        return;
+                    }
+                }
+
                 if (statisticsManager != null) {
                     statisticsManager.registerGeolocationRequest();
                 }
@@ -56,15 +73,7 @@ public class GeolocationHandler extends ChannelInboundHandlerAdapter {
                         new GeolocationProvider.LocationProviderCallback() {
                     @Override
                     public void onSuccess(double latitude, double longitude, double accuracy) {
-                        position.set(Position.KEY_APPROXIMATE, true);
-                        position.setValid(true);
-                        position.setFixTime(position.getDeviceTime());
-                        position.setLatitude(latitude);
-                        position.setLongitude(longitude);
-                        position.setAccuracy(accuracy);
-                        position.setAltitude(0);
-                        position.setSpeed(0);
-                        position.setCourse(0);
+                        updatePosition(position, latitude, longitude, accuracy);
                         ctx.fireChannelRead(position);
                     }
 
@@ -82,4 +91,16 @@ public class GeolocationHandler extends ChannelInboundHandlerAdapter {
         }
     }
 
+    private void updatePosition(Position position, double latitude, double longitude, double accuracy) {
+        position.set(Position.KEY_APPROXIMATE, true);
+        position.setValid(true);
+        position.setFixTime(position.getDeviceTime());
+        position.setLatitude(latitude);
+        position.setLongitude(longitude);
+        position.setAccuracy(accuracy);
+        position.setAltitude(0);
+        position.setSpeed(0);
+        position.setCourse(0);
+    }
+
 }
diff --git a/src/main/java/org/traccar/model/CellTower.java b/src/main/java/org/traccar/model/CellTower.java
index 16a28ea79..bebbb2432 100644
--- a/src/main/java/org/traccar/model/CellTower.java
+++ b/src/main/java/org/traccar/model/CellTower.java
@@ -19,6 +19,8 @@ import com.fasterxml.jackson.annotation.JsonInclude;
 import org.traccar.config.Config;
 import org.traccar.config.Keys;
 
+import java.util.Objects;
+
 @JsonInclude(JsonInclude.Include.NON_NULL)
 public class CellTower {
 
@@ -111,4 +113,22 @@ public class CellTower {
         mobileNetworkCode = Integer.parseInt(operatorString.substring(3));
     }
 
+    @Override
+    public boolean equals(Object o) {
+        if (this == o) return true;
+        if (o == null || getClass() != o.getClass()) return false;
+        CellTower cellTower = (CellTower) o;
+        return Objects.equals(radioType, cellTower.radioType)
+                && Objects.equals(cellId, cellTower.cellId)
+                && Objects.equals(locationAreaCode, cellTower.locationAreaCode)
+                && Objects.equals(mobileCountryCode, cellTower.mobileCountryCode)
+                && Objects.equals(mobileNetworkCode, cellTower.mobileNetworkCode)
+                && Objects.equals(signalStrength, cellTower.signalStrength);
+    }
+
+    @Override
+    public int hashCode() {
+        return Objects.hash(radioType, cellId, locationAreaCode, mobileCountryCode, mobileNetworkCode, signalStrength);
+    }
+
 }
diff --git a/src/main/java/org/traccar/model/Network.java b/src/main/java/org/traccar/model/Network.java
index 4d67fc5d8..e565f4f59 100644
--- a/src/main/java/org/traccar/model/Network.java
+++ b/src/main/java/org/traccar/model/Network.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2016 - 2019 Anton Tananaev (anton@traccar.org)
+ * Copyright 2016 - 2022 Anton Tananaev (anton@traccar.org)
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -19,6 +19,7 @@ import com.fasterxml.jackson.annotation.JsonInclude;
 
 import java.util.ArrayList;
 import java.util.Collection;
+import java.util.Objects;
 
 @JsonInclude(JsonInclude.Include.NON_NULL)
 public class Network {
@@ -118,4 +119,23 @@ public class Network {
         wifiAccessPoints.add(wifiAccessPoint);
     }
 
+    @Override
+    public boolean equals(Object o) {
+        if (this == o) return true;
+        if (o == null || getClass() != o.getClass()) return false;
+        Network network = (Network) o;
+        return Objects.equals(homeMobileCountryCode, network.homeMobileCountryCode)
+                && Objects.equals(homeMobileNetworkCode, network.homeMobileNetworkCode)
+                && Objects.equals(radioType, network.radioType)
+                && Objects.equals(carrier, network.carrier)
+                && Objects.equals(cellTowers, network.cellTowers)
+                && Objects.equals(wifiAccessPoints, network.wifiAccessPoints);
+    }
+
+    @Override
+    public int hashCode() {
+        return Objects.hash(
+                homeMobileCountryCode, homeMobileNetworkCode, radioType, carrier, cellTowers, wifiAccessPoints);
+    }
+
 }
diff --git a/src/main/java/org/traccar/model/WifiAccessPoint.java b/src/main/java/org/traccar/model/WifiAccessPoint.java
index 87a77f3c0..fa7be8700 100644
--- a/src/main/java/org/traccar/model/WifiAccessPoint.java
+++ b/src/main/java/org/traccar/model/WifiAccessPoint.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2016 Anton Tananaev (anton@traccar.org)
+ * Copyright 2016 - 2022 Anton Tananaev (anton@traccar.org)
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -17,6 +17,8 @@ package org.traccar.model;
 
 import com.fasterxml.jackson.annotation.JsonInclude;
 
+import java.util.Objects;
+
 @JsonInclude(JsonInclude.Include.NON_NULL)
 public class WifiAccessPoint {
 
@@ -63,4 +65,19 @@ public class WifiAccessPoint {
         this.channel = channel;
     }
 
+    @Override
+    public boolean equals(Object o) {
+        if (this == o) return true;
+        if (o == null || getClass() != o.getClass()) return false;
+        WifiAccessPoint that = (WifiAccessPoint) o;
+        return Objects.equals(macAddress, that.macAddress)
+                && Objects.equals(signalStrength, that.signalStrength)
+                && Objects.equals(channel, that.channel);
+    }
+
+    @Override
+    public int hashCode() {
+        return Objects.hash(macAddress, signalStrength, channel);
+    }
+
 }