Changes according to comments from @ashvayka

zbeacon
1 parent 8a5a4f09
Showing 12 changed files with 115 additions and 25 deletions
application/src/main/java/org/thingsboard/server/controller/FirmwareController.java
application/src/main/java/org/thingsboard/server/service/firmware/DefaultFirmwareStateService.java
common/dao-api/src/main/java/org/thingsboard/server/dao/firmware/FirmwareService.java
common/data/src/main/java/org/thingsboard/server/common/data/FirmwareInfo.java
common/data/src/main/java/org/thingsboard/server/common/data/firmware/ChecksumAlgorithm.java
dao/src/main/java/org/thingsboard/server/dao/firmware/BaseFirmwareService.java
dao/src/main/java/org/thingsboard/server/dao/model/sql/FirmwareEntity.java
dao/src/main/java/org/thingsboard/server/dao/model/sql/FirmwareInfoEntity.java
dao/src/test/java/org/thingsboard/server/dao/service/BaseDeviceProfileServiceTest.java
dao/src/test/java/org/thingsboard/server/dao/service/BaseDeviceServiceTest.java
dao/src/test/java/org/thingsboard/server/dao/service/BaseFirmwareServiceTest.java
ui-ngx/src/app/shared/models/firmware.models.ts
--- a/application/src/main/java/org/thingsboard/server/controller/FirmwareController.java
View file @7a4d302
+++ b/application/src/main/java/org/thingsboard/server/controller/FirmwareController.java
View file @7a4d302
@@ -15,7 +15,6 @@
  */
 package org.thingsboard.server.controller;
-import com.google.common.hash.Hashing;
 import lombok.extern.slf4j.Slf4j;
 import org.apache.commons.lang3.StringUtils;
 import org.springframework.core.io.ByteArrayResource;
@@ -33,6 +32,7 @@ import org.springframework.web.multipart.MultipartFile;
 import org.thingsboard.server.common.data.Firmware;
 import org.thingsboard.server.common.data.FirmwareInfo;
 import org.thingsboard.server.common.data.exception.ThingsboardException;
+import org.thingsboard.server.common.data.firmware.ChecksumAlgorithm;
 import org.thingsboard.server.common.data.id.FirmwareId;
 import org.thingsboard.server.common.data.page.PageData;
 import org.thingsboard.server.common.data.page.PageLink;
@@ -49,6 +49,7 @@ import java.nio.ByteBuffer;
 public class FirmwareController extends BaseController {
     public static final String FIRMWARE_ID = "firmwareId";
+    public static final String CHECKSUM_ALGORITHM = "checksumAlgorithm";
     @PreAuthorize("hasAnyAuthority( 'TENANT_ADMIN')")
     @RequestMapping(value = "/firmware/{firmwareId}/download", method = RequestMethod.GET)
@@ -115,9 +116,10 @@ public class FirmwareController extends BaseController {
     @ResponseBody
     public Firmware saveFirmwareData(@PathVariable(FIRMWARE_ID) String strFirmwareId,
                                      @RequestParam(required = false) String checksum,
-                                     @RequestParam() String checksumAlgorithm,
+                                     @RequestParam(CHECKSUM_ALGORITHM) String checksumAlgorithmStr,
                                      @RequestBody MultipartFile file) throws ThingsboardException {
         checkParameter(FIRMWARE_ID, strFirmwareId);
+        checkParameter(CHECKSUM_ALGORITHM, checksumAlgorithmStr);
         try {
             FirmwareId firmwareId = new FirmwareId(toUUID(strFirmwareId));
             FirmwareInfo info = checkFirmwareInfoId(firmwareId, Operation.READ);
@@ -129,6 +131,8 @@ public class FirmwareController extends BaseController {
             firmware.setVersion(info.getVersion());
             firmware.setAdditionalInfo(info.getAdditionalInfo());
+            ChecksumAlgorithm checksumAlgorithm = ChecksumAlgorithm.valueOf(checksumAlgorithmStr.toUpperCase());
+
             ByteBuffer data = ByteBuffer.wrap(file.getBytes());
             if (StringUtils.isEmpty(checksum)) {
                 checksum = firmwareService.generateChecksum(checksumAlgorithm, data);
@@ -139,7 +143,7 @@ public class FirmwareController extends BaseController {
             firmware.setFileName(file.getOriginalFilename());
             firmware.setContentType(file.getContentType());
             firmware.setData(data);
-            firmware.setDataSize((long) data.array().length);
+            firmware.setDataSize((long) data.capacity());
             return firmwareService.saveFirmware(firmware);
         } catch (Exception e) {
             throw handleException(e);
--- a/application/src/main/java/org/thingsboard/server/service/firmware/DefaultFirmwareStateService.java
View file @7a4d302
+++ b/application/src/main/java/org/thingsboard/server/service/firmware/DefaultFirmwareStateService.java
View file @7a4d302
@@ -227,7 +227,7 @@ public class DefaultFirmwareStateService implements FirmwareStateService {
         attributes.add(new BaseAttributeKvEntry(ts, new StringDataEntry(DataConstants.FIRMWARE_VERSION, firmware.getVersion())));
         attributes.add(new BaseAttributeKvEntry(ts, new LongDataEntry(FIRMWARE_SIZE, firmware.getDataSize())));
-        attributes.add(new BaseAttributeKvEntry(ts, new StringDataEntry(DataConstants.FIRMWARE_CHECKSUM_ALGORITHM, firmware.getChecksumAlgorithm())));
+        attributes.add(new BaseAttributeKvEntry(ts, new StringDataEntry(DataConstants.FIRMWARE_CHECKSUM_ALGORITHM, firmware.getChecksumAlgorithm().name())));
         attributes.add(new BaseAttributeKvEntry(ts, new StringDataEntry(DataConstants.FIRMWARE_CHECKSUM, firmware.getChecksum())));
         telemetryService.saveAndNotify(tenantId, deviceId, DataConstants.SHARED_SCOPE, attributes, new FutureCallback<>() {
             @Override
--- a/common/dao-api/src/main/java/org/thingsboard/server/dao/firmware/FirmwareService.java
View file @7a4d302
+++ b/common/dao-api/src/main/java/org/thingsboard/server/dao/firmware/FirmwareService.java
View file @7a4d302
@@ -17,6 +17,8 @@ package org.thingsboard.server.dao.firmware;
 import org.thingsboard.server.common.data.Firmware;
 import org.thingsboard.server.common.data.FirmwareInfo;
+import org.thingsboard.server.common.data.exception.ThingsboardException;
+import org.thingsboard.server.common.data.firmware.ChecksumAlgorithm;
 import org.thingsboard.server.common.data.id.FirmwareId;
 import org.thingsboard.server.common.data.id.TenantId;
 import org.thingsboard.server.common.data.page.PageData;
@@ -30,7 +32,9 @@ public interface FirmwareService {
     Firmware saveFirmware(Firmware firmware);
-    String generateChecksum(String checksumAlgorithm, ByteBuffer data);
+    PageData<String> getSupportedChecksumAlgorithms(PageLink pageLink);
+
+    String generateChecksum(ChecksumAlgorithm checksumAlgorithm, ByteBuffer data) throws ThingsboardException;
     Firmware findFirmwareById(TenantId tenantId, FirmwareId firmwareId);
--- a/common/data/src/main/java/org/thingsboard/server/common/data/FirmwareInfo.java
View file @7a4d302
+++ b/common/data/src/main/java/org/thingsboard/server/common/data/FirmwareInfo.java
View file @7a4d302
@@ -18,6 +18,7 @@ package org.thingsboard.server.common.data;
 import lombok.Data;
 import lombok.EqualsAndHashCode;
 import lombok.extern.slf4j.Slf4j;
+import org.thingsboard.server.common.data.firmware.ChecksumAlgorithm;
 import org.thingsboard.server.common.data.id.FirmwareId;
 import org.thingsboard.server.common.data.id.TenantId;
@@ -34,7 +35,7 @@ public class FirmwareInfo extends SearchTextBasedWithAdditionalInfo<FirmwareId> 
     private boolean hasData;
     private String fileName;
     private String contentType;
-    private String checksumAlgorithm;
+    private ChecksumAlgorithm checksumAlgorithm;
     private String checksum;
     private Long dataSize;
--- a/common/data/src/main/java/org/thingsboard/server/common/data/firmware/ChecksumAlgorithm.java 0 → 100644
View file @7a4d302
+++ b/common/data/src/main/java/org/thingsboard/server/common/data/firmware/ChecksumAlgorithm.java 0 → 100644
View file @7a4d302
+/**
+ * Copyright © 2016-2021 The Thingsboard Authors
+ *
+ * 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.thingsboard.server.common.data.firmware;
+
+public enum ChecksumAlgorithm {
+    MD5,
+    SHA256,
+    SHA384,
+    SHA512,
+    CRC32,
+    MURMUR3_32,
+    MURMUR3_128
+}
--- a/dao/src/main/java/org/thingsboard/server/dao/firmware/BaseFirmwareService.java
View file @7a4d302
+++ b/dao/src/main/java/org/thingsboard/server/dao/firmware/BaseFirmwareService.java
View file @7a4d302
@@ -26,6 +26,9 @@ import org.springframework.stereotype.Service;
 import org.thingsboard.server.common.data.Firmware;
 import org.thingsboard.server.common.data.FirmwareInfo;
 import org.thingsboard.server.common.data.Tenant;
+import org.thingsboard.server.common.data.exception.ThingsboardErrorCode;
+import org.thingsboard.server.common.data.exception.ThingsboardException;
+import org.thingsboard.server.common.data.firmware.ChecksumAlgorithm;
 import org.thingsboard.server.common.data.id.FirmwareId;
 import org.thingsboard.server.common.data.id.TenantId;
 import org.thingsboard.server.common.data.page.PageData;
@@ -35,8 +38,13 @@ import org.thingsboard.server.dao.service.DataValidator;
 import org.thingsboard.server.dao.service.PaginatedRemover;
 import org.thingsboard.server.dao.tenant.TenantDao;
+import java.lang.reflect.InvocationTargetException;
+import java.lang.reflect.Method;
 import java.nio.ByteBuffer;
+import java.util.ArrayList;
+import java.util.Arrays;
 import java.util.Collections;
+import java.util.List;
 import java.util.Optional;
 import static org.thingsboard.server.common.data.CacheConstants.FIRMWARE_CACHE;
@@ -102,7 +110,7 @@ public class BaseFirmwareService implements FirmwareService {
     }
     @Override
-    public String generateChecksum(String checksumAlgorithm, ByteBuffer data) {
+    public String generateChecksum(ChecksumAlgorithm checksumAlgorithm, ByteBuffer data) throws ThingsboardException {
         if (data == null || !data.hasArray() || data.array().length == 0) {
             throw new DataValidationException("Firmware data should be specified!");
@@ -110,22 +118,43 @@ public class BaseFirmwareService implements FirmwareService {
         HashFunction hashFunction;
         switch (checksumAlgorithm) {
-            case "sha256":
+            case MD5:
+                hashFunction = Hashing.md5();
+                break;
+            case SHA256:
                 hashFunction = Hashing.sha256();
                 break;
-            case "md5":
-                hashFunction = Hashing.md5();
+            case SHA384:
+                hashFunction = Hashing.sha384();
                 break;
-            case "crc32":
+            case SHA512:
+                hashFunction = Hashing.sha512();
+                break;
+            case CRC32:
                 hashFunction = Hashing.crc32();
                 break;
+            case MURMUR3_32:
+                hashFunction = Hashing.murmur3_32();
+                break;
+            case MURMUR3_128:
+                hashFunction = Hashing.murmur3_128();
+                break;
             default:
                 throw new DataValidationException("Unknown checksum algorithm!");
         }
-
         return hashFunction.hashBytes(data.array()).toString();
     }
+    @Override
+    public PageData<String> getSupportedChecksumAlgorithms(PageLink pageLink) {
+        List<String> methodNames = new ArrayList<>();
+        Method[] hashingMethods = Hashing.class.getMethods();
+        Arrays.stream(hashingMethods).forEach(method -> {
+            methodNames.add(method.getName());
+        });
+        return new PageData<>(methodNames, 1, methodNames.size(), false);
+    }
+
     @Override
     public Firmware findFirmwareById(TenantId tenantId, FirmwareId firmwareId) {
@@ -150,7 +179,8 @@ public class BaseFirmwareService implements FirmwareService {
     }
     @Override
-    public PageData<FirmwareInfo> findTenantFirmwaresByTenantIdAndHasData(TenantId tenantId, boolean hasData, PageLink pageLink) {
+    public PageData<FirmwareInfo> findTenantFirmwaresByTenantIdAndHasData(TenantId tenantId,
+                                                                          boolean hasData, PageLink pageLink) {
         log.trace("Executing findTenantFirmwaresByTenantIdAndHasData, tenantId [{}], hasData [{}] pageLink [{}]", tenantId, hasData, pageLink);
         validateId(tenantId, INCORRECT_TENANT_ID + tenantId);
         validatePageLink(pageLink);
@@ -243,14 +273,20 @@ public class BaseFirmwareService implements FirmwareService {
                 throw new DataValidationException("Firmware content type should be specified!");
             }
-            if (StringUtils.isEmpty(firmware.getChecksumAlgorithm())) {
+            if (firmware.getChecksumAlgorithm() == null) {
                 throw new DataValidationException("Firmware checksum algorithm should be specified!");
             }
             if (StringUtils.isEmpty(firmware.getChecksum())) {
                 throw new DataValidationException("Firmware checksum should be specified!");
             }
-            String currentChecksum = generateChecksum(firmware.getChecksumAlgorithm(), firmware.getData());
+            String currentChecksum;
+
+            try {
+                 currentChecksum = generateChecksum(firmware.getChecksumAlgorithm(), firmware.getData());
+            } catch (ThingsboardException e) {
+                throw new DataValidationException(e.getMessage());
+            }
             if (!currentChecksum.equals(firmware.getChecksum())) {
                 throw new DataValidationException("Wrong firmware file!");
--- a/dao/src/main/java/org/thingsboard/server/dao/model/sql/FirmwareEntity.java
View file @7a4d302
+++ b/dao/src/main/java/org/thingsboard/server/dao/model/sql/FirmwareEntity.java
View file @7a4d302
@@ -21,6 +21,7 @@ import lombok.EqualsAndHashCode;
 import org.hibernate.annotations.Type;
 import org.hibernate.annotations.TypeDef;
 import org.thingsboard.server.common.data.Firmware;
+import org.thingsboard.server.common.data.firmware.ChecksumAlgorithm;
 import org.thingsboard.server.common.data.id.FirmwareId;
 import org.thingsboard.server.common.data.id.TenantId;
 import org.thingsboard.server.dao.model.BaseSqlEntity;
@@ -30,6 +31,8 @@ import org.thingsboard.server.dao.util.mapping.JsonStringType;
 import javax.persistence.Column;
 import javax.persistence.Entity;
+import javax.persistence.EnumType;
+import javax.persistence.Enumerated;
 import javax.persistence.Table;
 import java.nio.ByteBuffer;
 import java.util.UUID;
@@ -68,8 +71,9 @@ public class FirmwareEntity extends BaseSqlEntity<Firmware> implements SearchTex
     @Column(name = FIRMWARE_CONTENT_TYPE_COLUMN)
     private String contentType;
+    @Enumerated(EnumType.STRING)
     @Column(name = FIRMWARE_CHECKSUM_ALGORITHM_COLUMN)
-    private String checksumAlgorithm;
+    private ChecksumAlgorithm checksumAlgorithm;
     @Column(name = FIRMWARE_CHECKSUM_COLUMN)
     private String checksum;
--- a/dao/src/main/java/org/thingsboard/server/dao/model/sql/FirmwareInfoEntity.java
View file @7a4d302
+++ b/dao/src/main/java/org/thingsboard/server/dao/model/sql/FirmwareInfoEntity.java
View file @7a4d302
@@ -22,6 +22,7 @@ import org.hibernate.annotations.Type;
 import org.hibernate.annotations.TypeDef;
 import org.thingsboard.common.util.JacksonUtil;
 import org.thingsboard.server.common.data.FirmwareInfo;
+import org.thingsboard.server.common.data.firmware.ChecksumAlgorithm;
 import org.thingsboard.server.common.data.id.FirmwareId;
 import org.thingsboard.server.common.data.id.TenantId;
 import org.thingsboard.server.dao.model.BaseSqlEntity;
@@ -31,6 +32,8 @@ import org.thingsboard.server.dao.util.mapping.JsonStringType;
 import javax.persistence.Column;
 import javax.persistence.Entity;
+import javax.persistence.EnumType;
+import javax.persistence.Enumerated;
 import javax.persistence.Table;
 import javax.persistence.Transient;
 import java.util.UUID;
@@ -70,8 +73,9 @@ public class FirmwareInfoEntity extends BaseSqlEntity<FirmwareInfo> implements S
     @Column(name = FIRMWARE_CONTENT_TYPE_COLUMN)
     private String contentType;
+    @Enumerated(EnumType.STRING)
     @Column(name = FIRMWARE_CHECKSUM_ALGORITHM_COLUMN)
-    private String checksumAlgorithm;
+    private ChecksumAlgorithm checksumAlgorithm;
     @Column(name = FIRMWARE_CHECKSUM_COLUMN)
     private String checksum;
@@ -108,7 +112,7 @@ public class FirmwareInfoEntity extends BaseSqlEntity<FirmwareInfo> implements S
     }
     public FirmwareInfoEntity(UUID id, long createdTime, UUID tenantId, String title, String version,
-                              String fileName, String contentType, String checksumAlgorithm, String checksum, Long dataSize,
+                              String fileName, String contentType, ChecksumAlgorithm checksumAlgorithm, String checksum, Long dataSize,
                               Object additionalInfo, boolean hasData) {
         this.id = id;
         this.createdTime = createdTime;
--- a/dao/src/test/java/org/thingsboard/server/dao/service/BaseDeviceProfileServiceTest.java
View file @7a4d302
+++ b/dao/src/test/java/org/thingsboard/server/dao/service/BaseDeviceProfileServiceTest.java
View file @7a4d302
@@ -30,6 +30,7 @@ import org.thingsboard.server.common.data.DeviceProfileInfo;
 import org.thingsboard.server.common.data.DeviceTransportType;
 import org.thingsboard.server.common.data.Firmware;
 import org.thingsboard.server.common.data.Tenant;
+import org.thingsboard.server.common.data.firmware.ChecksumAlgorithm;
 import org.thingsboard.server.common.data.id.TenantId;
 import org.thingsboard.server.common.data.page.PageData;
 import org.thingsboard.server.common.data.page.PageLink;
@@ -101,7 +102,7 @@ public class BaseDeviceProfileServiceTest extends AbstractServiceTest {
         firmware.setVersion("v1.0");
         firmware.setFileName("test.txt");
         firmware.setContentType("text/plain");
-        firmware.setChecksumAlgorithm("sha256");
+        firmware.setChecksumAlgorithm(ChecksumAlgorithm.SHA256);
         firmware.setChecksum("4bf5122f344554c53bde2ebb8cd2b7e3d1600ad631c385a5d7cce23c7785459a");
         firmware.setData(ByteBuffer.wrap(new byte[]{1}));
         Firmware savedFirmware = firmwareService.saveFirmware(firmware);
--- a/dao/src/test/java/org/thingsboard/server/dao/service/BaseDeviceServiceTest.java
View file @7a4d302
+++ b/dao/src/test/java/org/thingsboard/server/dao/service/BaseDeviceServiceTest.java
View file @7a4d302
@@ -28,6 +28,7 @@ import org.thingsboard.server.common.data.EntitySubtype;
 import org.thingsboard.server.common.data.Firmware;
 import org.thingsboard.server.common.data.Tenant;
 import org.thingsboard.server.common.data.TenantProfile;
+import org.thingsboard.server.common.data.firmware.ChecksumAlgorithm;
 import org.thingsboard.server.common.data.id.CustomerId;
 import org.thingsboard.server.common.data.id.TenantId;
 import org.thingsboard.server.common.data.page.PageData;
@@ -187,7 +188,7 @@ public abstract class BaseDeviceServiceTest extends AbstractServiceTest {
         firmware.setVersion("v1.0");
         firmware.setFileName("test.txt");
         firmware.setContentType("text/plain");
-        firmware.setChecksumAlgorithm("sha256");
+        firmware.setChecksumAlgorithm(ChecksumAlgorithm.SHA256);
         firmware.setChecksum("4bf5122f344554c53bde2ebb8cd2b7e3d1600ad631c385a5d7cce23c7785459a");
         firmware.setData(ByteBuffer.wrap(new byte[]{1}));
         Firmware savedFirmware = firmwareService.saveFirmware(firmware);
--- a/dao/src/test/java/org/thingsboard/server/dao/service/BaseFirmwareServiceTest.java
View file @7a4d302
+++ b/dao/src/test/java/org/thingsboard/server/dao/service/BaseFirmwareServiceTest.java
View file @7a4d302
@@ -26,6 +26,7 @@ import org.thingsboard.server.common.data.DeviceProfile;
 import org.thingsboard.server.common.data.Firmware;
 import org.thingsboard.server.common.data.FirmwareInfo;
 import org.thingsboard.server.common.data.Tenant;
+import org.thingsboard.server.common.data.firmware.ChecksumAlgorithm;
 import org.thingsboard.server.common.data.id.TenantId;
 import org.thingsboard.server.common.data.page.PageData;
 import org.thingsboard.server.common.data.page.PageLink;
@@ -42,7 +43,7 @@ public abstract class BaseFirmwareServiceTest extends AbstractServiceTest {
     private static final String FILE_NAME = "filename.txt";
     private static final String VERSION = "v1.0";
     private static final String CONTENT_TYPE = "text/plain";
-    private static final String CHECKSUM_ALGORITHM = "sha256";
+    private static final ChecksumAlgorithm CHECKSUM_ALGORITHM = ChecksumAlgorithm.SHA256;
     private static final String CHECKSUM = "4bf5122f344554c53bde2ebb8cd2b7e3d1600ad631c385a5d7cce23c7785459a";
     private static final ByteBuffer DATA = ByteBuffer.wrap(new byte[]{1});
--- a/ui-ngx/src/app/shared/models/firmware.models.ts
View file @7a4d302
+++ b/ui-ngx/src/app/shared/models/firmware.models.ts
View file @7a4d302
@@ -19,16 +19,24 @@ import { TenantId } from '@shared/models/id/tenant-id';
 import { FirmwareId } from '@shared/models/id/firmware-id';
 export enum ChecksumAlgorithm {
-  MD5 = 'md5',
-  SHA256 = 'sha256',
-  CRC32 = 'crc32'
+  MD5 = 'MD5',
+  SHA256 = 'SHA256',
+  SHA384 = 'SHA384',
+  SHA512 = 'SHA512',
+  CRC32 = 'CRC32',
+  MURMUR3_32 = 'MURMUR3_32',
+  MURMUR3_128 = 'MURMUR3_128'
 }
 export const ChecksumAlgorithmTranslationMap = new Map<ChecksumAlgorithm, string>(
   [
     [ChecksumAlgorithm.MD5, 'MD5'],
     [ChecksumAlgorithm.SHA256, 'SHA-256'],
-    [ChecksumAlgorithm.CRC32, 'CRC-32']
+    [ChecksumAlgorithm.SHA384, 'SHA-384'],
+    [ChecksumAlgorithm.SHA512, 'SHA-512'],
+    [ChecksumAlgorithm.CRC32, 'CRC-32'],
+    [ChecksumAlgorithm.MURMUR3_32, 'MURMUR3-32'],
+    [ChecksumAlgorithm.MURMUR3_128, 'MURMUR3-128']
   ]
 );