content: /*
   * This library is part of OpenCms -
   * the Open Source Content Management System
   *
   * Copyright (c) Alkacon Software GmbH & Co. KG (https://www.alkacon.com)
   *
   * This library is free software; you can redistribute it and/or
   * modify it under the terms of the GNU Lesser General Public
   * License as published by the Free Software Foundation; either
   * version 2.1 of the License, or (at your option) any later version.
   *
   * This library 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.
   *
   * For further information about Alkacon Software GmbH & Co. KG, please see the
   * company website: https://www.alkacon.com
   *
   * For further information about OpenCms, please see the
   * project website: https://www.opencms.org
   *
   * You should have received a copy of the GNU Lesser General Public
   * License along with this library; if not, write to the Free Software
   * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
   */
  
  package org.opencms.jsp;
  
  import org.opencms.file.CmsProperty;
  import org.opencms.flex.CmsFlexController;
  import org.opencms.i18n.CmsLocaleManager;
  import org.opencms.jsp.decorator.CmsHtmlDecorator;
  import org.opencms.jsp.decorator.I_CmsDecoratorConfiguration;
  import org.opencms.main.CmsLog;
  import org.opencms.util.CmsStringUtil;
  
  import java.util.Iterator;
  import java.util.List;
  import java.util.Locale;
  
  import javax.servlet.ServletRequest;
  import javax.servlet.jsp.JspException;
  import javax.servlet.jsp.tagext.BodyTagSupport;
  
  import org.apache.commons.logging.Log;
  
  /**
   * Implements the <code>&lt;cms:decorate&gt;&lt;/cms:decorate&gt;</code>
   * tag to decorate HTML content with configurated decoration maps.<p>
   *
   * @since 6.1.3
   */
  public class CmsJspTagDecorate extends BodyTagSupport {
  
      /** The name of the default decorator configuration. */
      public static final String DEFAULT_DECORATOR_CONFIGURATION = "org.opencms.jsp.decorator.CmsDecoratorConfiguration";
  
      /** The property to store the decorator classname .*/
      public static final String PROPERTY_CATEGORY = "category";
  
      /** The log object for this class. */
      private static final Log LOG = CmsLog.getLog(CmsJspTagDecorate.class);
  
      /** Serial version UID required for safe serialization. */
      private static final long serialVersionUID = 3072561342127379294L;
  
      /** Indicates the parse action should be disabled to allow inline editing in the container page editor. */
      private boolean m_allowInlineEdit;
  
      /** The configuration. */
      private String m_file;
  
      /** The decoration locale. */
      private String m_locale;
  
      /** List of upper case tag name strings of tags that should not be auto-corrected if closing divs are missing. */
      private List<String> m_noAutoCloseTags;
  
      /**
       * Internal action method.<p>
       *
       * DEcorates a HTMl content block.<p>
       *
       * @param content the content to be decorated
       * @param configFile the config file
       * @param locale the locale to use for decoration or NOLOCALE if not locale should be used
       * @param req the current request
       *
       * @return the decorated content
       */
      public String decorateTagAction(String content, String configFile, String locale, ServletRequest req) {
  
          try {
              Locale loc = null;
              CmsFlexController controller = CmsFlexController.getController(req);
              if (CmsStringUtil.isEmpty(locale)) {
                  loc = controller.getCmsObject().getRequestContext().getLocale();
              } else {
                  loc = CmsLocaleManager.getLocale(locale);
              }
  
              // read the decorator configurator class
              CmsProperty decoratorClass = controller.getCmsObject().readPropertyObject(
                  configFile,
                  PROPERTY_CATEGORY,
                  false);
              String decoratorClassName = decoratorClass.getValue();
              if (CmsStringUtil.isEmpty(decoratorClassName)) {
                  decoratorClassName = DEFAULT_DECORATOR_CONFIGURATION;
              }
  
              String encoding = controller.getCmsObject().getRequestContext().getEncoding();
              // use the correct decorator configurator and initialize it
              I_CmsDecoratorConfiguration config = (I_CmsDecoratorConfiguration)Class.forName(
                  decoratorClassName).newInstance();
              config.init(controller.getCmsObject(), configFile, loc);
  
              CmsHtmlDecorator decorator = new CmsHtmlDecorator(controller.getCmsObject(), config);
  
              decorator.setNoAutoCloseTags(m_noAutoCloseTags);
              return decorator.doDecoration(content, encoding);
          } catch (Exception e) {
              if (LOG.isErrorEnabled()) {
                  LOG.error(Messages.get().getBundle().key(Messages.ERR_PROCESS_TAG_1, "decoration"), e);
              }
              return content;
          }
      }
  
      /**
       * @see javax.servlet.jsp.tagext.Tag#doEndTag()
       * @return EVAL_PAGE
       * @throws JspException in case something goes wrong
       */
      @Override
      public int doEndTag() throws JspException {
  
          ServletRequest req = pageContext.getRequest();
          if (m_allowInlineEdit && CmsJspTagEditable.isEditableRequest(req)) {
              // during inline editing the content should not be parsed
              try {
                  getBodyContent().writeOut(pageContext.getOut());
                  release();
              } catch (Exception ex) {
                  release();
                  if (LOG.isErrorEnabled()) {
                      LOG.error(Messages.get().getBundle().key(Messages.ERR_PROCESS_TAG_1, "decoration"), ex);
                  }
                  // this is severe
                  throw new JspException(ex);
              }
          } else {
              // This will always be true if the page is called through OpenCms
              if (CmsFlexController.isCmsRequest(req)) {
                  try {
                      String content = decorateTagAction(getBodyContent().getString(), getFile(), getLocale(), req);
                      getBodyContent().clear();
                      getBodyContent().print(content);
                      getBodyContent().writeOut(pageContext.getOut());
  
                  } catch (Exception ex) {
                      if (LOG.isErrorEnabled()) {
                          LOG.error(Messages.get().getBundle().key(Messages.ERR_PROCESS_TAG_1, "decoration"), ex);
                      }
                      throw new JspException(ex);
                  }
              }
          }
          return EVAL_PAGE;
      }
  
      /**
       * Returns the file name.<p>
       *
       * @return the file name
       */
      public String getFile() {
  
          return m_file;
      }
  
      /**
       * Returns the locale name.<p>
       *
       * @return the locale name
       */
      public String getLocale() {
  
          return m_locale;
      }
  
      /**
       * Getter for the attribute "noAutoCloseTags" of the &lt;cms:parse&gt; tag.<p>
       *
       * Returns a <code>String</code> that consists of the comma-separated upper case tag names for which this
       * tag will not correct missing closing tags. <p>
       *
       *
       * @return a String that consists of the comma-separated upper case tag names for which this
       *      tag will not correct missing closing tags.
       */
      public String getNoAutoCloseTags() {
  
          StringBuffer result = new StringBuffer();
          if ((m_noAutoCloseTags != null) && (m_noAutoCloseTags.size() > 0)) {
              Iterator<String> it = m_noAutoCloseTags.iterator();
              while (it.hasNext()) {
                  result.append(it.next()).append(',');
              }
          }
          return result.toString();
      }
  
      /**
       * Returns if the parse action should be disabled to allow inline editing in the container page editor.<p>
       *
       * @return <code>true</code> if the parse action should be disabled to allow inline editing in the container page editor
       */
      public boolean isAllowInlineEdit() {
  
          return m_allowInlineEdit;
      }
  
      /**
       * Sets if the parse action should be disabled to allow inline editing in the container page editor.<p>
       *
       * @param allowInlineEdit <code>true</code> to allow inline editing
       */
      public void setAllowInlineEdit(boolean allowInlineEdit) {
  
          m_allowInlineEdit = allowInlineEdit;
      }
  
      /**
       * Sets the file name.<p>
       *
       * @param file the file name
       */
      public void setFile(String file) {
  
          if (file != null) {
              m_file = file.toLowerCase();
          } else {
              m_file = null;
          }
      }
  
      /**
       * Sets the locale name.<p>
       *
       * @param locale the locale name
       */
      public void setLocale(String locale) {
  
          m_locale = locale;
      }
  
      /**
       * Setter for the attribute "noAutoCloseTags" of the &lt;cms:parse&gt; tag.<p>
       *
       * Awaits a <code>String</code> that consists of the comma-separated upper case tag names for which this
       * tag should not correct missing closing tags.<p>
       *
       * @param noAutoCloseTagList a <code>String</code> that consists of the comma-separated upper case tag names for which this
       *      tag should not correct missing closing tags.
       */
      public void setNoAutoCloseTags(String noAutoCloseTagList) {
  
          m_noAutoCloseTags = CmsStringUtil.splitAsList(noAutoCloseTagList, ',');
  
      }
  }
  