Merge branch 'develop'

wcm-io · Sep 2, 2022 · 269c7ff · 269c7ff
2 parents 94d7c95 + edbca0b
commit 269c7ff
Show file tree

Hide file tree

Showing 6 changed files with 42 additions and 4 deletions.
diff --git a/changes.xml b/changes.xml
@@ -23,7 +23,14 @@
     xsi:schemaLocation="http://maven.apache.org/changes/1.0.0 http://maven.apache.org/plugins/maven-changes-plugin/xsd/changes-1.0.0.xsd">
   <body>
 
-    <release version="1.8.0" date="not released">
+    <release version="1.9.0" date="2022-09-02">
+      <action type="add" dev="sseifert"><![CDATA[
+        Add UrlHandler.applySiteUrlAutoDetection method which allows to apply the Site URL auto-detection via <code>&lt;auto&gt;</code> placeholder also
+        for custom code that reads the Site URLs from Site Config directly.
+      ]]></action>
+    </release>
+
+    <release version="1.8.0" date="2022-08-25">
       <action type="add" dev="sseifert"><![CDATA[
         Placeholder <code>&lt;auto&gt;</code> can be used in the author/publish URL properties in Site Config to enable auto-detection of these URLs based on the requested URL.
         The placeholder can be combined with a fallback URL - if auto-detection is not possible (because the link is build outside request context) the configured URL is used.

diff --git a/pom.xml b/pom.xml
@@ -31,7 +31,7 @@
 
   <groupId>io.wcm</groupId>
   <artifactId>io.wcm.handler.url</artifactId>
-  <version>1.8.0</version>
+  <version>1.9.0</version>
   <packaging>jar</packaging>
 
   <name>URL Handler</name>
@@ -49,7 +49,7 @@
     <site.url.module.prefix>handler/url</site.url.module.prefix>
 
     <!-- Enable reproducible builds -->
-    <project.build.outputTimestamp>2022-08-25T08:09:38Z</project.build.outputTimestamp>
+    <project.build.outputTimestamp>2022-09-02T07:59:22Z</project.build.outputTimestamp>
   </properties>
 
   <dependencies>

diff --git a/src/main/java/io/wcm/handler/url/UrlHandler.java b/src/main/java/io/wcm/handler/url/UrlHandler.java
@@ -107,4 +107,21 @@ public interface UrlHandler {
    */
   boolean isExternalized(@NotNull String url);
 
+  /**
+   * Applies auto-detection of Site URL (author or publish instance) for given Site URL that is
+   * configured in {@link SiteConfig}.
+   * <p>
+   * If this Site URL contains an <code>&lt;auto&gt;</code> placeholder the Site URL detection is enabled
+   * and the Site URL is replaced with the current hostname (if possible). Otherwise the remaining part of the
+   * Site URL string is returned as fallback.
+   * </p>
+   * <p>
+   * Site URL auto-detection does only work in context of a request - outside request context the placeholders
+   * is removed and the remaining string returned as fallback.
+   * </p>
+   * @param siteUrl Site URL (author or publish) {@link SiteConfig}.
+   * @return Automatic detected Site URL or fallback
+   */
+  String applySiteUrlAutoDetection(@Nullable String siteUrl);
+
 }
diff --git a/src/main/java/io/wcm/handler/url/impl/UrlHandlerImpl.java b/src/main/java/io/wcm/handler/url/impl/UrlHandlerImpl.java
@@ -33,6 +33,7 @@
 import org.apache.sling.models.annotations.injectorspecific.Self;
 import org.apache.sling.models.annotations.injectorspecific.SlingObject;
 import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
 
 import com.day.cq.wcm.api.Page;
 
@@ -346,4 +347,9 @@ String setFragment(String url, String fragment) {
     return urlBuilder.toString();
   }
 
+  @Override
+  public String applySiteUrlAutoDetection(@Nullable String siteUrl) {
+    return UrlPrefix.applyAutoDetection(siteUrl, self);
+  }
+
 }
diff --git a/src/main/java/io/wcm/handler/url/package-info.java b/src/main/java/io/wcm/handler/url/package-info.java
@@ -20,5 +20,5 @@
 /**
  * URL Handler API.
  */
-@org.osgi.annotation.versioning.Version("1.2.1")
+@org.osgi.annotation.versioning.Version("1.3.0")
 package io.wcm.handler.url;
diff --git a/src/test/java/io/wcm/handler/url/impl/UrlPrefixTest.java b/src/test/java/io/wcm/handler/url/impl/UrlPrefixTest.java
@@ -33,7 +33,9 @@
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.api.extension.ExtendWith;
 
+import io.wcm.handler.url.UrlHandler;
 import io.wcm.handler.url.testcontext.AppAemContext;
+import io.wcm.sling.commons.adapter.AdaptTo;
 import io.wcm.testing.mock.aem.junit5.AemContext;
 import io.wcm.testing.mock.aem.junit5.AemContextExtension;
 
@@ -121,6 +123,12 @@ void testRequestUrlPlaceholder() {
     assertEquals("http://servername:8080", applyAutoDetection("<auto>https://myhost", context.request()));
   }
 
+  @Test
+  void testRequestUrlPlaceholder_URLHandler() {
+    UrlHandler urlHandler = AdaptTo.notNull(context.request(), UrlHandler.class);
+    assertEquals("http://servername:8080", urlHandler.applySiteUrlAutoDetection("<auto>https://myhost"));
+  }
+
   @Test
   void testRequestPlaceholder_AEMaaCS_author() {
     context.request().setHeader(HTTP_HEADER_X_FORWARDED_HOST, "aemaacs-author");