private static final long serialVersionUID = 1L;

  private ContentletAPI conAPI = APILocator.getContentletAPI();

  private static PortletURLUtil portletURLUtil = new PortletURLUtil();

  private static UtilMethods utilMethods = new UtilMethods();

  private static InodeUtils inodeUtils = new InodeUtils();

  private static PermissionAPI permissionAPI = APILocator.getPermissionAPI();

  private static PortletAPI portletAPI = APILocator.getPortletAPI();

  private static LanguageAPI langAPI = APILocator.getLanguageAPI();

  private static HostWebAPI hostWebAPI = WebAPILocator.getHostWebAPI();

  public static  ThreadLocal<Context> velocityCtx = Logger.velocityCtx;

  /**

   * @param permissionAPI

   *            the permissionAPI to set

   */

  public static void setPermissionAPI(PermissionAPI permissionAPIRef) {

    permissionAPI = permissionAPIRef;

  }

  private String CHARSET = null;

  private String VELOCITY_HTMLPAGE_EXTENSION = null;

  public static final String VELOCITY_CONTEXT = "velocityContext";

  protected void service(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {

    if (DbConnectionFactory.isMsSql() && LicenseUtil.getLevel() < 299) {

      request.getRequestDispatcher("/portal/no_license.jsp").forward(request, response);

      return;

    }

    if (DbConnectionFactory.isOracle() && LicenseUtil.getLevel() < 399) {

      request.getRequestDispatcher("/portal/no_license.jsp").forward(request, response);

      return;

    }

    if (!LicenseUtil.isASAllowed()) {

      request.getRequestDispatcher("/portal/no_license.jsp").forward(request, response);

      return;

    }

    Long profileTime = null;

    if (Config.getBooleanProperty("VELOCITY_PROFILING", false)) {

      profileTime = Calendar.getInstance().getTimeInMillis();

    }

    try {

      // Check if the uri is a physical file. Fix for the cases when the

      // site configure VELOCITY_PAGE_EXTENSION as htm, html or any known

      // extension.

      // Example:

      // /html/js/tinymce/jscripts/tiny_mce/plugins/advlink/link.htm

      String uri = request.getRequestURI();

      uri = URLDecoder.decode(uri, "UTF-8");

      File file = new File(FileUtil.getRealPath(uri));

      if (file.exists()) {

        if(file.isDirectory()){

          file = new File(file.getAbsolutePath() + File.separator + "index." + Config.getStringProperty("VELOCITY_PAGE_EXTENSION"));

        }

        FileInputStream fileIS = new FileInputStream(file);

        ServletOutputStream servletOS = response.getOutputStream();

        int b;

        for (; -1 < (b = fileIS.read());) {

          servletOS.write(b);

        }

        fileIS.close();

        servletOS.flush();

        servletOS.close();

        return;

      }

      // If we are at a directory, e.g. /home

      // we need to redirect to /home/

      String forwardFor = (String) request.getRequestURL().toString();

      if (request.getAttribute(Globals.MAPPING_KEY) == null && forwardFor != null && !forwardFor.endsWith("/")

          && !forwardFor.endsWith("." + Config.getStringProperty("VELOCITY_PAGE_EXTENSION"))) {

        // The query string parameters should be preserved as well

        String queryString = request.getQueryString();

        response.sendRedirect(SecurityUtils.stripReferer(request, forwardFor + "/" + (UtilMethods.isSet(queryString) ? "?" + queryString : "")));

        return;

      }

      HttpSession session = request.getSession();

      boolean timemachine=session.getAttribute("tm_date")!=null;

      boolean ADMIN_MODE = !timemachine && session!=null && (session.getAttribute(com.dotmarketing.util.WebKeys.ADMIN_MODE_SESSION) != null);

      boolean PREVIEW_MODE = !timemachine && ADMIN_MODE && (session.getAttribute(com.dotmarketing.util.WebKeys.PREVIEW_MODE_SESSION) != null);

      boolean EDIT_MODE = !timemachine && ADMIN_MODE && (session.getAttribute(com.dotmarketing.util.WebKeys.EDIT_MODE_SESSION) != null);

      String value = request.getHeader("X-Requested-With");

      if ((value != null) && value.equals("XMLHttpRequest") && EDIT_MODE && ADMIN_MODE) {

        ADMIN_MODE = false;

      }

      // ### VALIDATE ARCHIVE ###

      if ((EDIT_MODE || PREVIEW_MODE) && isArchive(request)) {

        PREVIEW_MODE = true;

        EDIT_MODE = false;

        request.setAttribute("archive", true);

      }

      // ### END VALIDATE ARCHIVE ###

      LanguageWebAPI langWebAPI = WebAPILocator.getLanguageWebAPI();

      langWebAPI.checkSessionLocale(request);

      if (PREVIEW_MODE && ADMIN_MODE) {

        // preview mode has the left hand menu and edit buttons on the

        // working page

        Logger.debug(VelocityServlet.class, "VELOCITY SERVLET I'M ON PREVIEW MODE!!!");

        doPreviewMode(request, response);

      } else if (EDIT_MODE && ADMIN_MODE) {

        // edit mode has the left hand menu and edit buttons on the

        // working page

        Logger.debug(VelocityServlet.class, "VELOCITY SERVLET I'M ON EDIT MODE!!!");

        doEditMode(request, response);

      } else if (ADMIN_MODE) {

        // admin mode has the left hand menu and shows the live page in

        // the frame

        Logger.debug(VelocityServlet.class, "VELOCITY SERVLET I'M ON ADMIN MODE!!!");

        doAdminMode(request, response);

      } else {

        // live mode has no frame and shows the live page

        Logger.debug(VelocityServlet.class, "VELOCITY SERVLET I'M ON LIVE MODE!!!");

        doLiveMode(request, response);

      }

    } catch (ResourceNotFoundException rnfe) {

      // response.sendError(404);

      request.setAttribute(Constants.SERVE_URL, request.getRequestURI());

      request.getRequestDispatcher("/localResourceServlet").forward(request, response);

    } catch (ParseErrorException pee) {

      Logger.error(this, "Template Parse Exception : " + pee.toString(), pee);

      try {

        response.sendError(500, "Template Parse Exception");

      } catch (Throwable t) {

        Logger.error(this, t.getMessage(), t);

        PrintWriter out = response.getWriter();

        out.println("Template Parse Exception");

        out.println("On template:" + request.getRequestURI() + request.getQueryString());

      }

    } catch (MethodInvocationException mie) {

      Logger.error(this, "MethodInvocationException" + mie.toString(), mie);

      try {

        response.sendError(500, "MethodInvocationException Error on template");

      } catch (Throwable t) {

        Logger.error(this, t.getMessage(), t);

        PrintWriter out = response.getWriter();

        out.println("MethodInvocationException Error on template:" + request.getRequestURI() + request.getQueryString());

      }

    } catch (Exception e) {

      Logger.error(this, e.toString(), e);

      try {

        response.sendError(500, "MethodInvocationException Error on template");

      } catch (Throwable t) {

        Logger.error(this, t.getMessage(), t);

        PrintWriter out = response.getWriter();

        out.println("Error on template:" + request.getRequestURI() + request.getQueryString());

      }

    } finally {

      // catchall

      // added finally because of

      // http://jira.dotmarketing.net/browse/DOTCMS-1334

      try {

        HibernateUtil.commitTransaction();

      } catch (Exception e) {

        Logger.error(this, e.getMessage(), e);

      }

      DbConnectionFactory.closeConnection();

      velocityCtx.remove();

    }

    if (profileTime != null) {

      profileTime = Calendar.getInstance().getTimeInMillis() - profileTime;

      VelocityProfiler.log(VelocityServlet.class, "VelocityPage time: " + request.getRequestURL() + " " + profileTime + " millis");

    }

  }

  public void init(ServletConfig config) throws ServletException {

    // build the dirs

    new File(config.getServletContext().getRealPath("/WEB-INF/velocity/working")).mkdirs();

    new File(config.getServletContext().getRealPath("/WEB-INF/velocity/live")).mkdir();

    Config.initializeConfig();

    CHARSET = Config.getStringProperty("CHARSET");

    VELOCITY_HTMLPAGE_EXTENSION = Config.getStringProperty("VELOCITY_HTMLPAGE_EXTENSION");

  }

  protected void doAdminMode(HttpServletRequest request, HttpServletResponse response) throws Exception {

    // LIVE MODE - LIVE PAGE

    com.liferay.portal.model.User backendUser = null;

    backendUser = com.liferay.portal.util.PortalUtil.getUser(request);

    response.setContentType(CHARSET);

    Context context = VelocityUtil.getWebContext(request, response);

    String uri = URLDecoder.decode(request.getRequestURI(), UtilMethods.getCharsetConfiguration());

    uri = UtilMethods.cleanURI(uri);

    Host host = hostWebAPI.getCurrentHost(request);

    Identifier id = APILocator.getIdentifierAPI().find(host, uri);

    request.setAttribute("idInode", id.getInode());

    HTMLPage htmlPage = (HTMLPage) APILocator.getVersionableAPI()

        .findWorkingVersion(id, APILocator.getUserAPI().getSystemUser(), false);

    HTMLPageAPI htmlPageAPI = APILocator.getHTMLPageAPI();

    VelocityUtil.makeBackendContext(context, htmlPage, "", id.getURI(), request, true, false, false, host);

    boolean canUserWriteOnTemplate = permissionAPI.doesUserHavePermission(htmlPageAPI.getTemplateForWorkingHTMLPage(htmlPage),

        PERMISSION_WRITE, backendUser);

    context.put("EDIT_TEMPLATE_PERMISSION", canUserWriteOnTemplate);

    Template template = null;

    if (request.getParameter("leftMenu") != null) {

      template = VelocityUtil.getEngine().getTemplate("/preview_left_menu.vl");

    } else if (request.getParameter("mainFrame") != null) {

      template = VelocityUtil.getEngine().getTemplate("/live/" + id.getInode() + "." + VELOCITY_HTMLPAGE_EXTENSION);

    } else {

      template = VelocityUtil.getEngine().getTemplate("/preview_mode.vl");

    }

    Logger.debug(VelocityServlet.class, "Got the template!!!!" + id.getInode());

    PrintWriter out = response.getWriter();

    request.setAttribute(VELOCITY_CONTEXT, context);

    try {

      template.merge(context, out);

    } catch (ParseErrorException e) {

      out.append(e.getMessage());

    }

  }

  public void doLiveMode(HttpServletRequest request, HttpServletResponse response) throws Exception {

      LicenseUtil.startLiveMode();

      try {

        String uri = URLDecoder.decode(request.getRequestURI(), UtilMethods.getCharsetConfiguration());

        uri = UtilMethods.cleanURI(uri);

   

        Host host = hostWebAPI.getCurrentHost(request);

   

        // Map with all identifier inodes for a given uri.

        //

   

        // Checking the path is really live using the livecache

        String cachedUri = LiveCache.getPathFromCache(uri, host);

   

        // if we still have nothing, check live cache first (which has a 404 cache )

        if (cachedUri == null) {

          throw new ResourceNotFoundException(String.format("Resource %s not found in Live mode!", uri));

        }

   

        // now  we check identifier cache first (which DOES NOT have a 404 cache )

        Identifier ident = APILocator.getIdentifierAPI().find(host, uri);

        if(ident ==null && ident.getInode() == null){

          throw new ResourceNotFoundException(String.format("Resource %s not found in Live mode!", uri));

        }

        response.setContentType(CHARSET);

   

        request.setAttribute("idInode", String.valueOf(ident.getInode()));

        Logger.debug(VelocityServlet.class, "VELOCITY HTML INODE=" + ident.getInode());

   

        /*

         * JIRA http://jira.dotmarketing.net/browse/DOTCMS-4659

        //Set long lived cookie regardless of who this is */

        String _dotCMSID = UtilMethods.getCookieValue(request.getCookies(),

            com.dotmarketing.util.WebKeys.LONG_LIVED_DOTCMS_ID_COOKIE);

   

        if (!UtilMethods.isSet(_dotCMSID)) {

          // create unique generator engine

          Cookie idCookie = CookieUtil.createCookie();

          response.addCookie(idCookie);

        }

   

        com.liferay.portal.model.User user = null;

        HttpSession session = request.getSession(false);

        try {

          if(session!=null)

            user = (com.liferay.portal.model.User) session.getAttribute(com.dotmarketing.util.WebKeys.CMS_USER);

        } catch (Exception nsue) {

          Logger.warn(this, "Exception trying to getUser: " + nsue.getMessage(), nsue);

        }

   

        boolean signedIn = false;

   

        if (user != null) {

          signedIn = true;

        }

   

   

        Logger.debug(VelocityServlet.class, "Page Permissions for URI=" + uri);

   

        HTMLPage page = null;

        try {

          // we get the page and check permissions below

          page = APILocator.getHTMLPageAPI().loadLivePageById(ident.getInode(), APILocator.getUserAPI().getSystemUser(), false);

        } catch (Exception e) {

          Logger.error(HTMLPageWebAPI.class, "unable to load live version of page: " + ident.getInode() + " because " + e.getMessage());

          return;

        }

   

        // Check if the page is visible by a CMS Anonymous role

        if (!permissionAPI.doesUserHavePermission(page, PERMISSION_READ, user, true)) {

          // this page is protected. not anonymous access

   

          /*******************************************************************

           * If we need to redirect someone somewhere to login before seeing a

           * page, we need to edit the /portal/401.jsp page to sendRedirect

           * the user to the proper login page. We are not using the

           * REDIRECT_TO_LOGIN variable in the config any longer.

           ******************************************************************/

          if (!signedIn) {

            // No need for the below LAST_PATH attribute on the front end

            // http://jira.dotmarketing.net/browse/DOTCMS-2675

            // request.getSession().setAttribute(WebKeys.LAST_PATH,

            // new ObjectValuePair(uri, request.getParameterMap()));

            request.getSession().setAttribute(com.dotmarketing.util.WebKeys.REDIRECT_AFTER_LOGIN, uri);

   

            Logger.debug(VelocityServlet.class, "VELOCITY CHECKING PERMISSION: Page doesn't have anonymous access" + uri);

   

            Logger.debug(VelocityServlet.class, "401 URI = " + uri);

   

            Logger.debug(VelocityServlet.class, "Unauthorized URI = " + uri);

            response.sendError(401, "The requested page/file is unauthorized");

            return;

   

          } else if (!permissionAPI.getReadRoles(ident).contains(APILocator.getRoleAPI().loadLoggedinSiteRole())) {

            // user is logged in need to check user permissions

            Logger.debug(VelocityServlet.class, "VELOCITY CHECKING PERMISSION: User signed in");

   

            // check user permissions on this asset

            if (!permissionAPI.doesUserHavePermission(ident, PERMISSION_READ, user, true)) {

              // the user doesn't have permissions to see this page

              // go to unauthorized page

              Logger.warn(VelocityServlet.class, "VELOCITY CHECKING PERMISSION: Page doesn't have any access for this user");

              response.sendError(403, "The requested page/file is forbidden");

              return;

            }

          }

        }

   

        Logger.debug(VelocityServlet.class, "Recording the ClickStream");

        if(Config.getBooleanProperty("ENABLE_CLICKSTREAM_TRACKING", false)) {

          if (user != null) {

            UserProxy userProxy = com.dotmarketing.business.APILocator.getUserProxyAPI().getUserProxy(user,

                APILocator.getUserAPI().getSystemUser(), false);

            if (!userProxy.isNoclicktracking()) {

              ClickstreamFactory.addRequest((HttpServletRequest) request, ((HttpServletResponse) response), host);

            }

          } else {

            ClickstreamFactory.addRequest((HttpServletRequest) request, ((HttpServletResponse) response), host);

          }

        }

   

        // Begin Page Caching

        boolean buildCache = false;

        String key = getPageCacheKey(request);

        if (key != null) {

   

          String cachedPage = CacheLocator.getBlockDirectiveCache().get(key, (int) page.getCacheTTL());

   

          if (cachedPage == null || "refresh".equals(request.getParameter("dotcache"))

              || "refresh".equals(request.getAttribute("dotcache"))

              || "refresh".equals(request.getSession().getAttribute("dotcache"))) {

            // build cached response

            buildCache = true;

          } else {

            // have cached response and are not refreshing, send it

            response.getWriter().write(cachedPage);

            return;

          }

        }

   

        Writer out = (buildCache) ? new StringWriter(4096) : new VelocityFilterWriter(response.getWriter());

   

        //get the context from the requst if possible

        Context context = VelocityUtil.getWebContext(request, response);

   

        request.setAttribute("velocityContext", context);

        Logger.debug(VelocityServlet.class, "HTMLPage Identifier:" + ident.getInode());

   

   

   

        try {

   

          VelocityUtil.getEngine().getTemplate("/live/" + ident.getInode() + "." + VELOCITY_HTMLPAGE_EXTENSION).merge(context, out);

   

        } catch (ParseErrorException e) {

          // out.append(e.getMessage());

        }

   

        context = null;

        if (buildCache) {

          String trimmedPage = out.toString().trim();

          response.getWriter().write(trimmedPage);

          response.getWriter().close();

          synchronized (key) {

            //CacheLocator.getBlockDirectiveCache().clearCache();

            CacheLocator.getHTMLPageCache().remove(page);

            CacheLocator.getBlockDirectiveCache().add(getPageCacheKey(request), trimmedPage, (int) page.getCacheTTL());

          }

        } else {

          out.close();

        }

   

      }

      finally {

          LicenseUtil.stopLiveMode();

      }

  }

  @SuppressWarnings("unchecked")

  public void doPreviewMode(HttpServletRequest request, HttpServletResponse response) throws Exception {

    String uri = URLDecoder.decode(request.getRequestURI(), UtilMethods.getCharsetConfiguration());

    uri = UtilMethods.cleanURI(uri);

    Host host = hostWebAPI.getCurrentHost(request);

    StringBuilder preExecuteCode = new StringBuilder();

    Boolean widgetPreExecute = false;

    // Getting the user to check the permissions

    com.liferay.portal.model.User user = null;

    try {

        user = com.liferay.portal.util.PortalUtil.getUser( request );

    } catch (Exception nsue) {

      Logger.warn(this, "Exception trying getUser: " + nsue.getMessage(), nsue);

    }

    // Getting the identifier from the uri

    Identifier id = APILocator.getIdentifierAPI().find(host, uri);

    request.setAttribute("idInode", id.getInode());

    Logger.debug(VelocityServlet.class, "VELOCITY HTML INODE=" + id.getInode());

    Template template = null;

    Template hostVariablesTemplate = null;

    // creates the context where to place the variables

    response.setContentType(CHARSET);

    Context context = VelocityUtil.getWebContext(request, response);

    HTMLPage htmlPage = (HTMLPage) APILocator.getVersionableAPI().findWorkingVersion(id, user, true);

    HTMLPageAPI htmlPageAPI = APILocator.getHTMLPageAPI();

    PublishingEndPointAPI pepAPI = APILocator.getPublisherEndPointAPI();

    List<PublishingEndPoint> receivingEndpoints = pepAPI.getReceivingEndPoints();

    // to check user has permission to write on this page

        boolean hasWritePermOverHTMLPage = permissionAPI.doesUserHavePermission( htmlPage, PERMISSION_WRITE, user );

        boolean hasPublishPermOverHTMLPage = permissionAPI.doesUserHavePermission( htmlPage, PERMISSION_PUBLISH, user );

        boolean hasRemotePublishPermOverHTMLPage = hasPublishPermOverHTMLPage && LicenseUtil.getLevel() > 199;

        boolean hasEndPoints = UtilMethods.isSet( receivingEndpoints ) && !receivingEndpoints.isEmpty();

        context.put( "EDIT_HTMLPAGE_PERMISSION", new Boolean( hasWritePermOverHTMLPage ) );

        context.put( "PUBLISH_HTMLPAGE_PERMISSION", new Boolean( hasPublishPermOverHTMLPage ) );

        context.put( "REMOTE_PUBLISH_HTMLPAGE_PERMISSION", new Boolean( hasRemotePublishPermOverHTMLPage ) );

        context.put( "REMOTE_PUBLISH_END_POINTS", new Boolean( hasEndPoints ) );

        context.put( "canViewDiff", new Boolean( LicenseUtil.getLevel() > 199 ? true : false ) );

    boolean canUserWriteOnTemplate = permissionAPI.doesUserHavePermission(htmlPageAPI.getTemplateForWorkingHTMLPage(htmlPage),

        PERMISSION_WRITE, user, true);

    context.put("EDIT_TEMPLATE_PERMISSION", canUserWriteOnTemplate);

    com.dotmarketing.portlets.templates.model.Template cmsTemplate = com.dotmarketing.portlets.htmlpages.factories.HTMLPageFactory

        .getHTMLPageTemplate(htmlPage, true);

    Identifier templateIdentifier = APILocator.getIdentifierAPI().find(cmsTemplate);

    Logger.debug(VelocityServlet.class, "VELOCITY TEMPLATE INODE=" + cmsTemplate.getInode());

    VelocityUtil.makeBackendContext(context, htmlPage, cmsTemplate.getInode(), id.getURI(), request, true, false, true, host);

    context.put("previewPage", "2");

    context.put("livePage", "0");

    // get the containers for the page and stick them in context

    List<Container> containers = APILocator.getTemplateAPI().getContainersInTemplate(cmsTemplate,

        APILocator.getUserAPI().getSystemUser(),false);

    for (Container c : containers) {

      context.put(String.valueOf("container" + c.getIdentifier()),

          "/working/" + c.getIdentifier() + "." + Config.getStringProperty("VELOCITY_CONTAINER_EXTENSION"));

      context.put("EDIT_CONTAINER_PERMISSION" + c.getIdentifier(), permissionAPI.doesUserHavePermission(c, PERMISSION_WRITE, user, true));

      boolean hasWritePermOverTheStructure = false;

      for (ContainerStructure cs : APILocator.getContainerAPI().getContainerStructures(c)) {

        Structure st = StructureCache.getStructureByInode(cs.getStructureId());

        hasWritePermOverTheStructure |= permissionAPI.doesUserHavePermission(st, PERMISSION_WRITE, user, true);

      }

      context.put("ADD_CONTENT_PERMISSION" + c.getIdentifier(), new Boolean(hasWritePermOverTheStructure));

      Logger.debug(VelocityServlet.class, String.valueOf("container" + c.getIdentifier()) + "=/working/" + c.getIdentifier() + "."

          + Config.getStringProperty("VELOCITY_CONTAINER_EXTENSION"));

      String sort = (c.getSortContentletsBy() == null) ? "tree_order" : c.getSortContentletsBy();

      boolean staticContainer = !UtilMethods.isSet(c.getLuceneQuery());

      List<Contentlet> contentlets = null;

      // get contentlets only for main frame

      if (request.getParameter("mainFrame") != null) {

        if (staticContainer) {

          Logger.debug(VelocityServlet.class, "Static Container!!!!");

          Logger.debug(VelocityServlet.class, "html=" + htmlPage.getInode() + " container=" + c.getInode());

          // The container doesn't have categories

          Identifier idenHtmlPage = APILocator.getIdentifierAPI().find(htmlPage);

          Identifier idenContainer = APILocator.getIdentifierAPI().find(c);

          contentlets = conAPI.findPageContentlets(idenHtmlPage.getInode(), idenContainer.getInode(), sort, true, -1, user, true);

          Logger.debug(

              VelocityServlet.class,

              "Getting contentlets for language="

                  + (String) request.getSession().getAttribute(com.dotmarketing.util.WebKeys.HTMLPAGE_LANGUAGE)

                  + " contentlets =" + contentlets.size());

        }

        if (UtilMethods.isSet(contentlets) && contentlets.size() > 0) {

          Set<String> contentletIdentList = new HashSet<String>();

          List<Contentlet> contentletsFilter = new ArrayList<Contentlet>();

          for (Contentlet cont : contentlets) {

            if (!contentletIdentList.contains(cont.getIdentifier())) {

              contentletIdentList.add(cont.getIdentifier());

              contentletsFilter.add(cont);

            }

          }

          contentlets = contentletsFilter;

        }

        List<String> contentletList = new ArrayList<String>();

        if (contentlets != null && contentlets.size() > 0) {

          Iterator<Contentlet> iter = contentlets.iterator();

          int count = 0;

          while (iter.hasNext() && (count < c.getMaxContentlets())) {

            count++;

            Contentlet contentlet = (Contentlet) iter.next();

            Identifier contentletIdentifier = APILocator.getIdentifierAPI().find(contentlet);

            boolean hasWritePermOverContentlet = permissionAPI.doesUserHavePermission(contentlet, PERMISSION_WRITE, user, true);

            context.put("EDIT_CONTENT_PERMISSION" + contentletIdentifier.getInode(), new Boolean(hasWritePermOverContentlet));

            contentletList.add(String.valueOf(contentletIdentifier.getInode()));

            Logger.debug(this, "Adding contentlet=" + contentletIdentifier.getInode());

            Structure contStructure = contentlet.getStructure();

            if (contStructure.getStructureType() == Structure.STRUCTURE_TYPE_WIDGET) {

              Field field = contStructure.getFieldVar("widgetPreexecute");

              if (field != null && UtilMethods.isSet(field.getValues())) {

                preExecuteCode.append(field.getValues().trim() + "\n");

                widgetPreExecute = true;

              }

            }

          }

        }

        // sets contentletlist with all the files to load per

        // container

        context.put("contentletList" + c.getIdentifier(), contentletList);

        context.put("totalSize" + c.getIdentifier(), new Integer(contentletList.size()));

      }

    }

    Logger.debug(

        VelocityServlet.class,

        "Before finding template: /working/" + templateIdentifier.getInode() + "."

            + Config.getStringProperty("VELOCITY_TEMPLATE_EXTENSION"));

    Logger.debug(VelocityServlet.class, "Velocity directory:" + VelocityUtil.getEngine().getProperty(RuntimeConstants.FILE_RESOURCE_LOADER_PATH));

    if (request.getParameter("leftMenu") != null) {

      /*

       * try to get the messages from the session

       */

      List<String> list = new ArrayList<String>();

      if (SessionMessages.contains(request, "message")) {

        list.add((String) SessionMessages.get(request, "message"));

        SessionMessages.clear(request);

      }

      if (SessionMessages.contains(request, "custommessage")) {

        list.add((String) SessionMessages.get(request, "custommessage"));

        SessionMessages.clear(request);

      }

      if (list.size() > 0) {

        ArrayList<String> mymessages = new ArrayList<String>();

        Iterator<String> it = list.iterator();

        while (it.hasNext()) {

          try {

            String message = (String) it.next();

            Company comp = PublicCompanyFactory.getDefaultCompany();

            mymessages.add(LanguageUtil.get(comp.getCompanyId(), user.getLocale(), message));

          } catch (Exception e) {

          }

        }

        context.put("vmessages", mymessages);

      }

      template = VelocityUtil.getEngine().getTemplate("/preview_left_menu.vl");

    } else if (request.getParameter("mainFrame") != null) {

      hostVariablesTemplate = VelocityUtil.getEngine().getTemplate("/working/" + host.getIdentifier() + "." + Config.getStringProperty("VELOCITY_HOST_EXTENSION"));

            if ( cmsTemplate.isDrawed() ) {//We have a designed template

                //Setting some theme variables

                Map<String, Object> dotThemeData = DotTemplateTool.theme( cmsTemplate.getTheme(), host.getIdentifier() );

                context.put( "dotTheme", dotThemeData );

                context.put( "dotThemeLayout", DotTemplateTool.themeLayout( cmsTemplate.getInode() ) );

                //Our designed template

                template = VelocityUtil.getEngine().getTemplate( (String) dotThemeData.get( "templatePath" ) );

            } else {

                template = VelocityUtil.getEngine().getTemplate( "/working/" + templateIdentifier.getInode() + "." + Config.getStringProperty( "VELOCITY_TEMPLATE_EXTENSION" ) );

            }

    } else {

      template = VelocityUtil.getEngine().getTemplate("/preview_mode.vl");

    }

    PrintWriter out = response.getWriter();

    request.setAttribute("velocityContext", context);

    try {

      if (widgetPreExecute) {

        VelocityUtil.getEngine().evaluate(context, out, "", preExecuteCode.toString());

      }

      if (hostVariablesTemplate != null)

        hostVariablesTemplate.merge(context, out);

      template.merge(context, out);

    } catch (ParseErrorException e) {

      out.append(e.getMessage());

    }

  }

    @SuppressWarnings ("unchecked")

    protected void doEditMode ( HttpServletRequest request, HttpServletResponse response ) throws Exception {

        String uri = request.getRequestURI();

        uri = UtilMethods.cleanURI( uri );

        Host host = hostWebAPI.getCurrentHost( request );

        StringBuilder preExecuteCode = new StringBuilder();

        Boolean widgetPreExecute = false;

        // Getting the user to check the permissions

        com.liferay.portal.model.User backendUser = null;

        try {

            backendUser = com.liferay.portal.util.PortalUtil.getUser( request );

        } catch ( Exception nsue ) {

            Logger.warn( this, "Exception trying getUser: " + nsue.getMessage(), nsue );

        }

        // Getting the identifier from the uri

        Identifier id = APILocator.getIdentifierAPI().find( host, uri );

        request.setAttribute( "idInode", String.valueOf( id.getInode() ) );

        Logger.debug( VelocityServlet.class, "VELOCITY HTML INODE=" + id.getInode() );

        Template template;

        Template hostVariablesTemplate = null;

        // creates the context where to place the variables

        response.setContentType( CHARSET );

        Context context = VelocityUtil.getWebContext( request, response );

        HTMLPage htmlPage = (HTMLPage) APILocator.getVersionableAPI().findWorkingVersion( id, APILocator.getUserAPI().getSystemUser(), false );

        HTMLPageAPI htmlPageAPI = APILocator.getHTMLPageAPI();

        PublishingEndPointAPI pepAPI = APILocator.getPublisherEndPointAPI();

    List<PublishingEndPoint> receivingEndpoints = pepAPI.getReceivingEndPoints();

        // to check user has permission to write on this page

        boolean hasAddChildrenPermOverHTMLPage = permissionAPI.doesUserHavePermission( htmlPage, PERMISSION_CAN_ADD_CHILDREN, backendUser );

        boolean hasWritePermOverHTMLPage = permissionAPI.doesUserHavePermission( htmlPage, PERMISSION_WRITE, backendUser );

        boolean hasPublishPermOverHTMLPage = permissionAPI.doesUserHavePermission( htmlPage, PERMISSION_PUBLISH, backendUser );

        boolean hasRemotePublishPermOverHTMLPage = hasPublishPermOverHTMLPage && LicenseUtil.getLevel() > 199;

        boolean hasEndPoints = UtilMethods.isSet( receivingEndpoints ) && !receivingEndpoints.isEmpty();

        context.put( "ADD_CHILDREN_HTMLPAGE_PERMISSION", new Boolean( hasAddChildrenPermOverHTMLPage ) );

        context.put( "EDIT_HTMLPAGE_PERMISSION", new Boolean( hasWritePermOverHTMLPage ) );

        context.put( "PUBLISH_HTMLPAGE_PERMISSION", new Boolean( hasPublishPermOverHTMLPage ) );

        context.put( "REMOTE_PUBLISH_HTMLPAGE_PERMISSION", new Boolean( hasRemotePublishPermOverHTMLPage ) );

        context.put( "REMOTE_PUBLISH_END_POINTS", new Boolean(hasEndPoints) );

        context.put( "canAddForm", new Boolean( LicenseUtil.getLevel() > 199 ? true : false ) );

        context.put( "canViewDiff", new Boolean( LicenseUtil.getLevel() > 199 ? true : false ) );

        boolean canUserWriteOnTemplate = permissionAPI.doesUserHavePermission( htmlPageAPI.getTemplateForWorkingHTMLPage( htmlPage ), PERMISSION_WRITE, backendUser ) && portletAPI.hasTemplateManagerRights( backendUser );

        context.put( "EDIT_TEMPLATE_PERMISSION", canUserWriteOnTemplate );

        com.dotmarketing.portlets.templates.model.Template cmsTemplate = com.dotmarketing.portlets.htmlpages.factories.HTMLPageFactory.getHTMLPageTemplate( htmlPage, true );

        //issue- 1775 If User doesn't have edit permission on HTML Pages

       /* if(!hasWritePermOverHTMLPage){

          doPreviewMode(request, response);

          return;

        }*/

        if ( cmsTemplate == null ) {// DOTCMS-4051

            cmsTemplate = new com.dotmarketing.portlets.templates.model.Template();

            Logger.debug( VelocityServlet.class, "HTMLPAGE TEMPLATE NOT FOUND" );

        }

        Identifier templateIdentifier = APILocator.getIdentifierAPI().find( cmsTemplate );

        Logger.debug( VelocityServlet.class, "VELOCITY TEMPLATE INODE=" + cmsTemplate.getInode() );

        VelocityUtil.makeBackendContext( context, htmlPage, cmsTemplate.getInode(), id.getURI(), request, true, true, false, host );

        // added to show tabs

        context.put( "previewPage", "1" );

        // get the containers for the page and stick them in context

        List<Container> containers = APILocator.getTemplateAPI().getContainersInTemplate( cmsTemplate, APILocator.getUserAPI().getSystemUser(), false );

        for ( Container c : containers ) {

            context.put( String.valueOf( "container" + c.getIdentifier() ), "/working/" + c.getIdentifier() + "." + Config.getStringProperty( "VELOCITY_CONTAINER_EXTENSION" ) );

            boolean hasWritePermissionOnContainer = permissionAPI.doesUserHavePermission( c, PERMISSION_WRITE, backendUser, false )

                    && portletAPI.hasContainerManagerRights( backendUser );

            boolean hasReadPermissionOnContainer = permissionAPI.doesUserHavePermission( c, PERMISSION_READ, backendUser, false );

            context.put( "EDIT_CONTAINER_PERMISSION" + c.getIdentifier(), hasWritePermissionOnContainer );

            if ( Config.getBooleanProperty( "SIMPLE_PAGE_CONTENT_PERMISSIONING", true ) )

                context.put( "USE_CONTAINER_PERMISSION" + c.getIdentifier(), true );

            else

                context.put( "USE_CONTAINER_PERMISSION" + c.getIdentifier(), hasReadPermissionOnContainer );

            // to check user has permission to write this container

            boolean hasWritePermOverTheStructure = false;

      for (ContainerStructure cs : APILocator.getContainerAPI().getContainerStructures(c)) {

        Structure st = StructureCache.getStructureByInode(cs.getStructureId());

        hasWritePermOverTheStructure |= permissionAPI.doesUserHavePermission(st, PERMISSION_WRITE, backendUser);

      }

            context.put( "ADD_CONTENT_PERMISSION" + c.getIdentifier(), new Boolean( hasWritePermOverTheStructure ) );

            Logger.debug( VelocityServlet.class, String.valueOf( "container" + c.getIdentifier() ) + "=/working/" + c.getIdentifier() + "."

                    + Config.getStringProperty( "VELOCITY_CONTAINER_EXTENSION" ) );

            String sort = (c.getSortContentletsBy() == null) ? "tree_order" : c.getSortContentletsBy();

            List<Contentlet> contentlets = null;

            boolean staticContainer = !UtilMethods.isSet( c.getLuceneQuery() );

            // get contentlets only for main frame

            if ( request.getParameter( "mainFrame" ) != null ) {

                if ( staticContainer ) {

                    Logger.debug( VelocityServlet.class, "Static Container!!!!" );

                    Logger.debug( VelocityServlet.class, "html=" + htmlPage.getInode() + " container=" + c.getInode() );

                    // The container doesn't have categories

                    Identifier idenHtmlPage = APILocator.getIdentifierAPI().find( htmlPage );

                    Identifier idenContainer = APILocator.getIdentifierAPI().find( c );

                    contentlets = conAPI.findPageContentlets( idenHtmlPage.getInode(), idenContainer.getInode(), sort, true, -1, backendUser, true );

                    Logger.debug(

                            VelocityServlet.class,

                            "Getting contentlets for language="

                                    + (String) request.getSession().getAttribute( com.dotmarketing.util.WebKeys.HTMLPAGE_LANGUAGE )

                                    + " contentlets =" + contentlets.size() );

                } else {

                    String luceneQuery = c.getLuceneQuery();

                    int limit = c.getMaxContentlets();

                    String sortBy = c.getSortContentletsBy();

                    int offset = 0;

                    contentlets = conAPI.search( luceneQuery, limit, offset, sortBy, backendUser, true );

                }

                if ( UtilMethods.isSet( contentlets ) && contentlets.size() > 0 ) {

                    Set<String> contentletIdentList = new HashSet<String>();

                    List<Contentlet> contentletsFilter = new ArrayList<Contentlet>();

                    for ( Contentlet cont : contentlets ) {

                        if ( !contentletIdentList.contains( cont.getIdentifier() ) ) {

                            contentletIdentList.add( cont.getIdentifier() );

                            contentletsFilter.add( cont );

                        }

                    }

                    contentlets = contentletsFilter;

                }

                List<String> contentletList = new ArrayList<String>();

                if ( contentlets != null ) {

                    Iterator<Contentlet> iter = contentlets.iterator();

                    int count = 0;

                    while ( iter.hasNext() && (count < c.getMaxContentlets()) ) {

                        count++;

                        Contentlet contentlet = (Contentlet) iter.next();

                        Identifier contentletIdentifier = APILocator.getIdentifierAPI().find( contentlet );

                        boolean hasWritePermOverContentlet = permissionAPI.doesUserHavePermission( contentlet, PERMISSION_WRITE, backendUser );

                        context.put( "EDIT_CONTENT_PERMISSION" + contentletIdentifier.getInode(), new Boolean( hasWritePermOverContentlet ) );

                        contentletList.add( String.valueOf( contentletIdentifier.getInode() ) );

                        Logger.debug( this, "Adding contentlet=" + contentletIdentifier.getInode() );

                        Structure contStructure = contentlet.getStructure();

                        if ( contStructure.getStructureType() == Structure.STRUCTURE_TYPE_WIDGET ) {

                            Field field = contStructure.getFieldVar( "widgetPreexecute" );

                            if ( field != null && UtilMethods.isSet( field.getValues() ) ) {

                                preExecuteCode.append( field.getValues().trim() + "\n" );

                                widgetPreExecute = true;

                            }

                        }

                    }

                }

                // sets contentletlist with all the files to load per

                // container

                context.put( "contentletList" + c.getIdentifier(), contentletList );

                context.put( "totalSize" + c.getIdentifier(), new Integer( contentletList.size() ) );

                // ### Add the structure fake contentlet ###

                if ( contentletList.size() == 0 ) {

                  List<ContainerStructure> csList = APILocator.getContainerAPI().getContainerStructures(c);

                    for (ContainerStructure cs : csList) {

                      contentletList.add( cs.getStructureId() + "" );

          }

                    // sets contentletlist with all the files to load per

                    // container

                    context.remove( "contentletList" + c.getIdentifier() );

                    context.remove( "totalSize" + c.getIdentifier() );

                    // http://jira.dotmarketing.net/browse/DOTCMS-2876

                    context.put( "contentletList" + c.getIdentifier(), new long[0] );

                    context.put( "totalSize" + c.getIdentifier(), 0 );

                }

                // ### END Add the structure fake contentlet ###

            }

        }

        Logger.debug(

                VelocityServlet.class,

                "Before finding template: /working/" + templateIdentifier.getInode() + "."

                        + Config.getStringProperty( "VELOCITY_TEMPLATE_EXTENSION" ) );

        Logger.debug( VelocityServlet.class, "Velocity directory:" + VelocityUtil.getEngine().getProperty( RuntimeConstants.FILE_RESOURCE_LOADER_PATH ) );

        if ( request.getParameter( "leftMenu" ) != null ) {

            /*

                * try to get the messages from the session

                */

            List<String> list = new ArrayList<String>();

            if ( SessionMessages.contains( request, "message" ) ) {

                list.add( (String) SessionMessages.get( request, "message" ) );

                SessionMessages.clear( request );

            }

            if ( SessionMessages.contains( request, "custommessage" ) ) {

                list.add( (String) SessionMessages.get( request, "custommessage" ) );

                SessionMessages.clear( request );

            }

            if ( list.size() > 0 ) {

                ArrayList<String> mymessages = new ArrayList<String>();

                Iterator<String> it = list.iterator();

                while ( it.hasNext() ) {

                    try {

                        String message = (String) it.next();

                        Company comp = PublicCompanyFactory.getDefaultCompany();

                        mymessages.add( LanguageUtil.get( comp.getCompanyId(), backendUser.getLocale(), message ) );

                    } catch ( Exception e ) {

                    }

                }

                context.put( "vmessages", mymessages );

            }

            template = VelocityUtil.getEngine().getTemplate( "/preview_left_menu.vl" );

        } else if ( request.getParameter( "mainFrame" ) != null ) {

            hostVariablesTemplate = VelocityUtil.getEngine().getTemplate( "/working/" + host.getIdentifier() + "." + Config.getStringProperty( "VELOCITY_HOST_EXTENSION" ) );

            if ( cmsTemplate.isDrawed() ) {//We have a designed template

                //Setting some theme variables

                Map<String, Object> dotThemeData = DotTemplateTool.theme( cmsTemplate.getTheme(), host.getIdentifier() );

                context.put( "dotTheme", dotThemeData );

                context.put( "dotThemeLayout", DotTemplateTool.themeLayout( cmsTemplate.getInode() ) );

                //Our designed template

                template = VelocityUtil.getEngine().getTemplate( (String) dotThemeData.get( "templatePath" ) );

            } else {

                template = VelocityUtil.getEngine().getTemplate( "/working/" + templateIdentifier.getInode() + "." + Config.getStringProperty( "VELOCITY_TEMPLATE_EXTENSION" ) );

            }

        } else {

            // Return a resource not found right away if the page is not found,

            // not try to load the frames

            if ( !InodeUtils.isSet( templateIdentifier.getInode() ) )

                throw new ResourceNotFoundException( "" );

            template = VelocityUtil.getEngine().getTemplate( "/preview_mode.vl" );

        }

        PrintWriter out = response.getWriter();

        request.setAttribute( "velocityContext", context );

        try {

            if ( widgetPreExecute ) {

                VelocityUtil.getEngine().evaluate( context, out, "", preExecuteCode.toString() );

            }

            if ( hostVariablesTemplate != null )

                hostVariablesTemplate.merge( context, out );

            template.merge( context, out );

        } catch ( ParseErrorException e ) {

            out.append( e.getMessage() );

        }

    }

  // EACH CLIENT MAY HAVE ITS OWN VARIABLES

  // WE HAVE THE CLASS CLIENT THAT WILL IMPLEMENT THIS METHOD AND WILL BE ON

  // THE WEB.XML FILE

  protected abstract void _setClientVariablesOnContext(HttpServletRequest request, ChainedContext context);

  private boolean isArchive(HttpServletRequest request) throws PortalException, SystemException, DotDataException, DotSecurityException {

    String uri = request.getRequestURI();

    uri = UtilMethods.cleanURI(uri);

    Host host = null;

    String hostId = "";

    /*

     * String pageHostId = request.getParameter("host_id"); if (pageHostId

     * != null) { try { hostId = Long.parseLong(pageHostId); } catch

     * (Exception ex) { } }

     */

    hostId = request.getParameter("host_id");

    if (!InodeUtils.isSet(hostId)) {

      host = hostWebAPI.getCurrentHost(request);

      hostId = host.getIdentifier();

    }

    else {

      User user = (com.liferay.portal.model.User) request.getSession().getAttribute(com.dotmarketing.util.WebKeys.CMS_USER);

      if(user==null) {

        user = com.liferay.portal.util.PortalUtil.getUser(request);

      }

      host = hostWebAPI.find(hostId, user, true);

    }

    // Getting the identifier from the uri

    Identifier id = APILocator.getIdentifierAPI().find(host, uri);

    request.setAttribute("idInode", String.valueOf(id.getInode()));

    HTMLPage htmlPage = (HTMLPage) APILocator.getVersionableAPI()

        .findWorkingVersion(id, APILocator.getUserAPI().getSystemUser(), false);

    boolean isArchived = htmlPage.isDeleted();

    return isArchived;

  }

  /**

   * @author will this filter class strips all leading whitespace from the

   *         server response which is helpful for xml feeds and the like.

   */

  public class VelocityFilterWriter extends FilterWriter {

    private boolean firstNonWhiteSpace = false;

    public VelocityFilterWriter(Writer arg0) {

      super(arg0);

    }

    @Override

    public void write(char[] arg0) throws IOException {

      if (firstNonWhiteSpace) {

        super.write(arg0);

      } else {

        for (int i = 0; i < arg0.length; i++) {

          if (arg0[i] > 32) {

            firstNonWhiteSpace = true;

          }

          if (firstNonWhiteSpace) {

            super.write(arg0[i]);

          }

        }

      }

    }

    @Override

    public void write(String arg0) throws IOException {

      if (firstNonWhiteSpace) {

        super.write(arg0);

      } else {

        char[] stringChar = arg0.toCharArray();

        for (int i = 0; i < stringChar.length; i++) {

          if (stringChar[i] > 32) {

            firstNonWhiteSpace = true;

            super.write(arg0.substring(i, stringChar.length));

            break;

          }

        }

      }

    }

  }

  /**

   * This method trys to build a cache key based on the information given in

   * the request - if the page can't be cached, or caching is not availbale

   * then return null

   *

   * @param request

   * @return

   */

  private String getPageCacheKey(HttpServletRequest request) {

    // no license

    if (LicenseUtil.getLevel() < 100) {

      return null;

    }

    // don't cache posts

    if (!"GET".equalsIgnoreCase(request.getMethod())) {

      return null;

    }

    // nocache passed either as a session var, as a request var or as a

    // request attribute

    if ("no".equals(request.getParameter("dotcache")) || "no".equals(request.getAttribute("dotcache"))

        || "no".equals(request.getSession().getAttribute("dotcache"))) {

      return null;

    }

    String idInode = (String) request.getAttribute("idInode");

    User user = (com.liferay.portal.model.User) request.getSession().getAttribute(com.dotmarketing.util.WebKeys.CMS_USER);

    HTMLPage page = null;

    try {

      page = APILocator.getHTMLPageAPI().loadLivePageById(idInode, user, true);

    } catch (Exception e) {

      Logger.error(HTMLPageWebAPI.class, "unable to load live version of page: " + idInode + " because " + e.getMessage());

      return null;

    }

    if (page == null || page.getCacheTTL() < 1) {

      return null;

    }

    StringBuilder sb = new StringBuilder();

    sb.append(page.getInode());

    sb.append("_" + page.getModDate().getTime());

    String userId = (user != null) ? user.getUserId() : "PUBLIC";

    sb.append("_" + userId);

    String language = (String) request.getSession().getAttribute(com.dotmarketing.util.WebKeys.HTMLPAGE_LANGUAGE);

    sb.append("_" + language);

    String urlMap = (String) request.getAttribute(WebKeys.WIKI_CONTENTLET_INODE);

    if (urlMap != null) {

      sb.append("_" + urlMap);

    }

    if (UtilMethods.isSet(request.getQueryString())) {

      sb.append("_" + request.getQueryString());

    }

    return sb.toString();

  }

}