WebTemplateHelper.java example

Explorer
pentaho-platform-master
/*!
 * This program is free software; you can redistribute it and/or modify it under the
 * terms of the GNU Lesser General Public License, version 2.1 as published by the Free Software
 * Foundation.
 *
 * You should have received a copy of the GNU Lesser General Public License along with this
 * program; if not, you can obtain a copy at http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html
 * or from the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
 * without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 * See the GNU Lesser General Public License for more details.
 *
 * Copyright (c) 2002-2016 Pentaho Corporation..  All rights reserved.
 */

package org.pentaho.platform.web.http;

import org.apache.commons.io.IOUtils;
import org.pentaho.platform.api.engine.IPentahoSession;
import org.pentaho.platform.api.engine.IUITemplater;
import org.pentaho.platform.api.util.IVersionHelper;
import org.pentaho.platform.engine.core.system.PentahoSystem;
import org.pentaho.platform.engine.security.SecurityHelper;
import org.pentaho.platform.engine.services.actionsequence.ActionSequenceResource;
import org.pentaho.platform.util.messages.LocaleHelper;
import org.pentaho.platform.web.http.api.resources.utils.SystemUtils;
import org.pentaho.platform.web.http.messages.Messages;

public class WebTemplateHelper implements IUITemplater {
  private static String footerTemplate = null;

  private static final String FOOTER_TEMPLATE_FILENAME = "template-footer.html"; //$NON-NLS-1$

  private String headerContent = "";

  public void setHeaderContent( String headerContent ) {
    this.headerContent = headerContent;
  }

  public String processTemplate( String template, final String title, final String content,
      final IPentahoSession session ) {

    template = processTemplate( template, title, session );
    template = template.replaceFirst( "\\{content\\}", content ); //$NON-NLS-1$

    return template;
  }

  /*
   * TODO: This needs to be architected to be more performant
   */
  public String processTemplate( String template, final String title, final IPentahoSession session ) {

    if ( WebTemplateHelper.footerTemplate == null ) {
      WebTemplateHelper.footerTemplate = getTemplate( WebTemplateHelper.FOOTER_TEMPLATE_FILENAME, session );
    }
    template = template.replaceFirst( "\\{footer\\}", WebTemplateHelper.footerTemplate ); //$NON-NLS-1$
    template = template.replaceAll( "\\{title\\}", title ); //$NON-NLS-1$
    template = template.replaceAll( "\\{home\\}", Messages.getInstance().getString( "UI.USER_HOME" ) ); //$NON-NLS-1$ //$NON-NLS-2$
    template = template.replaceAll( "\\{navigate\\}", Messages.getInstance().getString( "UI.USER_NAVIGATE" ) ); //$NON-NLS-1$ //$NON-NLS-2$
    template = template.replaceAll( "\\{solutions\\}", Messages.getInstance().getString( "UI.USER_SOLUTIONS" ) ); //$NON-NLS-1$ //$NON-NLS-2$
    template = template.replaceAll( "\\{file-cache\\}", Messages.getInstance().getString( "UI.USER_FILE_CACHE" ) ); //$NON-NLS-1$ //$NON-NLS-2$
    template = template.replaceAll( "\\{new-content\\}", Messages.getInstance().getString( "UI.USER_NEW_CONTENT" ) ); //$NON-NLS-1$ //$NON-NLS-2$

    template = template.replaceAll( "\\{file\\}", Messages.getInstance().getString( "UI.USER_FILE" ) ); //$NON-NLS-1$ //$NON-NLS-2$
    template = template.replaceAll( "\\{view\\}", Messages.getInstance().getString( "UI.USER_VIEW" ) ); //$NON-NLS-1$ //$NON-NLS-2$
    template = template.replaceAll( "\\{nightly\\}", Messages.getInstance().getString( "UI.USER_NIGHTLY" ) ); //$NON-NLS-1$ //$NON-NLS-2$
    template = template.replaceAll( "\\{tracker\\}", Messages.getInstance().getString( "UI.USER_TRACKER" ) ); //$NON-NLS-1$ //$NON-NLS-2$
    template = template.replaceAll( "\\{new-report\\}", Messages.getInstance().getString( "UI.USER_NEW_REPORT" ) ); //$NON-NLS-1$ //$NON-NLS-2$
    template = template.replaceAll( "\\{new-view", Messages.getInstance().getString( "UI.USER_NEW_PIVOT" ) ); //$NON-NLS-1$ //$NON-NLS-2$
    template = template.replaceAll( "\\{admin\\}", Messages.getInstance().getString( "UI.USER_ADMIN" ) ); //$NON-NLS-1$ //$NON-NLS-2$
    template = template.replaceAll( "\\{about\\}", Messages.getInstance().getString( "UI.USER_ABOUT" ) ); //$NON-NLS-1$ //$NON-NLS-2$
    template = template.replaceAll( "\\{pentaho.org\\}", Messages.getInstance().getString( "UI.USER_PENTAHO.COM" ) ); //$NON-NLS-1$ //$NON-NLS-2$
    template = template.replaceAll( "\\{close\\}", Messages.getInstance().getString( "UI.USER_CLOSE" ) ); //$NON-NLS-1$ //$NON-NLS-2$
    template = template.replaceAll( "\\{forums\\}", Messages.getInstance().getString( "UI.USER_FORUMS" ) ); //$NON-NLS-1$ //$NON-NLS-2$
    template = template.replaceAll( "\\{demos\\}", Messages.getInstance().getString( "UI.USER_DEMOS" ) ); //$NON-NLS-1$ //$NON-NLS-2$
    template = template.replaceAll( "\\{downloads\\}", Messages.getInstance().getString( "UI.USER_DOWNLOADS" ) ); //$NON-NLS-1$ //$NON-NLS-2$
    template =
        template.replaceAll( "text/html; charset=utf-8", "text/html; charset=" + LocaleHelper.getSystemEncoding() ); //$NON-NLS-1$//$NON-NLS-2$ 
    template = template.replaceAll( "\\{text-direction\\}", LocaleHelper.getTextDirection() ); //$NON-NLS-1$
    template = template.replaceAll( "\\{logout\\}", Messages.getInstance().getString( "UI.USER_LOGOUT" ) ); //$NON-NLS-1$ //$NON-NLS-2$
    template = template.replaceAll( "\\{portal\\}", Messages.getInstance().getString( "UI.USER_PORTAL" ) ); //$NON-NLS-1$ //$NON-NLS-2$
    if ( PentahoSystem.getObjectFactory().objectDefined( IVersionHelper.class.getSimpleName() ) ) {
      IVersionHelper versionHelper = PentahoSystem.get( IVersionHelper.class, session );
      template =
          template
              .replaceAll( "\\{version\\}", "Version: " + versionHelper.getVersionInformation( PentahoSystem.class ) ); //$NON-NLS-1$ //$NON-NLS-2$
    }
    template = template.replaceAll( "\\{system\\}", PentahoSystem.getSystemName() ); //$NON-NLS-1$
    template = template.replaceAll( "\\{isLoggedIn\\}", session.isAuthenticated() ? "true" : "false" ); //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
    template = template.replaceAll( "\\{background-alert\\}", session.getBackgroundExecutionAlert() ? "true" : "false" ); //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
    template = template.replaceAll( "\\{header-content\\}", headerContent ); //$NON-NLS-1$ //$NON-NLS-2$
    template = template.replaceAll( "\\{body-tag\\}", "" ); //$NON-NLS-1$ //$NON-NLS-2$
    template =
        template.replaceAll( "\\{isAdmin\\}", SystemUtils.canAdminister()
            ? "true" : "false" ); //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
    template = template.replaceAll( "\\{copyright\\}", Messages.getInstance().getString( "UI.USER_COPYRIGHT" ) ); //$NON-NLS-1$ //$NON-NLS-2$

    return template;
  }

  public String getTemplate( final String templateName, final IPentahoSession session ) {

    String template = null;
    try {
      byte[] bytes =
          IOUtils.toByteArray( ActionSequenceResource.getInputStream( "system/custom/" + templateName, LocaleHelper
              .getLocale() ) );
      template = new String( bytes, LocaleHelper.getSystemEncoding() );
    } catch ( Throwable t ) {
      //ignore
    }

    if ( template == null ) {
      return Messages.getInstance().getString( "UI.ERROR_0001_BAD_TEMPLATE", "system/custom/" + templateName ); //$NON-NLS-1$
    } else {
      return template;
    }
  }

  public String[] breakTemplate( final String templateName, final String title, final IPentahoSession session ) {
    String template = getTemplate( templateName, session );
    return breakTemplateString( template, title, session );
  }

  public String[] breakTemplateString( String template, final String title, final IPentahoSession session ) {
    String token = "{content}"; //$NON-NLS-1$
    template = processTemplate( template, title, session );
    int index = template.indexOf( token );
    if ( index == -1 ) {
      return new String[] { template };
    } else {
      String[] sections = new String[2];
      sections[0] = template.substring( 0, index );
      sections[1] = template.substring( index + token.length() );
      return sections;
    }
  }

}