/**
    * This file Copyright (c) 2012-2018 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.ui.workbench.column;
  
  import info.magnolia.i18nsystem.SimpleTranslator;
  import info.magnolia.jcr.util.NodeTypes;
  import info.magnolia.ui.workbench.column.definition.StatusColumnDefinition;
  
  import java.security.AccessControlException;
  
  import javax.inject.Inject;
  import javax.jcr.Item;
  import javax.jcr.Node;
  import javax.jcr.RepositoryException;
  import javax.jcr.Session;
  
  import com.vaadin.v7.ui.Table;
  
  /**
   * Column formatter for displaying the activation status of an item. Creates icons that represents the activation and
   * permission status. Use the definition to configure which icons should be included.
   */
  public class StatusColumnFormatter extends AbstractColumnFormatter<StatusColumnDefinition> {
  
      protected final SimpleTranslator i18n;
  
      @Inject
      public StatusColumnFormatter(StatusColumnDefinition definition, SimpleTranslator i18n) {
          super(definition);
          this.i18n = i18n;
      }
  
      @Override
      public Object generateCell(Table source, Object itemId, Object columnId) {
  
          final Item jcrItem = getJcrItem(source, itemId);
          if (jcrItem != null && jcrItem.isNode()) {
              Node node = (Node) jcrItem;
  
              String activationStatus = "";
              ActivationStatus activationType;
              String activationStatusMessage = "";
              String permissionStatus = "";
  
              // activation status
              if (definition.isActivation()) {
                  Integer status;
                  try {
                      status = NodeTypes.Activatable.getActivationStatus(node);
                  } catch (RepositoryException e) {
                      status = NodeTypes.Activatable.ACTIVATION_STATUS_NOT_ACTIVATED;
                  }
  
                  switch (status) {
                  case NodeTypes.Activatable.ACTIVATION_STATUS_MODIFIED:
                      activationType = ActivationStatus.MODIFIED;
                      activationStatusMessage = i18n.translate("activation-status.columns.modified");
                      break;
                  case NodeTypes.Activatable.ACTIVATION_STATUS_ACTIVATED:
                      activationType = ActivationStatus.ACTIVATED;
                      activationStatusMessage = i18n.translate("activation-status.columns.activated");
                      break;
                  default:
                      activationType = ActivationStatus.NOT_ACTIVATED;
                      activationStatusMessage = i18n.translate("activation-status.columns.not-activated");
                  }
                  activationStatus = "<span class=\"" + activationType.getStyleName() + "\" title=\"" + activationStatusMessage + "\"></span>";
                  activationStatus = activationStatus + "<span class=\"hidden-for-aria\">" + activationStatusMessage + "</span>";
             }
 
             // permission status
             if (definition.isPermissions()) {
                 try {
                     node.getSession().checkPermission(node.getPath(), Session.ACTION_ADD_NODE + "," + Session.ACTION_REMOVE + "," + Session.ACTION_SET_PROPERTY);
                 } catch (AccessControlException e) {
                     permissionStatus = "<span class=\"icon-read-only\"></span>";
                 } catch (RepositoryException e) {
                     throw new RuntimeException("Could not access the JCR permissions for the following node identifier " + itemId, e);
                 }
             }
             return activationStatus + permissionStatus;
         }
         return null;
     }
 
     /**
      * Helper for representing activation status in the UI.
      */
     public enum ActivationStatus {
 
         ACTIVATED("icon-status-green", "color-green"),
         MODIFIED("icon-status-orange", "color-yellow"),
         NOT_ACTIVATED("icon-status-red", "color-red");
 
         private final String baseStyleName = "activation-status";
         private String icon;
         private String color;
 
         ActivationStatus(String icon, String color) {
             this.icon = icon;
             this.color = color;
         }
 
         public String getStyleName() {
             return baseStyleName + " " + icon + " " + color;
         }
 
         public String getBaseStyleName() {
             return baseStyleName;
         }
 
         public String getIcon() {
             return icon;
         }
 
         public String getColor() {
             return color;
         }
     }
 }