mediaUrl portal function #10610

enonic · Feb 12, 2025 · f97fbc0 · f97fbc0
1 parent 1caaa2d
commit f97fbc0
Show file tree

Hide file tree

Showing 16 changed files with 137 additions and 159 deletions.
diff --git a/modules/lib/lib-portal/src/main/java/com/enonic/xp/lib/portal/url/AttachmentUrlHandler.java b/modules/lib/lib-portal/src/main/java/com/enonic/xp/lib/portal/url/AttachmentUrlHandler.java
@@ -38,7 +38,7 @@ public final class AttachmentUrlHandler
 
     private String branch;
 
-    private String contentKey;
+    private String baseUriKey;
 
     private boolean offline;
 
@@ -94,9 +94,9 @@ public void setBranch( final String branch )
         this.branch = branch;
     }
 
-    public void setContentKey( final String contentKey )
+    public void setBaseUriKey( final String baseUriKey )
     {
-        this.contentKey = contentKey;
+        this.baseUriKey = baseUriKey;
     }
 
     public void setOffline( final Boolean offline )
@@ -145,7 +145,7 @@ public String createUrl()
             .download( this.download )
             .projectName( this.projectName )
             .branch( this.branch )
-            .contentKey( this.contentKey );
+            .baseUriKey( this.baseUriKey );
 
         if ( this.queryParams != null )
         {

diff --git a/modules/lib/lib-portal/src/main/java/com/enonic/xp/lib/portal/url/ImageUrlHandler.java b/modules/lib/lib-portal/src/main/java/com/enonic/xp/lib/portal/url/ImageUrlHandler.java
@@ -44,7 +44,7 @@ public final class ImageUrlHandler
 
     private String branch;
 
-    private String contentKey;
+    private String baseUriKey;
 
     private boolean offline;
 
@@ -108,9 +108,9 @@ public void setBranch( final String branch )
         this.branch = branch;
     }
 
-    public void setContentKey( final String contentKey )
+    public void setBaseUriKey( final String baseUriKey )
     {
-        this.contentKey = contentKey;
+        this.baseUriKey = baseUriKey;
     }
 
     public void setOffline( final Boolean offline )
@@ -156,7 +156,7 @@ public String createUrl()
             .scale( this.scale )
             .projectName( this.projectName )
             .branch( this.branch )
-            .contentKey( this.contentKey );
+            .baseUriKey( this.baseUriKey );
 
         if ( this.queryParams != null )
         {

diff --git a/modules/lib/lib-portal/src/main/resources/lib/xp/portal.ts b/modules/lib/lib-portal/src/main/resources/lib/xp/portal.ts
@@ -91,7 +91,7 @@ export type ImageUrlParams = IdXorPath & {
         | 'full';
     project?: string;
     branch?: string;
-    contentKey?: string;
+    baseUriKey?: string;
     offline?: boolean | undefined;
 };
 
@@ -120,7 +120,7 @@ interface ImageUrlHandler {
 
     setOffline(value: boolean): void;
 
-    setContentKey(value?: string | null): void;
+    setBaseUriKey(value?: string | null): void;
 
     createUrl(): string;
 }
@@ -141,7 +141,7 @@ interface ImageUrlHandler {
  * @param {string} [params.type=server] URL type. Either `server` (server-relative URL) or `absolute`.
  * @param {string} [params.projectName] Name of the project.
  * @param {string} [params.branch] Name of the branch.
- * @param {string} [params.contentKey] Key of the content.
+ * @param {string} [params.baseUriKey] Key of the content.
  * @param {boolean} [params.offline=false] Set to true if the URL should be generated without context of the current request.
  * @param {object} [params.params] Custom parameters to append to the url.
  *
@@ -161,7 +161,7 @@ export function imageUrl(params: ImageUrlParams): string {
     bean.setScale(params.scale);
     bean.setProjectName(params.project);
     bean.setBranch(params.branch);
-    bean.setContentKey(params.contentKey);
+    bean.setBaseUriKey(params.baseUriKey);
     bean.setOffline(params.offline || false);
 
     return bean.createUrl();
@@ -208,7 +208,7 @@ export interface AttachmentUrlParams {
     params?: object;
     project?: string;
     branch?: string;
-    contentKey?: string;
+    baseUriKey?: string;
     offline?: boolean;
 }
 
@@ -229,7 +229,7 @@ interface AttachmentUrlHandler {
 
     setBranch(value?: string | null): void;
 
-    setContentKey(value?: string | null): void;
+    setBaseUriKey(value?: string | null): void;
 
     setOffline(value: boolean): void;
 
@@ -252,7 +252,7 @@ interface AttachmentUrlHandler {
  * @param {string} [params.type=server] URL type. Either `server` (server-relative URL) or `absolute`.
  * @param {string} [params.projectName] Name of the project.
  * @param {string} [params.branch] Name of the branch.
- * @param {string} [params.contentKey] Key of the content.
+ * @param {string} [params.baseUriKey] Key of the content.
  * @param {boolean} [params.offline=false] Set to true if the URL should be generated without context of the current request.
  * @param {object} [params.params] Custom parameters to append to the url.
  *
@@ -268,7 +268,7 @@ export function attachmentUrl(params: AttachmentUrlParams): string {
     bean.setLabel(params.label);
     bean.setProjectName(params.project);
     bean.setBranch(params.branch);
-    bean.setContentKey(params.contentKey);
+    bean.setBaseUriKey(params.baseUriKey);
     bean.setOffline(params.offline || false);
     bean.setDownload(params.download || false);
     bean.setQueryParams(__.toScriptValue(params.params));

diff --git a/...ortal/portal-api/src/main/java/com/enonic/xp/portal/url/AttachmentUrlGeneratorParams.java b/...ortal/portal-api/src/main/java/com/enonic/xp/portal/url/AttachmentUrlGeneratorParams.java
@@ -1,5 +1,7 @@
 package com.enonic.xp.portal.url;
 
+import java.util.Collection;
+import java.util.Map;
 import java.util.Objects;
 
 import com.google.common.collect.HashMultimap;
@@ -146,9 +148,9 @@ public Builder setLabel( final String label )
             return this;
         }
 
-        public Builder addQueryParams( final Multimap<String, String> queryParams )
+        public Builder addQueryParams( final Map<String, Collection<String>> queryParams )
         {
-            this.queryParams.putAll( queryParams );
+            queryParams.forEach( this.queryParams::putAll );
             return this;
         }
 

diff --git a/modules/portal/portal-api/src/main/java/com/enonic/xp/portal/url/AttachmentUrlParams.java b/modules/portal/portal-api/src/main/java/com/enonic/xp/portal/url/AttachmentUrlParams.java
@@ -26,7 +26,7 @@ public final class AttachmentUrlParams
 
     private String branch;
 
-    private String contentKey;
+    private String baseUriKey;
 
     public String getId()
     {
@@ -63,9 +63,9 @@ public String getBranch()
         return branch;
     }
 
-    public String getContentKey()
+    public String getBaseUriKey()
     {
-        return contentKey;
+        return baseUriKey;
     }
 
     public AttachmentUrlParams id( final String value )
@@ -115,9 +115,9 @@ public AttachmentUrlParams branch( final String branch )
         return this;
     }
 
-    public AttachmentUrlParams contentKey( final String contentKey )
+    public AttachmentUrlParams baseUriKey( final String baseUriKey )
     {
-        this.contentKey = contentKey;
+        this.baseUriKey = baseUriKey;
         return this;
     }
 

diff --git a/...les/portal/portal-api/src/main/java/com/enonic/xp/portal/url/ImageUrlGeneratorParams.java b/...les/portal/portal-api/src/main/java/com/enonic/xp/portal/url/ImageUrlGeneratorParams.java
@@ -1,5 +1,7 @@
 package com.enonic.xp.portal.url;
 
+import java.util.Collection;
+import java.util.Map;
 import java.util.Objects;
 
 import com.google.common.collect.HashMultimap;
@@ -178,9 +180,9 @@ public Builder setScale( final String scale )
             return this;
         }
 
-        public Builder addQueryParams( final Multimap<String, String> queryParams )
+        public Builder addQueryParams( final Map<String, Collection<String>> queryParams )
         {
-            this.queryParams.putAll( queryParams );
+            queryParams.forEach( this.queryParams::putAll );
             return this;
         }
 

diff --git a/modules/portal/portal-api/src/main/java/com/enonic/xp/portal/url/ImageUrlParams.java b/modules/portal/portal-api/src/main/java/com/enonic/xp/portal/url/ImageUrlParams.java
@@ -31,7 +31,7 @@ public final class ImageUrlParams
 
     private String branch;
 
-    private String contentKey;
+    private String baseUriKey;
 
     public String getId()
     {
@@ -78,9 +78,9 @@ public String getBranch()
         return branch;
     }
 
-    public String getContentKey()
+    public String getBaseUriKey()
     {
-        return contentKey;
+        return baseUriKey;
     }
 
     public ImageUrlParams id( final String value )
@@ -142,9 +142,9 @@ public ImageUrlParams branch( final String branch )
         return this;
     }
 
-    public ImageUrlParams contentKey( final String contentKey )
+    public ImageUrlParams baseUriKey( final String baseUriKey )
     {
-        this.contentKey = contentKey;
+        this.baseUriKey = baseUriKey;
         return this;
     }
 

diff --git a/modules/portal/portal-api/src/main/java/com/enonic/xp/portal/url/PathStrategy.java b/modules/portal/portal-api/src/main/java/com/enonic/xp/portal/url/PathStrategy.java
diff --git a/modules/portal/portal-api/src/main/java/com/enonic/xp/portal/url/UrlStrategyFacade.java b/modules/portal/portal-api/src/main/java/com/enonic/xp/portal/url/UrlStrategyFacade.java
@@ -1,30 +1,10 @@
 package com.enonic.xp.portal.url;
 
 import com.enonic.xp.annotation.PublicApi;
-import com.enonic.xp.branch.Branch;
-import com.enonic.xp.content.Content;
-import com.enonic.xp.portal.PortalRequest;
-import com.enonic.xp.project.ProjectName;
 
 @PublicApi
 public interface UrlStrategyFacade
 {
-    BaseUrlStrategy offlineBaseUrlStrategy( ProjectName projectName, Branch branch, Content content, String urlType );
-
-    BaseUrlStrategy requestBaseUrlStrategy( PortalRequest portalRequest, String urlType );
-
-    ProjectName offlineProjectName( String projectName );
-
-    ProjectName requestProjectName( String projectName, PortalRequest portalRequest );
-
-    ProjectName offlinePrefixAndBaseUrlProjectName( String projectName );
-
-    Branch offlineBranch( String branch );
-
-    Branch requestBranch( String branch, PortalRequest portalRequest );
-
-    Branch offlinePrefixAndBaseUrlBranch( String branch );
-
     ImageUrlGeneratorParams offlineImageUrlParams( ImageUrlParams params );
 
     ImageUrlGeneratorParams requestImageUrlParams( ImageUrlParams params );

diff --git a/.../portal-impl/src/main/java/com/enonic/xp/portal/impl/url/AttachmentMediaPathStrategy.java b/.../portal-impl/src/main/java/com/enonic/xp/portal/impl/url/AttachmentMediaPathStrategy.java
@@ -10,7 +10,6 @@
 import com.enonic.xp.branch.Branch;
 import com.enonic.xp.content.ContentConstants;
 import com.enonic.xp.content.Media;
-import com.enonic.xp.portal.url.PathStrategy;
 import com.enonic.xp.project.ProjectName;
 
 import static com.enonic.xp.portal.impl.url.UrlBuilderHelper.appendParams;

diff --git a/...ortal/portal-impl/src/main/java/com/enonic/xp/portal/impl/url/ImageMediaPathStrategy.java b/...ortal/portal-impl/src/main/java/com/enonic/xp/portal/impl/url/ImageMediaPathStrategy.java
@@ -1,17 +1,18 @@
 package com.enonic.xp.portal.impl.url;
 
+import java.nio.charset.StandardCharsets;
 import java.util.Objects;
 
 import com.google.common.collect.LinkedListMultimap;
 import com.google.common.collect.Multimap;
+import com.google.common.hash.Hashing;
 import com.google.common.io.Files;
 
 import com.enonic.xp.attachment.Attachment;
 import com.enonic.xp.branch.Branch;
 import com.enonic.xp.content.Content;
 import com.enonic.xp.content.ContentConstants;
 import com.enonic.xp.content.Media;
-import com.enonic.xp.portal.url.PathStrategy;
 import com.enonic.xp.project.ProjectName;
 
 import static com.enonic.xp.portal.impl.url.UrlBuilderHelper.appendParams;
@@ -80,7 +81,20 @@ private Multimap<String, String> resolveQueryParams()
     private String resolveHash( final Media media )
     {
         final Attachment attachment = media.getMediaAttachment();
-        return attachment.getSha512() != null ? attachment.getSha512().substring( 0, 32 ) : null;
+
+        if ( attachment.getSha512() == null )
+        {
+            return null;
+        }
+
+        return Hashing.sha1()
+            .newHasher()
+            .putString( attachment.getSha512().substring( 0, 32 ), StandardCharsets.UTF_8 )
+            .putString( String.valueOf( media.getFocalPoint() ), StandardCharsets.UTF_8 )
+            .putString( String.valueOf( media.getCropping() ), StandardCharsets.UTF_8 )
+            .putString( String.valueOf( media.getOrientation() ), StandardCharsets.UTF_8 )
+            .hash()
+            .toString();
     }
 
     private String resolveName( final Content media, final String format )

diff --git a/...ortal/portal-impl/src/main/java/com/enonic/xp/portal/impl/url/OfflineBaseUrlStrategy.java b/...ortal/portal-impl/src/main/java/com/enonic/xp/portal/impl/url/OfflineBaseUrlStrategy.java
@@ -106,8 +106,11 @@ private String resolveBaseUrl( final SiteConfigs siteConfigs )
     private String normalizeBaseUrl( final String baseUrl )
     {
         final String path = UrlTypeConstants.SERVER_RELATIVE.equals( urlType ) ? URI.create( baseUrl ).getPath() : baseUrl;
-
-        return path + "/_";
+        if ( path.endsWith( "/" ) )
+        {
+            return path.substring( 0, path.length() - 1 ) + "/_/";
+        }
+        return path + "/_/";
     }
 
     static class Builder

diff --git a/modules/portal/portal-impl/src/main/java/com/enonic/xp/portal/impl/url/PathStrategy.java b/modules/portal/portal-impl/src/main/java/com/enonic/xp/portal/impl/url/PathStrategy.java
@@ -0,0 +1,6 @@
+package com.enonic.xp.portal.impl.url;
+
+public interface PathStrategy
+{
+    String generatePath();
+}