/**
    * 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.ui.field.factory;
  
  import info.magnolia.objectfactory.ComponentProvider;
  import info.magnolia.ui.api.i18n.I18NAuthoringSupport;
  import info.magnolia.ui.contentapp.DataFilter;
  import info.magnolia.ui.field.AbstractSelectFieldDefinition;
  import info.magnolia.ui.framework.datasource.DatasourceBundle;
  import info.magnolia.ui.framework.datasource.DatasourceSupport;
  import info.magnolia.ui.framework.datasource.components.ItemDescriber;
  import info.magnolia.ui.framework.datasource.components.SelectedItems;
  
  import java.lang.reflect.InvocationTargetException;
  import java.lang.reflect.Method;
  import java.util.Locale;
  import java.util.Optional;
  import java.util.function.Consumer;
  
  import javax.inject.Inject;
  
  import org.slf4j.Logger;
  import org.slf4j.LoggerFactory;
  
  import com.vaadin.data.HasDataProvider;
  import com.vaadin.data.HasFilterableDataProvider;
  import com.vaadin.data.HasValue;
  import com.vaadin.data.provider.DataProvider;
  import com.vaadin.ui.AbstractListing;
  import com.vaadin.ui.Component;
  import com.vaadin.ui.ItemCaptionGenerator;
  
  /**
   * Creates and initializes a selection field based on a field definition.
   *
   * @param <DEF> type of datasource definition
   * @param <D> type of definition
   * @param <T> type of select option
   * @param <F> select component type - can be a single or a multi select component
   */
  public abstract class AbstractSelectFieldFactory<DEF, D extends AbstractSelectFieldDefinition<T, DEF>, T, F extends Component & HasValue<T>> extends AbstractFieldFactory<D, T, F> {
      protected static final Logger log = LoggerFactory.getLogger(AbstractSelectFieldFactory.class);
  
      private final DatasourceBundle<DEF> dataSourceBundle;
  
      @Inject
      public AbstractSelectFieldFactory(ComponentProvider componentProvider, D definition, Locale locale, I18NAuthoringSupport i18NAuthoringSupport, DatasourceSupport datasourceSupport) {
          super(definition, componentProvider, locale, i18NAuthoringSupport);
          dataSourceBundle = Optional.ofNullable(definition.getDatasource()).map(datasourceSupport::getDatasourceBundle).orElse(null);
  
          if (dataSourceBundle == null) {
             log.info("Select definition named [{}] doesn't provide a datasource. Option values may not be available.", definition.getName());
          }
      }
  
      @Override
      public F createFieldComponent() {
          final F selectionField = createSelectionField();
  
          if (selectionField instanceof HasDataProvider) {
              getDataProvider().ifPresent(((HasDataProvider<T>) selectionField)::setDataProvider);
          }
  
          if (selectionField instanceof HasFilterableDataProvider) {
              getDataProvider().ifPresent(((HasFilterableDataProvider<T, DataFilter<DEF>>) selectionField)::setDataProvider);
          }
  
          if (selectionField instanceof AbstractListing) {
             getItemDescriber().ifPresent(describer -> {
                 final ItemCaptionGenerator<T> itemCaptionGenerator = item -> describer.describe(SelectedItems.of((T) item));
                 accessItemCaptionGeneratorSetter(selectionField).accept(itemCaptionGenerator);
             });
         }
 
         //TODO icon generator
         return selectionField;
     }
 
     /**
      * Used to initialize the desired subclass of AbstractSelect field component. Subclasses must override this method.
      */
     abstract protected F createSelectionField();
 
     protected Optional<? extends ItemDescriber> getItemDescriber() {
         return Optional.ofNullable(dataSourceBundle)
                 .flatMap(dsb -> dsb.lookup(ItemDescriber.class, getDefinition().getDatasource()));
     }
 
     protected Optional<? extends DataProvider> getDataProvider() {
         return Optional.ofNullable(dataSourceBundle)
                 .flatMap(bundle -> bundle.lookup(DataProvider.class, getDefinition().getDatasource()))
                 // wrap the data provider in a filterable one
                 // value is typically a string used to search options, e.g. in a combo box.
                 // We convert it to a DataFilter cause that's the object data provider will eventually use for filtering
                 .map(dataProvider -> dataProvider.withConvertedFilter(this::createDataFilter));
     }
 
     private DataFilter<DEF> createDataFilter(Object value) {
         final DataFilter<DEF> filter = new DataFilter<>();
         filter.setValue(value);
         filter.setFilteringMode(getDefinition().getFilteringMode());
         return filter;
     }
 
     // unfortunately AbstractSingleSelect#setItemCaptionGenerator, unlike AbstractMultiSelect, is not public
     // see also https://github.com/vaadin/framework/issues/10611
     private Consumer<ItemCaptionGenerator<T>> accessItemCaptionGeneratorSetter(Object field) {
         try {
             final Method method = field.getClass().getMethod("setItemCaptionGenerator", ItemCaptionGenerator.class);
             method.setAccessible(true);
             return itemCaptionGenerator -> {
                 try {
                     method.invoke(field, itemCaptionGenerator);
                 } catch (IllegalAccessException | InvocationTargetException e) {
                     log.error("An error occurred while trying to invoke method", e);
                 }
             };
         } catch (NoSuchMethodException e) {
             log.error("An error occurred while trying to access method", e);
             return itemCaptionGenerator -> {};
         }
     }
 }