/**
    * This file Copyright (c) 2019 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.templating.elements.attribute;
  
  import info.magnolia.i18nsystem.I18nizer;
  import info.magnolia.i18nsystem.LocaleProvider;
  import info.magnolia.i18nsystem.TranslationService;
  import info.magnolia.objectfactory.Components;
  import info.magnolia.rendering.context.RenderingContext;
  import info.magnolia.rendering.template.TemplateDefinition;
  import info.magnolia.templating.elements.AbstractContentTemplatingElement;
  import info.magnolia.templating.elements.AreaElement;
  
  import java.util.Optional;
  
  import javax.inject.Inject;
  import javax.inject.Provider;
  
  import org.apache.commons.lang3.StringUtils;
  
  /**
   * {@link ElementAttribute} for translated attributes.
   */
  public abstract class Translated implements ElementAttribute<AbstractContentTemplatingElement> {
  
      private final I18nizer i18nizer;
      private final Provider<RenderingContext> renderingContextProvider;
  
      Translated(I18nizer i18nizer, Provider<RenderingContext> renderingContextProvider) {
          this.i18nizer = i18nizer;
          this.renderingContextProvider = renderingContextProvider;
      }
  
      @Override
      public Optional<String> getValue(AbstractContentTemplatingElement element) {
          return Optional.ofNullable(getTranslation(element));
      }
  
      abstract String getTranslation(AbstractContentTemplatingElement renderableDefinition);
  
      <D> D i18nize(D renderableDefinition) {
          return i18nizer.decorate(renderableDefinition);
      }
  
      String legacyTranslate(String keyOrAlreadyTranslatedValue, String i18nBasename) {
          if (isMessageKey(keyOrAlreadyTranslatedValue)) {
              return Components.getComponent(TranslationService.class).translate(Components.getComponent(LocaleProvider.class), i18nBasename, new String[]{keyOrAlreadyTranslatedValue});
          } else {
              return keyOrAlreadyTranslatedValue;
          }
      }
  
      boolean isMessageKey(String key) {
          return !StringUtils.endsWith(key, ".") && StringUtils.contains(key, ".") && !StringUtils.contains(key, " ");
      }
  
      String getI18nBasename(AbstractContentTemplatingElement element) {
          TemplateDefinition parentDefinition = element instanceof AreaElement ? element.getTemplateDefinition() : renderingContextProvider.get().getParentAreaDefinition();
          TemplateDefinition templateDefinition = element instanceof AreaElement ? ((AreaElement) element).getAreaDefinition() : element.getTemplateDefinition();
          //compatibility with old i18n mechanism, remove when we get rid of i18nBasename
          return StringUtils.isNotEmpty(templateDefinition.getI18nBasename()) ? templateDefinition.getI18nBasename() : (parentDefinition == null ? null : parentDefinition.getI18nBasename());
      }
  
      /**
       * {@link ElementAttribute} for {@link info.magnolia.rendering.template.RenderableDefinition#getTitle()}.
       */
      public static class Label extends Translated {
  
         @Inject
         public Label(I18nizer i18nizer, Provider<RenderingContext> renderingContextProvider) {
             super(i18nizer, renderingContextProvider);
         }
 
         String getTranslation(AbstractContentTemplatingElement element) {
             TemplateDefinition definition = element instanceof AreaElement ? ((AreaElement) element).getAreaDefinition() : element.getTemplateDefinition();
             definition = i18nize(definition);
             String label = null;
             if (element instanceof AreaElement) {
                 label = ((AreaElement) element).getLabel();
             }
             if (label == null) {
                 label = definition.getTitle();
             }
             label = legacyTranslate(label, getI18nBasename(element));
             if (label == null || isMessageKey(label)) {
                 label = element instanceof AreaElement ? StringUtils.capitalize(((AreaElement) element).getName()) : definition.getName();
             }
             return label;
         }
     }
 
     /**
      * {@link ElementAttribute} for {@link info.magnolia.rendering.template.RenderableDefinition#getDescription()}.
      */
     public static class Description extends Translated {
 
         @Inject
         public Description(I18nizer i18nizer, Provider<RenderingContext> renderingContextProvider) {
             super(i18nizer, renderingContextProvider);
         }
 
         protected String getTranslation(AbstractContentTemplatingElement element) {
             //this was already translated with i18nizer. This is here just to keep compatibility with old i18n mechanism. Remove when we drop support of old i18n
 //            TemplateDefinition definition = element instanceof AreaElement ? ((AreaElement) element).getAreaDefinition() : element.getTemplateDefinition();
             TemplateDefinition definition = i18nize(element.getTemplateDefinition());
             String description = definition.getDescription();
             final String i18nBasename = getI18nBasename(element);
             description = this.legacyTranslate(description, i18nBasename);
             return isMessageKey(definition.getDescription()) ? null : description;
         }
     }
 }