ComponentLayoutHandler.java

package org.toobs.framework.pres.spring.controller;

import java.io.PrintWriter;
import java.util.Date;
import java.util.HashMap;
import java.util.Map;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.springframework.web.servlet.ModelAndView;
import org.springframework.web.util.UrlPathHelper;
import org.toobs.framework.doitref.IDoItRefQueue;
import org.toobs.framework.exception.PermissionException;
import org.toobs.framework.pres.component.ComponentException;
import org.toobs.framework.pres.component.ComponentNotFoundException;
import org.toobs.framework.pres.component.IComponentLayoutManager;
import org.toobs.framework.pres.component.RuntimeLayout;
import org.toobs.framework.pres.component.config.Parameter;
import org.toobs.framework.pres.sec.IComponentSecurity;
import org.toobs.framework.pres.util.ComponentRequestManager;
import org.toobs.framework.pres.util.ParameterUtil;
import org.toobs.framework.pres.util.PresConstants;
import org.toobs.framework.util.Configuration;


@SuppressWarnings("unchecked")
public class ComponentLayoutHandler implements IComponentLayoutHandler {

  private static Log log = LogFactory.getLog(ComponentLayoutHandler.class);
  
  private UrlPathHelper urlPathHelper = new UrlPathHelper();
  
  private IComponentLayoutManager componentLayoutManager = null;
  private ComponentRequestManager componentRequestManager = null;
  private IDoItRefQueue doItRefQueue = null;
  private IComponentSecurity layoutSecurity;
  
  /**
   * 
   * Retrieves the URL path to use for lookup and delegates to
   * <code>getViewNameForUrlPath</code>.
   * 
   * @throws Exception Exception fetching or rendering component.
   * @see #getViewNameForUrlPath
   * 
   */
  public ModelAndView handleRequestInternal(HttpServletRequest request, HttpServletResponse response) throws Exception {

    String output = "";
    String urlPath = this.urlPathHelper.getLookupPathForRequest(request);
    request.getSession().setAttribute(PresConstants.SESSION_LAST_VIEW, urlPath);
    String layoutId = ParameterUtil.extractViewNameFromUrlPath(urlPath);
    String contextPath = ParameterUtil.extractContextPathFromUrlPath(urlPath);
    String extension = ParameterUtil.extractExtensionFromUrlPath(urlPath);
    if (log.isDebugEnabled()) {
      log.debug("Rendering component layout '" + layoutId + "' for lookup path: " + urlPath);
    }
    
    Date startTime = null;
    if (log.isDebugEnabled()) {
      startTime = new Date();
    }
    //Get component and render it.
    if(null != layoutId && !layoutId.equals("")) {
      RuntimeLayout layout = null;
      long deployTime = 0L;
      try {
        request.setAttribute("layoutId", layoutId);
        request.setAttribute("contextPath", contextPath + (contextPath.length() > 0 ? "/" : ""));
        request.setAttribute("appContext", contextPath);
        request.setAttribute("outputFormat", extension);

        Date dts = null;
        if (log.isDebugEnabled()) {
          dts = new Date();
        }
        deployTime = Configuration.getInstance().getDeployTime();
        Date dte = null;
        if (log.isDebugEnabled()) {
          dte = new Date();
          log.debug("Deploy Check Time - " + (dte.getTime() - dts.getTime()));
        }
        request.setAttribute(PresConstants.DEPLOY_TIME, String.valueOf(deployTime));

        layout = this.componentLayoutManager.getLayout(layoutId, deployTime);
      } catch (ComponentNotFoundException cnfe) {
        log.warn("Component Layout " + layoutId + " not found.");
        layout = this.componentLayoutManager.getLayout("FeatureNotEnabled", deployTime);
        //throw cnfe;
      }
      try {
        Map params = ParameterUtil.buildParameterMap(request);
        componentRequestManager.set(request, response, params);
        boolean hasAccess = true;
        if (layoutSecurity != null) {
          hasAccess = layoutSecurity.hasAccess(layoutId);
        }
        params.put("pageAccess", String.valueOf(hasAccess));
        if (!hasAccess && layout.getConfig().getNoAccessLayout() != null) {
          try {
            layout = this.componentLayoutManager.getLayout(layout.getConfig().getNoAccessLayout(), deployTime);
            output = layout.render(componentRequestManager.get(), layout.isEmbedded());
          } catch (ComponentNotFoundException cnfe) {
            log.warn("No Access Component Layout " + layout.getConfig().getNoAccessLayout() + " not found.");
            throw cnfe;
          }
        } else {
          output = layout.render(componentRequestManager.get(), layout.isEmbedded(), false, extension);
        }
        
        if (layout.getDoItRef() != null) {
          Map actionParams = new HashMap();
          if (layout.getDoItRef().getParameterMapping() != null) {
            Parameter[] parameters = layout.getDoItRef().getParameterMapping().getParameter();
            ParameterUtil.mapDoItInputParameters(parameters, params, actionParams, true);
          }
          doItRefQueue.put(layout.getDoItRef().getDoItId(), actionParams);
        }
      } catch (ComponentException e) {
        Throwable t = e.rootCause();
        log.info("Root cause " + t.getClass().getName() + " " + t.getMessage());
        if (t instanceof PermissionException
            && (layout = this.componentLayoutManager.getLayout((PermissionException)t)) != null) {
          output = layout.render(componentRequestManager.get(), layout.isEmbedded());
        } else {
          throw e;
        }
      } catch (Exception e) {
        throw e;
      } finally {
        this.componentRequestManager.unset();
      }
      
    } else {
      throw new Exception ("No layoutId specified");
    }

    //Write out to the response.
    response.setContentType("text/html; charset=UTF-8");
    response.setHeader("Pragma",        "no-cache");                           // HTTP 1.0
    response.setHeader("Cache-Control", "no-cache, must-revalidate, private"); // HTTP 1.1
    PrintWriter writer = response.getWriter();
    writer.print(output);
    writer.flush();
    
    if (log.isDebugEnabled()) {
      Date endTime = new Date();
      log.debug("Time [" + layoutId + "] - " + (endTime.getTime() - startTime.getTime()));
    }
    return null;

  }

  public IComponentLayoutManager getComponentLayoutManager() {
    return componentLayoutManager;
  }

  public void setComponentLayoutManager(
      IComponentLayoutManager componentLayoutManager) {
    this.componentLayoutManager = componentLayoutManager;
  }

  public ComponentRequestManager getComponentRequestManager() {
    return componentRequestManager;
  }

  public void setComponentRequestManager(
      ComponentRequestManager componentRequestManager) {
    this.componentRequestManager = componentRequestManager;
  }

  public IDoItRefQueue getDoItRefQueue() {
    return doItRefQueue;
  }

  public void setDoItRefQueue(IDoItRefQueue doItRefQueue) {
    this.doItRefQueue = doItRefQueue;
  }

  public IComponentSecurity getLayoutSecurity() {
    return layoutSecurity;
  }

  public void setLayoutSecurity(IComponentSecurity layoutSecurity) {
    this.layoutSecurity = layoutSecurity;
  }

}