org.broadleafcommerce.common.web.resource.resolver.BundleResourceResolver.java Source code

Introduction

Here is the source code for org.broadleafcommerce.common.web.resource.resolver.BundleResourceResolver.java

Source

/*
 * #%L
 * broadleaf-theme
 * %%
 * Copyright (C) 2009 - 2015 Broadleaf Commerce
 * %%
 * 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 org.broadleafcommerce.common.web.resource.resolver;

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.broadleafcommerce.common.resource.service.ResourceBundlingService;
import org.springframework.core.Ordered;
import org.springframework.core.io.Resource;
import org.springframework.stereotype.Component;
import org.springframework.web.servlet.resource.AbstractResourceResolver;
import org.springframework.web.servlet.resource.ResourceResolverChain;

import java.io.IOException;
import java.util.List;

import javax.servlet.http.HttpServletRequest;

/**
 * A {@code ResourceResolver} that is used to serve previously bundled files.
 * 
 * <p>
 * It works with {@link ResourceBundlingService} which is able to create and read bundle files.
 *  
 * @author Brian Polster
 * @since Broadleaf 4.0
 */
@Component("blBundleResourceResolver")
public class BundleResourceResolver extends AbstractResourceResolver implements Ordered {

    protected static final Log LOG = LogFactory.getLog(BundleResourceResolver.class);

    private int order = BroadleafResourceResolverOrder.BLC_BUNDLE_RESOURCE_RESOLVER;

    @javax.annotation.Resource(name = "blResourceBundlingService")
    protected ResourceBundlingService bundlingService;

    @Override
    protected Resource resolveResourceInternal(HttpServletRequest request, String requestPath,
            List<? extends Resource> locations, ResourceResolverChain chain) {

        if (requestPath != null) {
            if (isBundleFile(requestPath)) {
                Resource bundle = bundlingService.resolveBundleResource(requestPath);

                logTraceInformation(bundle);
                if (bundle != null && bundle.exists()) {
                    return bundle;
                }
            }
        }

        return chain.resolveResource(request, requestPath, locations);
    }

    protected void logTraceInformation(Resource bundle) {
        if (LOG.isTraceEnabled()) {
            if (bundle == null) {
                LOG.trace("Resolving bundle, bundle is null");
            } else {
                LOG.trace("Resolving bundle, bundle is not null, bundle.exists() == " + bundle.exists()
                        + " ,filename = " + bundle.getFilename());
                try {
                    LOG.trace("Resolving bundle - File Path" + bundle.getFile().getAbsolutePath());
                } catch (IOException e) {
                    LOG.error("IOException debugging bundle code", e);
                }
            }
        }
    }

    @Override
    protected String resolveUrlPathInternal(String resourceUrlPath, List<? extends Resource> locations,
            ResourceResolverChain chain) {
        if (resourceUrlPath != null) {
            if (isBundleFile(resourceUrlPath)) {
                return resourceUrlPath;
            }
        }

        return chain.resolveUrlPath(resourceUrlPath, locations);

    }

    protected boolean isBundleFile(String requestPath) {
        boolean isBundle = bundlingService.checkForRegisteredBundleFile(requestPath);
        if (logger.isTraceEnabled()) {
            logger.trace(
                    "Checking isBundleFile, requestPath=\"" + requestPath + "\" isBundle=\"" + isBundle + "\"");
        }
        return isBundle;
    }

    @Override
    public int getOrder() {
        return order;
    }

    public void setOrder(int order) {
        this.order = order;
    }
}