-
Notifications
You must be signed in to change notification settings - Fork 746
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
SITES-13120 - Image Smart Crop support for remote assets in various S…
…ites core components (#2524) * add NextGen DM smart crop support. * add button * add alt * add test * fix css for aemcs * update README.md * add http test for smartcrop. * add UI test for smart crop dialog. * add UI test for NGDM smart crop. * fix for aemcs --------- Co-authored-by: igurjar <igurjar@adobe.com>
- Loading branch information
1 parent
ce27843
commit b49e22c
Showing
31 changed files
with
1,209 additions
and
52 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
150 changes: 150 additions & 0 deletions
150
...in/java/com/adobe/cq/wcm/core/components/internal/models/v3/NextGenDMImageURIBuilder.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,150 @@ | ||
| /*~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
| ~ Copyright 2023 Adobe | ||
| ~ | ||
| ~ 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 com.adobe.cq.wcm.core.components.internal.models.v3; | ||
|
|
||
| import java.util.HashMap; | ||
| import java.util.Map; | ||
| import java.util.Scanner; | ||
|
|
||
| import org.apache.commons.lang3.StringUtils; | ||
| import org.slf4j.Logger; | ||
| import org.slf4j.LoggerFactory; | ||
|
|
||
| import com.adobe.cq.ui.wcm.commons.config.NextGenDynamicMediaConfig; | ||
|
|
||
| import static com.adobe.cq.wcm.core.components.internal.models.v3.ImageImpl.DEFAULT_NGDM_ASSET_WIDTH; | ||
|
|
||
| public class NextGenDMImageURIBuilder { | ||
| private static final Logger LOGGER = LoggerFactory.getLogger(NextGenDMImageURIBuilder.class); | ||
| private static final String PATH_PLACEHOLDER_ASSET_ID = "{asset-id}"; | ||
| private static final String PATH_PLACEHOLDER_SEO_NAME = "{seo-name}"; | ||
| private static final String PATH_PLACEHOLDER_FORMAT = "{format}"; | ||
| private static final String DEFAULT_NGDM_ASSET_EXTENSION = "jpg"; | ||
|
|
||
| private NextGenDynamicMediaConfig config; | ||
| private String fileReference; | ||
| private String smartCropAspectRatio; | ||
| private int width = DEFAULT_NGDM_ASSET_WIDTH; | ||
|
|
||
| private int height; | ||
| private boolean preferWebp = true; | ||
|
|
||
| public NextGenDMImageURIBuilder(NextGenDynamicMediaConfig config, String fileReference) { | ||
| this.config = config; | ||
| this.fileReference = fileReference; | ||
| } | ||
|
|
||
| /** | ||
| * Smart Crop aspect ratio string. | ||
| * @param smartCropAspectRatio - a string in "width:height" format; | ||
| */ | ||
| public NextGenDMImageURIBuilder withSmartCrop(String smartCropAspectRatio) { | ||
| this.smartCropAspectRatio = smartCropAspectRatio; | ||
| return this; | ||
| } | ||
|
|
||
| /** | ||
| * Image width | ||
| * @param width - an integer. | ||
| */ | ||
| public NextGenDMImageURIBuilder withWidth(int width) { | ||
| this.width = width; | ||
| return this; | ||
| } | ||
|
|
||
| /** | ||
| * Image height | ||
| * @param height - an integer. | ||
| */ | ||
| public NextGenDMImageURIBuilder withHeight(int height) { | ||
| this.height = height; | ||
| return this; | ||
| } | ||
|
|
||
|
|
||
| /** | ||
| * Set to use webp image format. | ||
| * @param preferWebp - should set preferwebp param. | ||
| */ | ||
| public NextGenDMImageURIBuilder withPreferWebp(boolean preferWebp) { | ||
| this.preferWebp = preferWebp; | ||
| return this; | ||
| } | ||
|
|
||
| /** | ||
| * Use this to create a NextGen Dynamic Media Image URI. | ||
| * @return a uri. | ||
| */ | ||
| public String build() { | ||
| if(StringUtils.isNotEmpty(this.fileReference) && this.config != null) { | ||
| Scanner scanner = new Scanner(this.fileReference); | ||
| scanner.useDelimiter("/"); | ||
| String assetId = scanner.next(); | ||
| scanner = new Scanner(scanner.next()); | ||
| scanner.useDelimiter("\\."); | ||
| String assetName = scanner.hasNext() ? scanner.next() : assetId; | ||
| String assetExtension = scanner.hasNext() ? scanner.next() : DEFAULT_NGDM_ASSET_EXTENSION; | ||
| String imageDeliveryBasePath = this.config.getImageDeliveryBasePath(); | ||
| String imageDeliveryPath = imageDeliveryBasePath.replace(PATH_PLACEHOLDER_ASSET_ID, assetId); | ||
| imageDeliveryPath = imageDeliveryPath.replace(PATH_PLACEHOLDER_SEO_NAME, assetName); | ||
| imageDeliveryPath = imageDeliveryPath.replace(PATH_PLACEHOLDER_FORMAT, assetExtension); | ||
| String repositoryId = this.config.getRepositoryId(); | ||
| StringBuilder uriBuilder = new StringBuilder("https://" + repositoryId + imageDeliveryPath); | ||
| Map<String, String> params = new HashMap<>(); | ||
| if(this.width > 0) { | ||
| params.put("width", Integer.toString(this.width)); | ||
| } | ||
| if(this.height > 0) { | ||
| params.put("height", Integer.toString(this.height)); | ||
| } | ||
| if(this.preferWebp) { | ||
| params.put("preferwebp", "true"); | ||
| } | ||
| if (StringUtils.isNotEmpty(this.smartCropAspectRatio)) { | ||
| if (isValidSmartCrop(this.smartCropAspectRatio)) { | ||
| params.put("crop", String.format("%s,smart", this.smartCropAspectRatio)); | ||
| } else { | ||
| LOGGER.info("Invalid smartCrop value at {}", this.smartCropAspectRatio); | ||
| } | ||
| } | ||
| if(params.size() > 0) { | ||
| uriBuilder.append("?"); | ||
| for(Map.Entry<String, String> entry: params.entrySet()) { | ||
| uriBuilder.append(entry.getKey() + "=" + entry.getValue()); | ||
| uriBuilder.append("&"); | ||
| } | ||
| uriBuilder.deleteCharAt(uriBuilder.length() - 1); | ||
| } | ||
| return uriBuilder.toString(); | ||
| } | ||
| LOGGER.info("Invalid fileReference or NGDMConfig. fileReference = {}", this.fileReference); | ||
| return null; | ||
| } | ||
|
|
||
| private boolean isValidSmartCrop(String smartCropStr) { | ||
| String[] crops = smartCropStr.split(":"); | ||
| if (crops.length == 2) { | ||
| try { | ||
| Integer.parseInt(crops[0]); | ||
| Integer.parseInt(crops[1]); | ||
| return true; | ||
| } catch (NumberFormatException ex) { | ||
| return false; | ||
| } | ||
| } | ||
| return false; | ||
| } | ||
| } |
99 changes: 99 additions & 0 deletions
99
...main/java/com/adobe/cq/wcm/core/components/internal/models/v3/NextGenDMThumbnailImpl.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,99 @@ | ||
| /*~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
| ~ Copyright 2023 Adobe | ||
| ~ | ||
| ~ 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 com.adobe.cq.wcm.core.components.internal.models.v3; | ||
|
|
||
| import javax.annotation.PostConstruct; | ||
| import javax.inject.Inject; | ||
|
|
||
| import org.apache.commons.lang3.StringUtils; | ||
| import org.apache.sling.api.SlingHttpServletRequest; | ||
| import org.apache.sling.api.resource.Resource; | ||
| import org.apache.sling.api.resource.ValueMap; | ||
| import org.apache.sling.models.annotations.Exporter; | ||
| import org.apache.sling.models.annotations.Model; | ||
| import org.apache.sling.models.annotations.Optional; | ||
| import org.apache.sling.models.annotations.injectorspecific.Self; | ||
| import org.apache.sling.models.annotations.injectorspecific.SlingObject; | ||
| import org.slf4j.Logger; | ||
| import org.slf4j.LoggerFactory; | ||
|
|
||
| import com.adobe.cq.export.json.ExporterConstants; | ||
| import com.adobe.cq.ui.wcm.commons.config.NextGenDynamicMediaConfig; | ||
| import com.adobe.cq.wcm.core.components.models.nextgendm.NextGenDMThumbnail; | ||
|
|
||
| import static com.adobe.cq.wcm.core.components.internal.models.v3.ImageImpl.isNgdmImageReference; | ||
|
|
||
| @Model(adaptables = SlingHttpServletRequest.class, | ||
| adapters = {NextGenDMThumbnail.class}, | ||
| resourceType = NextGenDMThumbnailImpl.RESOURCE_TYPE) | ||
| @Exporter(name = ExporterConstants.SLING_MODEL_EXPORTER_NAME, extensions = ExporterConstants.SLING_MODEL_EXTENSION) | ||
| public class NextGenDMThumbnailImpl implements NextGenDMThumbnail { | ||
|
|
||
| private static final Logger LOGGER = LoggerFactory.getLogger(NextGenDMThumbnailImpl.class); | ||
| protected static final String RESOURCE_TYPE = "core/wcm/components/image/v3/image/nextgendmthumbnail"; | ||
|
|
||
| /** | ||
| * The current resource. | ||
| */ | ||
| @SlingObject | ||
| protected Resource resource; | ||
|
|
||
| @Self | ||
| private SlingHttpServletRequest request; | ||
|
|
||
| @Inject | ||
| @Optional | ||
| private NextGenDynamicMediaConfig nextGenDynamicMediaConfig; | ||
|
|
||
| private String componentPath; | ||
|
|
||
| private String src; | ||
|
|
||
| private String altText = ""; | ||
|
|
||
| @PostConstruct | ||
| private void initModel() { | ||
| componentPath = request.getRequestPathInfo().getSuffix(); | ||
| Resource component = request.getResourceResolver().getResource(componentPath); | ||
| ValueMap properties = component.getValueMap(); | ||
| String fileReference = properties.get("fileReference", String.class); | ||
| String smartCrop = properties.get("smartCrop", String.class); | ||
| ValueMap configs = resource.getValueMap(); | ||
| int width = configs.get("width", 480); | ||
| int height = configs.get("height", 480); | ||
| altText = configs.get("alt", "image thumbnail"); | ||
| if (isNgdmImageReference(fileReference)) { | ||
| NextGenDMImageURIBuilder builder = new NextGenDMImageURIBuilder(nextGenDynamicMediaConfig, fileReference) | ||
| .withPreferWebp(true) | ||
| .withWidth(width) | ||
| .withHeight(height); | ||
| if (StringUtils.isNotEmpty(smartCrop)) { | ||
| builder.withSmartCrop(smartCrop); | ||
| } | ||
| this.src = builder.build(); | ||
| } | ||
| } | ||
|
|
||
| @Override | ||
| public String getSrc() { | ||
| return src; | ||
| } | ||
|
|
||
| @Override | ||
| public String getAlt() { | ||
| return altText; | ||
| } | ||
| } |
29 changes: 29 additions & 0 deletions
29
...e/src/main/java/com/adobe/cq/wcm/core/components/models/nextgendm/NextGenDMThumbnail.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,29 @@ | ||
| /*~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
| ~ Copyright 2023 Adobe | ||
| ~ | ||
| ~ 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 com.adobe.cq.wcm.core.components.models.nextgendm; | ||
|
|
||
| import java.util.HashMap; | ||
| import java.util.Map; | ||
|
|
||
| public interface NextGenDMThumbnail { | ||
| default public String getSrc() { | ||
| return null; | ||
| } | ||
|
|
||
| default public String getAlt() { | ||
| return null; | ||
| } | ||
| } |
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.