/*
* Copyright 2010 Lincoln Baxter, III
*
* 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 org.ocpsoft.rewrite.faces;
import java.io.IOException;
import java.util.Collections;
import java.util.List;
import java.util.Locale;
import java.util.Map;
import javax.faces.FacesException;
import javax.faces.application.ViewHandler;
import javax.faces.component.UIViewRoot;
import javax.faces.context.FacesContext;
import javax.faces.view.ViewDeclarationLanguage;
import javax.servlet.http.HttpServletRequest;
import org.ocpsoft.common.pattern.WeightedComparator;
import org.ocpsoft.common.services.ServiceLoader;
import org.ocpsoft.common.util.Iterators;
import org.ocpsoft.rewrite.faces.spi.FacesActionUrlProvider;
import org.ocpsoft.rewrite.servlet.util.URLBuilder;
/**
* @author Lincoln Baxter, III <lincoln@ocpsoft.com>
*/
public class RewriteViewHandler extends ViewHandler
{
protected ViewHandler parent;
private final ThreadLocal<Boolean> bookmarkable = new ThreadLocal<Boolean>();
private List<FacesActionUrlProvider> providers;
/**
* <b>NOTE:</b> This method should only be used by the getBookmarkableURL and getActionURL methods, for the purposes
* of rewriting form URLs (which do not include viewParameters.)
*
* @return Bookmarkable state - defaults to false if not previously set;
*/
private boolean isBookmarkable()
{
Boolean result = bookmarkable.get();
if (result == null)
{
result = false;
bookmarkable.set(result);
}
return result;
}
@Override
public String deriveLogicalViewId(final FacesContext context, final String rawViewId)
{
return parent.deriveLogicalViewId(context, rawViewId);
}
private void setBookmarkable(final boolean value)
{
bookmarkable.set(value);
}
public RewriteViewHandler(final ViewHandler viewHandler)
{
super();
parent = viewHandler;
}
@Override
public Locale calculateLocale(final FacesContext facesContext)
{
return parent.calculateLocale(facesContext);
}
@Override
public String calculateRenderKitId(final FacesContext facesContext)
{
return parent.calculateRenderKitId(facesContext);
}
@Override
public UIViewRoot createView(final FacesContext context, final String viewId)
{
UIViewRoot view = parent.createView(context, viewId);
return view;
}
@Override
public UIViewRoot restoreView(final FacesContext context, final String viewId)
{
UIViewRoot view = parent.restoreView(context, viewId);
return view;
}
@Override
public String getActionURL(final FacesContext context, final String viewId)
{
/*
* When this method is called for forms, getBookmarkableURL is NOT called; therefore, we have a way to distinguish
* the two.
*/
HttpServletRequest request = (HttpServletRequest) context.getExternalContext().getRequest();
String result = null;
if (!isBookmarkable() && !RewriteNavigationHandler.isInNavigation(request)
&& (viewId != null)
&& viewId.equals(context.getViewRoot().getViewId()))
{
/*
* When rendering a form URL, Faces only provides the bare view-id, sans any bookmarkable parameters from the request.
* We need to restore those ourselves.
*/
for (FacesActionUrlProvider provider : getProviders()) {
result = provider.getActionURL(context, viewId);
if (result != null)
break;
}
if (result != null)
{
String parentActionURL = parent.getActionURL(context, viewId);
if (parentActionURL.contains("?"))
{
URLBuilder builder = URLBuilder.createFrom(result);
builder.getQueryStringBuilder().addParameters(parentActionURL);
result = builder.toURL();
}
}
}
if (result == null)
result = parent.getActionURL(context, viewId);
return result;
}
@SuppressWarnings("unchecked")
public List<FacesActionUrlProvider> getProviders()
{
if (providers == null)
{
providers = Iterators.asList(ServiceLoader.load(FacesActionUrlProvider.class));
Collections.sort(providers, new WeightedComparator());
}
return providers;
}
@Override
public String getBookmarkableURL(final FacesContext context, final String viewId,
final Map<String, List<String>> parameters, final boolean includeViewParams)
{
/*
* When this method is called for <h:link> tags, getActionURL is called as part of the parent call
*/
setBookmarkable(true);
String result = parent.getBookmarkableURL(context, viewId, parameters, includeViewParams);
setBookmarkable(false);
return result;
}
@Override
public String getRedirectURL(final FacesContext context, final String viewId,
final Map<String, List<String>> parameters, final boolean includeViewParams)
{
return parent.getRedirectURL(context, viewId, parameters, includeViewParams);
}
@Override
public String getResourceURL(final FacesContext facesContext, final String path)
{
return parent.getResourceURL(facesContext, path);
}
@Override
public void renderView(final FacesContext facesContext, final UIViewRoot viewRoot) throws IOException,
FacesException
{
parent.renderView(facesContext, viewRoot);
}
@Override
public void writeState(final FacesContext facesContext) throws IOException
{
parent.writeState(facesContext);
}
/**
* Canonicalize the given viewId, then pass that viewId to the next ViewHandler in the chain.
*/
@Override
public String deriveViewId(final FacesContext context, final String rawViewId)
{
String canonicalViewId = new URLDuplicatePathCanonicalizer().canonicalize(rawViewId);
return parent.deriveViewId(context, canonicalViewId);
}
@Override
public String calculateCharacterEncoding(final FacesContext context)
{
return parent.calculateCharacterEncoding(context);
}
@Override
public ViewDeclarationLanguage getViewDeclarationLanguage(final FacesContext context, final String viewId)
{
return parent.getViewDeclarationLanguage(context, viewId);
}
@Override
public void initView(final FacesContext context) throws FacesException
{
parent.initView(context);
}
}