Merge branch 'traccar:master' into master

7 files changed, 549 insertions, 0 deletions

diff --git a/src/main/java/org/traccar/broadcast/BaseBroadcastService.java b/src/main/java/org/traccar/broadcast/BaseBroadcastService.java
new file mode 100644
index 000000000..a95d333f2
--- /dev/null
+++ b/src/main/java/org/traccar/broadcast/BaseBroadcastService.java
@@ -0,0 +1,118 @@
+/*
+ * Copyright 2023 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.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.traccar.broadcast;
+
+import java.util.HashSet;
+import java.util.Map;
+import java.util.Set;
+
+import org.traccar.model.BaseModel;
+import org.traccar.model.Device;
+import org.traccar.model.Event;
+import org.traccar.model.Permission;
+import org.traccar.model.Position;
+
+public abstract class BaseBroadcastService implements BroadcastService {
+
+    private final Set<BroadcastInterface> listeners = new HashSet<>();
+
+    @Override
+    public boolean singleInstance() {
+        return true;
+    }
+
+    @Override
+    public void registerListener(BroadcastInterface listener) {
+        listeners.add(listener);
+    }
+
+    @Override
+    public void updateDevice(boolean local, Device device) {
+        BroadcastMessage message = new BroadcastMessage();
+        message.setDevice(device);
+        sendMessage(message);
+    }
+
+    @Override
+    public void updatePosition(boolean local, Position position) {
+        BroadcastMessage message = new BroadcastMessage();
+        message.setPosition(position);
+        sendMessage(message);
+    }
+
+    @Override
+    public void updateEvent(boolean local, long userId, Event event) {
+        BroadcastMessage message = new BroadcastMessage();
+        message.setUserId(userId);
+        message.setEvent(event);
+        sendMessage(message);
+    }
+
+    @Override
+    public void updateCommand(boolean local, long deviceId) {
+        BroadcastMessage message = new BroadcastMessage();
+        message.setCommandDeviceId(deviceId);
+        sendMessage(message);
+    }
+
+    @Override
+    public void invalidateObject(boolean local, Class<? extends BaseModel> clazz, long id) {
+        BroadcastMessage message = new BroadcastMessage();
+        message.setChanges(Map.of(Permission.getKey(clazz), id));
+        sendMessage(message);
+    }
+
+    @Override
+    public void invalidatePermission(
+            boolean local,
+            Class<? extends BaseModel> clazz1, long id1,
+            Class<? extends BaseModel> clazz2, long id2) {
+        BroadcastMessage message = new BroadcastMessage();
+        message.setChanges(Map.of(Permission.getKey(clazz1), id1, Permission.getKey(clazz2), id2));
+        sendMessage(message);
+    }
+
+    protected abstract void sendMessage(BroadcastMessage message);
+
+    protected void handleMessage(BroadcastMessage message) {
+        if (message.getDevice() != null) {
+            listeners.forEach(listener -> listener.updateDevice(false, message.getDevice()));
+        } else if (message.getPosition() != null) {
+            listeners.forEach(listener -> listener.updatePosition(false, message.getPosition()));
+        } else if (message.getUserId() != null && message.getEvent() != null) {
+            listeners.forEach(listener -> listener.updateEvent(false, message.getUserId(), message.getEvent()));
+        } else if (message.getCommandDeviceId() != null) {
+            listeners.forEach(listener -> listener.updateCommand(false, message.getCommandDeviceId()));
+        } else if (message.getChanges() != null) {
+            var iterator = message.getChanges().entrySet().iterator();
+            if (iterator.hasNext()) {
+                var first = iterator.next();
+                if (iterator.hasNext()) {
+                    var second = iterator.next();
+                    listeners.forEach(listener -> listener.invalidatePermission(
+                            false,
+                            Permission.getKeyClass(first.getKey()), first.getValue(),
+                            Permission.getKeyClass(second.getKey()), second.getValue()));
+                } else {
+                    listeners.forEach(listener -> listener.invalidateObject(
+                            false,
+                            Permission.getKeyClass(first.getKey()), first.getValue()));
+                }
+            }
+        }
+    }
+
+}
diff --git a/src/main/java/org/traccar/broadcast/BroadcastInterface.java b/src/main/java/org/traccar/broadcast/BroadcastInterface.java
new file mode 100644
index 000000000..673ebd8b8
--- /dev/null
+++ b/src/main/java/org/traccar/broadcast/BroadcastInterface.java
@@ -0,0 +1,45 @@
+/*
+ * Copyright 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.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.traccar.broadcast;
+
+import org.traccar.model.BaseModel;
+import org.traccar.model.Device;
+import org.traccar.model.Event;
+import org.traccar.model.Position;
+
+public interface BroadcastInterface {
+
+    default void updateDevice(boolean local, Device device) {
+    }
+
+    default void updatePosition(boolean local, Position position) {
+    }
+
+    default void updateEvent(boolean local, long userId, Event event) {
+    }
+
+    default void updateCommand(boolean local, long deviceId) {
+    }
+
+    default void invalidateObject(boolean local, Class<? extends BaseModel> clazz, long id) {
+    }
+
+    default void invalidatePermission(
+            boolean local,
+            Class<? extends BaseModel> clazz1, long id1,
+            Class<? extends BaseModel> clazz2, long id2) {
+    }
+}
diff --git a/src/main/java/org/traccar/broadcast/BroadcastMessage.java b/src/main/java/org/traccar/broadcast/BroadcastMessage.java
new file mode 100644
index 000000000..985848d04
--- /dev/null
+++ b/src/main/java/org/traccar/broadcast/BroadcastMessage.java
@@ -0,0 +1,85 @@
+/*
+ * Copyright 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.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.traccar.broadcast;
+
+import org.traccar.model.Device;
+import org.traccar.model.Event;
+import org.traccar.model.Position;
+
+import java.util.Map;
+
+public class BroadcastMessage {
+
+    private Device device;
+
+    public Device getDevice() {
+        return device;
+    }
+
+    public void setDevice(Device device) {
+        this.device = device;
+    }
+
+    private Position position;
+
+    public Position getPosition() {
+        return position;
+    }
+
+    public void setPosition(Position position) {
+        this.position = position;
+    }
+
+    private Long userId;
+
+    public Long getUserId() {
+        return userId;
+    }
+
+    public void setUserId(Long userId) {
+        this.userId = userId;
+    }
+
+    private Event event;
+
+    public Event getEvent() {
+        return event;
+    }
+
+    public void setEvent(Event event) {
+        this.event = event;
+    }
+
+    private Long commandDeviceId;
+
+    public Long getCommandDeviceId() {
+        return commandDeviceId;
+    }
+
+    public void setCommandDeviceId(Long commandDeviceId) {
+        this.commandDeviceId = commandDeviceId;
+    }
+
+    private Map<String, Long> changes;
+
+    public Map<String, Long> getChanges() {
+        return changes;
+    }
+
+    public void setChanges(Map<String, Long> changes) {
+        this.changes = changes;
+    }
+}
diff --git a/src/main/java/org/traccar/broadcast/BroadcastService.java b/src/main/java/org/traccar/broadcast/BroadcastService.java
new file mode 100644
index 000000000..a86c43b5b
--- /dev/null
+++ b/src/main/java/org/traccar/broadcast/BroadcastService.java
@@ -0,0 +1,23 @@
+/*
+ * Copyright 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.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.traccar.broadcast;
+
+import org.traccar.LifecycleObject;
+
+public interface BroadcastService extends LifecycleObject, BroadcastInterface {
+    boolean singleInstance();
+    void registerListener(BroadcastInterface listener);
+}
diff --git a/src/main/java/org/traccar/broadcast/MulticastBroadcastService.java b/src/main/java/org/traccar/broadcast/MulticastBroadcastService.java
new file mode 100644
index 000000000..1c02b319b
--- /dev/null
+++ b/src/main/java/org/traccar/broadcast/MulticastBroadcastService.java
@@ -0,0 +1,112 @@
+/*
+ * Copyright 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.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.traccar.broadcast;
+
+import com.fasterxml.jackson.databind.ObjectMapper;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import org.traccar.config.Config;
+import org.traccar.config.Keys;
+
+import java.io.IOException;
+import java.net.DatagramPacket;
+import java.net.DatagramSocket;
+import java.net.InetAddress;
+import java.net.InetSocketAddress;
+import java.net.MulticastSocket;
+import java.net.NetworkInterface;
+import java.nio.charset.StandardCharsets;
+import java.util.concurrent.ExecutorService;
+import java.util.concurrent.Executors;
+
+public class MulticastBroadcastService extends BaseBroadcastService {
+
+    private static final Logger LOGGER = LoggerFactory.getLogger(MulticastBroadcastService.class);
+
+    private final ObjectMapper objectMapper;
+
+    private final NetworkInterface networkInterface;
+    private final int port;
+    private final InetSocketAddress group;
+
+    private DatagramSocket publisherSocket;
+
+    private final ExecutorService service = Executors.newSingleThreadExecutor();
+    private final byte[] receiverBuffer = new byte[4096];
+
+    public MulticastBroadcastService(Config config, ObjectMapper objectMapper) throws IOException {
+        this.objectMapper = objectMapper;
+        port = config.getInteger(Keys.BROADCAST_PORT);
+        String interfaceName = config.getString(Keys.BROADCAST_INTERFACE);
+        if (interfaceName.indexOf('.') >= 0 || interfaceName.indexOf(':') >= 0) {
+            networkInterface = NetworkInterface.getByInetAddress(InetAddress.getByName(interfaceName));
+        } else {
+            networkInterface = NetworkInterface.getByName(interfaceName);
+        }
+        InetAddress address = InetAddress.getByName(config.getString(Keys.BROADCAST_ADDRESS));
+        group = new InetSocketAddress(address, port);
+    }
+
+    @Override
+    public boolean singleInstance() {
+        return false;
+    }
+
+    @Override
+    protected void sendMessage(BroadcastMessage message) {
+        try {
+            byte[] buffer = objectMapper.writeValueAsString(message).getBytes(StandardCharsets.UTF_8);
+            DatagramPacket packet = new DatagramPacket(buffer, buffer.length, group);
+            publisherSocket.send(packet);
+        } catch (IOException e) {
+            LOGGER.warn("Broadcast failed", e);
+        }
+    }
+
+    @Override
+    public void start() throws IOException {
+        service.submit(receiver);
+    }
+
+    @Override
+    public void stop() {
+        service.shutdown();
+    }
+
+    private final Runnable receiver = new Runnable() {
+        @Override
+        public void run() {
+            try (MulticastSocket socket = new MulticastSocket(port)) {
+                socket.setNetworkInterface(networkInterface);
+                socket.joinGroup(group, networkInterface);
+                publisherSocket = socket;
+                while (!service.isShutdown()) {
+                    DatagramPacket packet = new DatagramPacket(receiverBuffer, receiverBuffer.length);
+                    socket.receive(packet);
+                    if (networkInterface.inetAddresses().noneMatch(a -> a.equals(packet.getAddress()))) {
+                        String data = new String(packet.getData(), 0, packet.getLength(), StandardCharsets.UTF_8);
+                        handleMessage(objectMapper.readValue(data, BroadcastMessage.class));
+                    }
+                }
+                publisherSocket = null;
+                socket.leaveGroup(group, networkInterface);
+            } catch (IOException e) {
+                throw new RuntimeException(e);
+            }
+        }
+    };
+
+}
diff --git a/src/main/java/org/traccar/broadcast/NullBroadcastService.java b/src/main/java/org/traccar/broadcast/NullBroadcastService.java
new file mode 100644
index 000000000..f95037990
--- /dev/null
+++ b/src/main/java/org/traccar/broadcast/NullBroadcastService.java
@@ -0,0 +1,36 @@
+/*
+ * Copyright 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.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.traccar.broadcast;
+
+public class NullBroadcastService implements BroadcastService {
+
+    @Override
+    public boolean singleInstance() {
+        return true;
+    }
+
+    @Override
+    public void registerListener(BroadcastInterface listener) {
+    }
+
+    @Override
+    public void start() throws Exception {
+    }
+
+    @Override
+    public void stop() throws Exception {
+    }
+}
diff --git a/src/main/java/org/traccar/broadcast/RedisBroadcastService.java b/src/main/java/org/traccar/broadcast/RedisBroadcastService.java
new file mode 100644
index 000000000..e87ad5e61
--- /dev/null
+++ b/src/main/java/org/traccar/broadcast/RedisBroadcastService.java
@@ -0,0 +1,130 @@
+/*
+ * Copyright 2023 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.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.traccar.broadcast;
+
+import com.fasterxml.jackson.databind.ObjectMapper;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import org.traccar.config.Config;
+import org.traccar.config.Keys;
+
+import java.io.IOException;
+import java.util.UUID;
+import java.util.concurrent.ExecutorService;
+import java.util.concurrent.Executors;
+import redis.clients.jedis.Jedis;
+import redis.clients.jedis.JedisPubSub;
+import redis.clients.jedis.exceptions.JedisConnectionException;
+import redis.clients.jedis.exceptions.JedisException;
+
+public class RedisBroadcastService extends BaseBroadcastService {
+
+    private static final Logger LOGGER = LoggerFactory.getLogger(RedisBroadcastService.class);
+
+    private final ObjectMapper objectMapper;
+
+    private final ExecutorService service = Executors.newSingleThreadExecutor();
+
+    private final String url;
+    private final String channel = "traccar";
+
+    private Jedis subscriber;
+    private Jedis publisher;
+
+    private final String id = UUID.randomUUID().toString();
+
+    public RedisBroadcastService(Config config, ObjectMapper objectMapper) throws IOException {
+        this.objectMapper = objectMapper;
+        url = config.getString(Keys.BROADCAST_ADDRESS);
+
+        try {
+            subscriber = new Jedis(url);
+            publisher = new Jedis(url);
+            subscriber.connect();
+        } catch (JedisConnectionException e) {
+            throw new IOException(e);
+        }
+    }
+
+    @Override
+    public boolean singleInstance() {
+        return false;
+    }
+
+    @Override
+    protected void sendMessage(BroadcastMessage message) {
+        try {
+            String payload = id  + ":" + objectMapper.writeValueAsString(message);
+            publisher.publish(channel, payload);
+        } catch (IOException e) {
+            LOGGER.warn("Broadcast failed", e);
+        } catch (JedisConnectionException e) {
+            LOGGER.warn("Broadcast failed", e);
+        }
+    }
+
+    @Override
+    public void start() throws IOException {
+        service.submit(receiver);
+    }
+
+    @Override
+    public void stop() {
+        try {
+            if (subscriber != null) {
+                subscriber.close();
+                subscriber = null;
+            }
+        } catch (JedisException e) {
+            LOGGER.warn("Subscriber close failed", e);
+        }
+        try {
+            if (publisher != null) {
+                publisher.close();
+                publisher = null;
+            }
+        } catch (JedisException e) {
+            LOGGER.warn("Publisher close failed", e);
+        }
+        service.shutdown();
+    }
+
+    private final Runnable receiver = new Runnable() {
+        @Override
+        public void run() {
+            try {
+                subscriber.subscribe(new JedisPubSub() {
+                    @Override
+                    public void onMessage(String messageChannel, String message) {
+                        try {
+                            String[] parts = message.split(":", 2);
+                            if (messageChannel.equals(channel) && parts.length == 2 && !id.equals(parts[0])) {
+                                handleMessage(objectMapper.readValue(parts[1], BroadcastMessage.class));
+                            }
+                        } catch (IOException e) {
+                            LOGGER.warn("Broadcast handleMessage failed", e);
+                        }
+                    }
+                }, channel);
+            } catch (JedisConnectionException e) {
+                throw new RuntimeException(e);
+            } catch (JedisException e) {
+                throw new RuntimeException(e);
+            }
+        }
+    };
+
+}