-
-
Notifications
You must be signed in to change notification settings - Fork 9.8k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add OptionFilter for bulk option api (#1345)
* Add OptionFilter for bulk option api * Add another filter method for single option * Restrict OptionController response * Remove redundant api * feat: complete private option keys. * feat: complete private option keys. Co-authored-by: Ryan Wang <[email protected]>
- Loading branch information
Showing
7 changed files
with
316 additions
and
17 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
140 changes: 140 additions & 0 deletions
140
src/main/java/run/halo/app/service/impl/OptionFilter.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,140 @@ | ||
| package run.halo.app.service.impl; | ||
|
|
||
| import java.util.Collection; | ||
| import java.util.Collections; | ||
| import java.util.Objects; | ||
| import java.util.Optional; | ||
| import java.util.Set; | ||
| import java.util.stream.Collectors; | ||
| import org.springframework.util.CollectionUtils; | ||
| import org.springframework.util.StringUtils; | ||
| import run.halo.app.model.properties.AliOssProperties; | ||
| import run.halo.app.model.properties.ApiProperties; | ||
| import run.halo.app.model.properties.BaiduBosProperties; | ||
| import run.halo.app.model.properties.EmailProperties; | ||
| import run.halo.app.model.properties.HuaweiObsProperties; | ||
| import run.halo.app.model.properties.MinioProperties; | ||
| import run.halo.app.model.properties.QiniuOssProperties; | ||
| import run.halo.app.model.properties.SmmsProperties; | ||
| import run.halo.app.model.properties.TencentCosProperties; | ||
| import run.halo.app.model.properties.UpOssProperties; | ||
| import run.halo.app.model.support.HaloConst; | ||
| import run.halo.app.service.OptionService; | ||
|
|
||
| /** | ||
| * Option filter for private options. | ||
| * | ||
| * @author johnniang | ||
| * @date 2021-04-08 | ||
| */ | ||
| public class OptionFilter { | ||
|
|
||
| private final Set<String> defaultPrivateOptionKeys; | ||
|
|
||
| private final OptionService optionService; | ||
|
|
||
| public OptionFilter(OptionService optionService) { | ||
| this.optionService = optionService; | ||
| this.defaultPrivateOptionKeys = getDefaultPrivateOptionKeys(); | ||
| } | ||
|
|
||
| private Set<String> getDefaultPrivateOptionKeys() { | ||
| return Set.of( | ||
| AliOssProperties.OSS_DOMAIN.getValue(), | ||
| AliOssProperties.OSS_BUCKET_NAME.getValue(), | ||
| AliOssProperties.OSS_ACCESS_KEY.getValue(), | ||
| AliOssProperties.OSS_ACCESS_SECRET.getValue(), | ||
|
|
||
| ApiProperties.API_ACCESS_KEY.getValue(), | ||
|
|
||
| BaiduBosProperties.BOS_DOMAIN.getValue(), | ||
| BaiduBosProperties.BOS_ENDPOINT.getValue(), | ||
| BaiduBosProperties.BOS_BUCKET_NAME.getValue(), | ||
| BaiduBosProperties.BOS_ACCESS_KEY.getValue(), | ||
| BaiduBosProperties.BOS_SECRET_KEY.getValue(), | ||
|
|
||
| EmailProperties.USERNAME.getValue(), | ||
| EmailProperties.PASSWORD.getValue(), | ||
| EmailProperties.FROM_NAME.getValue(), | ||
|
|
||
| HuaweiObsProperties.OSS_DOMAIN.getValue(), | ||
| HuaweiObsProperties.OSS_ENDPOINT.getValue(), | ||
| HuaweiObsProperties.OSS_BUCKET_NAME.getValue(), | ||
| HuaweiObsProperties.OSS_ACCESS_KEY.getValue(), | ||
| HuaweiObsProperties.OSS_ACCESS_SECRET.getValue(), | ||
|
|
||
| MinioProperties.ENDPOINT.getValue(), | ||
| MinioProperties.BUCKET_NAME.getValue(), | ||
| MinioProperties.ACCESS_KEY.getValue(), | ||
| MinioProperties.ACCESS_SECRET.getValue(), | ||
|
|
||
| QiniuOssProperties.OSS_ZONE.getValue(), | ||
| QiniuOssProperties.OSS_ACCESS_KEY.getValue(), | ||
| QiniuOssProperties.OSS_SECRET_KEY.getValue(), | ||
| QiniuOssProperties.OSS_DOMAIN.getValue(), | ||
| QiniuOssProperties.OSS_BUCKET.getValue(), | ||
|
|
||
| SmmsProperties.SMMS_API_SECRET_TOKEN.getValue(), | ||
|
|
||
| TencentCosProperties.COS_DOMAIN.getValue(), | ||
| TencentCosProperties.COS_REGION.getValue(), | ||
| TencentCosProperties.COS_BUCKET_NAME.getValue(), | ||
| TencentCosProperties.COS_SECRET_ID.getValue(), | ||
| TencentCosProperties.COS_SECRET_KEY.getValue(), | ||
|
|
||
| UpOssProperties.OSS_PASSWORD.getValue(), | ||
| UpOssProperties.OSS_BUCKET.getValue(), | ||
| UpOssProperties.OSS_DOMAIN.getValue(), | ||
| UpOssProperties.OSS_OPERATOR.getValue() | ||
| ); | ||
| } | ||
|
|
||
| private Set<String> getConfiguredPrivateOptionKeys() { | ||
| // resolve configured private option names | ||
| return optionService.getByKey(HaloConst.PRIVATE_OPTION_KEY, String.class) | ||
| .map(privateOptions -> privateOptions.split(",")) | ||
| .map(Set::of) | ||
| .orElse(Collections.emptySet()) | ||
| .stream() | ||
| .map(String::trim) | ||
| .collect(Collectors.toUnmodifiableSet()); | ||
| } | ||
|
|
||
| /** | ||
| * Filter option keys to prevent outsider from accessing private options. | ||
| * | ||
| * @param optionKeys option key collection | ||
| * @return filtered option keys | ||
| */ | ||
| public Set<String> filter(Collection<String> optionKeys) { | ||
| if (CollectionUtils.isEmpty(optionKeys)) { | ||
| return Collections.emptySet(); | ||
| } | ||
|
|
||
| return optionKeys.stream() | ||
| .filter(Objects::nonNull) | ||
| .filter(optionKey -> !optionKey.isBlank()) | ||
| .filter(optionKey -> !defaultPrivateOptionKeys.contains(optionKey)) | ||
| .filter(optionKey -> !getConfiguredPrivateOptionKeys().contains(optionKey)) | ||
| .collect(Collectors.toUnmodifiableSet()); | ||
| } | ||
|
|
||
| /** | ||
| * Filter option key to prevent outsider from accessing private option. | ||
| * | ||
| * @param optionKey option key | ||
| * @return an optional of option key | ||
| */ | ||
| public Optional<String> filter(String optionKey) { | ||
| if (!StringUtils.hasText(optionKey)) { | ||
| return Optional.empty(); | ||
| } | ||
| if (defaultPrivateOptionKeys.contains(optionKey)) { | ||
| return Optional.empty(); | ||
| } | ||
| if (getConfiguredPrivateOptionKeys().contains(optionKey)) { | ||
| return Optional.empty(); | ||
| } | ||
| return Optional.of(optionKey); | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.