/* * JBoss, Home of Professional Open Source * Copyright 2013, Red Hat, Inc. and individual contributors * by the @authors tag. See the copyright.txt in the distribution for a * full listing of individual contributors. * * This is free software; you can redistribute it and/or modify it * under the terms of the GNU Lesser General Public License as * published by the Free Software Foundation; either version 2.1 of * the License, or (at your option) any later version. * * This software is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * Lesser General Public License for more details. * * You should have received a copy of the GNU Lesser General Public * License along with this software; if not, write to the Free * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA * 02110-1301 USA, or see the FSF site: http://www.fsf.org. */ package org.richfaces.resource.mapping; import javax.faces.application.ProjectStage; import javax.faces.context.FacesContext; import org.richfaces.application.configuration.ConfigurationServiceHelper; import org.richfaces.application.CoreConfiguration; /** * <p> * Determines whenever RichFaces resources should be loaded optimized and how should be optimized. * </p> * * @author <a href="http://community.jboss.org/people/lfryc">Lukas Fryc</a> */ enum ResourceLoadingOptimizationConfiguration { /** * Packaging of selected static resources of certain types (CSS/JS) */ Packed(CoreConfiguration.Items.resourceOptimizationPackagingStages), /** * Compression of static resources which is supported (CSS/JS) */ Compressed(CoreConfiguration.Items.resourceOptimizationCompressionStages); private static final String STATIC_RESOURCES_FEATURE_NAME = "Static"; private static final String FEATURES_PLACEHOLDER = "%Features%"; private static final String DEFAULT_FEATURE_MAPPING_FILE = "META-INF/richfaces/optimizedResourcesMapping/%Features%.properties"; private CoreConfiguration.Items associatedConfiguration; private ResourceLoadingOptimizationConfiguration(CoreConfiguration.Items associatedConfiguration) { this.associatedConfiguration = associatedConfiguration; } static String getResourceLoadingSpecificMappingFile() { return format(DEFAULT_FEATURE_MAPPING_FILE, getEnabledFeatures()); } /** * Returns true if resource loading optimization feature is enabled in configuration. * * @return true if resource loading optimization feature is enabled in configuration; false otherwise */ static boolean isEnabled() { return ConfigurationServiceHelper.getBooleanConfigurationValue(FacesContext.getCurrentInstance(), CoreConfiguration.Items.resourceOptimizationEnabled); } /** * <p> * Determines if the feature is enabled in current project stage. * </p> * * <p> * Can be configured with either any {@link ProjectStage} items separated by comma, or with keyword 'All' or 'None' * representing all application stages or no stage respectively. * </p> * * @return true if the feature is enabled in current stage; false otherwise */ private boolean enabled() { String configuredPhases = PropertiesMappingConfiguration.getConfiguration(associatedConfiguration); if (configuredPhases == null) { return false; } ProjectStage projectStage = FacesContext.getCurrentInstance().getApplication().getProjectStage(); return "All".equals(configuredPhases) || configuredPhases.matches("(^|.*,)" + projectStage.toString() + "($|,.*)"); } /** * <p> * Constructs infix composed from items of enumeration of features which are turned on in current {@link ProjectStage}. * </p> * * <p> * If no feature is enabled, infix "Static" is returned. * </p> * * <p> * Items are composed in order in which are specified in {@link ResourceMappingConfiguration} enumeration. * </p> * * @return infix composed from items of enumeration of features which are turned on in current {@link ProjectStage}; * "Static" is returned when no other feature enabled */ private static String getEnabledFeatures() { StringBuffer affix = new StringBuffer(); for (ResourceLoadingOptimizationConfiguration feature : ResourceLoadingOptimizationConfiguration.values()) { if (feature.enabled()) { affix.append(feature.toString()); } } if (affix.length() == 0) { return STATIC_RESOURCES_FEATURE_NAME; } return affix.toString(); } private static String format(String string, String message) { return string.replace(FEATURES_PLACEHOLDER, message); } }