/**
    * This file Copyright (c) 2012-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.pages.app.column;
  
  import info.magnolia.config.registry.Registry;
  import info.magnolia.i18nsystem.I18nizer;
  import info.magnolia.objectfactory.Components;
  import info.magnolia.pages.app.field.TemplateSelectorFieldFactory;
  import info.magnolia.rendering.template.TemplateDefinition;
  import info.magnolia.rendering.template.assignment.TemplateDefinitionAssignment;
  import info.magnolia.rendering.template.registry.TemplateDefinitionRegistry;
  import info.magnolia.ui.workbench.column.AbstractColumnFormatter;
  
  import java.text.MessageFormat;
  
  import javax.inject.Inject;
  import javax.jcr.Item;
  import javax.jcr.Node;
  import javax.jcr.RepositoryException;
  
  import org.apache.commons.lang3.StringUtils;
  import org.slf4j.Logger;
  import org.slf4j.LoggerFactory;
  
  import com.vaadin.v7.ui.Table;
  
  /**
   * Column formatter used to display the title of a page's template.
   *
   * @see TemplateColumnDefinition
   */
  public class TemplateColumnFormatter extends AbstractColumnFormatter<TemplateColumnDefinition> {
  
      private static final Logger log = LoggerFactory.getLogger(TemplateColumnFormatter.class);
  
      private final TemplateDefinitionRegistry templateRegistry;
      private final TemplateDefinitionAssignment templateDefinitionAssignment;
      private final I18nizer i18nizer;
  
      @Inject
      public TemplateColumnFormatter(TemplateColumnDefinition definition, TemplateDefinitionRegistry templateRegistry, TemplateDefinitionAssignment templateDefinitionAssignment, I18nizer i18nizer) {
          super(definition);
          this.templateRegistry = templateRegistry;
          this.templateDefinitionAssignment = templateDefinitionAssignment;
          this.i18nizer = i18nizer;
      }
  
      /**
       * @deprecated since 5.4.3. Use {@link #TemplateColumnFormatter(TemplateColumnDefinition, info.magnolia.rendering.template.registry.TemplateDefinitionRegistry, info.magnolia.rendering.template.assignment.TemplateDefinitionAssignment, info.magnolia.i18nsystem.I18nizer)} instead.
       */
      @Deprecated
      public TemplateColumnFormatter(TemplateColumnDefinition definition, TemplateDefinitionRegistry templateRegistry, TemplateDefinitionAssignment templateDefinitionAssignment) {
          this(definition, templateRegistry, templateDefinitionAssignment, Components.getComponent(I18nizer.class));
      }
  
      @Override
      public Object generateCell(Table source, Object itemId, Object columnId) {
          final Item jcrItem = getJcrItem(source, itemId);
  
          if (jcrItem == null || !jcrItem.isNode()) {
              return "";
          }
  
          Node node = (Node) jcrItem;
  
          // Get template id
          String templateId;
          try {
             templateId = templateDefinitionAssignment.getAssignedTemplate(node);
         } catch (RepositoryException e) {
             return "Unknown";
         }
 
         // Get template definition
         TemplateDefinition template = null;
         try {
             template = templateRegistry.getProvider(templateId).get();
         } catch (Registry.NoSuchDefinitionException e) {
             log.warn("Template with id {} not found.", templateId);
         }
 
         if (template == null) {
             return MessageFormat.format(definition.getUnknownTemplateLabel(), templateId);
         } else {
             return getI18nTitle(template);
         }
     }
 
     private String getI18nTitle(TemplateDefinition definition) {
         String translatedTitle = i18nizer.decorate(definition).getTitle();
         if (isMessageKey(translatedTitle)) { //compatibility with old i18n mechanism, remove when we get rid of i18nBasename
             translatedTitle = TemplateSelectorFieldFactory.getI18nTitle(definition);
         }
         return translatedTitle;
     }
 
     private boolean isMessageKey(String key) {
         return !StringUtils.endsWith(key, ".") && StringUtils.contains(key, ".") && !StringUtils.contains(key, " ");
     }
 }