com.adobe.acs.commons.ccvar.impl.AllPagePropertiesContentVariableProvider Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of acs-aem-commons-bundle Show documentation
Main ACS AEM Commons OSGi Bundle. Includes commons utilities.
There is a newer version: 6.9.4
Show newest version
/*
 * ACS AEM Commons
 *
 * Copyright (C) 2013 - 2023 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.acs.commons.ccvar.impl;

import com.adobe.acs.commons.ccvar.ContentVariableProvider;
import com.adobe.acs.commons.ccvar.PropertyConfigService;
import com.adobe.acs.commons.ccvar.util.PropertyAggregatorUtil;
import com.day.cq.wcm.api.Page;
import com.day.cq.wcm.api.PageManager;
import org.apache.sling.api.SlingHttpServletRequest;
import org.apache.sling.api.resource.Resource;
import org.apache.sling.api.resource.ValueMap;
import org.osgi.service.component.annotations.Component;
import org.osgi.service.component.annotations.Reference;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import java.util.Map;

/**
 * Default {@link ContentVariableProvider} provided that will aggregate the current and inherited page properties
 * based on the request information passed in.
 */
@Component(service = ContentVariableProvider.class)
public class AllPagePropertiesContentVariableProvider implements ContentVariableProvider {

    private static final Logger LOG = LoggerFactory.getLogger(AllPagePropertiesContentVariableProvider.class);

    public static final String PAGE_PROP_PREFIX = "page_properties";
    private static final String INHERITED_PAGE_PROP_PREFIX = "inherited_page_properties";

    @Reference
    private PropertyConfigService propertyConfigService;

    @Override
    public void addProperties(Map map, SlingHttpServletRequest request) {
        Resource resource = request.getResource();

        PageManager pageManager = resource.getResourceResolver().adaptTo(PageManager.class);
        if (pageManager == null) {
            LOG.warn("PageManager was null, skipping properties.");
            return;
        }
        Page page = pageManager.getContainingPage(resource);

        if (page == null) {
            LOG.warn("No containing page found for resource at {}", resource.getPath());
            return;
        }

        // Add current page properties
        addPagePropertiesToMap(map, page, PAGE_PROP_PREFIX, propertyConfigService);

        // Add inherited page properties
        while (page != null) {
            addPagePropertiesToMap(map, page, INHERITED_PAGE_PROP_PREFIX, propertyConfigService);
            page = page.getParent();
        }
    }

    /**
     * Add the properties of a page to the given map.  Excluded properties are found in the
     * {@link PropertyConfigService} service.
     *
     * @param map                   the map that should be updated with the properties and their values
     * @param page                  the page containing properties
     * @param prefix                the prefix to apply to the
     * @param propertyConfigService the {@link PropertyConfigService} used to check type and exclusion
     */
    private void addPagePropertiesToMap(Map map, Page page, String prefix,
                                              PropertyConfigService propertyConfigService) {
        ValueMap pageProperties = page.getProperties();
        PropertyAggregatorUtil.addPropertiesToMap(map, pageProperties.entrySet(), prefix, false, propertyConfigService);
    }

    @Override
    public boolean accepts(SlingHttpServletRequest request) {
        PageManager pageManager = request.getResourceResolver().adaptTo(PageManager.class);
        if (pageManager == null) {
            LOG.warn("PageManager is null, not accepting this request.");
            return false;
        }
        Page page = pageManager.getContainingPage(request.getResource());
        return page != null && page.getPath().startsWith("/content/");
    }
}