Skip to content

Update S3 plugin version and enhance thumbnail link generation #203

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
f2c-ci-robot merged 1 commit into from
Dec 23, 2025
Merged

Update S3 plugin version and enhance thumbnail link generation #203

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion build.gradle
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ repositories {
}

dependencies {
implementation platform('run.halo.tools.platform:plugin:2.21.0-alpha.1')
implementation platform('run.halo.tools.platform:plugin:2.22.0-alpha.1')
compileOnly 'run.halo.app:api'

implementation platform('software.amazon.awssdk:bom:2.31.58')
Expand Down
134 changes: 117 additions & 17 deletions src/main/java/run/halo/s3os/S3OsAttachmentHandler.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,5 @@
package run.halo.s3os;

import java.net.URI;
import java.net.URISyntaxException;
import java.nio.ByteBuffer;
import java.nio.file.FileAlreadyExistsException;
import java.time.Duration;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.UUID;
import java.util.concurrent.ConcurrentHashMap;
import lombok.extern.slf4j.Slf4j;
import org.apache.commons.lang3.StringUtils;
import org.pf4j.Extension;
Expand All @@ -19,17 +9,21 @@
import org.springframework.core.io.buffer.DefaultDataBufferFactory;
import org.springframework.http.MediaType;
import org.springframework.http.MediaTypeFactory;
import org.springframework.lang.NonNull;
import org.springframework.lang.Nullable;
import org.springframework.web.server.ServerErrorException;
import org.springframework.web.server.ServerWebInputException;
import org.springframework.web.util.UriComponentsBuilder;
import reactor.core.Exceptions;
import reactor.core.publisher.Flux;
import reactor.core.publisher.Mono;
import reactor.core.scheduler.Schedulers;
import reactor.util.context.Context;
import reactor.util.retry.Retry;
import run.halo.app.core.attachment.ThumbnailSize;
import run.halo.app.core.extension.attachment.Attachment;
import run.halo.app.core.extension.attachment.Attachment.AttachmentSpec;
import run.halo.app.core.extension.attachment.Attachment.AttachmentStatus;
import run.halo.app.core.extension.attachment.Constant;
import run.halo.app.core.extension.attachment.Policy;
import run.halo.app.core.extension.attachment.endpoint.AttachmentHandler;
Expand All @@ -44,18 +38,47 @@
import software.amazon.awssdk.regions.Region;
import software.amazon.awssdk.services.s3.S3Client;
import software.amazon.awssdk.services.s3.S3Configuration;
import software.amazon.awssdk.services.s3.model.*;
import software.amazon.awssdk.services.s3.model.CompleteMultipartUploadRequest;
import software.amazon.awssdk.services.s3.model.CompletedMultipartUpload;
import software.amazon.awssdk.services.s3.model.CompletedPart;
import software.amazon.awssdk.services.s3.model.CreateMultipartUploadRequest;
import software.amazon.awssdk.services.s3.model.DeleteObjectRequest;
import software.amazon.awssdk.services.s3.model.GetObjectRequest;
import software.amazon.awssdk.services.s3.model.HeadObjectRequest;
import software.amazon.awssdk.services.s3.model.HeadObjectResponse;
import software.amazon.awssdk.services.s3.model.NoSuchKeyException;
import software.amazon.awssdk.services.s3.model.UploadPartRequest;
import software.amazon.awssdk.services.s3.presigner.S3Presigner;
import software.amazon.awssdk.services.s3.presigner.model.GetObjectPresignRequest;
import software.amazon.awssdk.utils.SdkAutoCloseable;

import java.net.URI;
import java.net.URISyntaxException;
import java.nio.ByteBuffer;
import java.nio.file.FileAlreadyExistsException;
import java.time.Duration;
import java.util.Arrays;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Optional;
import java.util.UUID;
import java.util.concurrent.ConcurrentHashMap;
import java.util.function.Function;
import java.util.stream.Collectors;

@Slf4j
@Extension
public class S3OsAttachmentHandler implements AttachmentHandler {

public static final String OBJECT_KEY = "s3os.plugin.halo.run/object-key";

public static final String URL_SUFFIX_ANNO_KEY = "s3os.plugin.halo.run/url-suffix";

public static final String SKIP_REMOTE_DELETION_ANNO = "s3os.plugin.halo.run/skip-remote-deletion";

private static final MediaType IMAGE_MEDIA_TYPE = MediaType.parseMediaType("image/*");

public static final int MULTIPART_MIN_PART_SIZE = 5 * 1024 * 1024;

/**
Expand Down Expand Up @@ -156,18 +179,73 @@ public Mono<URI> getPermalink(Attachment attachment, Policy policy, ConfigMap co
if (!this.shouldHandle(policy)) {
return Mono.empty();
}
return Mono.justOrEmpty(doGetPermalink(attachment, S3OsProperties.convertFrom(configMap)));
}

@Override
public Mono<Map<ThumbnailSize, URI>> getThumbnailLinks(Attachment attachment, Policy policy, ConfigMap configMap) {
if (!this.shouldHandle(policy)) {
return Mono.empty();
}
var properties = S3OsProperties.convertFrom(configMap);
return Mono.just(doGetThumbnailLinks(attachment, properties));
}

private Optional<URI> doGetPermalink(Attachment attachment, S3OsProperties properties) {
var objectKey = getObjectKey(attachment);
if (objectKey == null) {
// fallback to default handler for backward compatibility
return Mono.empty();
return Optional.empty();
}
var properties = S3OsProperties.convertFrom(configMap);
var objectURL = properties.toObjectURL(objectKey);
var urlSuffix = getUrlSuffixAnnotation(attachment);
if (StringUtils.isNotBlank(urlSuffix)) {
objectURL += urlSuffix;
}
return Mono.just(URI.create(objectURL));
return Optional.of(URI.create(objectURL));
}

@NonNull
private Map<ThumbnailSize, URI> doGetThumbnailLinks(Attachment attachment, S3OsProperties properties) {
// TODO Support configuring media types that support thumbnails
var support = Optional.ofNullable(attachment.getSpec().getMediaType())
.map(MediaType::parseMediaType)
.map(IMAGE_MEDIA_TYPE::isCompatibleWith)
.orElse(false);
if (!support) {
if (log.isDebugEnabled()) {
log.debug("Attachment {} media type {} is not compatible with image/*, skip generating thumbnail links",
attachment.getMetadata().getName(), attachment.getSpec().getMediaType());
}
return Map.of();
}

var thumbnailParamPattern = properties.getThumbnailParamPattern();
if (StringUtils.isBlank(thumbnailParamPattern) || !thumbnailParamPattern.contains("{width}")) {
return Map.of();
}
return Optional.ofNullable(attachment.getStatus())
.map(AttachmentStatus::getPermalink)
.filter(StringUtils::isNotBlank)
.map(URI::create)
.or(() -> doGetPermalink(attachment, properties))
.map(permalink -> Arrays.stream(ThumbnailSize.values())
.collect(Collectors.toMap(Function.identity(), size -> {
var thumbnailParam = thumbnailParamPattern.replace("{width}", String.valueOf(size.getWidth()));
var isQueryPattern = thumbnailParam.startsWith("?");
if (isQueryPattern) {
return UriComponentsBuilder.fromUri(permalink)
.query(thumbnailParam.substring(1))
.build(true)
.toUri();
}
return UriComponentsBuilder.fromUri(permalink)
.path(thumbnailParam)
.build(true)
.toUri();
}))
)
.orElse(Map.of());
}

@Nullable
Expand Down Expand Up @@ -213,6 +291,17 @@ Attachment buildAttachment(S3OsProperties properties, ObjectDetail objectDetail)
var attachment = new Attachment();
attachment.setMetadata(metadata);
attachment.setSpec(spec);
attachment.setStatus(new AttachmentStatus());
doGetPermalink(attachment, properties).ifPresent(permalink ->
attachment.getStatus().setPermalink(permalink.toString())
);
var thumbnails = doGetThumbnailLinks(attachment, properties);
var mappedThumbnails = thumbnails.keySet()
.stream()
.collect(Collectors.toMap(ThumbnailSize::name, size -> thumbnails.get(size).toString()));
if (!mappedThumbnails.isEmpty()) {
attachment.getStatus().setThumbnails(mappedThumbnails);
}
log.info("Built attachment {} successfully", objectDetail.uploadState.objectKey);
return attachment;
}
Expand Down Expand Up @@ -369,8 +458,8 @@ Mono<UploadState> checkFileExistsAndRename(UploadState uploadState,
if (uploadingFile.put(uploadState.getUploadingMapKey(),
uploadState.getUploadingMapKey()) != null) {
return Mono.error(new FileAlreadyExistsException("文件 " + uploadState.objectKey
+
" 已存在，建议更名后重试。[local]"));
+
" 已存在，建议更名后重试。[local]"));
}
uploadState.needRemoveMapKey = true;
// check whether file exists
Expand All @@ -388,7 +477,7 @@ Mono<UploadState> checkFileExistsAndRename(UploadState uploadState,
&& response.sdkHttpResponse().isSuccessful()) {
return Mono.error(
new FileAlreadyExistsException("文件 " + uploadState.objectKey
+ " 已存在，建议更名后重试。[remote]"));
+ " 已存在，建议更名后重试。[remote]"));
} else {
return Mono.just(uploadState);
}
Expand Down Expand Up @@ -463,18 +552,29 @@ boolean shouldHandle(Policy policy) {
}

record ObjectDetail(UploadState uploadState, HeadObjectResponse objectMetadata) {

}

static class UploadState {

final S3OsProperties properties;

final String originalFileName;

String uploadId;

int partCounter;

Map<Integer, CompletedPart> completedParts = new HashMap<>();

int buffered = 0;

String contentType;

String fileName;

String objectKey;

boolean needRemoveMapKey = false;

public UploadState(S3OsProperties properties, String fileName, boolean needRandomJudge) {
Expand Down
106 changes: 0 additions & 106 deletions src/main/java/run/halo/s3os/S3ThumbnailProvider.java
View file
Open in desktop

This file was deleted.

2 changes: 1 addition & 1 deletion src/main/resources/plugin.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ metadata:
name: PluginS3ObjectStorage
spec:
enabled: true
requires: ">=2.21.0"
requires: ">=2.22.0"
author:
name: Halo
website: https://github.com/halo-dev
Expand Down
Loading