Mount widget interfaces to admin tool #10701

anatol-sialitski · anatol-sialitski · commit 28b822b96f0f · 2024-09-25T15:47:40.000+02:00
diff --git a/modules/admin/admin-api/src/main/java/com/enonic/xp/admin/tool/AdminToolDescriptor.java b/modules/admin/admin-api/src/main/java/com/enonic/xp/admin/tool/AdminToolDescriptor.java
@@ -1,6 +1,7 @@
 package com.enonic.xp.admin.tool;
 
 import java.util.Objects;
+import java.util.Set;
 
 import com.google.common.collect.ImmutableSet;
 
@@ -30,6 +31,8 @@ public class AdminToolDescriptor
 
     private final ApiMountDescriptors apiMounts;
 
+    private final ImmutableSet<String> interfaces;
+
     private AdminToolDescriptor( final Builder builder )
     {
         key = builder.key;
@@ -39,6 +42,7 @@ private AdminToolDescriptor( final Builder builder )
         descriptionI18nKey = builder.descriptionI18nKey;
         allowedPrincipals = PrincipalKeys.from( builder.allowedPrincipals.build() );
         apiMounts = Objects.requireNonNullElse( builder.apiMounts, ApiMountDescriptors.empty() );
+        interfaces = builder.interfaces.build();
     }
 
     public DescriptorKey getKey()
@@ -86,6 +90,16 @@ public boolean isAccessAllowed( final PrincipalKeys principalKeys )
         return principalKeys.contains( RoleKeys.ADMIN ) || principalKeys.stream().anyMatch( allowedPrincipals::contains );
     }
 
+    public Set<String> getInterfaces()
+    {
+        return interfaces;
+    }
+
+    public boolean hasInterface( final String interfaceName )
+    {
+        return interfaces.contains( interfaceName );
+    }
+
     public boolean isAppLauncherApplication()
     {
         return displayName != null;
@@ -128,6 +142,8 @@ public static final class Builder
 
         private final ImmutableSet.Builder<PrincipalKey> allowedPrincipals = ImmutableSet.builder();
 
+        private final ImmutableSet.Builder<String> interfaces = ImmutableSet.builder();
+
         private Builder()
         {
         }
@@ -174,6 +190,12 @@ public Builder apiMounts( final ApiMountDescriptors apiMountDescriptors )
             return this;
         }
 
+        public Builder addInterface( final String interfaceName )
+        {
+            this.interfaces.add( interfaceName );
+            return this;
+        }
+
         public AdminToolDescriptor build()
         {
             return new AdminToolDescriptor( this );
diff --git a/modules/admin/admin-api/src/main/java/com/enonic/xp/admin/widget/WidgetDescriptor.java b/modules/admin/admin-api/src/main/java/com/enonic/xp/admin/widget/WidgetDescriptor.java
@@ -37,7 +37,7 @@ public class WidgetDescriptor
 
     private final ImmutableMap<String, String> config;
 
-    private static final String URL_PREFIX = "_/widget/";
+    private static final String URL_PREFIX = "_/admin/widget/";
 
     private WidgetDescriptor( final Builder builder )
     {
diff --git a/modules/admin/admin-impl/src/main/java/com/enonic/xp/admin/impl/portal/WidgetApiHandler.java b/modules/admin/admin-impl/src/main/java/com/enonic/xp/admin/impl/portal/WidgetApiHandler.java
@@ -8,6 +8,8 @@
 import org.osgi.service.component.annotations.Component;
 import org.osgi.service.component.annotations.Reference;
 
+import com.enonic.xp.admin.tool.AdminToolDescriptor;
+import com.enonic.xp.admin.tool.AdminToolDescriptorService;
 import com.enonic.xp.admin.widget.WidgetDescriptor;
 import com.enonic.xp.admin.widget.WidgetDescriptorService;
 import com.enonic.xp.app.ApplicationKey;
@@ -22,23 +24,31 @@
 import com.enonic.xp.web.WebResponse;
 import com.enonic.xp.web.universalapi.UniversalApiHandler;
 
-@Component(immediate = true, service = UniversalApiHandler.class, property = {"applicationKey=widget", "apiKey=",
+@Component(immediate = true, service = UniversalApiHandler.class, property = {"applicationKey=admin", "apiKey=widget",
     "allowedPrincipals=role:system.admin.login", "allowedPrincipals=role:system.admin"})
 public class WidgetApiHandler
     implements UniversalApiHandler
 {
-    private static final Pattern WIDGET_API_PATTERN = Pattern.compile( "^/(_|api)/widget/(?<appKey>[^/]+)/(?<widgetKey>[^/]+)" );
+    private static final Pattern WIDGET_API_PATTERN = Pattern.compile( "^/(_|api)/admin/widget/(?<appKey>[^/]+)/(?<widgetKey>[^/]+)" );
+
+    private static final Pattern TOOL_PREFIX_PATTERN = Pattern.compile( "^/admin/(?<appKey>[^/]+)/(?<toolName>[^/]+)" );
+
+    private static final String GENERIC_WIDGET_INTERFACE = "generic";
 
     private final ControllerScriptFactory controllerScriptFactory;
 
     private final WidgetDescriptorService widgetDescriptorService;
 
+    private final AdminToolDescriptorService adminToolDescriptorService;
+
     @Activate
     public WidgetApiHandler( @Reference final ControllerScriptFactory controllerScriptFactory,
-                             @Reference final WidgetDescriptorService widgetDescriptorService )
+                             @Reference final WidgetDescriptorService widgetDescriptorService,
+                             @Reference final AdminToolDescriptorService adminToolDescriptorService )
     {
         this.controllerScriptFactory = controllerScriptFactory;
         this.widgetDescriptorService = widgetDescriptorService;
+        this.adminToolDescriptorService = adminToolDescriptorService;
     }
 
     @Override
@@ -66,6 +76,8 @@ public WebResponse handle( final WebRequest webRequest )
             throw WebException.forbidden( String.format( "You don't have permission to access [%s]", descriptorKey ) );
         }
 
+        verifyMounts( widgetDescriptor, webRequest );
+
         final PortalRequest portalRequest = createPortalRequest( webRequest, descriptorKey );
 
         final ResourceKey script = ResourceKey.from( descriptorKey.getApplicationKey(),
@@ -74,6 +86,29 @@ public WebResponse handle( final WebRequest webRequest )
         return controllerScriptFactory.fromScript( script ).execute( portalRequest );
     }
 
+    private void verifyMounts( final WidgetDescriptor widgetDescriptor, final WebRequest webRequest )
+    {
+        if ( !widgetDescriptor.hasInterface( GENERIC_WIDGET_INTERFACE ) && webRequest.getEndpointPath() != null )
+        {
+            final Matcher toolMatcher = TOOL_PREFIX_PATTERN.matcher( webRequest.getRawPath() );
+            if ( toolMatcher.find() )
+            {
+                final DescriptorKey toolDescriptorKey =
+                    DescriptorKey.from( resolveApplicationKey( toolMatcher.group( "appKey" ) ), toolMatcher.group( "toolName" ) );
+                final AdminToolDescriptor adminToolDescriptor = adminToolDescriptorService.getByKey( toolDescriptorKey );
+                if ( adminToolDescriptor != null && !adminToolDescriptor.getInterfaces().isEmpty() )
+                {
+                    if ( widgetDescriptor.getInterfaces().stream().noneMatch( adminToolDescriptor::hasInterface ) )
+                    {
+                        throw WebException.notFound(
+                            String.format( "Widget [%s] is not mounted to admin tool [%s]", widgetDescriptor.getKey(),
+                                           toolDescriptorKey ) );
+                    }
+                }
+            }
+        }
+    }
+
     private PortalRequest createPortalRequest( final WebRequest webRequest, final DescriptorKey descriptorKey )
     {
         final PortalRequest portalRequest =
diff --git a/modules/admin/admin-impl/src/main/java/com/enonic/xp/admin/impl/tool/XmlAdminToolDescriptorParser.java b/modules/admin/admin-impl/src/main/java/com/enonic/xp/admin/impl/tool/XmlAdminToolDescriptorParser.java
@@ -19,6 +19,10 @@ public class XmlAdminToolDescriptorParser
 
     private static final String API_DESCRIPTOR_TAG_NAME = "api";
 
+    private static final String INTERFACES_DESCRIPTOR_TAG_NAME = "interfaces";
+
+    private static final String INTERFACE_DESCRIPTOR_TAG_NAME = "interface";
+
     private static final int APPLICATION_KEY_INDEX = 0;
 
     private static final int API_KEY_INDEX = 1;
@@ -55,6 +59,16 @@ protected void doParse( final DomElement root )
         }
 
         this.builder.apiMounts( ApiMountDescriptors.from( parseApiMounts( root.getChild( APIS_DESCRIPTOR_TAG_NAME ) ) ) );
+
+        final DomElement interfaces = root.getChild( INTERFACES_DESCRIPTOR_TAG_NAME );
+        if ( interfaces != null )
+        {
+            final List<DomElement> interfaceList = interfaces.getChildren( INTERFACE_DESCRIPTOR_TAG_NAME );
+            for ( DomElement anInterface : interfaceList )
+            {
+                this.builder.addInterface( anInterface.getValue().trim() );
+            }
+        }
     }
 
     private List<ApiMountDescriptor> parseApiMounts( final DomElement apisElement )
diff --git a/modules/admin/admin-impl/src/test/java/com/enonic/xp/admin/impl/portal/WidgetApiHandlerTest.java b/modules/admin/admin-impl/src/test/java/com/enonic/xp/admin/impl/portal/WidgetApiHandlerTest.java
@@ -3,6 +3,7 @@
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
 
+import com.enonic.xp.admin.tool.AdminToolDescriptorService;
 import com.enonic.xp.admin.widget.WidgetDescriptor;
 import com.enonic.xp.admin.widget.WidgetDescriptorService;
 import com.enonic.xp.app.ApplicationKey;
@@ -34,13 +35,16 @@ public class WidgetApiHandlerTest
 
     private WidgetDescriptorService widgetDescriptorService;
 
+    private AdminToolDescriptorService adminToolDescriptorService;
+
     @BeforeEach
     public void setUp()
     {
         this.controllerScriptFactory = mock( ControllerScriptFactory.class );
         this.widgetDescriptorService = mock( WidgetDescriptorService.class );
+        this.adminToolDescriptorService = mock( AdminToolDescriptorService.class );
 
-        this.handler = new WidgetApiHandler( this.controllerScriptFactory, this.widgetDescriptorService );
+        this.handler = new WidgetApiHandler( this.controllerScriptFactory, this.widgetDescriptorService, this.adminToolDescriptorService );
     }
 
 
diff --git a/modules/admin/admin-impl/src/test/java/com/enonic/xp/admin/impl/tool/XmlAdminToolDescriptorParserTest.java b/modules/admin/admin-impl/src/test/java/com/enonic/xp/admin/impl/tool/XmlAdminToolDescriptorParserTest.java
@@ -1,5 +1,7 @@
 package com.enonic.xp.admin.impl.tool;
 
+import java.util.Set;
+
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
 
@@ -15,6 +17,7 @@
 import static org.junit.jupiter.api.Assertions.assertEquals;
 import static org.junit.jupiter.api.Assertions.assertNotNull;
 import static org.junit.jupiter.api.Assertions.assertThrows;
+import static org.junit.jupiter.api.Assertions.assertTrue;
 
 public class XmlAdminToolDescriptorParserTest
     extends XmlModelParserTest
@@ -73,6 +76,23 @@ public void testParseWithApis()
         assertEquals( "", apiMountDescriptor4.getApiKey() );
     }
 
+    @Test
+    public void testParseWithInterfaces()
+        throws Exception
+    {
+        parse( this.parser, "-interfaces.xml" );
+
+        final AdminToolDescriptor toolDescriptor = this.builder.build();
+
+        assertResult( toolDescriptor );
+
+        assertEquals( 2, toolDescriptor.getInterfaces().size() );
+
+        final Set<String> interfaces = toolDescriptor.getInterfaces();
+        assertTrue( interfaces.contains( "generic" ) );
+        assertTrue( interfaces.contains( "admin.dashboard" ) );
+    }
+
     @Test
     public void testParseWithInvalidApis()
     {
diff --git a/modules/admin/admin-impl/src/test/resources/com/enonic/xp/admin/impl/tool/XmlAdminToolDescriptorParserTest-interfaces.xml b/modules/admin/admin-impl/src/test/resources/com/enonic/xp/admin/impl/tool/XmlAdminToolDescriptorParserTest-interfaces.xml
@@ -0,0 +1,12 @@
+<?xml version="1.0"?>
+<tool xmlns="urn:enonic:xp:model:1.0">
+  <display-name i18n="key.display-name">My admin tool</display-name>
+  <description i18n="key.description">Tool description</description>
+  <allow>
+    <principal>role:system.admin</principal>
+  </allow>
+  <interfaces>
+    <interface>generic</interface>
+    <interface>admin.dashboard</interface>
+  </interfaces>
+</tool>
diff --git a/modules/core/core-api/src/main/resources/META-INF/xsd/model.xsd b/modules/core/core-api/src/main/resources/META-INF/xsd/model.xsd
@@ -301,6 +301,13 @@
         </xs:complexType>
       </xs:element>
       <xs:element name="apis" minOccurs="0" type="apiMount"/>
+      <xs:element minOccurs="0" name="interfaces">
+        <xs:complexType>
+          <xs:sequence>
+            <xs:element maxOccurs="unbounded" minOccurs="0" name="interface" type="xs:string"/>
+          </xs:sequence>
+        </xs:complexType>
+      </xs:element>
     </xs:sequence>
   </xs:complexType>
 

Original file line number	Diff line number	Diff line change
`@@ -37,7 +37,7 @@ public class WidgetDescriptor`
`37`	`37`
`38`	`38`	`private final ImmutableMap<String, String> config;`
`39`	`39`
`40`		`- private static final String URL_PREFIX = "_/widget/";`
	`40`	`+ private static final String URL_PREFIX = "_/admin/widget/";`
`41`	`41`
`42`	`42`	`private WidgetDescriptor( final Builder builder )`
`43`	`43`	`{`