gvSIG projects pool

/*

 * gvSIG. Desktop Geographic Information System.

 * 

 * Copyright (C) 2007-2020 gvSIG Association.

 * 

 * This program is free software; you can redistribute it and/or

 * modify it under the terms of the GNU General Public License

 * as published by the Free Software Foundation; either version 3

 * of the License, or (at your option) any later version.

 * 

 * This program is distributed in the hope that it will be useful,

 * but WITHOUT ANY WARRANTY; without even the implied warranty of

 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

 * GNU General Public License for more details.

 * 

 * You should have received a copy of the GNU General Public License 

 * along with this program. If not, see <https://www.gnu.org/licenses/>. 

 * 

 * For any additional information, do not hesitate to contact us

 * at info AT gvsig.com, or visit our website www.gvsig.com.

 */

package org.gvsig.vcsgis.swing.impl.checkout;

import java.awt.event.ActionEvent;

import javax.swing.ComboBoxModel;

import javax.swing.JComponent;

import javax.swing.SwingUtilities;

import javax.swing.event.ChangeEvent;

import org.apache.commons.lang3.StringUtils;

import org.gvsig.fmap.dal.feature.FeatureStore;

import org.gvsig.tools.ToolsLocator;

import org.gvsig.tools.dispose.DisposeUtils;

import org.gvsig.tools.i18n.I18nManager;

import org.gvsig.tools.swing.api.Component;

import org.gvsig.tools.swing.api.ToolsSwingLocator;

import org.gvsig.tools.swing.api.ToolsSwingManager;

import org.gvsig.tools.swing.api.ToolsSwingUtils;

import org.gvsig.tools.swing.api.pickercontroller.PickerController;

import org.gvsig.tools.swing.api.task.TaskStatusController;

import org.gvsig.tools.swing.api.task.TaskStatusSwingManager;

import org.gvsig.tools.swing.api.windowmanager.Dialog;

import org.gvsig.tools.swing.api.windowmanager.WindowManager_v2;

import org.gvsig.tools.util.LabeledValue;

import org.gvsig.vcsgis.lib.VCSGisEntity;

import static org.gvsig.vcsgis.lib.VCSGisManager.ERR_CANT_CHECKOUT;

import static org.gvsig.vcsgis.lib.VCSGisManager.ERR_OK;

import org.gvsig.vcsgis.lib.VCSGisRevision;

import org.gvsig.vcsgis.lib.VCSGisRuntimeException;

import org.gvsig.vcsgis.lib.workspace.VCSGisWorkspace;

import org.gvsig.vcsgis.swing.VCSGisJCheckout;

import org.gvsig.vcsgis.swing.VCSGisSwingLocator;

import org.gvsig.vcsgis.swing.VCSGisSwingManager;

import org.gvsig.vcsgis.swing.VCSGisSwingServices;

import org.gvsig.vcsgis.swing.VCSGisEntitySelectorController;

import static org.gvsig.vcsgis.swing.VCSGisEntitySelectorController.ACTION_BEGIN_PROCESSING_ID;

import static org.gvsig.vcsgis.swing.VCSGisEntitySelectorController.ACTION_END_PROCESSING_ID;

import static org.gvsig.vcsgis.swing.VCSGisEntitySelectorController.ACTION_RELOAD_ID;

import static org.gvsig.vcsgis.swing.VCSGisEntitySelectorController.ACTION_SELECT_ID;

import static org.gvsig.vcsgis.swing.VCSGisEntitySelectorController.REMOTE_ENTITIES;

import static org.gvsig.vcsgis.swing.impl.VCSGisSwingCommons.notInSwingThreadInvokeLater;

import static org.gvsig.vcsgis.swing.impl.VCSGisSwingCommons.refreshDocument;

import static org.gvsig.vcsgis.swing.impl.VCSGisSwingCommons.showAuthenticationErrors;

import static org.gvsig.vcsgis.swing.impl.VCSGisSwingCommons.showAuthenticationRequiredMessage;

import static org.gvsig.vcsgis.swing.impl.VCSGisSwingManagerImpl.ICON_GROUP_NAME;

import static org.gvsig.vcsgis.swing.impl.VCSGisSwingManagerImpl.ICON_PROVIDER_NAME;

import static org.gvsig.vcsgis.swing.impl.VCSGisSwingManagerImpl.registerIcons;

import org.gvsig.vcsgis.swing.impl.revisions.VCSGisRevisionPickerControllerImpl;

import org.slf4j.LoggerFactory;

/**

 *

 * @author gvSIG Team

 */

public class VCSGisJCheckoutImpl extends VCSGisJCheckoutView

        implements Component, VCSGisJCheckout {

    private static final org.slf4j.Logger LOGGER = LoggerFactory.getLogger(VCSGisJCheckoutImpl.class);

    private Dialog dialog;

    private boolean processing;

    private PickerController<VCSGisWorkspace> workspacePicker;

    private TaskStatusController taskStatusController;

    private VCSGisRevisionPickerControllerImpl revisionPicker;

    private VCSGisEntitySelectorController entitySelector;

    public VCSGisJCheckoutImpl() {

        processing = false;

        translate();

        initComponents();

    }

    private void initComponents() {

        TaskStatusSwingManager taskStatusManager = ToolsSwingLocator.getTaskStatusSwingManager();

        VCSGisSwingManager swingManager = VCSGisSwingLocator.getVCSGisSwingManager();

        VCSGisSwingServices services = swingManager.getDefaultServices();

        this.entitySelector = VCSGisSwingLocator.getVCSGisSwingManager().createEntitySelectorController(lstTables, txtFilter, btnTable);

        this.entitySelector.setFilter(REMOTE_ENTITIES);

        this.entitySelector.setViewFilter(REMOTE_ENTITIES);

        this.entitySelector.setChecksEnabled(false);

        this.entitySelector.addActionListener((ActionEvent e) -> {

            switch(e.getID()){

                case ACTION_RELOAD_ID:

                case ACTION_BEGIN_PROCESSING_ID:

                case ACTION_END_PROCESSING_ID:

                    doUpdateComponents();

                    break;

                case ACTION_SELECT_ID:

                    doChangeTable();

                    break;

            }

        });

        this.entitySelector.addChangeListener((ChangeEvent e) -> {

            doUpdateComponents();

        });

        this.taskStatusController = taskStatusManager.createTaskStatusController(

                this.lblStatusTitle,

                this.lblStatusMessages,

                this.pbStatus

        );

        this.taskStatusController.setShowCancelButton(false);

        this.taskStatusController.setShowRemoveTaskButton(false);

        this.taskStatusController.bind(ToolsLocator.getTaskStatusManager());

        SwingUtilities.invokeLater(() -> {this.setVisibleStatus(false); });

        this.workspacePicker = swingManager.createWorkspacePickerController(

                cboWorkspaces,

                btnInitWorkspace

        );

        this.workspacePicker.addChangeListener((ChangeEvent e) -> {

            doChangeWorkspace();

            doUpdateComponents();

        });

        this.revisionPicker = new VCSGisRevisionPickerControllerImpl(txtRevision, btnRevision);

        ComboBoxModel<LabeledValue> viewDocumentsModel = services.getViewDocumentsComboBoxModel();

        cboView.setModel(viewDocumentsModel);

        cboView.addActionListener((ActionEvent e) -> {

            doUpdateComponents();

        });

        this.rdbDontAddToProject.addActionListener((ActionEvent e) -> {

            doUpdateComponents();

        });

        this.rdbAddLayerToView.addActionListener((ActionEvent e) -> {

            doUpdateComponents();

        });

        this.rdbAddTableToProject.addActionListener((ActionEvent e) -> {

            doUpdateComponents();

        });

        this.chkOverwriteTable.addActionListener((ActionEvent e) -> {

            doUpdateComponents();

        });

        showMessage(" ", null);

        ToolsSwingUtils.ensureRowsCols(this, 16, 60);

    }

    @Override

    public JComponent asJComponent() {

        return this;

    }

    public void setVisibleStatus(boolean visible) {

        if( notInSwingThreadInvokeLater(() -> {setVisibleStatus(visible);}) ) {

            return;

        }

        this.lblStatusTitle.setVisible(visible);

        this.pbStatus.setVisible(visible);

        this.lblStatusMessages.setVisible(true);

    }

    @Override

    public void setDialog(Dialog dialog) {

        this.dialog = dialog;

        this.doUpdateComponents();

    }

    private void doChangeWorkspace() {

        try {

            VCSGisWorkspace ws = this.getWorkspace();

            if (ws == null) {

                this.entitySelector.setWorkspace(ws);

                this.revisionPicker.setWorkspace(ws);

                return;

            }

            if (ws.authenticate(null)) {

                this.entitySelector.setWorkspace(ws);

                this.revisionPicker.setWorkspace(ws);

                return;

            }

            showAuthenticationRequiredMessage("_VCS_Checkout");

            this.workspacePicker.set(null);

            doChangeWorkspace();

        } catch (VCSGisRuntimeException e1) {

            LOGGER.warn("Can't set workspace.", e1);

            if (showAuthenticationErrors("_VCS_Checkout", e1)) {

                this.workspacePicker.set(null);

                doChangeWorkspace();

            }

        } catch (Exception e2) {

            LOGGER.warn("Can't set workspace.", e2);

        }

    }

    @Override

    public VCSGisWorkspace getWorkspace() {

        return this.workspacePicker.get();

    }

    private void doUpdateComponents() {

        if( notInSwingThreadInvokeLater(this::doUpdateComponents) ) {

            return;

        }

        try {

            boolean isProcessing = this.processing || this.entitySelector.isProcessing();

            I18nManager i18n = ToolsLocator.getI18nManager();

            VCSGisWorkspace workspace = getWorkspace();

            VCSGisEntity selectedTable = this.entitySelector.getSelectedEntity();

            boolean exists = workspace!=null && 

                    workspace.existsInWorkspace(selectedTable);

            this.chkOverwriteTable.setEnabled(!isProcessing && exists);

            boolean canCheckout = !isProcessing && 

                    workspace!=null &&

                    selectedTable != null && 

                    (!exists || this.chkOverwriteTable.isSelected());

            if (selectedTable == null || canCheckout) {

                showMessage("", null);

            } else {

                showMessage(

                        i18n.getTranslation("_The_selected_table_is_already_in_the_working_copy"),

                        i18n.getTranslation("_To_download_updated_data_use_show_changes_tool")

                );

            }

            this.revisionPicker.setEnabled(canCheckout);

            this.lblRevisions.setEnabled(canCheckout);

            this.rdbDontAddToProject.setEnabled(canCheckout);

            this.rdbAddTableToProject.setEnabled(canCheckout);

            if (canCheckout) {

                if (isLayer(selectedTable)) {

                    this.rdbAddLayerToView.setEnabled(canCheckout);

                    this.cboView.setEnabled(canCheckout && this.rdbAddLayerToView.isSelected());

                } else {

                    this.rdbAddLayerToView.setEnabled(false);

                    this.cboView.setEnabled(false);

                }

            } else {

                this.rdbAddLayerToView.setEnabled(false);

                this.cboView.setEnabled(false);

            }

            this.workspacePicker.setEnabled(!isProcessing);

            this.entitySelector.setEnabled(!isProcessing && workspace!=null );

            if (dialog != null) {

                LabeledValue selectedView = (LabeledValue) cboView.getSelectedItem();

                boolean dontAddNothing = rdbDontAddToProject.isSelected();

                boolean addLayerToView = rdbAddLayerToView.isSelected() && selectedView != null && selectedView.getValue() != null;

                boolean addTableToProject = rdbAddTableToProject.isSelected();

                this.dialog.setButtonEnabled(WindowManager_v2.BUTTON_OK,

                        canCheckout && (dontAddNothing || (addLayerToView || addTableToProject))

                );

            }

        } catch (VCSGisRuntimeException e1) {

            LOGGER.warn("Can't updating components.", e1);

            if (showAuthenticationErrors("_VCS_Checkout", e1)) {

                this.workspacePicker.set(null);

                doChangeWorkspace();

                doUpdateComponents();

            }

        } catch (Exception e2) {

            LOGGER.warn("Can't updating components.", e2);

        }

    }

    private boolean isLayer(VCSGisEntity entity) {

        return entity != null && !StringUtils.isBlank(entity.getGeometryFieldName());

    }

    @Override

    public int checkout() {

        I18nManager i18n = ToolsLocator.getI18nManager();

        setVisibleStatus(true);

        VCSGisEntity entity = entitySelector.getSelectedEntity();

        final VCSGisWorkspace workspace = this.getWorkspace();

        VCSGisRevision revision = this.revisionPicker.get();

        if (workspace != null && entity != null) {

            try {

                processing = true;

                doUpdateComponents();

                showMessage(i18n.getTranslation("_Processing"), null);

                int res = ERR_OK;

                if(chkOverwriteTable.isSelected()){

                    res = workspace.removeEntity(entity.getEntityCode());

                }

                if(res == ERR_OK){

                    res = workspace.checkout(

                            entity.getEntityName(),

                            (revision == null) ? null : revision.getRevisionCode()

                    );

                    VCSGisEntity lEntity = workspace.getEntity(entity.getEntityCode());

                    String resources = lEntity.getResources();

                    if(StringUtils.isNotBlank(resources)){

                        try{

                            if(!workspace.existsInWorkspace(resources)){

                                workspace.checkout(

                                        resources,

                                        null

                                );

                            }

                        } catch (Exception e){

                            LOGGER.warn("Can't checkout resources table '"+resources+"'", e);

                        }

                        workspace.getExplorer().setCustomResources(entity.getEntityName(), resources, true);

                    }

                    postCheckout(res, entity);                   

                }

                showMessage(i18n.getTranslation("_Ended_process"), null);

                return res;

            } finally {

                processing = false;

                doUpdateComponents();

            }

        }

        return ERR_CANT_CHECKOUT;

    }

    private void postCheckout(int checkoutStatus, VCSGisEntity entity) {

        if( notInSwingThreadInvokeLater(() -> {postCheckout(checkoutStatus,entity);}) ) {

            return;

        }

        VCSGisSwingManager swingManager = VCSGisSwingLocator.getVCSGisSwingManager();

        VCSGisSwingServices services = swingManager.getDefaultServices();

        final VCSGisWorkspace workspace = this.getWorkspace();

        if (checkoutStatus == ERR_OK) {

            FeatureStore store = null;

            try {

                store = workspace.getFeatureStore(entity.getEntityName());

                if (!rdbDontAddToProject.isSelected()) {

                    if (rdbAddLayerToView.isSelected()) {

                        if (isLayer(entity)) {

                            String layerName = store.getName();

                            services.addLayerToView(store, (LabeledValue) cboView.getSelectedItem(), layerName);

                        }

                    }

                    if (rdbAddTableToProject.isSelected()) {

                        services.addTableToProject(workspace, store);

                    }

                }

                if (chkOverwriteTable.isSelected()) {

                    refreshDocument(store);

                }

            } finally {

                DisposeUtils.disposeQuietly(store);

            }

            this.setVisibleStatus(false);

        } else {

            this.setVisibleStatus(true);

        }

        this.doUpdateComponents();

    }

    private void showMessage(String message, String toolTipText) {

        if( notInSwingThreadInvokeLater(() -> {showMessage(message, toolTipText);}) ) {

            return;

        }

        this.lblStatusMessages.setText(message);

        this.lblStatusMessages.setToolTipText(toolTipText);

    }

    private void translate() {

        ToolsSwingManager swingManager = ToolsSwingLocator.getToolsSwingManager();

        swingManager.translate(this.lblWorkspace);

        swingManager.translate(this.lblTable);

        swingManager.translate(this.lblRevisions);

        swingManager.translate(this.rdbDontAddToProject);

        swingManager.translate(this.rdbAddLayerToView);

        swingManager.translate(this.rdbAddTableToProject);

        swingManager.translate(this.chkOverwriteTable);

    }

    @Override

    public boolean isProcessing() {

        return processing;

    }

    public static void selfRegister() {

        String[][] iconsInfo = new String[][]{

            new String[]{ICON_PROVIDER_NAME, ICON_GROUP_NAME, "vcsgis-checkout"},};

        registerIcons(iconsInfo);

    }

    private void doChangeTable() {

        VCSGisWorkspace workspace = getWorkspace();

        VCSGisEntity selectedTable = this.entitySelector.getSelectedEntity();

        boolean isLayer = isLayer(selectedTable);

        this.rdbAddLayerToView.setSelected(isLayer && !this.rdbDontAddToProject.isSelected());

        this.rdbAddTableToProject.setSelected(!isLayer && !this.rdbDontAddToProject.isSelected());

        if(isLayer) {

            if (this.cboView.getModel().getSize() > 0) {

                this.cboView.setEnabled(true);

                if (this.cboView.getModel().getSize() == 2) {

                    this.cboView.setSelectedIndex(1);

                } else {

                    this.cboView.setSelectedIndex(0);

                }

            } else {

                this.cboView.setEnabled(false);

            }

        }

        this.revisionPicker.setEntity(selectedTable);

        this.chkOverwriteTable.setSelected(workspace!=null && workspace.existsInWorkspace(selectedTable));

        doUpdateComponents();

    }

    @Override

    public VCSGisEntity getTable() {

        return this.entitySelector.getSelectedEntity();

    }

}