/**
    * This file Copyright (c) 2017 Magnolia International
    * Ltd.  (http://www.magnolia-cms.com). All rights reserved.
    *
    *
    * This file is dual-licensed under both the Magnolia
    * Network Agreement and the GNU General Public License.
    * You may elect to use one or the other of these licenses.
    *
   * This file is distributed in the hope that it will be
   * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
   * implied warranty of MERCHANTABILITY or FITNESS FOR A
   * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
   * Redistribution, except as permitted by whichever of the GPL
   * or MNA you select, is prohibited.
   *
   * 1. For the GPL license (GPL), you can redistribute and/or
   * modify this file under the terms of the GNU General
   * Public License, Version 3, as published by the Free Software
   * Foundation.  You should have received a copy of the GNU
   * General Public License, Version 3 along with this program;
   * if not, write to the Free Software Foundation, Inc., 51
   * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
   *
   * 2. For the Magnolia Network Agreement (MNA), this file
   * and the accompanying materials are made available under the
   * terms of the MNA which accompanies this distribution, and
   * is available at http://www.magnolia-cms.com/mna.html
   *
   * Any modifications to this file must keep this entire header
   * intact.
   *
   */
  package info.magnolia.cms.core;
  
  import info.magnolia.cms.beans.runtime.File;
  import info.magnolia.util.EscapeUtil;
  
  import java.util.Arrays;
  import java.util.Locale;
  
  import javax.inject.Inject;
  import javax.inject.Provider;
  import javax.jcr.Node;
  
  /**
   * Wrapper around {@code AggregationState} created in order to escape all output to rendering.
   * See {@code info.magnolia.rendering.renderer.AbstractRenderer#getAggregationStateSafely}.
   *
   * Should you need the raw output, it can still be accessed from a template, with, for instance:
   * {@code ${state.unwrap().originalURI}}. However, be warned that this may expose your webapp to XSS attacks.
   *
   * <b>
   *     This class belongs to Magnolia's "private" API and it should NOT be extended/overridden, even though it is not marked as final.
   *     Its API and/or implementation may change without notice. The class may also be removed altogether without notice.
   * </b>
   */
  public class HTMLEscapingAggregationState extends AggregationState {
  
      final private Provider<AggregationState> aggregationStateProvider;
  
      @Inject
      protected HTMLEscapingAggregationState(Provider<AggregationState> aggregationStateProvider) {
          this.aggregationStateProvider = aggregationStateProvider;
      }
  
      /**
       * <b>WARNING:</b> doing for instance {@code ${state.unwrap()} in a template and then calling any method on the raw
       * {@link AggregationState} will disable automatic HTML escaping provided by this wrapper thus potentially exposing
       * your webapp to XSS attacks.
       *
       * @return the plain {@link AggregationState} object.
       */
      public AggregationState unwrap() {
          return this.aggregationStateProvider.get();
      }
  
      // escaped getters
  
      @Override
      public String getCurrentURI() {
          return EscapeUtil.escapeXss(aggregationStateProvider.get().getCurrentURI());
      }
  
      @Override
      public String getOriginalURI() {
          return EscapeUtil.escapeXss(aggregationStateProvider.get().getOriginalURI());
      }
  
      @Override
      public String getOriginalURL() {
          return EscapeUtil.escapeXss(aggregationStateProvider.get().getOriginalURL());
      }
  
      @Override
      public String getQueryString() {
          return EscapeUtil.escapeXss(aggregationStateProvider.get().getQueryString());
      }
  
     @Override
     public String getCharacterEncoding() {
         return aggregationStateProvider.get().getCharacterEncoding();
     }
 
     @Override
     public String getOriginalBrowserURI() {
         return EscapeUtil.escapeXss(aggregationStateProvider.get().getOriginalBrowserURI());
     }
 
     @Override
     public String getOriginalBrowserURL() {
         return EscapeUtil.escapeXss(aggregationStateProvider.get().getOriginalBrowserURL());
     }
 
     @Override
     public String getExtension() {
         return aggregationStateProvider.get().getExtension();
     }
 
     @Override
     public String getHandle() {
         return aggregationStateProvider.get().getHandle();
     }
 
     @Override
     public String getRepository() {
         return aggregationStateProvider.get().getRepository();
     }
 
     @Override
     public String getSelector() {
         return EscapeUtil.escapeXss(aggregationStateProvider.get().getSelector());
     }
 
     @Override
     public String getTemplateName() {
         return aggregationStateProvider.get().getTemplateName();
     }
 
     @Override
     protected String stripContextPathIfExists(String uri) {
         return aggregationStateProvider.get().stripContextPathIfExists(uri);
     }
 
     @Override
     public String[] getSelectors() {
         return Arrays.stream(aggregationStateProvider.get().getSelectors())
                      .map(s -> EscapeUtil.escapeXss(s))
                      .toArray(String[]::new);
     }
 
     // delegate - setters
 
     @Override
     public void setOriginalURI(String originalURI) {
         aggregationStateProvider.get().setOriginalURI(originalURI);
     }
 
     @Override
     public void setOriginalBrowserURI(String originalBrowserURI) {
         aggregationStateProvider.get().setOriginalBrowserURI(originalBrowserURI);
     }
 
     @Override
     public void setCurrentURI(String currentURI) {
         aggregationStateProvider.get().setCurrentURI(currentURI);
     }
 
     @Override
     public void setQueryString(String queryString) {
         aggregationStateProvider.get().setQueryString(queryString);
     }
 
     @Override
     public void setOriginalURL(String originalURL) {
         aggregationStateProvider.get().setOriginalURL(originalURL);
     }
 
     @Override
     public void setOriginalBrowserURL(String originalBrowserURL) {
         aggregationStateProvider.get().setOriginalBrowserURL(originalBrowserURL);
     }
 
     @Override
     public void setCharacterEncoding(String characterEncoding) {
         aggregationStateProvider.get().setCharacterEncoding(characterEncoding);
     }
 
     @Override
     public void setExtension(String extension) {
         aggregationStateProvider.get().setExtension(extension);
     }
 
     @Override
     public void setFile(File file) {
         aggregationStateProvider.get().setFile(file);
     }
 
     @Override
     public void setHandle(String handle) {
         aggregationStateProvider.get().setHandle(handle);
     }
 
     @Override
     public void setMainContentNode(final Node mainContentNode) {
         aggregationStateProvider.get().setMainContentNode(mainContentNode);
     }
 
     @Override
     public void setRepository(String repository) {
         aggregationStateProvider.get().setRepository(repository);
     }
 
     @Override
     public void setSelector(String selector) {
         aggregationStateProvider.get().setSelector(selector);
     }
 
     @Override
     public void setTemplateName(String templateName) {
         aggregationStateProvider.get().setTemplateName(templateName);
     }
 
     @Override
     public void setLocale(Locale locale) {
         aggregationStateProvider.get().setLocale(locale);
     }
 
     @Override
     public void setPreviewMode(boolean previewMode) {
         aggregationStateProvider.get().setPreviewMode(previewMode);
     }
 
     @Override
     public void setChannel(Channel channel) {
         aggregationStateProvider.get().setChannel(channel);
     }
 
     @Override
     public void setCurrentContentNode(final Node currentContentNode) {
         aggregationStateProvider.get().setCurrentContentNode(currentContentNode);
     }
 
     // misc
 
     @Override
     public File getFile() {
         return aggregationStateProvider.get().getFile();
     }
 
     @Override
     public Node getMainContentNode() {
         return aggregationStateProvider.get().getMainContentNode();
     }
 
     public Node getCurrentContentNode() {
         return aggregationStateProvider.get().getCurrentContentNode();
     }
 
     @Override
     public Locale getLocale() {
         return aggregationStateProvider.get().getLocale();
     }
 
     @Override
     public boolean isPreviewMode() {
         return aggregationStateProvider.get().isPreviewMode();
     }
 
     @Override
     public Channel getChannel() {
         return aggregationStateProvider.get().getChannel();
     }
 }