To patch the rendering result of a ZK portlet, you can implement
* {@link PageRenderPatch} (and specified it in {@link org.zkoss.zk.ui.sys.Attributes#PORTLET_RENDER_PATCH_CLASS}).
* @author tomyeh
*/
public class DHtmlLayoutPortletFix extends GenericPortlet {
private static final Log log = Log.lookup(DHtmlLayoutPortletFix.class);
/** The parameter or attribute to specify the path of the ZUML page. */
private static final String ATTR_PAGE = "zk_page";
/** The parameter or attribute to specify the path of the richlet. */
private static final String ATTR_RICHLET = "zk_richlet";
/** The default page. */
private String _defpage;
public void init() throws PortletException {
_defpage = getPortletConfig().getInitParameter(ATTR_PAGE);
}
protected void doView(RenderRequest request, RenderResponse response)
throws PortletException, IOException {
//try parameter first and then attribute
boolean bRichlet = false;
String path = request.getParameter(ATTR_PAGE);
if (path == null) {
path = (String)request.getAttribute(ATTR_PAGE);
if (path == null) {
PortletPreferences prefs = request.getPreferences();
path = prefs.getValue(ATTR_PAGE, null);
if (path == null) {
path = request.getParameter(ATTR_RICHLET);
bRichlet = path != null;
if (!bRichlet) {
path = (String)request.getAttribute(ATTR_RICHLET);
bRichlet = path != null;
if (!bRichlet) {
path = prefs.getValue(ATTR_RICHLET, null);
bRichlet = path != null;
if (!bRichlet)
path = _defpage;
}
}
}
}
}
final Session sess = getSession(request);
if (!SessionsCtrl.requestEnter(sess)) {
handleError(sess, request, response, path, null,
Messages.get(MZk.TOO_MANY_REQUESTS));
return;
}
SessionsCtrl.setCurrent(sess);
try {
if (!process(sess, request, response, path, bRichlet))
handleError(sess, request, response, path, null, null);
} catch (Throwable ex) {
handleError(sess, request, response, path, ex, null);
} finally {
SessionsCtrl.requestExit(sess);
SessionsCtrl.setCurrent((Session)null);
}
}
/** Returns the session. */
private Session getSession(RenderRequest request)
throws PortletException {
final WebApp wapp = getWebManager().getWebApp();
final PortletSession psess = request.getPortletSession();
final Session sess = SessionsCtrl.getSession(wapp, psess);
return sess != null ? sess:
SessionsCtrl.newSession(wapp, psess, request);
}
/** Process a portlet request.
* @return false if the page is not found.
* @since 3.0.0
*/
protected boolean process(Session sess, RenderRequest request,
RenderResponse response, String path, boolean bRichlet)
throws PortletException, IOException {
// Class org.zkoss.lang.D is missing in ZK 6.0.1 release build
//if (D.ON && log.debugable()) log.debug("Creates from "+path);
final WebManager webman = getWebManager();
final WebApp wapp = webman.getWebApp();
final WebAppCtrl wappc = (WebAppCtrl)wapp;
final HttpServletRequest httpreq = new RenderHttpServletRequestFix(RenderHttpServletRequest.getInstance(request));
final HttpServletResponse httpres = RenderHttpServletResponse.getInstance(response);
final ServletContext svlctx = (ServletContext)wapp.getNativeContext();
final DesktopRecycle dtrc = wapp.getConfiguration().getDesktopRecycle();
Desktop desktop = dtrc != null ?
DesktopRecycles.beforeService(dtrc, svlctx, sess, httpreq, httpres, path): null;
try {
if (desktop != null) { //recycle
final Page page = Utils.getMainPage(desktop);
if (page != null) {
final Execution exec =
new ExecutionImpl(svlctx, httpreq, httpres, desktop, page);
fixContentType(response);
wappc.getUiEngine()
.recycleDesktop(exec, page, response.getWriter());
} else
desktop = null; //something wrong (not possible; just in case)
}
if (desktop == null) {
desktop = webman.getDesktop(sess, httpreq, httpres, path, true);
if (desktop == null) //forward or redirect
return true;
final RequestInfo ri = new RequestInfoImpl(
wapp, sess, desktop, httpreq,
PageDefinitions.getLocator(wapp, path));
((SessionCtrl)sess).notifyClientRequest(true);
final Page page;
final PageRenderPatch patch = getRenderPatch();
final Writer out = patch.beforeRender(ri);
final UiFactory uf = wappc.getUiFactory();
if (uf.isRichlet(ri, bRichlet)) {
final Richlet richlet = uf.getRichlet(ri, path);
if (richlet == null)
return false; //not found
page = WebManager.newPage(uf, ri, richlet, httpres, path);
final Execution exec =
new ExecutionImpl(svlctx, httpreq, httpres, desktop, page);
fixContentType(response);
wappc.getUiEngine().execNewPage(exec, richlet, page,
out != null ? out: response.getWriter());
} else if (path != null) {
final PageDefinition pagedef = uf.getPageDefinition(ri, path);
if (pagedef == null)
return false; //not found
page = WebManager.newPage(uf, ri, pagedef, httpres, path);
final Execution exec =
new ExecutionImpl(svlctx, httpreq, httpres, desktop, page);
fixContentType(response);
wappc.getUiEngine().execNewPage(exec, pagedef, page,
out != null ? out: response.getWriter());
} else
return true; //nothing to do
if (out != null)
patch.patchRender(ri, page, out, response.getWriter());
}
} finally {
if (dtrc != null)
DesktopRecycles.afterService(dtrc, desktop);
}
return true; //success
}
private static PageRenderPatch getRenderPatch() {
if (_prpatch != null)
return _prpatch;
synchronized (DHtmlLayoutPortletFix.class) {
if (_prpatch != null)
return _prpatch;
final PageRenderPatch patch;
final String clsnm = Library.getProperty(
org.zkoss.zk.ui.sys.Attributes.PORTLET_RENDER_PATCH_CLASS);
if (clsnm == null) {
patch = new PageRenderPatch() {
public Writer beforeRender(RequestInfo reqInfo) {
return null;
}
public void patchRender(RequestInfo reqInfo, Page page, Writer result, Writer out)
throws IOException {
}
};
} else {
try {
patch = (PageRenderPatch)Classes.newInstanceByThread(clsnm);
} catch (ClassCastException ex) {
throw new UiException(clsnm+" must implement "+PageRenderPatch.class.getName());
} catch (Throwable ex) {
throw UiException.Aide.wrap(ex, "Unable to instantiate");
}
}
return _prpatch = patch;
}
}
private static PageRenderPatch _prpatch;
private static void fixContentType(RenderResponse response) {
//Bug 1548478: content-type is required for some implementation (JBoss Portal)
if (response.getContentType() == null)
response.setContentType("text/html;charset=UTF-8");
}
/** Returns the layout servlet.
*/
private final WebManager getWebManager()
throws PortletException {
final WebManager webman =
(WebManager)getPortletContext().getAttribute(WebManager.ATTR_WEB_MANAGER);
if (webman == null)
throw new PortletException("The Layout Servlet not found. Make sure