Refactor attribute lookup

14 files changed, 81 insertions, 89 deletions

diff --git a/src/main/java/org/traccar/config/Keys.java b/src/main/java/org/traccar/config/Keys.java
index 410947079..5909ae517 100644
--- a/src/main/java/org/traccar/config/Keys.java
+++ b/src/main/java/org/traccar/config/Keys.java
@@ -124,7 +124,8 @@ public final class Keys {
      */
     public static final ConfigSuffix<Boolean> PROTOCOL_ACK = new BooleanConfigSuffix(
             ".ack",
-            List.of(KeyType.CONFIG));
+            List.of(KeyType.CONFIG, KeyType.DEVICE),
+            false);
 
     /**
      * Ignore device reported fix time. Useful in case some devices report invalid time. Currently only available for
@@ -269,6 +270,22 @@ public final class Keys {
             List.of(KeyType.CONFIG));
 
     /**
+     * Use alternative format for the protocol of commands.
+     */
+    public static final ConfigSuffix<Boolean> PROTOCOL_ALTERNATIVE = new BooleanConfigSuffix(
+            ".alternative",
+            List.of(KeyType.CONFIG, KeyType.DEVICE),
+            false);
+
+    /**
+     * Protocol format includes a language field.
+     */
+    public static final ConfigSuffix<Boolean> PROTOCOL_LANGUAGE = new BooleanConfigSuffix(
+            ".language",
+            List.of(KeyType.CONFIG, KeyType.DEVICE),
+            false);
+
+    /**
      * Server wide connection timeout value in seconds. See protocol timeout for more information.
      */
     public static final ConfigKey<Integer> SERVER_TIMEOUT = new IntegerConfigKey(
@@ -945,6 +962,14 @@ public final class Keys {
             List.of(KeyType.CONFIG));
 
     /**
+     * Ignore odometer value reported by the device and use server-calculated total distance instead. This is useful
+     * if device reports invalid or zero odometer values.
+     */
+    public static final ConfigKey<Boolean> REPORT_IGNORE_ODOMETER = new BooleanConfigKey(
+            "report.ignoreOdometer",
+            List.of(KeyType.CONFIG));
+
+    /**
      * Boolean flag to enable or disable position filtering.
      */
     public static final ConfigKey<Boolean> FILTER_ENABLE = new BooleanConfigKey(
@@ -1120,6 +1145,14 @@ public final class Keys {
             List.of(KeyType.CONFIG));
 
     /**
+     * List of attributes to copy. Attributes should be separated by a comma without any spacing.
+     * For example: alarm,ignition
+     */
+    public static final ConfigKey<String> PROCESSING_COPY_ATTRIBUTES = new StringConfigKey(
+            "processing.copyAttributes",
+            List.of(KeyType.CONFIG, KeyType.DEVICE));
+
+    /**
      * Enable computed attributes processing.
      */
     public static final ConfigKey<Boolean> PROCESSING_COMPUTED_ATTRIBUTES_DEVICE_ATTRIBUTES = new BooleanConfigKey(
diff --git a/src/main/java/org/traccar/database/DeviceManager.java b/src/main/java/org/traccar/database/DeviceManager.java
index eee19c4c2..86334ede8 100644
--- a/src/main/java/org/traccar/database/DeviceManager.java
+++ b/src/main/java/org/traccar/database/DeviceManager.java
@@ -253,54 +253,6 @@ public class DeviceManager extends BaseObjectManager<Device> implements Identity
         return result;
     }
 
-    @Override
-    public boolean lookupAttributeBoolean(
-            long deviceId, String attributeName, boolean defaultValue, boolean lookupServer, boolean lookupConfig) {
-        Object result = lookupAttribute(deviceId, attributeName, lookupServer, lookupConfig);
-        if (result != null) {
-            return result instanceof String ? Boolean.parseBoolean((String) result) : (Boolean) result;
-        }
-        return defaultValue;
-    }
-
-    @Override
-    public String lookupAttributeString(
-            long deviceId, String attributeName, String defaultValue, boolean lookupServer, boolean lookupConfig) {
-        Object result = lookupAttribute(deviceId, attributeName, lookupServer, lookupConfig);
-        return result != null ? (String) result : defaultValue;
-    }
-
-    private Object lookupAttribute(long deviceId, String attributeName, boolean lookupServer, boolean lookupConfig) {
-        Object result = null;
-        Device device = getById(deviceId);
-        if (device != null) {
-            result = device.getAttributes().get(attributeName);
-            if (result == null) {
-                long groupId = device.getGroupId();
-                while (groupId > 0) {
-                    Group group = cacheManager.getObject(Group.class, device.getGroupId());
-                    if (group != null) {
-                        result = group.getAttributes().get(attributeName);
-                        if (result != null) {
-                            break;
-                        }
-                        groupId = group.getGroupId();
-                    } else {
-                        groupId = 0;
-                    }
-                }
-            }
-            if (result == null && lookupServer) {
-                Server server = cacheManager.getServer();
-                result = server.getAttributes().get(attributeName);
-            }
-            if (result == null && lookupConfig) {
-                result = Context.getConfig().getString(attributeName);
-            }
-        }
-        return result;
-    }
-
     public DeviceState getDeviceState(long deviceId) {
         DeviceState deviceState = deviceStates.get(deviceId);
         if (deviceState == null) {
diff --git a/src/main/java/org/traccar/database/IdentityManager.java b/src/main/java/org/traccar/database/IdentityManager.java
index 1897c637f..5ef1c8c5e 100644
--- a/src/main/java/org/traccar/database/IdentityManager.java
+++ b/src/main/java/org/traccar/database/IdentityManager.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2015 - 2019 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.
@@ -28,10 +28,4 @@ public interface IdentityManager {
 
     boolean isLatestPosition(Position position);
 
-    boolean lookupAttributeBoolean(
-            long deviceId, String attributeName, boolean defaultValue, boolean lookupServer, boolean lookupConfig);
-
-    String lookupAttributeString(
-            long deviceId, String attributeName, String defaultValue, boolean lookupServer, boolean lookupConfig);
-
 }
diff --git a/src/main/java/org/traccar/handler/CopyAttributesHandler.java b/src/main/java/org/traccar/handler/CopyAttributesHandler.java
index 8285dcc5d..405a52ecd 100644
--- a/src/main/java/org/traccar/handler/CopyAttributesHandler.java
+++ b/src/main/java/org/traccar/handler/CopyAttributesHandler.java
@@ -20,8 +20,9 @@ import io.netty.channel.ChannelHandler;
 import org.traccar.BaseDataHandler;
 import org.traccar.config.Config;
 import org.traccar.config.Keys;
-import org.traccar.database.IdentityManager;
+import org.traccar.helper.model.AttributeUtil;
 import org.traccar.model.Position;
+import org.traccar.session.cache.CacheManager;
 
 import javax.inject.Inject;
 
@@ -29,20 +30,20 @@ import javax.inject.Inject;
 public class CopyAttributesHandler extends BaseDataHandler {
 
     private final boolean enabled;
-    private final IdentityManager identityManager;
+    private final CacheManager cacheManager;
 
     @Inject
-    public CopyAttributesHandler(Config config, IdentityManager identityManager) {
+    public CopyAttributesHandler(Config config, CacheManager cacheManager) {
         enabled = config.getBoolean(Keys.PROCESSING_COPY_ATTRIBUTES_ENABLE);
-        this.identityManager = identityManager;
+        this.cacheManager = cacheManager;
     }
 
     @Override
     protected Position handlePosition(Position position) {
         if (enabled) {
-            String attributesString = identityManager.lookupAttributeString(
-                    position.getDeviceId(), "processing.copyAttributes", "", false, true);
-            Position last = identityManager.getLastPosition(position.getDeviceId());
+            String attributesString = AttributeUtil.lookup(
+                    cacheManager, Keys.PROCESSING_COPY_ATTRIBUTES, position.getDeviceId());
+            Position last = cacheManager.getPosition(position.getDeviceId());
             if (last != null) {
                 for (String attribute : attributesString.split("[ ,]")) {
                     if (last.getAttributes().containsKey(attribute)
diff --git a/src/main/java/org/traccar/protocol/Gt06ProtocolEncoder.java b/src/main/java/org/traccar/protocol/Gt06ProtocolEncoder.java
index 569f4a809..e1c17710b 100644
--- a/src/main/java/org/traccar/protocol/Gt06ProtocolEncoder.java
+++ b/src/main/java/org/traccar/protocol/Gt06ProtocolEncoder.java
@@ -19,6 +19,7 @@ import io.netty.buffer.ByteBuf;
 import io.netty.buffer.Unpooled;
 import org.traccar.BaseProtocolEncoder;
 import org.traccar.Protocol;
+import org.traccar.config.Keys;
 import org.traccar.helper.Checksum;
 import org.traccar.helper.model.AttributeUtil;
 import org.traccar.model.Command;
@@ -33,8 +34,8 @@ public class Gt06ProtocolEncoder extends BaseProtocolEncoder {
 
     private ByteBuf encodeContent(long deviceId, String content) {
 
-        boolean language = getIdentityManager()
-            .lookupAttributeBoolean(deviceId, getProtocolName() + ".language", false, false, true);
+        boolean language = AttributeUtil.lookup(
+                getCacheManager(), Keys.PROTOCOL_LANGUAGE.withPrefix(getProtocolName()), deviceId);
 
         ByteBuf buf = Unpooled.buffer();
 
@@ -66,8 +67,8 @@ public class Gt06ProtocolEncoder extends BaseProtocolEncoder {
     @Override
     protected Object encodeCommand(Command command) {
 
-        boolean alternative = getIdentityManager().lookupAttributeBoolean(
-                command.getDeviceId(), getProtocolName() + ".alternative", false, false, true);
+        boolean alternative = AttributeUtil.lookup(
+                getCacheManager(), Keys.PROTOCOL_ALTERNATIVE.withPrefix(getProtocolName()), command.getDeviceId());
 
         String password = AttributeUtil.getDevicePassword(
                 getCacheManager(), command.getDeviceId(), getProtocolName(), "123456");
diff --git a/src/main/java/org/traccar/protocol/H02ProtocolEncoder.java b/src/main/java/org/traccar/protocol/H02ProtocolEncoder.java
index 7fca0f93e..86b8c80d4 100644
--- a/src/main/java/org/traccar/protocol/H02ProtocolEncoder.java
+++ b/src/main/java/org/traccar/protocol/H02ProtocolEncoder.java
@@ -18,6 +18,8 @@ package org.traccar.protocol;
 
 import org.traccar.Protocol;
 import org.traccar.StringProtocolEncoder;
+import org.traccar.config.Keys;
+import org.traccar.helper.model.AttributeUtil;
 import org.traccar.model.Command;
 
 import java.util.Date;
@@ -58,8 +60,9 @@ public class H02ProtocolEncoder extends StringProtocolEncoder {
                 return formatCommand(time, uniqueId, "S20", "1", "0");
             case Command.TYPE_POSITION_PERIODIC:
                 String frequency = command.getAttributes().get(Command.KEY_FREQUENCY).toString();
-                if (getIdentityManager().lookupAttributeBoolean(
-                        command.getDeviceId(), getProtocolName() + ".alternative", false, false, true)) {
+                if (AttributeUtil.lookup(
+                        getCacheManager(), Keys.PROTOCOL_ALTERNATIVE.withPrefix(getProtocolName()),
+                        command.getDeviceId())) {
                     return formatCommand(time, uniqueId, "D1", frequency);
                 } else {
                     return formatCommand(time, uniqueId, "S71", "22", frequency);
diff --git a/src/main/java/org/traccar/protocol/HuabaoProtocolEncoder.java b/src/main/java/org/traccar/protocol/HuabaoProtocolEncoder.java
index 82cf03b51..ada7e3fba 100644
--- a/src/main/java/org/traccar/protocol/HuabaoProtocolEncoder.java
+++ b/src/main/java/org/traccar/protocol/HuabaoProtocolEncoder.java
@@ -19,7 +19,9 @@ import io.netty.buffer.ByteBuf;
 import io.netty.buffer.Unpooled;
 import org.traccar.BaseProtocolEncoder;
 import org.traccar.Protocol;
+import org.traccar.config.Keys;
 import org.traccar.helper.DataConverter;
+import org.traccar.helper.model.AttributeUtil;
 import org.traccar.model.Command;
 
 import java.text.SimpleDateFormat;
@@ -34,8 +36,8 @@ public class HuabaoProtocolEncoder extends BaseProtocolEncoder {
     @Override
     protected Object encodeCommand(Command command) {
 
-        boolean alternative = getIdentityManager().lookupAttributeBoolean(
-                command.getDeviceId(), getProtocolName() + ".alternative", false, false, true);
+        boolean alternative = AttributeUtil.lookup(
+                getCacheManager(), Keys.PROTOCOL_ALTERNATIVE.withPrefix(getProtocolName()), command.getDeviceId());
 
         ByteBuf id = Unpooled.wrappedBuffer(
                 DataConverter.parseHex(getUniqueId(command.getDeviceId())));
diff --git a/src/main/java/org/traccar/protocol/MeiligaoProtocolEncoder.java b/src/main/java/org/traccar/protocol/MeiligaoProtocolEncoder.java
index 7784ab093..21f9f8801 100644
--- a/src/main/java/org/traccar/protocol/MeiligaoProtocolEncoder.java
+++ b/src/main/java/org/traccar/protocol/MeiligaoProtocolEncoder.java
@@ -19,8 +19,10 @@ import io.netty.buffer.ByteBuf;
 import io.netty.buffer.Unpooled;
 import org.traccar.BaseProtocolEncoder;
 import org.traccar.Protocol;
+import org.traccar.config.Keys;
 import org.traccar.helper.Checksum;
 import org.traccar.helper.DataConverter;
+import org.traccar.helper.model.AttributeUtil;
 import org.traccar.model.Command;
 
 import java.nio.charset.StandardCharsets;
@@ -58,8 +60,8 @@ public class MeiligaoProtocolEncoder extends BaseProtocolEncoder {
     @Override
     protected Object encodeCommand(Command command) {
 
-        boolean alternative = getIdentityManager().lookupAttributeBoolean(
-                command.getDeviceId(), getProtocolName() + ".alternative", false, false, true);
+        boolean alternative = AttributeUtil.lookup(
+                getCacheManager(), Keys.PROTOCOL_ALTERNATIVE.withPrefix(getProtocolName()), command.getDeviceId());
 
         int outputControlMessageType = alternative
                 ? MeiligaoProtocolDecoder.MSG_OUTPUT_CONTROL_1
diff --git a/src/main/java/org/traccar/protocol/MeitrackProtocolEncoder.java b/src/main/java/org/traccar/protocol/MeitrackProtocolEncoder.java
index 799e14ea2..365dbb35a 100644
--- a/src/main/java/org/traccar/protocol/MeitrackProtocolEncoder.java
+++ b/src/main/java/org/traccar/protocol/MeitrackProtocolEncoder.java
@@ -17,7 +17,9 @@ package org.traccar.protocol;
 
 import org.traccar.Protocol;
 import org.traccar.StringProtocolEncoder;
+import org.traccar.config.Keys;
 import org.traccar.helper.Checksum;
+import org.traccar.helper.model.AttributeUtil;
 import org.traccar.model.Command;
 
 import java.util.Map;
@@ -41,8 +43,8 @@ public class MeitrackProtocolEncoder extends StringProtocolEncoder {
 
         Map<String, Object> attributes = command.getAttributes();
 
-        boolean alternative = getIdentityManager().lookupAttributeBoolean(
-                command.getDeviceId(), getProtocolName() + ".alternative", false, false, true);
+        boolean alternative = AttributeUtil.lookup(
+                getCacheManager(), Keys.PROTOCOL_ALTERNATIVE.withPrefix(getProtocolName()), command.getDeviceId());
 
         switch (command.getType()) {
             case Command.TYPE_POSITION_SINGLE:
diff --git a/src/main/java/org/traccar/protocol/T55ProtocolDecoder.java b/src/main/java/org/traccar/protocol/T55ProtocolDecoder.java
index 3d892c021..409c7e768 100644
--- a/src/main/java/org/traccar/protocol/T55ProtocolDecoder.java
+++ b/src/main/java/org/traccar/protocol/T55ProtocolDecoder.java
@@ -17,6 +17,8 @@ package org.traccar.protocol;
 
 import io.netty.channel.Channel;
 import org.traccar.BaseProtocolDecoder;
+import org.traccar.config.Keys;
+import org.traccar.helper.model.AttributeUtil;
 import org.traccar.session.DeviceSession;
 import org.traccar.NetworkMessage;
 import org.traccar.Protocol;
@@ -128,10 +130,12 @@ public class T55ProtocolDecoder extends BaseProtocolDecoder {
     private Position decodeGprmc(
             DeviceSession deviceSession, String sentence, SocketAddress remoteAddress, Channel channel) {
 
-        if (deviceSession != null && channel != null && !(channel instanceof DatagramChannel)
-                && getIdentityManager().lookupAttributeBoolean(
-                        deviceSession.getDeviceId(), getProtocolName() + ".ack", false, false, true)) {
-            channel.writeAndFlush(new NetworkMessage("OK1\r\n", remoteAddress));
+        if (deviceSession != null && channel != null && !(channel instanceof DatagramChannel)) {
+            boolean ack = AttributeUtil.lookup(
+                    getCacheManager(), Keys.PROTOCOL_ACK.withPrefix(getProtocolName()), deviceSession.getDeviceId());
+            if (ack) {
+                channel.writeAndFlush(new NetworkMessage("OK1\r\n", remoteAddress));
+            }
         }
 
         Parser parser = new Parser(PATTERN_GPRMC, sentence);
diff --git a/src/main/java/org/traccar/protocol/Tk103ProtocolEncoder.java b/src/main/java/org/traccar/protocol/Tk103ProtocolEncoder.java
index a0e9b199c..e3e1ae961 100644
--- a/src/main/java/org/traccar/protocol/Tk103ProtocolEncoder.java
+++ b/src/main/java/org/traccar/protocol/Tk103ProtocolEncoder.java
@@ -18,6 +18,8 @@ package org.traccar.protocol;
 
 import org.traccar.Protocol;
 import org.traccar.StringProtocolEncoder;
+import org.traccar.config.Keys;
+import org.traccar.helper.model.AttributeUtil;
 import org.traccar.model.Command;
 
 public class Tk103ProtocolEncoder extends StringProtocolEncoder {
@@ -41,12 +43,12 @@ public class Tk103ProtocolEncoder extends StringProtocolEncoder {
     @Override
     protected Object encodeCommand(Command command) {
 
-        boolean alternative = forceAlternative || getIdentityManager().lookupAttributeBoolean(
-                command.getDeviceId(), getProtocolName() + ".alternative", false, false, true);
+        boolean alternative = AttributeUtil.lookup(
+                getCacheManager(), Keys.PROTOCOL_ALTERNATIVE.withPrefix(getProtocolName()), command.getDeviceId());
 
         initDevicePassword(command, "123456");
 
-        if (alternative) {
+        if (alternative || forceAlternative) {
             switch (command.getType()) {
                 case Command.TYPE_CUSTOM:
                     return formatAlt(command, "%s", Command.KEY_DATA);
diff --git a/src/main/java/org/traccar/reports/StopsReportProvider.java b/src/main/java/org/traccar/reports/StopsReportProvider.java
index a63d7ee21..192d7a0f7 100644
--- a/src/main/java/org/traccar/reports/StopsReportProvider.java
+++ b/src/main/java/org/traccar/reports/StopsReportProvider.java
@@ -57,8 +57,7 @@ public class StopsReportProvider {
     }
 
     private Collection<StopReportItem> detectStops(long deviceId, Date from, Date to) throws StorageException {
-        boolean ignoreOdometer = Context.getDeviceManager()
-                .lookupAttributeBoolean(deviceId, "report.ignoreOdometer", false, false, true);
+        boolean ignoreOdometer = config.getBoolean(Keys.REPORT_IGNORE_ODOMETER);
         return reportUtils.detectTripsAndStops(
                 PositionUtil.getPositions(storage, deviceId, from, to), ignoreOdometer, StopReportItem.class);
     }
diff --git a/src/main/java/org/traccar/reports/SummaryReportProvider.java b/src/main/java/org/traccar/reports/SummaryReportProvider.java
index 86d76b4e3..f3a9786b9 100644
--- a/src/main/java/org/traccar/reports/SummaryReportProvider.java
+++ b/src/main/java/org/traccar/reports/SummaryReportProvider.java
@@ -74,8 +74,7 @@ public class SummaryReportProvider {
                     result.setMaxSpeed(position.getSpeed());
                 }
             }
-            boolean ignoreOdometer = Context.getDeviceManager()
-                    .lookupAttributeBoolean(deviceId, "report.ignoreOdometer", false, false, true);
+            boolean ignoreOdometer = config.getBoolean(Keys.REPORT_IGNORE_ODOMETER);
             result.setDistance(PositionUtil.calculateDistance(firstPosition, previousPosition, !ignoreOdometer));
             result.setSpentFuel(reportUtils.calculateFuel(firstPosition, previousPosition));
 
diff --git a/src/main/java/org/traccar/reports/TripsReportProvider.java b/src/main/java/org/traccar/reports/TripsReportProvider.java
index bec4c39fd..928609b9e 100644
--- a/src/main/java/org/traccar/reports/TripsReportProvider.java
+++ b/src/main/java/org/traccar/reports/TripsReportProvider.java
@@ -57,9 +57,7 @@ public class TripsReportProvider {
     }
 
     private Collection<TripReportItem> detectTrips(long deviceId, Date from, Date to) throws StorageException {
-        boolean ignoreOdometer = Context.getDeviceManager()
-                .lookupAttributeBoolean(deviceId, "report.ignoreOdometer", false, false, true);
-
+        boolean ignoreOdometer = config.getBoolean(Keys.REPORT_IGNORE_ODOMETER);
         return reportUtils.detectTripsAndStops(
                 PositionUtil.getPositions(storage, deviceId, from, to), ignoreOdometer, TripReportItem.class);
     }