/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you 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.apache.myfaces.extensions.cdi.jsf.impl.config.view;
import static org.apache.myfaces.extensions.cdi.core.impl.util.CodiUtils.getContextualReferenceByName;
import org.apache.myfaces.extensions.cdi.core.api.InvocationOrder;
import org.apache.myfaces.extensions.cdi.core.api.scope.conversation.WindowContext;
import org.apache.myfaces.extensions.cdi.core.api.Advanced;
import org.apache.myfaces.extensions.cdi.core.api.UnhandledException;
import static org.apache.myfaces.extensions.cdi.jsf.impl.util.ExceptionUtils.invalidPhasesCallbackMethod;
import org.apache.myfaces.extensions.cdi.jsf.api.listener.phase.JsfPhaseListener;
import org.apache.myfaces.extensions.cdi.jsf.api.config.view.PageBeanDescriptor;
import org.apache.myfaces.extensions.cdi.jsf.impl.config.view.spi.EditableViewConfigDescriptor;
import org.apache.myfaces.extensions.cdi.jsf.impl.config.view.spi.LifecycleAwarePageBeanDescriptor;
import org.apache.myfaces.extensions.cdi.jsf.impl.config.view.spi.RequestLifecycleCallbackEntry;
import org.apache.myfaces.extensions.cdi.jsf.api.config.view.ViewConfigDescriptor;
import org.apache.myfaces.extensions.cdi.jsf.impl.scope.conversation.WindowContextManagerObserver;
import javax.faces.event.PhaseEvent;
import javax.faces.event.PhaseListener;
import javax.faces.event.PhaseId;
import javax.faces.component.UIViewRoot;
import javax.faces.context.FacesContext;
import javax.inject.Inject;
import javax.enterprise.inject.spi.BeanManager;
import java.util.List;
import java.lang.reflect.Method;
import java.lang.reflect.InvocationTargetException;
/**
* PhaseListener which calls the view-controller callbacks
*/
//This class is no cdi-bean, there will be a #veto during the bootstrapping process
@Advanced
@JsfPhaseListener
@InvocationOrder(2000)
@SuppressWarnings({"UnusedDeclaration"})
public final class PhasesLifecycleCallbackPhaseListener implements PhaseListener
{
private static final long serialVersionUID = 6893021853444122202L;
private static final String INITIALIZED_VIEW_ID_MARKER_KEY = PhasesLifecycleCallbackPhaseListener.class.getName();
@Inject
private WindowContext windowContext;
//all implementations will be serializable
@Inject
private BeanManager beanManager;
/**
* {@inheritDoc}
*/
public void afterPhase(PhaseEvent event)
{
processInitView(event);
processPostRenderView(event);
processPhaseCallbacks(event, false);
}
/**
* {@inheritDoc}
*/
public void beforePhase(PhaseEvent event)
{
processInitView(event);
processPreRenderView(event);
processPhaseCallbacks(event, true);
}
private void processInitView(PhaseEvent event)
{
if(event.getPhaseId().equals(PhaseId.RESTORE_VIEW) && !isRedirectRequest(event.getFacesContext()))
{
return;
}
//TODO check if we have to restrict the other callbacks as well
//leads to a call of @BeforePhase but not the corresponding @AfterPhase call of the corresponding callbacks
//don't call the callbacks in case of an initial redirct
if(Boolean.TRUE.equals(event.getFacesContext().getExternalContext().getRequestMap()
.get(WindowContextManagerObserver.INITIAL_REDIRCT_PERFORMED_KEY)))
{
return;
}
if (isValidView(event.getFacesContext()))
{
processInitView(event.getFacesContext().getViewRoot().getViewId());
}
}
private void processInitView(String viewId)
{
//view already initialized in this or any prev. request
if(viewId.equals(this.windowContext.getAttribute(INITIALIZED_VIEW_ID_MARKER_KEY, String.class)))
{
return;
}
//override the view-id if we have a new view
this.windowContext.setAttribute(INITIALIZED_VIEW_ID_MARKER_KEY, viewId);
ViewConfigDescriptor viewDefinitionEntry = ViewConfigCache.getViewConfigDescriptor(viewId);
if (viewDefinitionEntry instanceof EditableViewConfigDescriptor)
{
((EditableViewConfigDescriptor)viewDefinitionEntry).invokeInitViewMethods();
}
}
private void processPreRenderView(PhaseEvent event)
{
UIViewRoot uiViewRoot = event.getFacesContext().getViewRoot();
if (event.getPhaseId().equals(PhaseId.RENDER_RESPONSE) && uiViewRoot != null)
{
processPreRenderView(uiViewRoot.getViewId());
}
}
private void processPostRenderView(PhaseEvent event)
{
UIViewRoot uiViewRoot = event.getFacesContext().getViewRoot();
if (event.getPhaseId().equals(PhaseId.RENDER_RESPONSE) && uiViewRoot != null)
{
processPostRenderView(uiViewRoot.getViewId());
}
}
private void processPreRenderView(String viewId)
{
ViewConfigDescriptor viewDefinitionEntry = ViewConfigCache.getViewConfigDescriptor(viewId);
if (viewDefinitionEntry instanceof EditableViewConfigDescriptor)
{
((EditableViewConfigDescriptor)viewDefinitionEntry).invokePreRenderViewMethods();
}
}
private void processPostRenderView(String viewId)
{
ViewConfigDescriptor viewDefinitionEntry = ViewConfigCache.getViewConfigDescriptor(viewId);
if (viewDefinitionEntry instanceof EditableViewConfigDescriptor)
{
((EditableViewConfigDescriptor)viewDefinitionEntry).invokePostRenderViewMethods();
}
}
/**
* {@inheritDoc}
*/
public javax.faces.event.PhaseId getPhaseId()
{
return javax.faces.event.PhaseId.ANY_PHASE;
}
private void processPhaseCallbacks(PhaseEvent phaseEvent, boolean beforePhase)
{
UIViewRoot viewRoot = phaseEvent.getFacesContext().getViewRoot();
if(viewRoot == null)
{
return;
}
String viewId = viewRoot.getViewId();
ViewConfigDescriptor viewDefinitionEntry = ViewConfigCache.getViewConfigDescriptor(viewId);
if(viewDefinitionEntry == null)
{
return;
}
List<PageBeanDescriptor> beanEntries = viewDefinitionEntry.getPageBeanDescriptors();
Object bean;
RequestLifecycleCallbackEntry phasesLifecycleCallbackEntry;
List<Method> lifecycleCallbacks;
for(PageBeanDescriptor beanEntry : beanEntries)
{
if(!(beanEntry instanceof LifecycleAwarePageBeanDescriptor))
{
continue;
}
phasesLifecycleCallbackEntry = ((LifecycleAwarePageBeanDescriptor)beanEntry)
.getPhasesLifecycleCallback(phaseEvent.getPhaseId());
if(phasesLifecycleCallbackEntry == null)
{
continue;
}
if(beforePhase)
{
lifecycleCallbacks = phasesLifecycleCallbackEntry.getBeforePhaseCallbacks();
}
else
{
lifecycleCallbacks = phasesLifecycleCallbackEntry.getAfterPhaseCallbacks();
}
if(lifecycleCallbacks.isEmpty())
{
continue;
}
//TODO provide a detailed error message in case of a missing bean
bean = getContextualReferenceByName(this.beanManager, beanEntry.getBeanName(), Object.class);
invokePhasesLifecycleCallbacks(bean, lifecycleCallbacks, phaseEvent);
}
}
private void invokePhasesLifecycleCallbacks(Object bean, List<Method> lifecycleCallbacks, PhaseEvent phaseEvent)
{
try
{
Class<?>[] parameterTypes;
for(Method currentMethod : lifecycleCallbacks)
{
currentMethod.setAccessible(true);
parameterTypes = currentMethod.getParameterTypes();
if(parameterTypes.length == 0)
{
currentMethod.invoke(bean);
}
else if(parameterTypes.length == 1 && PhaseEvent.class.isAssignableFrom(parameterTypes[0]))
{
currentMethod.invoke(bean, phaseEvent);
}
else
{
throw invalidPhasesCallbackMethod(bean.getClass(), currentMethod);
}
}
}
catch (IllegalAccessException e)
{
throw new UnhandledException(e);
}
catch (InvocationTargetException e)
{
throw new UnhandledException(e);
}
}
private boolean isValidView(FacesContext facesContext)
{
return facesContext.getViewRoot() != null && facesContext.getViewRoot().getViewId() != null;
}
private boolean isRedirectRequest(FacesContext facesContext)
{
return facesContext.getResponseComplete();
}
}