Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
FORMS-17362 | Add Cloudflare Turnstile Support (#1487)
* FORMS-17362 | Add Cloudflare Turnstile Support * FORMS-17362 | Add FT in test cases * FORMS-17362 | Addressing review comments * FORMS-17362 | Bump up af-core & af-custom-functions * FORMS-17362 | Add test for inline form in sites * FORMS-17362 | Fix test for turnstile authoring * FORMS-17362 | Fix test for recaptcha authoring * FORMS-17362 | Addressing review comments * FORMS-17362 | Addressing review comments * FORMS-17362 | Addressing review comments * FORMS-17362 | Fixing doc string * FORMS-17362 | Fix gh exporter-validate * FORMS-17362 | Move @JsonIgnore to interface and abstract class * Improving coverage --------- Co-authored-by: Navneet Agarwal <[email protected]> Co-authored-by: Rishi Mehta <[email protected]>
- Loading branch information
3 people
authored
Dec 5, 2024
1 parent
2207d43
commit 07639b3
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
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,156 @@ | ||
| /*~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
| ~ Copyright 2024 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.forms.core.components.internal.models.v1.form; | ||
|
|
||
| import java.util.LinkedHashMap; | ||
| import java.util.Map; | ||
|
|
||
| import javax.annotation.PostConstruct; | ||
| import javax.inject.Inject; | ||
| import javax.inject.Named; | ||
|
|
||
| import org.apache.sling.api.SlingHttpServletRequest; | ||
| import org.apache.sling.api.resource.Resource; | ||
| import org.apache.sling.api.resource.ResourceResolver; | ||
| import org.apache.sling.models.annotations.Exporter; | ||
| import org.apache.sling.models.annotations.Model; | ||
| import org.apache.sling.models.annotations.injectorspecific.InjectionStrategy; | ||
| import org.apache.sling.models.annotations.injectorspecific.OSGiService; | ||
| import org.apache.sling.models.annotations.injectorspecific.ValueMapValue; | ||
| import org.osgi.service.component.annotations.Reference; | ||
| import org.slf4j.Logger; | ||
| import org.slf4j.LoggerFactory; | ||
|
|
||
| import com.adobe.aemds.guide.model.TurnstileConfiguration; | ||
| import com.adobe.aemds.guide.service.CloudConfigurationProvider; | ||
| import com.adobe.aemds.guide.service.GuideException; | ||
| import com.adobe.cq.export.json.ComponentExporter; | ||
| import com.adobe.cq.export.json.ExporterConstants; | ||
| import com.adobe.cq.forms.core.components.internal.form.FormConstants; | ||
| import com.adobe.cq.forms.core.components.models.form.Turnstile; | ||
| import com.adobe.cq.forms.core.components.util.AbstractCaptchaImplV2; | ||
|
|
||
| @Model( | ||
| adaptables = { SlingHttpServletRequest.class, Resource.class }, | ||
| adapters = { Turnstile.class, | ||
| ComponentExporter.class }, | ||
| resourceType = { FormConstants.RT_FD_FORM_TURNSTILE_V1 }) | ||
| @Exporter(name = ExporterConstants.SLING_MODEL_EXPORTER_NAME, extensions = ExporterConstants.SLING_MODEL_EXTENSION) | ||
| public class TurnstileImpl extends AbstractCaptchaImplV2 implements Turnstile { | ||
| private static final Logger LOGGER = LoggerFactory.getLogger(TurnstileImpl.class); | ||
|
|
||
| @Inject | ||
| private ResourceResolver resourceResolver; | ||
|
|
||
| private Resource resource; | ||
| private String captchaSiteKey; | ||
|
|
||
| @Reference | ||
| @ValueMapValue(injectionStrategy = InjectionStrategy.OPTIONAL) | ||
| private TurnstileConfiguration turnstileConfiguration; | ||
|
|
||
| @OSGiService | ||
| @ValueMapValue(injectionStrategy = InjectionStrategy.OPTIONAL) | ||
| private CloudConfigurationProvider cloudConfigurationProvider; | ||
|
|
||
| @ValueMapValue(injectionStrategy = InjectionStrategy.OPTIONAL) | ||
| @Named("cloudServicePath") | ||
| protected String cloudServicePath; | ||
|
|
||
| @ValueMapValue(injectionStrategy = InjectionStrategy.OPTIONAL) | ||
| @Named("size") | ||
| protected String size; | ||
|
|
||
| @Override | ||
| public String getCloudServicePath() { | ||
| return cloudServicePath; | ||
| } | ||
|
|
||
| @Override | ||
| public String getProvider() { | ||
| return "turnstile"; | ||
| } | ||
|
|
||
| @Override | ||
| public String getSize() { | ||
| return size; | ||
| } | ||
|
|
||
| /** | ||
| * Set the turnstileConfiguration, by fetching it from the cloud configurations. | ||
| * Also sets the captchaSiteKey. | ||
| */ | ||
| private void setTurnstileConfiguration() { | ||
| LOGGER.debug("[AF] [Captcha] [TURNSTILE] Fetching cloud configuration for turnstile."); | ||
| if (cloudConfigurationProvider != null) { | ||
| try { | ||
| resource = resourceResolver.getResource(this.getPath()); | ||
| turnstileConfiguration = cloudConfigurationProvider.getTurnstileCloudConfiguration(resource); | ||
| if (turnstileConfiguration != null) { | ||
| captchaSiteKey = turnstileConfiguration.getSiteKey(); | ||
| } else { | ||
| LOGGER.debug("[AF] [Captcha] [TURNSTILE] Cloud configuration for turnstile is not available for " + this.getPath()); | ||
|
Check warning on line 106 in bundles/af-core/src/main/java/com/adobe/cq/forms/core/components/internal/models/v1/form/TurnstileImpl.java
|
||
| } | ||
| } catch (GuideException e) { | ||
| LOGGER.error( | ||
| "[AF] [Captcha] [TURNSTILE] Error while fetching cloud configuration, upgrade to latest release to use turnstile.", e); | ||
| } | ||
| } else { | ||
| LOGGER.error( | ||
|
Check warning on line 113 in bundles/af-core/src/main/java/com/adobe/cq/forms/core/components/internal/models/v1/form/TurnstileImpl.java
|
||
| "[AF] [Captcha] [TURNSTILE] Error while fetching cloud configuration, upgrade to latest release to use turnstile."); | ||
| } | ||
| } | ||
|
|
||
| @PostConstruct | ||
| @Override | ||
| public Map<String, Object> getCaptchaProperties() { | ||
| Map<String, Object> customCaptchaProperties = new LinkedHashMap<>(); | ||
| String siteKey = null, uri = null, widgetType = null; | ||
| if (turnstileConfiguration == null) { | ||
| setTurnstileConfiguration(); | ||
| } | ||
| if (turnstileConfiguration != null) { | ||
| customCaptchaProperties.put(CAPTCHA_URI, turnstileConfiguration.getClientSideJsUrl()); | ||
| customCaptchaProperties.put(CAPTCHA_WIDGET_TYPE, turnstileConfiguration.getWidgetType()); | ||
| } | ||
| customCaptchaProperties.put(CAPTCHA_SIZE, getSize()); | ||
| customCaptchaProperties.put(CAPTCHA_THEME, CAPTCHA_THEME_LIGHT); | ||
| return customCaptchaProperties; | ||
| } | ||
|
|
||
| @PostConstruct | ||
| @Override | ||
| public String getCaptchaDisplayMode() { | ||
| CaptchaDisplayMode captchaDisplayMode = CaptchaDisplayMode.VISIBLE; | ||
| if (turnstileConfiguration == null) { | ||
| setTurnstileConfiguration(); | ||
|
Check warning on line 140 in bundles/af-core/src/main/java/com/adobe/cq/forms/core/components/internal/models/v1/form/TurnstileImpl.java
|
||
| } | ||
| if (turnstileConfiguration != null && CaptchaDisplayMode.INVISIBLE.getValue().equals(turnstileConfiguration.getWidgetType())) { | ||
| captchaDisplayMode = CaptchaDisplayMode.INVISIBLE; | ||
| } | ||
| return captchaDisplayMode.getValue(); | ||
| } | ||
|
|
||
| @PostConstruct | ||
| @Override | ||
| public String getCaptchaSiteKey() { | ||
| if (turnstileConfiguration == null) { | ||
| setTurnstileConfiguration(); | ||
|
Check warning on line 152 in bundles/af-core/src/main/java/com/adobe/cq/forms/core/components/internal/models/v1/form/TurnstileImpl.java
|
||
| } | ||
| return this.captchaSiteKey; | ||
| } | ||
| } | ||
Oops, something went wrong.