io.wcm.wcm.commons.util.Template.java Source code

Introduction

Here is the source code for io.wcm.wcm.commons.util.Template.java

Source

/*
 * #%L
 * wcm.io
 * %%
 * Copyright (C) 2014 wcm.io
 * %%
 * 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.
 * #L%
 */
package io.wcm.wcm.commons.util;

import java.util.EnumSet;
import java.util.regex.Matcher;
import java.util.regex.Pattern;

import org.apache.commons.lang3.StringUtils;
import org.osgi.annotation.versioning.ProviderType;

import com.day.cq.wcm.api.NameConstants;
import com.day.cq.wcm.api.Page;

/**
 * Template utility methods
 */
@ProviderType
public final class Template {

    static final Pattern TEMPLATE_PATH_PATTERN = Pattern.compile("^/(apps|libs)/(.+)/templates(/.*)?/([^/]+)$");

    private Template() {
        // static methods only
    }

    /**
     * Gets the resource type for a given template path.
     * This i based on the assumption that:
     * Given a template path is /apps/{app_path}/tempaltes/{optinal_path}/{template_path}
     * then the resource path is at /apps/{app_path}/components/{optinal_path}/page/{template_path}
     * @param templatePath Template path
     * @return Resource type path or null if template path did not match expectations
     */
    public static String getResourceTypeFromTemplatePath(String templatePath) {
        if (templatePath == null) {
            return null;
        }
        String resource = null;
        Matcher matcher = TEMPLATE_PATH_PATTERN.matcher(templatePath);
        if (matcher.matches()) {
            resource = "/" + matcher.group(1) + "/" + matcher.group(2) + "/components"
                    + StringUtils.defaultString(matcher.group(3)) + "/page/" + matcher.group(4);
        }
        return resource;
    }

    /**
     * Checks if the given page uses a specific template.
     * @param page AEM page
     * @param templates Template(s)
     * @return true if the page uses the template
     */
    public static boolean is(Page page, TemplatePathInfo... templates) {
        if (page == null || templates == null || templates.length == 0) {
            return false;
        }
        String templatePath = page.getProperties().get(NameConstants.PN_TEMPLATE, String.class);
        for (TemplatePathInfo template : templates) {
            if (template.getTemplatePath().equals(templatePath)) {
                return true;
            }
        }
        return false;
    }

    /**
     * Checks if the given page uses a specific template.
     * @param page AEM page
     * @param templatePaths Template path(s)
     * @return true if the page uses the template
     */
    public static boolean is(Page page, String... templatePaths) {
        if (page == null || templatePaths == null || templatePaths.length == 0) {
            return false;
        }
        String templatePath = page.getProperties().get(NameConstants.PN_TEMPLATE, String.class);
        for (String givenTemplatePath : templatePaths) {
            if (StringUtils.equals(templatePath, givenTemplatePath)) {
                return true;
            }
        }
        return false;
    }

    /**
     * Lookup a template by the given template path.
     * @param templatePath Path of template
     * @return The {@link TemplatePathInfo} instance or null for unknown template paths
     */
    public static TemplatePathInfo forTemplatePath(String templatePath, TemplatePathInfo... templates) {
        if (templatePath == null || templates == null || templates.length == 0) {
            return null;
        }
        for (TemplatePathInfo template : templates) {
            if (StringUtils.equals(template.getTemplatePath(), templatePath)) {
                return template;
            }
        }
        return null;
    }

    /**
     * Lookup a template by the given template path.
     * @param templatePath Path of template
     * @return The {@link TemplatePathInfo} instance or null for unknown template paths
     */
    @SafeVarargs
    public static <E extends Enum<E> & TemplatePathInfo> TemplatePathInfo forTemplatePath(String templatePath,
            Class<E>... templateEnums) {
        if (templatePath == null || templateEnums == null) {
            return null;
        }
        for (Class<E> templateEnum : templateEnums) {
            for (E template : EnumSet.allOf(templateEnum)) {
                if (StringUtils.equals(template.getTemplatePath(), templatePath)) {
                    return template;
                }
            }
        }
        return null;
    }

    /**
     * Lookup template for given page.
     * @param page Page
     * @return The {@link TemplatePathInfo} instance or null for unknown template paths
     */
    public static TemplatePathInfo forPage(Page page, TemplatePathInfo... templates) {
        if (page == null || templates == null) {
            return null;
        }
        String templatePath = page.getProperties().get(NameConstants.PN_TEMPLATE, String.class);
        return forTemplatePath(templatePath, templates);
    }

    /**
     * Lookup template for given page.
     * @param page Page
     * @return The {@link TemplatePathInfo} instance or null for unknown template paths
     */
    @SafeVarargs
    public static <E extends Enum<E> & TemplatePathInfo> TemplatePathInfo forPage(Page page,
            Class<E>... templateEnums) {
        if (page == null || templateEnums == null) {
            return null;
        }
        String templatePath = page.getProperties().get(NameConstants.PN_TEMPLATE, String.class);
        return forTemplatePath(templatePath, templateEnums);
    }

}