Merge pull request #9846 from thingsboard/feature/public-images

Public images

application/src/main/data/upgrade/3.6.1/schema_update.sql

@@ -16,6 +16,28 @@
 
 -- RESOURCES UPDATE START
 
+ALTER TABLE resource ADD COLUMN IF NOT EXISTS descriptor varchar;
+ALTER TABLE resource ADD COLUMN IF NOT EXISTS preview bytea;
+ALTER TABLE resource ADD COLUMN IF NOT EXISTS external_id uuid;
+ALTER TABLE resource ADD COLUMN IF NOT EXISTS is_public boolean default true;
+ALTER TABLE resource ADD COLUMN IF NOT EXISTS public_resource_key varchar(32) unique;
+
+CREATE INDEX IF NOT EXISTS idx_resource_etag ON resource(tenant_id, etag);
+CREATE INDEX IF NOT EXISTS idx_resource_type_public_resource_key ON resource(resource_type, public_resource_key);
+
+CREATE OR REPLACE FUNCTION generate_resource_public_key()
+RETURNS text AS $$
+DECLARE
+  chars text := 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789';
+  result text := '';
+BEGIN
+  FOR i IN 1..32 LOOP
+    result := result || substr(chars, floor(random()*62)::int + 1, 1);
+  END LOOP;
+  RETURN result;
+END;
+$$ LANGUAGE plpgsql;
+
 DO
 $$
     BEGIN
@@ -24,15 +46,13 @@ $$
             ALTER TABLE resource ADD COLUMN data bytea;
             UPDATE resource SET data = decode(base64_data, 'base64') WHERE base64_data IS NOT NULL;
             ALTER TABLE resource DROP COLUMN base64_data;
+        ELSE
+            UPDATE resource SET public_resource_key = generate_resource_public_key() WHERE resource_type = 'IMAGE' AND public_resource_key IS NULL;
         END IF;
     END;
 $$;
 
-ALTER TABLE resource ADD COLUMN IF NOT EXISTS descriptor varchar;
-ALTER TABLE resource ADD COLUMN IF NOT EXISTS preview bytea;
-ALTER TABLE resource ADD COLUMN IF NOT EXISTS external_id uuid;
-
-CREATE INDEX IF NOT EXISTS idx_resource_etag ON resource(tenant_id, etag);
+DROP FUNCTION generate_resource_public_key;
 
 -- RESOURCES UPDATE END
 

application/src/main/java/org/thingsboard/server/config/ThingsboardSecurityConfiguration.java

@@ -75,7 +75,7 @@ public class ThingsboardSecurityConfiguration {
     public static final String FORM_BASED_LOGIN_ENTRY_POINT = "/api/auth/login";
     public static final String PUBLIC_LOGIN_ENTRY_POINT = "/api/auth/login/public";
     public static final String TOKEN_REFRESH_ENTRY_POINT = "/api/auth/token";
-    protected static final String[] NON_TOKEN_BASED_AUTH_ENTRY_POINTS = new String[] {"/index.html", "/assets/**", "/static/**", "/api/noauth/**", "/webjars/**",  "/api/license/**"};
+    protected static final String[] NON_TOKEN_BASED_AUTH_ENTRY_POINTS = new String[] {"/index.html", "/assets/**", "/static/**", "/api/noauth/**", "/webjars/**",  "/api/license/**", "/api/images/public/**"};
     public static final String TOKEN_BASED_AUTH_ENTRY_POINT = "/api/**";
     public static final String WS_ENTRY_POINT = "/api/ws/**";
     public static final String MAIL_OAUTH2_PROCESSING_ENTRY_POINT = "/api/admin/mail/oauth2/code";

application/src/main/java/org/thingsboard/server/controller/ImageController.java

@@ -15,7 +15,6 @@
  */
 package org.thingsboard.server.controller;
 
-import com.fasterxml.jackson.core.JsonProcessingException;
 import io.swagger.annotations.ApiParam;
 import lombok.RequiredArgsConstructor;
 import lombok.extern.slf4j.Slf4j;
@@ -50,6 +49,7 @@
 import org.thingsboard.server.common.data.page.PageData;
 import org.thingsboard.server.common.data.page.PageLink;
 import org.thingsboard.server.common.data.security.Authority;
+import org.thingsboard.server.common.data.util.ThrowingSupplier;
 import org.thingsboard.server.dao.resource.ImageCacheKey;
 import org.thingsboard.server.dao.resource.ImageService;
 import org.thingsboard.server.dao.service.validator.ResourceDataValidator;
@@ -89,6 +89,10 @@ public class ImageController extends BaseController {
     private static final String SYSTEM_IMAGE = "system";
     private static final String TENANT_IMAGE = "tenant";
 
+    private static final String IMAGE_TYPE_PARAM_DESCRIPTION = "Type of the image: tenant or system";
+    private static final String IMAGE_TYPE_PARAM_ALLOWABLE_VALUES = "tenant, system";
+    private static final String IMAGE_KEY_PARAM_DESCRIPTION = "Image resource key, for example thermostats_dashboard_background.jpeg";
+
     @PreAuthorize("hasAnyAuthority('SYS_ADMIN', 'TENANT_ADMIN')")
     @PostMapping("/api/image")
     public TbResourceInfo uploadImage(@RequestPart MultipartFile file,
@@ -110,12 +114,15 @@ public TbResourceInfo uploadImage(@RequestPart MultipartFile file,
         descriptor.setMediaType(file.getContentType());
         image.setDescriptorValue(descriptor);
         image.setData(file.getBytes());
+        image.setPublic(true);
         return tbImageService.save(image, user);
     }
 
     @PreAuthorize("hasAnyAuthority('SYS_ADMIN', 'TENANT_ADMIN')")
     @PutMapping(IMAGE_URL)
-    public TbResourceInfo updateImage(@PathVariable String type,
+    public TbResourceInfo updateImage(@ApiParam(value = IMAGE_TYPE_PARAM_DESCRIPTION, allowableValues = IMAGE_TYPE_PARAM_ALLOWABLE_VALUES, required = true)
+                                      @PathVariable String type,
+                                      @ApiParam(value = IMAGE_KEY_PARAM_DESCRIPTION, required = true)
                                       @PathVariable String key,
                                       @RequestPart MultipartFile file) throws Exception {
         TbResourceInfo imageInfo = checkImageInfo(type, key, Operation.WRITE);
@@ -133,29 +140,65 @@ public TbResourceInfo updateImage(@PathVariable String type,
 
     @PreAuthorize("hasAnyAuthority('SYS_ADMIN', 'TENANT_ADMIN')")
     @PutMapping(IMAGE_URL + "/info")
-    public TbResourceInfo updateImageInfo(@PathVariable String type,
+    public TbResourceInfo updateImageInfo(@ApiParam(value = IMAGE_TYPE_PARAM_DESCRIPTION, allowableValues = IMAGE_TYPE_PARAM_ALLOWABLE_VALUES, required = true)
+                                          @PathVariable String type,
+                                          @ApiParam(value = IMAGE_KEY_PARAM_DESCRIPTION, required = true)
                                           @PathVariable String key,
-                                          @RequestBody TbResourceInfo newImageInfo) throws ThingsboardException {
+                                          @RequestBody TbResourceInfo request) throws ThingsboardException {
+        TbResourceInfo imageInfo = checkImageInfo(type, key, Operation.WRITE);
+        TbResourceInfo newImageInfo = new TbResourceInfo(imageInfo);
+        newImageInfo.setTitle(request.getTitle());
+        return tbImageService.save(newImageInfo, imageInfo, getCurrentUser());
+    }
+
+    @PreAuthorize("hasAnyAuthority('SYS_ADMIN', 'TENANT_ADMIN')")
+    @PutMapping(IMAGE_URL + "/public/{isPublic}")
+    public TbResourceInfo updateImagePublicStatus(@ApiParam(value = IMAGE_TYPE_PARAM_DESCRIPTION, allowableValues = IMAGE_TYPE_PARAM_ALLOWABLE_VALUES, required = true)
+                                                  @PathVariable String type,
+                                                  @ApiParam(value = IMAGE_KEY_PARAM_DESCRIPTION, required = true)
+                                                  @PathVariable String key,
+                                                  @PathVariable boolean isPublic) throws ThingsboardException {
         TbResourceInfo imageInfo = checkImageInfo(type, key, Operation.WRITE);
-        imageInfo.setTitle(newImageInfo.getTitle());
-        return tbImageService.save(imageInfo, getCurrentUser());
+        TbResourceInfo newImageInfo = new TbResourceInfo(imageInfo);
+        newImageInfo.setPublic(isPublic);
+        return tbImageService.save(newImageInfo, imageInfo, getCurrentUser());
     }
 
     @PreAuthorize("hasAnyAuthority('SYS_ADMIN', 'TENANT_ADMIN', 'CUSTOMER_USER')")
     @GetMapping(value = IMAGE_URL, produces = "image/*")
-    public ResponseEntity<ByteArrayResource> downloadImage(@PathVariable String type,
+    public ResponseEntity<ByteArrayResource> downloadImage(@ApiParam(value = IMAGE_TYPE_PARAM_DESCRIPTION, allowableValues = IMAGE_TYPE_PARAM_ALLOWABLE_VALUES, required = true)
+                                                           @PathVariable String type,
+                                                           @ApiParam(value = IMAGE_KEY_PARAM_DESCRIPTION, required = true)
                                                            @PathVariable String key,
                                                            @RequestHeader(name = HttpHeaders.IF_NONE_MATCH, required = false) String etag) throws Exception {
         return downloadIfChanged(type, key, etag, false);
     }
 
+    @GetMapping(value = "/api/images/public/{publicResourceKey}", produces = "image/*")
+    public ResponseEntity<ByteArrayResource> downloadPublicImage(@PathVariable String publicResourceKey,
+                                                                 @RequestHeader(name = HttpHeaders.IF_NONE_MATCH, required = false) String etag) throws Exception {
+        ImageCacheKey cacheKey = ImageCacheKey.forPublicImage(publicResourceKey);
+        return downloadIfChanged(cacheKey, etag, () -> imageService.getPublicImageInfoByKey(publicResourceKey));
+    }
+
     @PreAuthorize("hasAnyAuthority('SYS_ADMIN', 'TENANT_ADMIN')")
     @GetMapping(value = IMAGE_URL + "/export")
-    public ImageExportData exportImage(@PathVariable String type, @PathVariable String key) throws Exception {
+    public ImageExportData exportImage(@ApiParam(value = IMAGE_TYPE_PARAM_DESCRIPTION, allowableValues = IMAGE_TYPE_PARAM_ALLOWABLE_VALUES, required = true)
+                                       @PathVariable String type,
+                                       @ApiParam(value = IMAGE_KEY_PARAM_DESCRIPTION, required = true)
+                                       @PathVariable String key) throws Exception {
         TbResourceInfo imageInfo = checkImageInfo(type, key, Operation.READ);
         ImageDescriptor descriptor = imageInfo.getDescriptor(ImageDescriptor.class);
         byte[] data = imageService.getImageData(imageInfo.getTenantId(), imageInfo.getId());
-        return new ImageExportData(descriptor.getMediaType(), imageInfo.getFileName(), imageInfo.getTitle(), imageInfo.getResourceKey(), Base64Utils.encodeToString(data));
+        return ImageExportData.builder()
+                .mediaType(descriptor.getMediaType())
+                .fileName(imageInfo.getFileName())
+                .title(imageInfo.getTitle())
+                .resourceKey(imageInfo.getResourceKey())
+                .isPublic(imageInfo.isPublic())
+                .publicResourceKey(imageInfo.getPublicResourceKey())
+                .data(Base64Utils.encodeToString(data))
+                .build();
     }
 
     @PreAuthorize("hasAnyAuthority('SYS_ADMIN', 'TENANT_ADMIN')")
@@ -172,27 +215,32 @@ public TbResourceInfo importImage(@RequestBody ImageExportData imageData) throws
         } else {
             image.setTitle(imageData.getFileName());
         }
-        image.setResourceKey(imageData.getResourceKey());
         image.setResourceType(ResourceType.IMAGE);
+        image.setResourceKey(imageData.getResourceKey());
+        image.setPublic(imageData.isPublic());
+        image.setPublicResourceKey(imageData.getPublicResourceKey());
         ImageDescriptor descriptor = new ImageDescriptor();
         descriptor.setMediaType(imageData.getMediaType());
         image.setDescriptorValue(descriptor);
         image.setData(Base64Utils.decodeFromString(imageData.getData()));
         return tbImageService.save(image, user);
-
     }
 
     @PreAuthorize("hasAnyAuthority('SYS_ADMIN', 'TENANT_ADMIN', 'CUSTOMER_USER')")
     @GetMapping(value = IMAGE_URL + "/preview", produces = "image/png")
-    public ResponseEntity<ByteArrayResource> downloadImagePreview(@PathVariable String type,
+    public ResponseEntity<ByteArrayResource> downloadImagePreview(@ApiParam(value = IMAGE_TYPE_PARAM_DESCRIPTION, allowableValues = IMAGE_TYPE_PARAM_ALLOWABLE_VALUES, required = true)
+                                                                  @PathVariable String type,
+                                                                  @ApiParam(value = IMAGE_KEY_PARAM_DESCRIPTION, required = true)
                                                                   @PathVariable String key,
                                                                   @RequestHeader(name = HttpHeaders.IF_NONE_MATCH, required = false) String etag) throws Exception {
         return downloadIfChanged(type, key, etag, true);
     }
 
     @PreAuthorize("hasAnyAuthority('SYS_ADMIN', 'TENANT_ADMIN')")
     @GetMapping(IMAGE_URL + "/info")
-    public TbResourceInfo getImageInfo(@PathVariable String type,
+    public TbResourceInfo getImageInfo(@ApiParam(value = IMAGE_TYPE_PARAM_DESCRIPTION, allowableValues = IMAGE_TYPE_PARAM_ALLOWABLE_VALUES, required = true)
+                                       @PathVariable String type,
+                                       @ApiParam(value = IMAGE_KEY_PARAM_DESCRIPTION, required = true)
                                        @PathVariable String key) throws ThingsboardException {
         return checkImageInfo(type, key, Operation.READ);
     }
@@ -223,40 +271,49 @@ public PageData<TbResourceInfo> getImages(@ApiParam(value = PAGE_SIZE_DESCRIPTIO
 
     @PreAuthorize("hasAnyAuthority('SYS_ADMIN', 'TENANT_ADMIN')")
     @DeleteMapping(IMAGE_URL)
-    public ResponseEntity<TbImageDeleteResult> deleteImage(@PathVariable String type,
+    public ResponseEntity<TbImageDeleteResult> deleteImage(@ApiParam(value = IMAGE_TYPE_PARAM_DESCRIPTION, allowableValues = IMAGE_TYPE_PARAM_ALLOWABLE_VALUES, required = true)
+                                                           @PathVariable String type,
+                                                           @ApiParam(value = IMAGE_KEY_PARAM_DESCRIPTION, required = true)
                                                            @PathVariable String key,
                                                            @RequestParam(name = "force", required = false) boolean force) throws ThingsboardException {
         TbResourceInfo imageInfo = checkImageInfo(type, key, Operation.DELETE);
         TbImageDeleteResult result = tbImageService.delete(imageInfo, getCurrentUser(), force);
         return (result.isSuccess() ? ResponseEntity.ok() : ResponseEntity.badRequest()).body(result);
     }
 
-    private ResponseEntity<ByteArrayResource> downloadIfChanged(String type, String key, String etag, boolean preview) throws ThingsboardException, JsonProcessingException {
-        ImageCacheKey cacheKey = new ImageCacheKey(getTenantId(type), key, preview);
+    private ResponseEntity<ByteArrayResource> downloadIfChanged(String type, String key, String etag, boolean preview) throws Exception {
+        ImageCacheKey cacheKey = ImageCacheKey.forImage(getTenantId(type), key, preview);
+        return downloadIfChanged(cacheKey, etag, () -> checkImageInfo(type, key, Operation.READ));
+    }
+
+    private ResponseEntity<ByteArrayResource> downloadIfChanged(ImageCacheKey cacheKey, String etag, ThrowingSupplier<TbResourceInfo> imageInfoSupplier) throws Exception {
         if (StringUtils.isNotEmpty(etag)) {
             etag = StringUtils.remove(etag, '\"'); // etag is wrapped in double quotes due to HTTP specification
             if (etag.equals(tbImageService.getETag(cacheKey))) {
                 return ResponseEntity.status(HttpStatus.NOT_MODIFIED).build();
             }
         }
-        TenantId tenantId = getTenantId();
-        TbResourceInfo imageInfo = checkImageInfo(type, key, Operation.READ);
+
+        TbResourceInfo imageInfo = checkNotNull(imageInfoSupplier.get());
         String fileName = imageInfo.getFileName();
         ImageDescriptor descriptor = imageInfo.getDescriptor(ImageDescriptor.class);
         byte[] data;
-        if (preview) {
+        if (cacheKey.isPreview()) {
             descriptor = descriptor.getPreviewDescriptor();
-            data = imageService.getImagePreview(tenantId, imageInfo.getId());
+            data = imageService.getImagePreview(imageInfo.getTenantId(), imageInfo.getId());
         } else {
-            data = imageService.getImageData(tenantId, imageInfo.getId());
+            data = imageService.getImageData(imageInfo.getTenantId(), imageInfo.getId());
         }
         tbImageService.putETag(cacheKey, descriptor.getEtag());
         var result = ResponseEntity.ok()
-                .header(HttpHeaders.CONTENT_DISPOSITION, "attachment;filename=" + fileName)
-                .header("x-filename", fileName)
                 .header("Content-Type", descriptor.getMediaType())
                 .contentLength(data.length)
                 .eTag(descriptor.getEtag());
+        if (!cacheKey.isPublic()) {
+            result
+                    .header(HttpHeaders.CONTENT_DISPOSITION, "attachment;filename=" + fileName)
+                    .header("x-filename", fileName);
+        }
         if (systemImagesBrowserTtlInMinutes > 0 && imageInfo.getTenantId().isSysTenantId()) {
             result.cacheControl(CacheControl.maxAge(systemImagesBrowserTtlInMinutes, TimeUnit.MINUTES));
         } else if (tenantImagesBrowserTtlInMinutes > 0 && !imageInfo.getTenantId().isSysTenantId()) {

application/src/main/java/org/thingsboard/server/service/install/update/DefaultCacheCleanupService.java

@@ -27,6 +27,7 @@
 import java.util.Objects;
 import java.util.Optional;
 
+import static org.thingsboard.server.common.data.CacheConstants.RESOURCE_INFO_CACHE;
 import static org.thingsboard.server.common.data.CacheConstants.SECURITY_SETTINGS_CACHE;
 
 @RequiredArgsConstructor
@@ -91,6 +92,7 @@ public void clearCache(String fromVersion) throws Exception {
             case "3.6.1":
                 log.info("Clearing cache to upgrade from version 3.6.1 to 3.6.2");
                 clearCacheByName(SECURITY_SETTINGS_CACHE);
+                clearCacheByName(RESOURCE_INFO_CACHE);
                 break;
             default:
                 //Do nothing, since cache cleanup is optional.