[EAK-617] Display the list of available OSGi configurations

core/pom.xml

@@ -31,13 +31,15 @@
                         </Import-Package>
                         <Sling-Model-Packages>
                             com.exadel.aem.toolkit.core.authoring.models,
+                            com.exadel.aem.toolkit.core.configurator.models,
                             com.exadel.aem.toolkit.core.lists.models,
                             com.exadel.aem.toolkit.core.policymanagement.models
                         </Sling-Model-Packages>
                         <Export-Package>
                             com.exadel.aem.toolkit.api.*,
                             com.exadel.aem.toolkit.core.authoring.models,
                             com.exadel.aem.toolkit.core.injectors.*,
+                            com.exadel.aem.toolkit.core.configurator.models.*,
                             com.exadel.aem.toolkit.core.lists.models.*,
                             com.exadel.aem.toolkit.core.lists.utils,
                         </Export-Package>

core/src/main/java/com/exadel/aem/toolkit/core/authoring/models/ExpressionSupport.java

@@ -0,0 +1,59 @@
+/*
+ * 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.exadel.aem.toolkit.core.authoring.models;
+
+import java.util.Locale;
+
+import org.apache.commons.lang3.StringUtils;
+import org.apache.sling.api.SlingHttpServletRequest;
+import org.apache.sling.models.annotations.Model;
+import org.apache.sling.models.annotations.injectorspecific.OSGiService;
+import org.apache.sling.models.annotations.injectorspecific.SlingObject;
+import com.adobe.granite.ui.components.ExpressionResolver;
+
+import com.exadel.aem.toolkit.api.annotations.injectors.RequestAttribute;
+
+/**
+ * Provides Granite EL expression resolver for using in HTL scripts
+ */
+@Model(adaptables = SlingHttpServletRequest.class)
+public class ExpressionSupport {
+
+    @SlingObject
+    private SlingHttpServletRequest request;
+
+    @RequestAttribute
+    private String property;
+
+    @OSGiService
+    private ExpressionResolver expressionResolver;
+
+    /**
+     * Gets the resolved value of the property specified in the {@code property} request attribute
+     * @return The resolved string value
+     */
+    public String getValue() {
+        String expression = StringUtils.isNotEmpty(property)
+            ? request.getResource().getValueMap().get(property, String.class)
+            : null;
+        if (StringUtils.isEmpty(expression) || expressionResolver == null) {
+            return StringUtils.EMPTY;
+        }
+        try {
+            return expressionResolver.resolve(expression, Locale.getDefault(), String.class, request);
+        } catch (Exception e) {
+            return StringUtils.EMPTY;
+        }
+    }
+}

core/src/main/java/com/exadel/aem/toolkit/core/authoring/models/RenderConditionSupport.java

@@ -0,0 +1,54 @@
+/*
+ * 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.exadel.aem.toolkit.core.authoring.models;
+
+import java.io.IOException;
+import javax.servlet.ServletException;
+
+import org.apache.sling.api.SlingHttpServletRequest;
+import org.apache.sling.api.SlingHttpServletResponse;
+import org.apache.sling.models.annotations.Model;
+import org.apache.sling.models.annotations.injectorspecific.SlingObject;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import com.adobe.granite.ui.components.rendercondition.RenderConditionHelper;
+
+/**
+ * Provides Granite render condition support for using in HTL scripts
+ */
+@Model(adaptables = SlingHttpServletRequest.class)
+public class RenderConditionSupport {
+
+    private static final Logger LOG = LoggerFactory.getLogger(RenderConditionSupport.class);
+
+    @SlingObject
+    private SlingHttpServletRequest request;
+
+    @SlingObject
+    private SlingHttpServletResponse response;
+
+    /**
+     * Checks the render condition associated with the current resource
+     * @return True or false
+     */
+    public boolean check() {
+        RenderConditionHelper helper = new RenderConditionHelper(request, response);
+        try {
+            return helper.getRenderCondition(request.getResource()).check();
+        } catch (ServletException | IOException e) {
+            LOG.error("Render condition check failed", e);
+        }
+        return false;
+    }
+}

core/src/main/java/com/exadel/aem/toolkit/core/configurator/models/internal/ConfigAccess.java

@@ -0,0 +1,134 @@
+/*
+ * 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.exadel.aem.toolkit.core.configurator.models.internal;
+
+import java.util.Objects;
+import javax.servlet.http.HttpServletRequest;
+
+import org.apache.commons.lang3.StringUtils;
+import org.osgi.framework.BundleContext;
+import org.osgi.framework.FrameworkUtil;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import com.adobe.granite.ui.components.ExpressionCustomizer;
+
+import com.exadel.aem.toolkit.core.configurator.services.ConfigChangeListener;
+import com.exadel.aem.toolkit.core.configurator.utils.PermissionUtil;
+import com.exadel.aem.toolkit.core.configurator.utils.RequestUtil;
+
+/**
+ * Enumerates possible outcomes of a configuration access request
+ * <p><u>Note</u>: This class is not a part of the public API and is subject to change. Do not use it in your own code
+ */
+public enum ConfigAccess {
+
+    GRANTED(null),
+
+    DISABLED("This tool is disabled in OSGi configuration"),
+    FACTORY_CONFIG("Factory configs are currently not supported"),
+    INVALID_CONFIG("Configuration is missing or invalid"),
+    NO_ACCESS("You don't have access to this feature"),
+    NO_CONFIG("No configuration specified"),
+    OSGI_FAILURE("Could not acquire OSGi entity");
+
+    private static final Logger LOG = LoggerFactory.getLogger(ConfigAccess.class);
+
+    private static final String KEY = "configAccess";
+
+    private final String error;
+
+    /**
+     * Default (instantiation-restricting) constructor
+     * @param error Error message; null if access is granted
+     */
+    ConfigAccess(String error) {
+        this.error = error;
+    }
+
+    /**
+     * Gets the error message associated with this access result
+     * @return String value; null if access is granted
+     */
+    public String getError() {
+        return error;
+    }
+
+    /**
+     * Indicates whether access is granted
+     * @return True or false
+     */
+    public boolean isGranted() {
+        return StringUtils.isEmpty(error);
+    }
+
+    /**
+     * Determines the access result for the current request; caches the result in the request attribute for future
+     * reference
+     * @param request The current request
+     * @return The access result
+     */
+    public static ConfigAccess from(HttpServletRequest request) {
+        if (request == null) {
+            return OSGI_FAILURE;
+        }
+
+        ExpressionCustomizer customizer = ExpressionCustomizer.from(request);
+        ConfigAccess result = (ConfigAccess) customizer.getVariable(KEY);
+        if (result != null) {
+            return result;
+        }
+        result = pick(request);
+        customizer.setVariable(KEY, result);
+        return result;
+    }
+
+    /**
+     * Determines the access result for the current request
+     * @param request The current request
+     * @return The access result
+     */
+    private static ConfigAccess pick(HttpServletRequest request) {
+        if (!PermissionUtil.hasModifyPermission(request)) {
+            return NO_ACCESS;
+        }
+
+        String configId = RequestUtil.getConfigPid(request);
+        if (StringUtils.isEmpty(configId)) {
+            return request.getRequestURI().contains("/etoolbox/config")
+                && PermissionUtil.hasGlobalModifyPermission(request) ? GRANTED : NO_CONFIG;
+        }
+
+        try {
+            BundleContext context = Objects.requireNonNull(FrameworkUtil.getBundle(ConfigAccess.class).getBundleContext());
+            ConfigChangeListener listener = Objects.requireNonNull(context.getService(context.getServiceReference(ConfigChangeListener.class)));
+            if (!listener.isEnabled()) {
+                return DISABLED;
+            }
+        } catch (RuntimeException e) {
+            LOG.error(OSGI_FAILURE.getError(), e);
+            return OSGI_FAILURE;
+        }
+
+        ConfigDefinition config = ConfigDefinition.from(request);
+        if (!config.isValid()) {
+            return INVALID_CONFIG;
+        }
+
+        if (config.isFactory()) {
+            return FACTORY_CONFIG;
+        }
+
+        return GRANTED;
+    }
+}

core/src/main/java/com/exadel/aem/toolkit/core/configurator/servlets/ConfigAttribute.java → core/src/main/java/com/exadel/aem/toolkit/core/configurator/models/internal/ConfigAttribute.java

@@ -11,7 +11,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package com.exadel.aem.toolkit.core.configurator.servlets;
+package com.exadel.aem.toolkit.core.configurator.models.internal;
 
 import org.apache.commons.lang3.ArrayUtils;
 import org.osgi.service.metatype.AttributeDefinition;
@@ -20,9 +20,10 @@
 
 /**
  * Represents a configuration attribute, i.e., a pair of {@link AttributeDefinition} and its value
+ * <p><b>Note</b>: This class is not a part of the public API and is subject to change. Do not use it in your own code
  * @see ConfigDefinition
  */
-class ConfigAttribute {
+public class ConfigAttribute {
     private final AttributeDefinition definition;
     private final Object value;
 
@@ -31,7 +32,7 @@ class ConfigAttribute {
      * @param definition The attribute definition
      * @param value      The attribute value
      */
-    ConfigAttribute(AttributeDefinition definition, Object value) {
+    public ConfigAttribute(AttributeDefinition definition, Object value) {
         this.definition = definition;
         this.value = value;
     }