/**
    * This file Copyright (c) 2019-2021 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.contentapp.action;
  
  import info.magnolia.ui.CloseHandler;
  import info.magnolia.ui.ValueContext;
  import info.magnolia.ui.api.action.ActionExecutionException;
  import info.magnolia.ui.contentapp.Datasource;
  import info.magnolia.ui.editor.EditorView;
  import info.magnolia.ui.observation.DatasourceObservation;
  
  import java.util.Collection;
  import java.util.List;
  import java.util.stream.Collectors;
  
  import javax.inject.Inject;
  
  import com.vaadin.data.BinderValidationStatus;
  import com.vaadin.data.BindingValidationStatus;
  import com.vaadin.ui.Component;
  
  import lombok.AccessLevel;
  import lombok.Getter;
  
  /**
   * Save the form view present in the context.
   */
  @Getter(AccessLevel.PROTECTED)
  public class CommitAction<T> extends CloseAction<CommitActionDefinition> {
  
      private final ValueContext<T> valueContext;
      private final EditorView<T> form;
      private final Datasource<T> datasource;
      private final DatasourceObservation.Manual datasourceObservation;
  
      @Inject
      public CommitAction(CommitActionDefinition definition, CloseHandler closeHandler, ValueContext<T> valueContext, EditorView<T> form, Datasource<T> datasource, DatasourceObservation.Manual datasourceObservation) {
          super(definition, closeHandler);
          this.valueContext = valueContext;
          this.form = form;
          this.datasource = datasource;
          this.datasourceObservation = datasourceObservation;
      }
  
      @Override
      public void execute() throws ActionExecutionException {
          if (!validateForm()) {
              return;
          }
  
          write();
  
          super.execute();
      }
  
      protected boolean validateForm() {
          List<BindingValidationStatus<?>> bindingValidationErrors = getBindingValidationErrors();
  
          // If there are any validation errors, focus on the first focusable parent and return
          if (!bindingValidationErrors.isEmpty()) {
  
              // Fetch all the form validation errors for the first locale
              for (BindingValidationStatus<?> validationStatus : bindingValidationErrors) {
                  Component field = (Component) validationStatus.getField();
                  Component parent = field.getParent();
  
                  while ((parent != null) && !(parent instanceof Component.Focusable)) {
                      parent = parent.getParent();
                 }
 
                 if (parent != null) {
                     ((Component.Focusable) parent).focus();
                     break;
                 }
             }
             return false;
         }
         return true;
     }
 
     protected List<BindingValidationStatus<?>> getBindingValidationErrors() {
         List<BinderValidationStatus<?>> validationStatuses = form.validate();
         // Flatten the list of FieldValidationErrors from both the form and the subforms
         return validationStatuses.stream()
                 .map(BinderValidationStatus::getFieldValidationErrors)
                 .flatMap(Collection::stream)
                 .collect(Collectors.toList());
     }
 
     protected void write() {
         valueContext.getSingle().ifPresent(item -> {
             form.write(item);
             datasource.commit(item);
             datasourceObservation.trigger();
         });
     }
 
 }