EDIT

/**

* Copyright (C) 2018 EDIT

* European Distributed Institute of Taxonomy

* http://www.e-taxonomy.eu

*

* The contents of this file are subject to the Mozilla Public License Version 1.1

* See LICENSE.TXT at the top of this package for the full license terms.

*/

package eu.etaxonomy.cdm.vaadin.view.name;

import java.util.ArrayList;

import java.util.Arrays;

import java.util.EnumSet;

import java.util.HashSet;

import java.util.List;

import java.util.Optional;

import java.util.UUID;

import java.util.stream.Collectors;

import org.apache.log4j.Logger;

import org.hibernate.criterion.Restrictions;

import org.springframework.beans.factory.annotation.Autowired;

import org.springframework.context.annotation.Scope;

import org.vaadin.spring.events.annotation.EventBusListenerMethod;

import com.vaadin.data.util.BeanItemContainer;

import com.vaadin.spring.annotation.SpringComponent;

import eu.etaxonomy.cdm.api.service.DeleteResult;

import eu.etaxonomy.cdm.api.service.IService;

import eu.etaxonomy.cdm.api.service.registration.IRegistrationWorkingSetService;

import eu.etaxonomy.cdm.api.service.registration.RegistrationWorkingSetService;

import eu.etaxonomy.cdm.format.reference.ReferenceEllypsisFormatter;

import eu.etaxonomy.cdm.format.reference.ReferenceEllypsisFormatter.LabelType;

import eu.etaxonomy.cdm.model.common.Annotation;

import eu.etaxonomy.cdm.model.common.AnnotationType;

import eu.etaxonomy.cdm.model.name.NameTypeDesignation;

import eu.etaxonomy.cdm.model.name.NameTypeDesignationStatus;

import eu.etaxonomy.cdm.model.name.TaxonName;

import eu.etaxonomy.cdm.model.permission.CRUD;

import eu.etaxonomy.cdm.model.reference.NamedSource;

import eu.etaxonomy.cdm.model.reference.NamedSourceBase;

import eu.etaxonomy.cdm.model.reference.Reference;

import eu.etaxonomy.cdm.model.reference.ReferenceFactory;

import eu.etaxonomy.cdm.model.reference.ReferenceType;

import eu.etaxonomy.cdm.persistence.dao.initializer.EntityInitStrategy;

import eu.etaxonomy.cdm.service.CdmFilterablePagingProvider;

import eu.etaxonomy.cdm.service.CdmStore;

import eu.etaxonomy.cdm.service.UserHelperAccess;

import eu.etaxonomy.cdm.vaadin.event.EditorActionTypeFilter;

import eu.etaxonomy.cdm.vaadin.event.EntityChangeEvent;

import eu.etaxonomy.cdm.vaadin.event.EntityChangeEvent.Type;

import eu.etaxonomy.cdm.vaadin.event.ReferenceEditorAction;

import eu.etaxonomy.cdm.vaadin.event.TaxonNameEditorAction;

import eu.etaxonomy.cdm.vaadin.event.ToOneRelatedEntityButtonUpdater;

import eu.etaxonomy.cdm.vaadin.event.ToOneRelatedEntityReloader;

import eu.etaxonomy.cdm.vaadin.ui.RegistrationUIDefaults;

import eu.etaxonomy.cdm.vaadin.ui.config.TaxonNamePopupEditorConfig;

import eu.etaxonomy.cdm.vaadin.util.ReferenceEllypsisCaptionGenerator;

import eu.etaxonomy.cdm.vaadin.view.reference.ReferencePopupEditor;

import eu.etaxonomy.cdm.vaadin.view.reference.RegistrationUiReferenceEditorFormConfigurator;

import eu.etaxonomy.vaadin.mvp.AbstractCdmEditorPresenter;

import eu.etaxonomy.vaadin.mvp.AbstractView;

import eu.etaxonomy.vaadin.mvp.BeanInstantiator;

import eu.etaxonomy.vaadin.mvp.BoundField;

import eu.etaxonomy.vaadin.ui.view.PopupView;

/**

 * @author a.kohlbecker

 * @since Jan 26, 2018

 *

 */

@SpringComponent

@Scope("prototype")

public class NameTypeDesignationPresenter

        extends AbstractCdmEditorPresenter<NameTypeDesignation, NameTypeDesignationEditorView> {

    private static final long serialVersionUID = 896305051895903033L;

    public static final Logger logger = Logger.getLogger(SpecimenTypeDesignationWorkingsetEditorPresenter.class);

    @Autowired

    private IRegistrationWorkingSetService registrationWorkingSetService;

    HashSet<TaxonName> typifiedNamesAsLoaded;

    private TaxonName typifiedNameInContext;

    /**

     * The unit of publication in which the type designation has been published.

     * This may be any type listed in {@link RegistrationUIDefaults#NOMECLATURAL_PUBLICATION_UNIT_TYPES}

     * but never a {@link ReferenceType#Section}

     */

    private NamedSourceBase publishedUnit;

    protected static BeanInstantiator<NameTypeDesignation> defaultBeanInstantiator = new BeanInstantiator<NameTypeDesignation>() {

        @Override

        public NameTypeDesignation createNewBean() {

            return NameTypeDesignation.NewInstance();

        }

    };

    private CdmFilterablePagingProvider<Reference,Reference> referencePagingProvider;

    private BeanInstantiator<Reference> newReferenceInstantiator;

    @Override

    protected BeanInstantiator<NameTypeDesignation> defaultBeanInstantiator(){

       return defaultBeanInstantiator;

    }

    @Override

    protected NameTypeDesignation loadBeanById(Object identifier) {

        NameTypeDesignation bean;

        NameTypeDesignationWorkingsetIds idset = (NameTypeDesignationWorkingsetIds)identifier;

        if(idset.isForNewTypeDesignation()) {

            Reference reference = getRepo().getReferenceService().load(idset.getPublishedUnitUuid());

            try {

                setPublishedUnit(NamedSource.NewPrimarySourceInstance(reference, null));

            } catch(Exception e) {

                throw new RuntimeException("Reference of invalid type passed via NameTypeDesignationWorkingsetIds as publishedUnitUuid ", e);

            }

            EntityInitStrategy initstrategy = RegistrationWorkingSetService.NAME_INIT_STRATEGY

                    .clone()

                    .extend("typeDesignations", RegistrationWorkingSetService.TYPEDESIGNATION_INIT_STRATEGY, true);

            typifiedNameInContext = getRepo().getNameService().load(idset.getTypifiedNameUuid(), initstrategy.getPropertyPaths());

            bean = super.loadBeanById(null);

        } else {

            bean = super.loadBeanById(idset.getBaseEntityRef().getUuid());

            // TODO prevent from errors due to inconsistent data, two options:

            // 1. handle error condition here

            // 2. always set typifiedNameUuid in NameTypeDesignationWorkingsetIds

            typifiedNameInContext = bean.getTypifiedNames().iterator().next();

            try {

                setPublishedUnit(bean.getTypifiedNames().iterator().next().getNomenclaturalSource());

            } catch (Exception e) {

                // FIXME report error state instead

                logger.error("Error on finding published unit in " + bean, e);

            }

        }

        Reference typifiedNameNomRef = typifiedNameInContext.getNomenclaturalReference();

        while(typifiedNameNomRef.getType().equals(ReferenceType.Section)

                && typifiedNameNomRef.getInReference() != null) {

            typifiedNameNomRef = typifiedNameNomRef.getInReference();

        }

        getView().setInTypedesignationOnlyAct(Optional.of(typifiedNameNomRef != null && !typifiedNameNomRef.equals(getPublishedUnit().getCitation())));

        if (getPublishedUnit() != null) {

            // reduce available references to those which are sections of

            // the publicationUnit and the publishedUnit itself

            referencePagingProvider.getCriteria()

                    .add(Restrictions.or(

                            Restrictions.and(

                                    Restrictions.eq("inReference", getPublishedUnit().getCitation()),

                                    Restrictions.eq("type", ReferenceType.Section)),

                            Restrictions.idEq(publishedUnit.getCitation().getId()))

                         );

            // new Reference only a sub sections of the publishedUnit

            newReferenceInstantiator = new BeanInstantiator<Reference>() {

                @Override

                public Reference createNewBean() {

                    Reference newRef = ReferenceFactory.newSection();

                    Reference reference = getRepo().getReferenceService().load(

                            getPublishedUnit().getCitation().getUuid(),

                            ReferenceEllypsisFormatter.INIT_STRATEGY

                            );

                    newRef.setInReference(reference);

                    return newRef;

                }

            };

        }

        getView().getTypeStatusSelect().setContainerDataSource(provideTypeStatusTermItemContainer());

        return bean;

    }

    @Override

    protected NameTypeDesignation loadCdmEntity(UUID uuid) {

        EntityInitStrategy initStrategy = new EntityInitStrategy(Arrays.asList(new String []{

                "$",

                "annotations.*", // * is needed as log as we are using a table in FilterableAnnotationsField

                "typifiedNames.typeDesignations", // important !!

                "typifiedNames.nomenclaturalSource.citation",

                "typeName.$",

                "source.citation",

                "source.annotations",

                "source.markers",

                "source.links",

                "designationSource.citation",

                "designationSource.annotations",

                "designationSource.markers",

                "designationSource.links",

                }

        ));

        initStrategy.extend("typifiedNames.nomenclaturalSource.citation", ReferenceEllypsisFormatter.INIT_STRATEGY, false);

        initStrategy.extend("citation", ReferenceEllypsisFormatter.INIT_STRATEGY, false);

        NameTypeDesignation typeDesignation;

        if(uuid != null){

            typeDesignation = (NameTypeDesignation) getRepo().getNameService().loadTypeDesignation(uuid, initStrategy.getPropertyPaths());

        } else {

            typeDesignation = createNewBean();

        }

        typifiedNamesAsLoaded = new HashSet<>(typeDesignation.getTypifiedNames());

        return typeDesignation;

    }

    protected BeanItemContainer<NameTypeDesignationStatus> provideTypeStatusTermItemContainer() {

        BeanItemContainer<NameTypeDesignationStatus> container = cdmBeanItemContainerFactory.buildBeanItemContainer(NameTypeDesignationStatus.class);

        List<NameTypeDesignationStatus> filteredItems = container.getItemIds().stream().filter(tsb ->

                    getView().checkInTypeDesignationOnlyAct()

                    || tsb.hasDesignationSource() == true

                )

                .collect(Collectors.toList());

        container.removeAllItems();

        container.addAll(filteredItems);

        return container;

    }

    @Override

    public void handleViewEntered() {

        getView().getTypeStatusSelect().setContainerDataSource(cdmBeanItemContainerFactory.buildBeanItemContainer(NameTypeDesignationStatus.class));

        getView().getTypeStatusSelect().setItemCaptionPropertyId("description");

        getView().getTypeStatusSelect().setNullSelectionAllowed(true);

        getView().getDesignationReferenceCombobox().getSelect().setCaptionGenerator(

                new ReferenceEllypsisCaptionGenerator(LabelType.BIBLIOGRAPHIC, getView().getDesignationReferenceCombobox().getSelect())

                );

        referencePagingProvider = pagingProviderFactory.referencePagingProvider();

        getView().getDesignationReferenceCombobox().loadFrom(referencePagingProvider, referencePagingProvider, referencePagingProvider.getPageSize());

        getView().getDesignationReferenceCombobox().setNestedButtonStateUpdater(new ToOneRelatedEntityButtonUpdater<Reference>(getView().getDesignationReferenceCombobox()));

        getView().getDesignationReferenceCombobox().getSelect().addValueChangeListener(new ToOneRelatedEntityReloader<>(getView().getDesignationReferenceCombobox(), this));

        CdmFilterablePagingProvider<TaxonName,TaxonName> namePagingProvider = pagingProviderFactory.taxonNamesWithoutOrthophicIncorrect();

        getView().getTypeNameField().loadFrom(namePagingProvider, namePagingProvider, namePagingProvider.getPageSize());

        getView().getTypeNameField().setNestedButtonStateUpdater(new ToOneRelatedEntityButtonUpdater<TaxonName>(getView().getTypeNameField()));

        getView().getTypeNameField().getSelect().addValueChangeListener(new ToOneRelatedEntityReloader<>(getView().getTypeNameField(), this));

        getView().getTypifiedNamesComboboxSelect().setPagingProviders(namePagingProvider, namePagingProvider, namePagingProvider.getPageSize(), this);

        getView().getAnnotationsField().setAnnotationTypeItemContainer(cdmBeanItemContainerFactory.buildVocabularyTermsItemContainer(

                AnnotationType.EDITORIAL().getVocabulary().getUuid()));

    }

    @Override

    protected void guaranteePerEntityCRUDPermissions(UUID identifier) {

        if(crud != null){

            newAuthorityCreated = UserHelperAccess.userHelper().createAuthorityForCurrentUser(NameTypeDesignation.class, identifier, crud, null);

        }

    }

    @Override

    protected void guaranteePerEntityCRUDPermissions(NameTypeDesignation bean) {

        // TODO Auto-generated method stub

    }

    @Override

    protected IService<NameTypeDesignation> getService() {

        // No TypeDesignationService :( so I need override the generic save and delete methods

        return null;

    }

    @Override

    protected void deleteBean(NameTypeDesignation bean){

        // deleteTypedesignation(uuid, uuid) needs to be called so the name is loaded in the transaction of the method and is saved.

        DeleteResult deletResult = getRepo().getNameService().deleteTypeDesignation(typifiedNameInContext.getUuid(), bean.getUuid());

        if(deletResult.isOk()){

            EntityChangeEvent changeEvent = new EntityChangeEvent(bean, Type.REMOVED, (AbstractView) getView());

            viewEventBus.publish(this, changeEvent);

        } else {

            CdmStore.handleDeleteresultInError(deletResult);

        }

    }

    @Override

    protected NameTypeDesignation preSaveBean(NameTypeDesignation bean) {

        if(!bean.hasDesignationSource()) {

            bean.setDesignationSource(null); // this effectively removes the designation reference and reference detail

        }

        if(bean.isNotDesignated()) {

            // having a type name makes no sense in this case, therefore we now remove it now

            bean.setTypeName(null);

        }

        // the typifiedNames can only be set on the name side, so we need to

        // handle changes explicitly here

        HashSet<TaxonName> typifiedNames = new HashSet<>(bean.getTypifiedNames());

        // handle adds

        for(TaxonName name : typifiedNames){

            if(name == null){

                throw new NullPointerException("typifiedName must not be null");

            }

            if(!name.getTypeDesignations().contains(bean)){

                name.addTypeDesignation(bean, false);

            }

        }

        // handle removed

        for(TaxonName name : typifiedNamesAsLoaded){

            if(!typifiedNames.contains(name)){

                name.removeTypeDesignation(bean);

            }

            // FIXME do we need to save the names here or is the delete cascaded from the typedesignation to the name?

        }

        // handle annotation changes

        List<Annotation> annotations = getView().getAnnotationsField().getValue();

        List<Annotation> currentAnnotations = new ArrayList<>(bean.getAnnotations());

        List<Annotation> annotationsSeen = new ArrayList<>();

        for(Annotation a : annotations){

            if(a == null){

                continue;

            }

            if(!currentAnnotations.contains(a)){

                bean.addAnnotation(a);

            }

            annotationsSeen.add(a);

        }

        for(Annotation a : currentAnnotations){

            if(!annotationsSeen.contains(a)){

                bean.removeAnnotation(a);

            }

        }

        return bean;

    }

    @EventBusListenerMethod(filter = EditorActionTypeFilter.Add.class)

    public void onTaxonNameEditorActionAdd(TaxonNameEditorAction action){

        if(!isFromOwnView(action)){

            return;

        }

        TaxonNamePopupEditor typeNamePopup = openPopupEditor(TaxonNamePopupEditor.class, action);

        typeNamePopup.grantToCurrentUser(EnumSet.of(CRUD.UPDATE, CRUD.DELETE));

        typeNamePopup.withDeleteButton(true);

        TaxonNamePopupEditorConfig.configure(typeNamePopup);

        typeNamePopup.loadInEditor(null);

    }

    @EventBusListenerMethod(filter = EditorActionTypeFilter.Edit.class)

    public void onTaxonNameEditorActionEdit(TaxonNameEditorAction action){

        if(!isFromOwnView(action)){

            return;

        }

        TaxonNamePopupEditor typeNamePopup = openPopupEditor(TaxonNamePopupEditor.class, action);

        typeNamePopup.grantToCurrentUser(EnumSet.of(CRUD.UPDATE, CRUD.DELETE));

        typeNamePopup.withDeleteButton(true);

        TaxonNamePopupEditorConfig.configure(typeNamePopup);

        typeNamePopup.loadInEditor(action.getEntityUuid());

    }

    @EventBusListenerMethod(filter = EditorActionTypeFilter.Add.class)

    public void onReferenceEditorActionAdd(ReferenceEditorAction event) {

        if (getView() == null || event.getSourceView() != getView()) {

            return;

        }

        ReferencePopupEditor referenceEditorPopup = openPopupEditor(ReferencePopupEditor.class, event);

        referenceEditorPopup.grantToCurrentUser(EnumSet.of(CRUD.UPDATE, CRUD.DELETE));

        referenceEditorPopup.withDeleteButton(true);

        RegistrationUiReferenceEditorFormConfigurator

            .create(newReferenceInstantiator != null)

            .configure(referenceEditorPopup, newReferenceInstantiator);

        referenceEditorPopup.loadInEditor(null);

    }

    @EventBusListenerMethod(filter = EditorActionTypeFilter.Edit.class)

    public void onReferenceEditorActionEdit(ReferenceEditorAction event) {

        if (!isFromOwnView(event)) {

            return;

        }

        ReferencePopupEditor referenceEditorPopup = openPopupEditor(ReferencePopupEditor.class, event);

        referenceEditorPopup.withDeleteButton(true);

        // TODO this should be configurable per UI -

        // RegistrationUiReferenceEditorFormConfigurator as spring bean,

        // different spring profiles

        // see also similar methods in TaxonName and SpecimenTypeDesigationEditors

        RegistrationUiReferenceEditorFormConfigurator

            .create(newReferenceInstantiator != null)

            .configure(referenceEditorPopup, newReferenceInstantiator);

        referenceEditorPopup.loadInEditor(event.getEntityUuid());

    }

    @EventBusListenerMethod

    public void onEntityChangeEvent(EntityChangeEvent<?>event){

        BoundField boundTargetField = boundTargetField((PopupView) event.getSourceView());

        if(boundTargetField != null){

            if(boundTargetField.matchesPropertyIdPath("typeName")){

                if(event.isCreateOrModifiedType()){

                    getCache().load(event.getEntity());

                    if(event.isCreatedType()){

                        getView().getTypeNameField().setValue((TaxonName) event.getEntity());

                    } else {

                        getView().getTypeNameField().reload();

                    }

                }

                if(event.isRemovedType()){

                    getView().getTypeNameField().selectNewItem(null);

                }

            }

        }

    }

    /**

     * @return

     *  the {@link #publishedUnit}

     */

    public NamedSourceBase getPublishedUnit() {

        return publishedUnit;

    }

    /**

     * @param publishedUnit

     *  The unit of publication in which the type designation has been published.

     *  This may be any type listed in {@link RegistrationUIDefaults#NOMECLATURAL_PUBLICATION_UNIT_TYPES}

     */

    protected void setPublishedUnit(NamedSourceBase publishedUnit) throws Exception {

        if(publishedUnit == null) {

            throw new NullPointerException();

        }

        if(publishedUnit.getCitation() == null) {

            throw new NullPointerException("The citation of the published unit must not be null.");

        }

        if(!RegistrationUIDefaults.NOMECLATURAL_PUBLICATION_UNIT_TYPES.contains(publishedUnit.getCitation().getType())) {

            throw new Exception("The referrence type '"  + publishedUnit.getType() + "'is not allowed for publishedUnit.");

        }

        this.publishedUnit = publishedUnit;

    }

}