/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright 1997-2008 Sun Microsystems, Inc. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can obtain
* a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
* or glassfish/bootstrap/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
* Sun designates this particular file as subject to the "Classpath" exception
* as provided by Sun in the GPL Version 2 section of the License file that
* accompanied this code. If applicable, add the following below the License
* Header, with the fields enclosed by brackets [] replaced by your own
* identifying information: "Portions Copyrighted [year]
* [name of copyright owner]"
*
* Contributor(s):
*
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*
* This file incorporates work covered by the following copyright and
* permission notice:
*
* 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.sun.faces.facelets.impl;
import com.sun.faces.facelets.Facelet;
import com.sun.faces.facelets.FaceletFactory;
import com.sun.faces.facelets.compiler.Compiler;
import com.sun.faces.util.Cache;
import com.sun.faces.util.FacesLogger;
import com.sun.faces.util.Util;
import javax.el.ELException;
import javax.faces.FacesException;
import javax.faces.view.facelets.FaceletException;
import javax.faces.view.facelets.FaceletHandler;
import javax.faces.view.facelets.ResourceResolver;
import java.io.FileNotFoundException;
import java.io.IOException;
import java.io.InputStream;
import java.net.URL;
import java.net.URLConnection;
import java.util.HashMap;
import java.util.Map;
import java.util.logging.Level;
import java.util.logging.Logger;
import java.util.regex.Pattern;
/**
* Default FaceletFactory implementation.
*
* @author Jacob Hookom
* @version $Id: DefaultFaceletFactory.java,v 1.10 2007/04/09 01:13:17 youngm
* Exp $
*/
public class DefaultFaceletFactory extends FaceletFactory {
protected final static Logger log = FacesLogger.FACELETS_FACTORY.getLogger();
private final Compiler compiler;
private Map<String, DefaultFacelet> facelets;
private Map<String, DefaultFacelet> metadataFacelets;
private Map<String, URL> relativeLocations;
private final ResourceResolver resolver;
private final URL baseUrl;
private final long refreshPeriod;
Cache<String,IdMapper> idMappers;
// ------------------------------------------------------------ Constructors
public DefaultFaceletFactory(Compiler compiler, ResourceResolver resolver)
throws IOException {
this(compiler, resolver, -1);
}
public DefaultFaceletFactory(Compiler compiler,
ResourceResolver resolver,
long refreshPeriod) {
Util.notNull("compiler", compiler);
Util.notNull("resolver", resolver);
this.compiler = compiler;
this.facelets = new HashMap<String, DefaultFacelet>();
this.metadataFacelets = new HashMap<String, DefaultFacelet>();
this.relativeLocations = new HashMap<String, URL>();
this.resolver = resolver;
this.baseUrl = resolver.resolveUrl("/");
this.idMappers = new Cache<String,IdMapper>(new IdMapperFactory());
// this.location = url;
this.refreshPeriod = (refreshPeriod >= 0) ? refreshPeriod * 1000 : -1;
if (log.isLoggable(Level.FINE)) {
log.fine("Using ResourceResolver: " + resolver);
log.fine("Using Refresh Period: " + this.refreshPeriod);
}
}
/*
* (non-Javadoc)
*
* @see com.sun.facelets.FaceletFactory#getResourceResolver
*/
public ResourceResolver getResourceResolver() {
return resolver;
}
/*
* (non-Javadoc)
*
* @see com.sun.facelets.FaceletFactory#getFacelet(java.lang.String)
*/
public Facelet getFacelet(String uri) throws IOException {
return this.getFacelet(resolveURL(uri));
}
public Facelet getMetadataFacelet(String uri) throws IOException {
return this.getMetadataFacelet(resolveURL(uri));
}
/**
* Resolves a path based on the passed URL. If the path starts with '/', then
* resolve the path against {@link javax.faces.context.ExternalContext#getResource(java.lang.String)
* javax.faces.context.ExternalContext#getResource(java.lang.String)}.
* Otherwise create a new URL via {@link URL#URL(java.net.URL,
* java.lang.String) URL(URL, String)}.
*
* @param source base to resolve from
* @param path relative path to the source
*
* @return resolved URL
*
* @throws IOException
*/
public URL resolveURL(URL source, String path) throws IOException {
if (path.startsWith("/")) {
URL url = this.resolver.resolveUrl(path);
if (url == null) {
throw new FileNotFoundException(path
+ " Not Found in ExternalContext as a Resource");
}
return url;
} else {
return new URL(source, path);
}
}
/**
* Create a Facelet from the passed URL. This method checks if the cached
* Facelet needs to be refreshed before returning. If so, uses the passed URL
* to build a new instance;
*
* @param url source url
*
* @return Facelet instance
*
* @throws IOException
* @throws FaceletException
* @throws FacesException
* @throws ELException
*/
public Facelet getFacelet(URL url) throws IOException {
Util.notNull("url", url);
String key = url.toString();
DefaultFacelet f = this.facelets.get(key);
if (f == null || this.needsToBeRefreshed(f)) {
f = this.createFacelet(url);
if (this.refreshPeriod != 0) {
Map<String, DefaultFacelet> newLoc = new HashMap<String, DefaultFacelet>(this.facelets);
newLoc.put(key, f);
this.facelets = newLoc;
}
}
return f;
}
public Facelet getMetadataFacelet(URL url) throws IOException {
Util.notNull("url", url);
String key = url.toString();
DefaultFacelet f = this.metadataFacelets.get(key);
if (f == null || this.needsToBeRefreshed(f)) {
f = this.createMetadataFacelet(url);
if (this.refreshPeriod != 0) {
Map<String, DefaultFacelet> newLoc = new HashMap<String, DefaultFacelet>(this.metadataFacelets);
newLoc.put(key, f);
this.metadataFacelets = newLoc;
}
}
return f;
}
public boolean needsToBeRefreshed(URL url) {
boolean result = false;
Util.notNull("url", url);
String key = url.toString();
DefaultFacelet f = this.facelets.get(key);
result = (f == null || this.needsToBeRefreshed(f));
return result;
}
/**
* Template method for determining if the Facelet needs to be refreshed.
*
* @param facelet Facelet that could have expired
*
* @return true if it needs to be refreshed
*/
protected boolean needsToBeRefreshed(DefaultFacelet facelet) {
// if set to 0, constantly reload-- nocache
if (this.refreshPeriod == 0) {
return true;
}
// if set to -1, never reload
if (this.refreshPeriod == -1) {
return false;
}
long ttl = facelet.getCreateTime() + this.refreshPeriod;
URL url = facelet.getSource();
InputStream is = null;
if (System.currentTimeMillis() > ttl) {
try {
URLConnection conn = url.openConnection();
is = conn.getInputStream();
long atl = conn.getLastModified();
return atl > ttl;
} catch (Exception e) {
throw new FaceletException("Error Checking Last Modified for "
+ facelet.getAlias(), e);
} finally {
if (is != null) {
try {
is.close();
} catch (Exception e) {
// do nothing
}
}
}
}
return false;
}
private URL resolveURL(String uri) throws IOException {
URL url = this.relativeLocations.get(uri);
if (url == null) {
url = this.resolveURL(this.baseUrl, uri);
if (url != null) {
Map<String, URL> newLoc = new HashMap<String, URL>(this.relativeLocations);
newLoc.put(uri, url);
this.relativeLocations = newLoc;
} else {
throw new IOException("'" + uri + "' not found.");
}
}
return url;
}
/**
* Uses the internal Compiler reference to build a Facelet given the passed
* URL.
*
* @param url source
*
* @return a Facelet instance
*
* @throws IOException
* @throws FaceletException
* @throws FacesException
* @throws ELException
*/
private DefaultFacelet createFacelet(URL url) throws IOException {
if (log.isLoggable(Level.FINE)) {
log.fine("Creating Facelet for: " + url);
}
String escapedBaseURL = Pattern.quote(this.baseUrl.getFile());
String alias = '/' + url.getFile().replaceFirst(escapedBaseURL, "");
try {
FaceletHandler h = this.compiler.compile(url, alias);
return new DefaultFacelet(this,
this.compiler.createExpressionFactory(),
url,
alias,
h);
} catch (FileNotFoundException fnfe) {
throw new FileNotFoundException("Facelet "
+ alias
+ " not found at: "
+ url.toExternalForm());
}
}
private DefaultFacelet createMetadataFacelet(URL url) throws IOException {
if (log.isLoggable(Level.FINE)) {
log.fine("Creating Metadata Facelet for: " + url);
}
String escapedBaseURL = Pattern.quote(this.baseUrl.getFile());
String alias = '/' + url.getFile().replaceFirst(escapedBaseURL, "");
try {
FaceletHandler h = this.compiler.metadataCompile(url, alias);
return new DefaultFacelet(this,
this.compiler.createExpressionFactory(),
url,
alias,
h);
} catch (FileNotFoundException fnfe) {
throw new FileNotFoundException("Facelet "
+ alias
+ " not found at: "
+ url.toExternalForm());
}
}
public long getRefreshPeriod() {
return refreshPeriod;
}
// ---------------------------------------------------------- Nested Classes
private static final class IdMapperFactory implements Cache.Factory<String,IdMapper> {
// ------------------------------------------ Methods from Cache.Factory
public IdMapper newInstance(String arg) throws InterruptedException {
return new IdMapper();
}
}
}