/**
    * This file Copyright (c) 2016-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.admincentral.usermenu.field.factory;
  
  import static org.apache.commons.lang3.StringUtils.EMPTY;
  
  import info.magnolia.context.Context;
  import info.magnolia.i18nsystem.SimpleTranslator;
  import info.magnolia.objectfactory.Components;
  import info.magnolia.ui.api.context.UiContext;
  import info.magnolia.ui.api.i18n.I18NAuthoringSupport;
  import info.magnolia.ui.form.field.definition.SelectFieldDefinition;
  import info.magnolia.ui.form.field.definition.SelectFieldOptionDefinition;
  import info.magnolia.ui.form.field.factory.SelectFieldFactory;
  
  import java.util.ArrayList;
  import java.util.List;
  import java.util.TimeZone;
  
  import javax.inject.Inject;
  
  import com.vaadin.v7.data.Item;
  import com.vaadin.v7.data.Property;
  import com.vaadin.v7.shared.ui.combobox.FilteringMode;
  import com.vaadin.v7.ui.AbstractSelect;
  
  /**
   * Creates and initializes a timezone field.
   */
  public class TimeZoneFieldFactory extends SelectFieldFactory<TimeZoneFieldFactory.Definition> {
  
      /**
       * @deprecated not used anymore in timezone options, though some user profiles might still have it.
       */
      @Deprecated
      static final String BROWSER_TIMEZONE = "browser";
  
      private final Context context;
      private final SimpleTranslator i18n;
  
      @Inject
      public TimeZoneFieldFactory(Definition definition, Item relatedFieldItem, UiContext uiContext, I18NAuthoringSupport i18nAuthoringSupport,
                                  Context context, SimpleTranslator i18n) {
          super(definition, relatedFieldItem, uiContext, i18nAuthoringSupport);
          this.context = context;
          this.i18n = i18n;
      }
  
      /**
       * @deprecated since 5.4.11, use {@link #TimeZoneFieldFactory(Definition, Item, UiContext, I18NAuthoringSupport, Context, SimpleTranslator)} instead
       */
      @Deprecated
      public TimeZoneFieldFactory(Definition definition, Item relatedFieldItem, Context context, SimpleTranslator i18n) {
          this(definition, relatedFieldItem, null, Components.getComponent(I18NAuthoringSupport.class), context, i18n);
      }
  
      @Override
      protected AbstractSelect createFieldComponent() {
          AbstractSelect select = super.createFieldComponent();
          select.setNullSelectionAllowed(true);
          select.setNullSelectionItemId(EMPTY);
          return select;
      }
  
      @Override
      public void setPropertyDataSourceAndDefaultValue(Property property) {
          super.setPropertyDataSourceAndDefaultValue(property);
  
         if (property.getValue() == null || property.getValue().equals(BROWSER_TIMEZONE)) {
             // sanity check — make sure there's a first value up for grabs
             if (select.getItemIds() != null && !select.getItemIds().isEmpty()) {
                 property.setValue(select.getItemIds().iterator().next());
             }
         }
     }
 
     @Override
     public List<SelectFieldOptionDefinition> getOptions() {
         final List<SelectFieldOptionDefinition> options = new ArrayList<>();
 
         TimeZone defaultTimeZone = TimeZone.getDefault();
         String defaultLabel = i18n.translate("ui-admincentral.editUserProfile.preferences.timezone.default", defaultTimeZone.getDisplayName(context.getLocale()));
         SelectFieldOptionDefinition defaultOption = new SelectFieldOptionDefinition();
         defaultOption.setName("default");
         defaultOption.setValue(EMPTY);
         defaultOption.setLabel(defaultLabel);
         options.add(defaultOption);
 
         for (String timeZoneStr : TimeZone.getAvailableIDs()) {
             SelectFieldOptionDefinition option = new SelectFieldOptionDefinition();
             TimeZone timeZone = TimeZone.getTimeZone(timeZoneStr);
             option.setValue(timeZoneStr);
             option.setLabel(timeZoneStr + " (" + timeZone.getDisplayName(false, TimeZone.LONG, context.getLocale()) + ")");
             options.add(option);
         }
         return options;
     }
 
     /**
      * Definition for {@link TimeZoneFieldFactory}.
      */
     public static class Definition extends SelectFieldDefinition {
         public Definition() {
             setSortOptions(false); // We want to have the default timezone at top
             setFilteringMode(FilteringMode.CONTAINS);
             setTextInputAllowed(true);
         }
     }
 }