feat(print-properties): Adding dorContainer in each component and pageTemplate in FormContainer and new print specific components

bundles/af-core/pom.xml

@@ -653,6 +653,10 @@
             <artifactId>core.wcm.components.core</artifactId>
             <scope>provided</scope>
         </dependency>
+        <dependency>
+            <groupId>com.adobe.aem</groupId>
+            <artifactId>core-forms-print-components-print-dor-api</artifactId>
+        </dependency>
         <dependency>
             <groupId>org.apache.sling</groupId>
             <artifactId>org.apache.sling.testing.caconfig-mock-plugin</artifactId>

bundles/af-core/src/main/java/com/adobe/cq/forms/core/components/internal/form/FormConstants.java

@@ -148,4 +148,6 @@ private FormConstants() {
 
     /** Form definition type indicating submission view */
     public static final String FORM_DEFINITION_SUBMISSION = "submission";
+
+    public static final String PRINT_CHANNEL_MARKER = "print";
 }

bundles/af-core/src/main/java/com/adobe/cq/forms/core/components/internal/models/v1/form/ButtonImpl.java

@@ -109,6 +109,10 @@ public Map<String, Object> getDorProperties() {
         if (dorColspan != null) {
             customDorProperties.put("dorColspan", dorColspan);
         }
+        Map<String, Object> dorContainer = getDorContainer();
+        if (dorContainer != null) {
+            customDorProperties.put(CUSTOM_DOR_CONTAINER_WRAPPER, dorContainer);
+        }
         return customDorProperties;
     }
 

bundles/af-core/src/main/java/com/adobe/cq/forms/core/components/internal/models/v1/form/FragmentImpl.java

@@ -15,7 +15,9 @@
  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~*/
 package com.adobe.cq.forms.core.components.internal.models.v1.form;
 
-import java.util.*;
+import java.util.ArrayList;
+import java.util.List;
+import java.util.Map;
 
 import javax.annotation.PostConstruct;
 
@@ -43,6 +45,7 @@
 import com.adobe.cq.forms.core.components.models.form.FormContainer;
 import com.adobe.cq.forms.core.components.models.form.Fragment;
 import com.adobe.cq.forms.core.components.util.ComponentUtils;
+import com.day.cq.commons.jcr.JcrConstants;
 import com.fasterxml.jackson.annotation.JsonIgnore;
 
 @Model(
@@ -55,6 +58,7 @@
 public class FragmentImpl extends PanelImpl implements Fragment {
 
     public static final String CUSTOM_FRAGMENT_PROPERTY_WRAPPER = "fd:fragment";
+    private static final String PRINT_CHANNEL_PATH = "/" + JcrConstants.JCR_CONTENT + "/" + "print";
 
     @OSGiService
     private SlingModelFilter slingModelFilter;
@@ -70,6 +74,9 @@ public class FragmentImpl extends PanelImpl implements Fragment {
     @PostConstruct
     private void initFragmentModel() {
         ResourceResolver resourceResolver = resource.getResourceResolver();
+
+        fragmentPath = this.getFragmentPathBasedOnChannel(fragmentPath);
+
         fragmentContainer = ComponentUtils.getFragmentContainer(resourceResolver, fragmentPath);
         if (request != null) {
             FormClientLibManager formClientLibManager = request.adaptTo(FormClientLibManager.class);
@@ -80,6 +87,20 @@ private void initFragmentModel() {
         }
     }
 
+    private String getFragmentPathBasedOnChannel(String fragmentPath) {
+        Resource formContainerResource = resource;
+        String fragmentPathOfChannel = fragmentPath;
+        while (formContainerResource != null) {
+            String resourceType = formContainerResource.getValueMap().get("sling:resourceType", String.class);
+            if (resourceType != null && resourceType.contains(FormConstants.PRINT_CHANNEL_MARKER)) {
+                fragmentPathOfChannel = fragmentPath + PRINT_CHANNEL_PATH;
+                break;
+            }
+            formContainerResource = formContainerResource.getParent();
+        }
+        return fragmentPathOfChannel;
+    }
+
     @JsonIgnore
     public String getFragmentPath() {
         return fragmentPath;

bundles/af-core/src/main/java/com/adobe/cq/forms/core/components/internal/models/v1/form/PanelImpl.java

@@ -145,6 +145,10 @@ public Map<String, Object> getDorProperties() {
         if (dorLayoutType != null) {
             customDorProperties.put(DOR_LAYOUT_TYPE, dorLayoutType);
         }
+        Map<String, Object> dorContainer = getDorContainer();
+        if (dorContainer != null) {
+            customDorProperties.put(CUSTOM_DOR_CONTAINER_WRAPPER, dorContainer);
+        }
         return customDorProperties;
     }
 

bundles/af-core/src/main/java/com/adobe/cq/forms/core/components/models/form/FormComponent.java

@@ -76,6 +76,17 @@ default Map<String, Object> getDorProperties() {
         return Collections.emptyMap();
     }
 
+    /**
+     * DOR container
+     *
+     * @since com.adobe.cq.forms.core.components.models.form 2.1.0
+     */
+    @JsonView(Views.DoR.class)
+    @JsonInclude(JsonInclude.Include.NON_EMPTY)
+    default Map<String, Object> getDorContainer() {
+        return Collections.emptyMap();
+    }
+
     /**
      * Returns getPath of the form field
      *

bundles/af-core/src/main/java/com/adobe/cq/forms/core/components/util/AbstractFormComponentImpl.java

@@ -17,7 +17,18 @@
 
 import java.io.IOException;
 import java.math.BigDecimal;
-import java.util.*;
+import java.util.AbstractMap;
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.Calendar;
+import java.util.Collections;
+import java.util.HashMap;
+import java.util.HashSet;
+import java.util.LinkedHashMap;
+import java.util.List;
+import java.util.Map;
+import java.util.Optional;
+import java.util.Set;
 import java.util.function.Predicate;
 import java.util.regex.Pattern;
 import java.util.stream.Collectors;
@@ -49,6 +60,7 @@
 import com.adobe.cq.forms.core.components.models.form.FieldType;
 import com.adobe.cq.forms.core.components.models.form.FormComponent;
 import com.adobe.cq.forms.core.components.models.form.Label;
+import com.adobe.cq.forms.core.components.models.form.print.dorapi.DorContainer;
 import com.adobe.cq.wcm.core.components.models.Component;
 import com.adobe.cq.wcm.core.components.util.ComponentUtils;
 import com.day.cq.i18n.I18n;
@@ -58,6 +70,7 @@
 import com.fasterxml.jackson.annotation.JsonInclude;
 import com.fasterxml.jackson.annotation.JsonProperty;
 import com.fasterxml.jackson.core.JsonGenerator;
+import com.fasterxml.jackson.core.type.TypeReference;
 import com.fasterxml.jackson.databind.JsonNode;
 import com.fasterxml.jackson.databind.JsonSerializer;
 import com.fasterxml.jackson.databind.ObjectMapper;
@@ -258,6 +271,7 @@ protected boolean getEditMode() {
     }
 
     public static final String CUSTOM_DOR_PROPERTY_WRAPPER = "fd:dor";
+    public static final String CUSTOM_DOR_CONTAINER_WRAPPER = "dorContainer";
     // used for DOR and SPA editor to work
     public static final String CUSTOM_JCR_PATH_PROPERTY_WRAPPER = "fd:path";
 
@@ -544,6 +558,10 @@ public Map<String, Object> getDorProperties() {
         if (dorBindRef != null) {
             customDorProperties.put("dorBindRef", dorBindRef);
         }
+        Map<String, Object> dorContainer = getDorContainer();
+        if (dorContainer != null) {
+            customDorProperties.put(CUSTOM_DOR_CONTAINER_WRAPPER, dorContainer);
+        }
         return customDorProperties;
     }
 
@@ -567,4 +585,26 @@ private List<String> getDisabledXFAScripts() {
         }
         return new ArrayList<>(disabledScripts);
     }
+
+    /**
+     * Returns the dor container properties.
+     * 
+     * @return Map of dor container properties if `fd:dorContainer` node is present otherwise returns null
+     */
+    @JsonIgnore
+    @Override
+    public Map<String, Object> getDorContainer() {
+        if (resource != null) {
+            Resource dorContainerResource = resource.getChild("fd:dorContainer");
+            if (dorContainerResource != null) {
+                DorContainer dorContainer = dorContainerResource.adaptTo(DorContainer.class);
+                ObjectMapper objectMapper = new ObjectMapper();
+                if (dorContainer != null) {
+                    return objectMapper.convertValue(dorContainer, new TypeReference<Map<String, Object>>() {});
+                }
+            }
+        }
+        return null;
+    }
+
 }

bundles/af-core/src/main/java/com/adobe/cq/forms/core/components/views/Views.java

@@ -29,4 +29,10 @@ public static class Publish {}
      */
     public static class Author extends Publish {}
 
+    /**
+     * Use this view for including the print-specific properties
+     * Eg; dorContainer and pageTemplate
+     */
+    public static class DoR extends Author {}
+
 }

bundles/af-core/src/test/java/com/adobe/cq/forms/core/components/internal/models/v1/form/ButtonImplTest.java

@@ -15,19 +15,24 @@
  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~*/
 package com.adobe.cq.forms.core.components.internal.models.v1.form;
 
+import java.util.HashMap;
+import java.util.Map;
+
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.api.extension.ExtendWith;
 import org.mockito.Mockito;
 
 import com.adobe.cq.forms.core.Utils;
 import com.adobe.cq.forms.core.components.internal.form.FormConstants;
-import com.adobe.cq.forms.core.components.models.form.*;
+import com.adobe.cq.forms.core.components.models.form.Button;
+import com.adobe.cq.forms.core.components.models.form.FieldType;
 import com.adobe.cq.forms.core.context.FormsCoreComponentTestContext;
 import io.wcm.testing.mock.aem.junit5.AemContext;
 import io.wcm.testing.mock.aem.junit5.AemContextExtension;
 
 import static org.junit.Assert.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertTrue;
 
 @ExtendWith(AemContextExtension.class)
 public class ButtonImplTest {
@@ -148,4 +153,13 @@ void testNoFieldType() {
         Button button = Utils.getComponentUnderTest(PATH_BUTTON_NO_FIELDTYPE, Button.class, context);
         assertEquals(FieldType.BUTTON.getValue(), button.getFieldType());
     }
+
+    @Test
+    void testDorContainer() {
+        Button mockButton = Mockito.mock(ButtonImpl.class);
+        Mockito.when(mockButton.getDorContainer()).thenReturn(new HashMap<>());
+        Mockito.when(mockButton.getDorProperties()).thenCallRealMethod();
+        Map<String, Object> dorProperties = mockButton.getDorProperties();
+        assertTrue(dorProperties.containsKey(ButtonImpl.CUSTOM_DOR_CONTAINER_WRAPPER));
+    }
 }

bundles/af-core/src/test/java/com/adobe/cq/forms/core/components/internal/models/v1/form/PanelImplTest.java

@@ -15,6 +15,7 @@
  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~*/
 package com.adobe.cq.forms.core.components.internal.models.v1.form;
 
+import java.util.HashMap;
 import java.util.HashSet;
 import java.util.Map;
 import java.util.Set;
@@ -40,6 +41,7 @@
 
 import static org.junit.Assert.assertEquals;
 import static org.junit.Assert.assertNotNull;
+import static org.junit.jupiter.api.Assertions.assertTrue;
 
 @ExtendWith(AemContextExtension.class)
 public class PanelImplTest {
@@ -137,4 +139,13 @@ void testNoFieldType() {
         Panel panel = Utils.getComponentUnderTest(PATH_PANEL_WITHOUT_FIELDTYPE, Panel.class, context);
         assertEquals(FieldType.PANEL.getValue(), panel.getFieldType());
     }
+
+    @Test
+    void testDorContainer() {
+        Panel mockPanel = Mockito.mock(PanelImpl.class);
+        Mockito.when(mockPanel.getDorContainer()).thenReturn(new HashMap<>());
+        Mockito.when(mockPanel.getDorProperties()).thenCallRealMethod();
+        Map<String, Object> dorProperties = mockPanel.getDorProperties();
+        assertTrue(dorProperties.containsKey(PanelImpl.CUSTOM_DOR_CONTAINER_WRAPPER));
+    }
 }

bundles/af-core/src/test/java/com/adobe/cq/forms/core/components/internal/models/v1/form/RadioButtonImplTest.java

@@ -427,4 +427,4 @@ void testNoFieldType() {
         RadioButton radioButton = getRadioButtonUnderTest(PATH_RADIOBUTTON_WITHOUT_FIELDTYPE);
         assertEquals(FieldType.RADIO_GROUP.getValue(), radioButton.getFieldType());
     }
-}
+}

bundles/af-core/src/test/java/com/adobe/cq/forms/core/components/internal/models/v2/form/FormContainerImplTest.java

@@ -35,6 +35,7 @@
 import org.apache.http.impl.client.HttpClientBuilder;
 import org.apache.http.osgi.services.HttpClientBuilderFactory;
 import org.apache.sling.api.resource.Resource;
+import org.apache.sling.api.resource.ValueMap;
 import org.apache.sling.i18n.ResourceBundleProvider;
 import org.apache.sling.testing.mock.sling.MockResourceBundle;
 import org.apache.sling.testing.mock.sling.MockResourceBundleProvider;
@@ -54,7 +55,13 @@
 import com.adobe.cq.forms.core.Utils;
 import com.adobe.cq.forms.core.components.internal.form.FormConstants;
 import com.adobe.cq.forms.core.components.internal.form.ReservedProperties;
-import com.adobe.cq.forms.core.components.models.form.*;
+import com.adobe.cq.forms.core.components.models.form.AutoSaveConfiguration;
+import com.adobe.cq.forms.core.components.models.form.FieldType;
+import com.adobe.cq.forms.core.components.models.form.FormClientLibManager;
+import com.adobe.cq.forms.core.components.models.form.FormContainer;
+import com.adobe.cq.forms.core.components.models.form.FormMetaData;
+import com.adobe.cq.forms.core.components.models.form.TextInput;
+import com.adobe.cq.forms.core.components.models.form.ThankYouOption;
 import com.adobe.cq.forms.core.components.views.Views;
 import com.adobe.cq.forms.core.context.FormsCoreComponentTestContext;
 import com.day.cq.i18n.I18n;
@@ -96,6 +103,7 @@ public class FormContainerImplTest {
         + "/formContainer-cc-form-spreadsheet-submission";
     private static final String PATH_CC_FORM_REST_SUBMISSION = CONTENT_ROOT
         + "/formContainer-cc-form-rest-submission";
+    private static final String PATH_FORM_WITH_FRAGMENT = CONTENT_ROOT + "/formcontainerv2-with-fragment";
 
     private static final String PATH_FORM_WITHOUT_FIELDTYPE = CONTENT_ROOT + "/formcontainerv2-without-fieldtype";
     private static final String PATH_FORM_WITH_AUTO_SAVE = CONTENT_ROOT + "/formcontainerv2WithAutoSave";
@@ -439,6 +447,7 @@ void testGetName() throws Exception {
     @Test
     public void testRequestAttributeIfContainerPageDifferent() {
         Resource resource = Mockito.mock(Resource.class);
+        Mockito.when(resource.getValueMap()).thenReturn(ValueMap.EMPTY);
         Page afPage = Mockito.mock(Page.class);
         Mockito.when(afPage.getPath()).thenReturn(AF_PATH);
         PageManager pageManager = Mockito.mock(PageManager.class);
@@ -785,4 +794,10 @@ public void testActionForCCFormRestSubmission() throws Exception {
             !decodedAction.endsWith(".model.json"));
         Utils.testJSONExport(formContainer, Utils.getTestExporterJSONPath(BASE, PATH_CC_FORM_REST_SUBMISSION));
     }
+
+    @Test
+    void testJSONExportWithFragment() throws Exception {
+        FormContainer formContainer = Utils.getComponentUnderTest(PATH_FORM_WITH_FRAGMENT, FormContainerImpl.class, context);
+        Utils.testJSONExport(formContainer, Utils.getTestExporterJSONPath(BASE, PATH_FORM_WITH_FRAGMENT));
+    }
 }

bundles/af-core/src/test/java/com/adobe/cq/forms/core/components/models/form/FormComponentTest.java

@@ -0,0 +1,35 @@
+/*~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+ ~ Copyright 2022 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.models.form;
+
+import java.util.Collections;
+
+import org.junit.jupiter.api.Test;
+import org.mockito.Mockito;
+import org.osgi.annotation.versioning.ProviderType;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+
+@ProviderType
+public class FormComponentTest {
+    @Test
+    public void testGetDorContainer() {
+        FormComponent formComponent = Mockito.mock(FormComponent.class);
+        Mockito.when(formComponent.getDorContainer()).thenCallRealMethod();
+        assertEquals(Collections.emptyMap(), formComponent.getDorContainer());
+    }
+
+}