Add device sharing (fix #3789, fix #4936, fix #5025)

schema/changelog-5.11.xml

@@ -0,0 +1,17 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<databaseChangeLog
+  xmlns="http://www.liquibase.org/xml/ns/dbchangelog"
+  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+  xsi:schemaLocation="http://www.liquibase.org/xml/ns/dbchangelog
+                      http://www.liquibase.org/xml/ns/dbchangelog/dbchangelog-3.4.xsd"
+  logicalFilePath="changelog-5.11">
+
+  <changeSet author="author" id="changelog-5.11">
+
+    <addColumn tableName="tc_users">
+      <column name="temporary" type="BOOLEAN" defaultValueBoolean="false" />
+    </addColumn>
+
+  </changeSet>
+
+</databaseChangeLog>

schema/changelog-master.xml

@@ -41,5 +41,6 @@
   <include file="changelog-5.8.xml" relativeToChangelogFile="true" />
   <include file="changelog-5.9.xml" relativeToChangelogFile="true" />
   <include file="changelog-5.10.xml" relativeToChangelogFile="true" />
+  <include file="changelog-5.11.xml" relativeToChangelogFile="true" />
 
 </databaseChangeLog>

src/main/java/org/traccar/api/resource/DeviceResource.java

@@ -15,12 +15,15 @@
  */
 package org.traccar.api.resource;
 
+import jakarta.ws.rs.FormParam;
 import org.traccar.api.BaseObjectResource;
+import org.traccar.api.signature.TokenManager;
 import org.traccar.broadcast.BroadcastService;
 import org.traccar.database.MediaManager;
 import org.traccar.helper.LogAction;
 import org.traccar.model.Device;
 import org.traccar.model.DeviceAccumulators;
+import org.traccar.model.Permission;
 import org.traccar.model.Position;
 import org.traccar.model.User;
 import org.traccar.session.ConnectionManager;
@@ -46,7 +49,9 @@ import jakarta.ws.rs.core.Response;
 import java.io.File;
 import java.io.FileInputStream;
 import java.io.IOException;
+import java.security.GeneralSecurityException;
 import java.util.Collection;
+import java.util.Date;
 import java.util.LinkedList;
 import java.util.List;
 
@@ -67,6 +72,9 @@ public class DeviceResource extends BaseObjectResource<Device> {
     @Inject
     private MediaManager mediaManager;
 
+    @Inject
+    private TokenManager tokenManager;
+
     public DeviceResource() {
         super(Device.class);
     }
@@ -183,4 +191,33 @@ public class DeviceResource extends BaseObjectResource<Device> {
         return Response.status(Response.Status.NOT_FOUND).build();
     }
 
+    @Path("share")
+    @Consumes(MediaType.APPLICATION_FORM_URLENCODED)
+    @POST
+    public String shareDevice(
+            @FormParam("deviceId") long deviceId,
+            @FormParam("expiration") Date expiration) throws StorageException, GeneralSecurityException, IOException {
+
+        User user = permissionsService.getUser(getUserId());
+
+        Device device = storage.getObject(Device.class, new Request(
+                new Columns.All(),
+                new Condition.And(
+                        new Condition.Equals("id", deviceId),
+                        new Condition.Permission(User.class, user.getId(), Device.class))));
+
+        User share = new User();
+        share.setName(device.getName());
+        share.setEmail(user.getEmail() + ":" + device.getUniqueId());
+        share.setExpirationTime(expiration);
+        share.setTemporary(true);
+        share.setReadonly(true);
+
+        share.setId(storage.addObject(share, new Request(new Columns.Exclude("id"))));
+
+        storage.addPermission(new Permission(User.class, share.getId(), Device.class, deviceId));
+
+        return tokenManager.generateToken(share.getId(), expiration);
+    }
+
 }

src/main/java/org/traccar/model/User.java

@@ -261,6 +261,16 @@ public class User extends ExtendedModel implements UserRestrictions, Disableable
         this.totpKey = totpKey;
     }
 
+    private boolean temporary;
+
+    public boolean getTemporary() {
+        return temporary;
+    }
+
+    public void setTemporary(boolean temporary) {
+        this.temporary = temporary;
+    }
+
     @QueryIgnore
     public String getPassword() {
         return null;

src/main/java/org/traccar/schedule/ScheduleManager.java

@@ -39,6 +39,7 @@ public class ScheduleManager implements LifecycleObject {
     public void start() {
         executor = Executors.newSingleThreadScheduledExecutor();
         var tasks = List.of(
+                TaskDeleteTemporary.class,
                 TaskReports.class,
                 TaskDeviceInactivityCheck.class,
                 TaskWebSocketKeepalive.class,

src/main/java/org/traccar/schedule/TaskDeleteTemporary.java

@@ -0,0 +1,61 @@
+/*
+ * 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.schedule;
+
+import jakarta.inject.Inject;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import org.traccar.model.User;
+import org.traccar.storage.Storage;
+import org.traccar.storage.StorageException;
+import org.traccar.storage.query.Condition;
+import org.traccar.storage.query.Request;
+
+import java.util.Date;
+import java.util.concurrent.ScheduledExecutorService;
+import java.util.concurrent.TimeUnit;
+
+public class TaskDeleteTemporary implements ScheduleTask {
+
+    private static final Logger LOGGER = LoggerFactory.getLogger(TaskDeleteTemporary.class);
+
+    private static final long CHECK_PERIOD_HOURS = 1;
+
+    private final Storage storage;
+
+    @Inject
+    public TaskDeleteTemporary(Storage storage) {
+        this.storage = storage;
+    }
+
+    @Override
+    public void schedule(ScheduledExecutorService executor) {
+        executor.scheduleAtFixedRate(this, CHECK_PERIOD_HOURS, CHECK_PERIOD_HOURS, TimeUnit.HOURS);
+    }
+
+    @Override
+    public void run() {
+        try {
+           storage.removeObject(User.class, new Request(
+                    new Condition.And(
+                            new Condition.Equals("temporary", true),
+                            new Condition.Compare("expirationTime", "<", "time", new Date()))));
+        } catch (StorageException e) {
+            LOGGER.warn("Failed to delete temporary users", e);
+        }
+    }
+
+}

src/main/java/org/traccar/schedule/TaskReports.java

@@ -51,7 +51,7 @@ public class TaskReports implements ScheduleTask {
 
     private static final Logger LOGGER = LoggerFactory.getLogger(TaskReports.class);
 
-    private static final long CHECK_PERIOD_MINUTES = 1;
+    private static final long CHECK_PERIOD_MINUTES = 15;
 
     private final Storage storage;
     private final Injector injector;