EDIT

/**

* Copyright (C) 2017 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.taxeditor.editor.descriptiveDataSet;

import java.util.ArrayList;

import java.util.Arrays;

import java.util.Collection;

import java.util.Collections;

import java.util.HashSet;

import java.util.Iterator;

import java.util.List;

import java.util.Map;

import java.util.Set;

import java.util.UUID;

import javax.annotation.PostConstruct;

import javax.annotation.PreDestroy;

import javax.inject.Inject;

import javax.inject.Named;

import org.eclipse.core.runtime.IProgressMonitor;

import org.eclipse.e4.core.contexts.ContextInjectionFactory;

import org.eclipse.e4.core.contexts.IEclipseContext;

import org.eclipse.e4.ui.di.Focus;

import org.eclipse.e4.ui.di.Persist;

import org.eclipse.e4.ui.model.application.ui.MDirtyable;

import org.eclipse.e4.ui.services.EMenuService;

import org.eclipse.e4.ui.services.IServiceConstants;

import org.eclipse.e4.ui.workbench.modeling.ESelectionService;

import org.eclipse.jface.dialogs.Dialog;

import org.eclipse.jface.util.LocalSelectionTransfer;

import org.eclipse.jface.viewers.IStructuredSelection;

import org.eclipse.jface.viewers.StructuredSelection;

import org.eclipse.jface.viewers.StyledString.Styler;

import org.eclipse.jface.viewers.Viewer;

import org.eclipse.swt.SWT;

import org.eclipse.swt.dnd.DND;

import org.eclipse.swt.dnd.Transfer;

import org.eclipse.swt.events.FocusAdapter;

import org.eclipse.swt.events.FocusEvent;

import org.eclipse.swt.events.KeyAdapter;

import org.eclipse.swt.events.KeyEvent;

import org.eclipse.swt.events.ModifyEvent;

import org.eclipse.swt.events.ModifyListener;

import org.eclipse.swt.events.SelectionAdapter;

import org.eclipse.swt.graphics.TextStyle;

import org.eclipse.swt.widgets.Composite;

import org.eclipse.swt.widgets.Control;

import org.eclipse.swt.widgets.Display;

import org.eclipse.swt.widgets.Shell;

import eu.etaxonomy.cdm.api.conversation.ConversationHolder;

import eu.etaxonomy.cdm.api.conversation.IConversationEnabled;

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

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

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

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

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

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

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

import eu.etaxonomy.cdm.model.description.DescriptiveDataSet;

import eu.etaxonomy.cdm.model.description.FeatureTree;

import eu.etaxonomy.cdm.model.location.NamedArea;

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

import eu.etaxonomy.cdm.model.taxon.ITaxonTreeNode;

import eu.etaxonomy.cdm.model.taxon.TaxonNode;

import eu.etaxonomy.cdm.persistence.dto.TaxonNodeDto;

import eu.etaxonomy.cdm.persistence.hibernate.CdmDataChangeMap;

import eu.etaxonomy.taxeditor.editor.l10n.Messages;

import eu.etaxonomy.taxeditor.model.IDirtyMarkable;

import eu.etaxonomy.taxeditor.model.IPartContentHasDetails;

import eu.etaxonomy.taxeditor.model.IPartContentHasSupplementalData;

import eu.etaxonomy.taxeditor.model.MessagingUtils;

import eu.etaxonomy.taxeditor.preference.wizard.AreaLabelProvider;

import eu.etaxonomy.taxeditor.preference.wizard.CheckBoxTreeComposite;

import eu.etaxonomy.taxeditor.preference.wizard.DistributionContentProvider;

import eu.etaxonomy.taxeditor.session.ICdmEntitySession;

import eu.etaxonomy.taxeditor.session.ICdmEntitySessionEnabled;

import eu.etaxonomy.taxeditor.store.CdmStore;

import eu.etaxonomy.taxeditor.ui.element.CdmFormFactory;

import eu.etaxonomy.taxeditor.workbench.part.IE4SavablePart;

/**

 * Editor for configuring DescriptiveDataSets

 * @author pplitzner

 * @since Nov 21, 2017

 *

 */

public class DescriptiveDataSetEditor implements IE4SavablePart, IConversationEnabled, ICdmEntitySessionEnabled,

IPartContentHasDetails, IPartContentHasSupplementalData, IDirtyMarkable {

    private DescriptiveDataSetComposite composite;

    private ConversationHolder conversation;

    private ICdmEntitySession cdmEntitySession;

    private DescriptiveDataSet descriptiveDataSet;

    private final int dndOperations = DND.DROP_MOVE;

    @Inject

    private MDirtyable dirty;

    @Inject

    private ESelectionService selectionService;

    private ModifyListener labelModifyListener;

    @PostConstruct

    public void create(Composite parent, IEclipseContext context, @Named(IServiceConstants.ACTIVE_SHELL)Shell shell,

            EMenuService menuService){

        if (CdmStore.isActive()){

            if(conversation == null){

                conversation = CdmStore.createConversation();

            }

            if(cdmEntitySession == null){

                cdmEntitySession = CdmStore.getCurrentSessionManager().newSession(this, true);

            }

        }

        else{

            return;

        }

        CdmFormFactory cdmFormFactory = new CdmFormFactory(Display.getCurrent());

        ContextInjectionFactory.inject(cdmFormFactory, context);

        composite = new DescriptiveDataSetComposite(parent, SWT.NONE);

        labelModifyListener = new ModifyListener() {

            @Override

            public void modifyText(ModifyEvent e) {

                descriptiveDataSet.setLabel(composite.getTxt_label().getText());

                dirty.setDirty(true);

            }

        };

        composite.getRankMin().addSelectionChangedListener(event->dirty.setDirty(true));

        composite.getRankMin().setText("Select min rank...");

        composite.getRankMax().addSelectionChangedListener(event->dirty.setDirty(true));

        composite.getRankMin().setText("Select max rank...");

        composite.getBtnRemoveRankMin().addSelectionListener(new SelectionAdapter() {

            @Override

            public void widgetSelected(org.eclipse.swt.events.SelectionEvent e) {

             composite.getRankMin().setElement(null);

             dirty.setDirty(true);

            }

        });

        composite.getBtnRemoveRankMax().addSelectionListener(new SelectionAdapter() {

            @Override

            public void widgetSelected(org.eclipse.swt.events.SelectionEvent e) {

                composite.getRankMax().setElement(null);

                dirty.setDirty(true);

            }

        });

        composite.getBtnChooseArea().addSelectionListener(new SelectionAdapter() {

            @Override

            public void widgetSelected(org.eclipse.swt.events.SelectionEvent e) {

                AreasSelectionDialog areasSelectionDialog = new AreasSelectionDialog(composite.getShell(), composite.getAreas());

                areasSelectionDialog.open();

                Set<NamedArea> selectedAreas = areasSelectionDialog.getSelectedAreas();

                if(selectedAreas!=null){

                    composite.setAreas(selectedAreas);

                    dirty.setDirty(true);

                }

            }

        });

        composite.getBtnRemoveArea().addSelectionListener(new SelectionAdapter() {

            @Override

            public void widgetSelected(org.eclipse.swt.events.SelectionEvent e) {

                composite.removeArea();

                dirty.setDirty(true);

            }

        });

        composite.getFeatureTreeEditorComposite().init("Character Tree", null, null, e->selectionService.setSelection(e.getSelection()), this, null);

        //add drag'n'drop support

        Transfer[] transfers = new Transfer[] {LocalSelectionTransfer.getTransfer()};

        composite.getTaxonNodeTree().addDropSupport(dndOperations, transfers, new TaxonNodeDropAdapter(this));

        composite.getTaxonNodeTree().getTree().addKeyListener(new KeyAdapter() {

            @Override

            public void keyPressed(KeyEvent e) {

                if(e.character==SWT.DEL){

                    removeSelectedTaxonNodes();

                }

            }

        });

        //create context menu

        menuService.registerContextMenu(composite.getTaxonNodeTree().getControl(), "eu.etaxonomy.taxeditor.editor.descriptiveDataSet.DescriptiveDataSetEditor.popupmenu.specimeneditor");

    }

    public void init(UUID descriptiveDataSetUuid) {

        this.descriptiveDataSet = cdmEntitySession.remoteLoad(CdmStore.getService(IDescriptiveDataSetService.class), descriptiveDataSetUuid);

        if(descriptiveDataSet.getLabel()!=null){

            composite.getTxt_label().setText(descriptiveDataSet.getLabel());

        }

        if(descriptiveDataSet.getDescriptiveSystem()!=null){

            composite.setCharacters(descriptiveDataSet.getDescriptiveSystem());

        }

        Rank maxRank = descriptiveDataSet.getMaxRank();

        if(maxRank!=null){

            composite.setRankMax(maxRank);

        }

        Rank minRank = descriptiveDataSet.getMinRank();

        if(minRank!=null){

            composite.setRankMin(minRank);

        }

        Set<NamedArea> geoFilter = descriptiveDataSet.getGeoFilter();

        if(geoFilter!=null && !geoFilter.isEmpty()){

            composite.setAreas(geoFilter);

        }

        Set<TaxonNode> taxonSubtreeFilter = descriptiveDataSet.getTaxonSubtreeFilter();

        if(taxonSubtreeFilter!=null){

            composite.getTaxonNodeTree().setInput(taxonSubtreeFilter);

        }

        composite.getTxt_label().addModifyListener(labelModifyListener);

        composite.getTxt_label().addFocusListener(new FocusAdapter() {

            @Override

            public void focusGained(FocusEvent e) {

                super.focusGained(e);

                selectionService.setSelection(new StructuredSelection(descriptiveDataSet));

            }

        });

        selectionService.setSelection(new StructuredSelection(descriptiveDataSet));

    }

    public void addTaxonNode(TaxonNodeDto taxonNodeDto){

        TaxonNode taxonNode = cdmEntitySession.remoteLoad(CdmStore.getService(ITaxonNodeService.class), taxonNodeDto.getUuid());

        //check if node belongs to same classification

        Set<TaxonNode> taxonSubtreeFilter = descriptiveDataSet.getTaxonSubtreeFilter();

        if(taxonSubtreeFilter!=null && !taxonSubtreeFilter.isEmpty()){

            if(!taxonSubtreeFilter.iterator().next().getClassification().equals(taxonNode.getClassification())){

                MessagingUtils.warningDialog(Messages.TaxonNodeDropAdapter_CLASSIFICATIONS_NO_MATCH, this.getClass(),

                        Messages.TaxonNodeDropAdapter_CLASSIFICATIONS_NO_MATCH_MESSAGE);

                return;

            }

        }

        Viewer taxonTreeViewer = getTaxonTreeViewer();

        Object input = taxonTreeViewer.getInput();

        Collection<TaxonNode> treeNodes;

        if(input==null){

            treeNodes = new ArrayList<>();

        }

        else{

            treeNodes = (Collection<TaxonNode>) input;

        }

        treeNodes.add(taxonNode);

        taxonTreeViewer.setInput(treeNodes);

        dirty.setDirty(true);

    }

    public void removeSelectedTaxonNodes(){

        IStructuredSelection selection = (IStructuredSelection) composite.getTaxonNodeTree().getSelection();

        if(selection.toList().stream().anyMatch(object->!(object instanceof TaxonNode))){

            MessagingUtils.warningDialog(Messages.DescriptiveDataSetEditor_DELETE_FAIL_TITLE, this.getClass(), Messages.DescriptiveDataSetEditor_DELETE_FAIL_MESSAGE);

            return;

        }

        Iterator<Object> iterator = selection.iterator();

        Viewer taxonTreeViewer = getTaxonTreeViewer();

        Collection<TaxonNode> input = (Collection<TaxonNode>) taxonTreeViewer.getInput();

        while(iterator.hasNext()){

            Object next = iterator.next();

            TaxonNode taxonNode = (TaxonNode) next;

            input.remove(taxonNode);

            descriptiveDataSet.removeTaxonSubtree(taxonNode);

        }

        taxonTreeViewer.setInput(input);

        dirty.setDirty(true);

    }

    @Persist

    @Override

    public void save(IProgressMonitor monitor) {

        Set<NamedArea> areas = composite.getAreas();

        Object input = composite.getTaxonNodeTree().getInput();

        if(input!=null){

            descriptiveDataSet.setTaxonSubtreeFilter(new HashSet<>());//clear existing filter

            Collection<ITaxonTreeNode> taxonNodes = (Collection<ITaxonTreeNode>) input;

            for (ITaxonTreeNode taxonTreeNode : taxonNodes) {

                if(taxonTreeNode instanceof TaxonNode){

                    TaxonNode taxonNode = (TaxonNode)taxonTreeNode;

                    descriptiveDataSet.addTaxonSubtree(taxonNode);

                }

            }

        }

        FeatureTree characters = composite.getCharacters();

        if(characters!=null){

            //save characters because they can be modified in this editor

            characters.getDistinctFeatures().forEach(character->CdmStore.getService(ITermService.class).merge(character,true));

        }

        DefinedTermBase rankMaxSelection = composite.getRankMax().getSelection();

        Rank rankMax = null;

        if(rankMaxSelection instanceof Rank){

            rankMax = (Rank) rankMaxSelection;

        }

        DefinedTermBase rankMinSelection = composite.getRankMin().getSelection();

        Rank rankMin = null;

        if(rankMinSelection instanceof Rank){

            rankMin = (Rank) rankMinSelection;

        }

        descriptiveDataSet.setMaxRank(rankMax);

        descriptiveDataSet.setMinRank(rankMin);

        descriptiveDataSet.setDescriptiveSystem(characters);

        descriptiveDataSet.setGeoFilter(areas);

        conversation.commit();

        CdmStore.getService(IDescriptiveDataSetService.class).merge(descriptiveDataSet, true);

        dirty.setDirty(false);

    }

    @PreDestroy

    public void dispose() {

        if (conversation != null) {

            conversation.close();

            conversation = null;

        }

        if(cdmEntitySession != null) {

            cdmEntitySession.dispose();

            cdmEntitySession = null;

        }

        dirty.setDirty(false);

    }

    @Focus

    public void setFocus() {

        if(composite!=null){

            composite.setFocus();

        }

        if (getConversationHolder() != null) {

            getConversationHolder().bind();

        }

        if(cdmEntitySession != null) {

            cdmEntitySession.bind();

        }

    }

    public Viewer getTaxonTreeViewer() {

        return composite.getTaxonNodeTree();

    }

    public DescriptiveDataSet getDescriptiveDataSet() {

        return descriptiveDataSet;

    }

    @Override

    public void update(CdmDataChangeMap arg0) {

    }

    @Override

    public ICdmEntitySession getCdmEntitySession() {

        return cdmEntitySession;

    }

    @Override

    public Collection<DescriptiveDataSet> getRootEntities() {

        return Collections.singleton(descriptiveDataSet);

    }

    @Override

    public Map<Object, List<String>> getPropertyPathsMap() {

        return null;

    }

    @Override

    public ConversationHolder getConversationHolder() {

        return conversation;

    }

    @Override

    public void changed(Object element) {

        dirty.setDirty(true);

    }

    @Override

    public void forceDirty() {

        dirty.setDirty(true);

    }

    private class AreasSelectionDialog extends Dialog{

        private CheckBoxTreeComposite treeComposite;

        private Set<NamedArea> selectedAreas = new HashSet<>();

        private Collection<TermVocabulary<NamedArea>> namedAreas;

        protected AreasSelectionDialog(Shell parentShell, Set<NamedArea> selectedAreas) {

            super(parentShell);

            this.selectedAreas = selectedAreas;

            this.namedAreas = CdmStore.getService(IVocabularyService.class).findByTermType(TermType.NamedArea, null);

        }

        @Override

        protected Control createDialogArea(Composite parent) {

            Styler styler = new Styler() {

                @Override

                public void applyStyles(TextStyle textStyle) {

                    textStyle.foreground = Display.getCurrent().getSystemColor(SWT.COLOR_BLACK);

                }

            };

            treeComposite = new CheckBoxTreeComposite(parent, new DistributionContentProvider(), new AreaLabelProvider(styler), SWT.NONE);

            treeComposite.getViewer().setInput(namedAreas);

            treeComposite.getViewer().setCheckedElements(selectedAreas.toArray());

            return treeComposite;

        }

        @Override

        protected void configureShell(Shell newShell) {

            super.configureShell(newShell);

            newShell.setText("Choose areas");

        }

        @Override

        protected void okPressed() {

            selectedAreas.clear();

            selectedAreas = new HashSet(Arrays.asList(treeComposite.getViewer().getCheckedElements()));

            super.okPressed();

        }

        @Override

        protected boolean isResizable() {

            return true;

        }

        public Set<NamedArea> getSelectedAreas(){

            return selectedAreas;

        }

    }

}