/**
* Licensed to Apereo under one or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information regarding copyright ownership. Apereo
* 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 the
* following location:
*
* <p>http://www.apache.org/licenses/LICENSE-2.0
*
* <p>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.apereo.portal.rendering;
import java.util.Map;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import javax.xml.namespace.QName;
import javax.xml.stream.XMLEventReader;
import javax.xml.stream.events.StartElement;
import javax.xml.stream.events.XMLEvent;
import org.apereo.portal.layout.IUserLayoutManager;
import org.apereo.portal.portlet.om.IPortletWindow;
import org.apereo.portal.portlet.om.IPortletWindowId;
import org.apereo.portal.portlet.registry.IPortletWindowRegistry;
import org.apereo.portal.portlet.rendering.IPortletExecutionManager;
import org.apereo.portal.utils.Tuple;
import org.apereo.portal.utils.cache.CacheKey;
import org.apereo.portal.xml.stream.FilteringXMLEventReader;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
/**
* Initiates portlet rendering based each encountered {@link IUserLayoutManager#CHANNEL_HEADER} and
* {@link IUserLayoutManager#CHANNEL} element in the event stream
*
*/
public class PortletRenderingInitiationStAXComponent extends StAXPipelineComponentWrapper {
protected final Logger logger = LoggerFactory.getLogger(getClass());
private IPortletExecutionManager portletExecutionManager;
private IPortletWindowRegistry portletWindowRegistry;
@Autowired
public void setPortletExecutionManager(IPortletExecutionManager portletExecutionManager) {
this.portletExecutionManager = portletExecutionManager;
}
@Autowired
public void setPortletWindowRegistry(IPortletWindowRegistry portletWindowRegistry) {
this.portletWindowRegistry = portletWindowRegistry;
}
/* (non-Javadoc)
* @see org.apereo.portal.rendering.PipelineComponent#getCacheKey(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)
*/
@Override
public CacheKey getCacheKey(HttpServletRequest request, HttpServletResponse response) {
//Initiating rendering of portlets will change the stream at all
return this.wrappedComponent.getCacheKey(request, response);
}
/* (non-Javadoc)
* @see org.apereo.portal.rendering.PipelineComponent#getEventReader(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)
*/
@Override
public PipelineEventReader<XMLEventReader, XMLEvent> getEventReader(
HttpServletRequest request, HttpServletResponse response) {
final PipelineEventReader<XMLEventReader, XMLEvent> pipelineEventReader =
this.wrappedComponent.getEventReader(request, response);
final XMLEventReader eventReader = pipelineEventReader.getEventReader();
final PortletRenderingXMLEventReader filteredEventReader =
new PortletRenderingXMLEventReader(request, response, eventReader);
final Map<String, String> outputProperties = pipelineEventReader.getOutputProperties();
return new PipelineEventReaderImpl<XMLEventReader, XMLEvent>(
filteredEventReader, outputProperties);
}
private class PortletRenderingXMLEventReader extends FilteringXMLEventReader {
private final HttpServletRequest request;
private final HttpServletResponse response;
public PortletRenderingXMLEventReader(
HttpServletRequest request, HttpServletResponse response, XMLEventReader reader) {
super(reader);
this.request = request;
this.response = response;
}
@Override
protected XMLEvent filterEvent(XMLEvent event, boolean peek) {
if (event.isStartElement()) {
final StartElement startElement = event.asStartElement();
final QName name = startElement.getName();
final String localName = name.getLocalPart();
if (IUserLayoutManager.CHANNEL.equals(localName)) {
final Tuple<IPortletWindow, StartElement> portletWindowAndElement =
portletWindowRegistry.getPortletWindow(request, startElement);
if (portletWindowAndElement == null) {
logger.warn("No portlet window found for: " + localName);
return null;
}
final IPortletWindow portletWindow = portletWindowAndElement.first;
final IPortletWindowId portletWindowId = portletWindow.getPortletWindowId();
if (!portletExecutionManager.isPortletRenderRequested(
portletWindowId, this.request, this.response)) {
portletExecutionManager.startPortletRender(
portletWindowId, this.request, this.response);
logger.debug("Initiated portlet markup rendering for: {}", portletWindow);
} else {
logger.debug("Portlet render already requested for: {}", portletWindow);
}
return portletWindowAndElement.second;
}
if (IUserLayoutManager.CHANNEL_HEADER.equals(localName)) {
final Tuple<IPortletWindow, StartElement> portletWindowAndElement =
portletWindowRegistry.getPortletWindow(request, startElement);
if (portletWindowAndElement == null) {
logger.warn("No portlet window found for: " + localName);
return null;
}
final IPortletWindow portletWindow = portletWindowAndElement.first;
final IPortletWindowId portletWindowId = portletWindow.getPortletWindowId();
if (!portletExecutionManager.isPortletRenderHeaderRequested(
portletWindowId, this.request, this.response)) {
portletExecutionManager.startPortletHeaderRender(
portletWindowId, this.request, this.response);
logger.debug("Initiated portlet head rendering for: {}", portletWindow);
} else {
logger.debug(
"Portlet header render already requested for: {}", portletWindow);
}
return portletWindowAndElement.second;
}
}
return event;
}
}
}