/**
    * This file Copyright (c) 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.admincentral.badge;
  
  import info.magnolia.context.Context;
  import info.magnolia.i18nsystem.SimpleTranslator;
  import info.magnolia.icons.MagnoliaIcons;
  import info.magnolia.ui.api.location.Location;
  import info.magnolia.ui.api.location.LocationController;
  import info.magnolia.ui.theme.ResurfaceTheme;
  
  import javax.inject.Inject;
  
  import com.vaadin.shared.ui.ContentMode;
  import com.vaadin.ui.Button;
  import com.vaadin.ui.Composite;
  import com.vaadin.ui.CssLayout;
  import com.vaadin.ui.Label;
  import com.vaadin.ui.VerticalLayout;
  
  /**
   * Base abstract class for header badge, a component displaying item count and status e.g. for tasks and notifications.
   */
  public abstract class AbstractBadge extends Composite {
  
      private static final String BADGE_INDICATOR = "%s<span class='status " + MagnoliaIcons.RADIO_FILL.getCssClass() + " color-green'></span>";
      private final VerticalLayout layout = new VerticalLayout();
      private final Label itemCount = new Label();
      private final String userName;
      private final SimpleTranslator i18n;
  
      @Inject
      AbstractBadge(LocationController controller, Context context, SimpleTranslator i18n) {
          this.userName = context.getUser().getName();
          this.i18n = i18n;
  
          layout.setSizeUndefined();
          layout.setMargin(true);
          layout.setSpacing(false);
          layout.addStyleName("header-component");
  
          itemCount.addStyleNames("indicator", "heading-2");
          itemCount.setContentMode(ContentMode.HTML);
  
          Button openArrow = new Button(MagnoliaIcons.ARROW1_S);
          openArrow.addStyleNames(ResurfaceTheme.BUTTON_ICON, "open-arrow");
          openArrow.addClickListener(event -> {
              if (getLocation().getAppName().equals(controller.getWhere().getAppName())) {
                  onBadgeDeselected();
              } else {
                  controller.goTo(getLocation());
              }
          });
  
          CssLayout cssLayout = new CssLayout();
          cssLayout.addComponents(itemCount, openArrow);
  
          Label label = new Label(getCaption());
          label.addStyleName("label");
  
          layout.addComponents(cssLayout, label);
  
          setCompositionRoot(layout);
      }
  
      protected void onBadgeDeselected() {
      }
  
     /**
      * Updates badge with the items' current status.
      * @see #getStatus()
      */
     void update() {
         final Status status = getStatus();
         layout.setDescription(status.getDescription());
 
         if (status.newItemsAvailable()) {
             itemCount.setValue(String.format(BADGE_INDICATOR, status.getItemCountAsString()));
         } else {
             itemCount.setValue(status.getItemCountAsString());
         }
     }
 
     /**
      * @return the {@link Status} of the item type.
      */
     abstract Status getStatus();
 
     /**
      * @return the {@link Location} to go to upon clicking the badge.
      */
     abstract Location getLocation();
 
     String getUserName() {
         return userName;
     }
 
     SimpleTranslator getI18n() {
         return i18n;
     }
 
     /**
      * Item status. Helps to visually indicate if a badge contains new items.
      * Provides a description text and the overall item count.
      * Count depends on the item type, e.g. notifications, tasks, etc.
      */
     static final class Status {
         private final boolean newItemsAvailable;
         private final int itemCount;
         private final String description;
 
         Status(boolean newItemsAvailable, int itemCount, String description) {
             this.newItemsAvailable = newItemsAvailable;
             this.itemCount = itemCount;
             this.description = description;
         }
 
         boolean newItemsAvailable() {
             return newItemsAvailable;
         }
 
         int getItemCount() {
             return itemCount;
         }
 
         String getDescription() {
             return description;
         }
 
         String getItemCountAsString() {
             return itemCount >= 100 ? "99+" : String.valueOf(itemCount);
         }
     }
 }