RenamePresenter.java

/*******************************************************************************
 * Copyright (c) 2012-2016 Codenvy, S.A.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *   Codenvy, S.A. - initial API and implementation
 *******************************************************************************/
package org.eclipse.che.ide.ext.java.client.refactoring.rename.wizard;

import com.google.inject.Inject;
import com.google.inject.Singleton;

import org.eclipse.che.api.promises.client.Function;
import org.eclipse.che.api.promises.client.FunctionException;
import org.eclipse.che.api.promises.client.Operation;
import org.eclipse.che.api.promises.client.OperationException;
import org.eclipse.che.api.promises.client.Promise;
import org.eclipse.che.api.promises.client.PromiseError;
import org.eclipse.che.ide.api.app.AppContext;
import org.eclipse.che.ide.api.editor.EditorAgent;
import org.eclipse.che.ide.api.editor.EditorPartPresenter;
import org.eclipse.che.ide.api.notification.NotificationManager;
import org.eclipse.che.ide.dto.DtoFactory;
import org.eclipse.che.ide.ext.java.client.JavaLocalizationConstant;
import org.eclipse.che.ide.ext.java.client.project.node.JavaFileNode;
import org.eclipse.che.ide.ext.java.client.project.node.PackageNode;
import org.eclipse.che.ide.ext.java.client.projecttree.JavaSourceFolderUtil;
import org.eclipse.che.ide.ext.java.client.refactoring.RefactorInfo;
import org.eclipse.che.ide.ext.java.client.refactoring.RefactoringUpdater;
import org.eclipse.che.ide.ext.java.client.refactoring.preview.PreviewPresenter;
import org.eclipse.che.ide.ext.java.client.refactoring.rename.wizard.RenameView.ActionDelegate;
import org.eclipse.che.ide.ext.java.client.refactoring.rename.wizard.similarnames.SimilarNamesConfigurationPresenter;
import org.eclipse.che.ide.ext.java.client.refactoring.service.RefactoringServiceClient;
import org.eclipse.che.ide.ext.java.shared.dto.refactoring.ChangeCreationResult;
import org.eclipse.che.ide.ext.java.shared.dto.refactoring.CreateRenameRefactoring;
import org.eclipse.che.ide.ext.java.shared.dto.refactoring.RefactoringResult;
import org.eclipse.che.ide.ext.java.shared.dto.refactoring.RefactoringSession;
import org.eclipse.che.ide.ext.java.shared.dto.refactoring.RefactoringStatus;
import org.eclipse.che.ide.ext.java.shared.dto.refactoring.RefactoringStatusEntry;
import org.eclipse.che.ide.ext.java.shared.dto.refactoring.RenameRefactoringSession;
import org.eclipse.che.ide.ext.java.shared.dto.refactoring.RenameSettings;
import org.eclipse.che.ide.ext.java.shared.dto.refactoring.ValidateNewName;
import org.eclipse.che.ide.jseditor.client.texteditor.TextEditor;
import org.eclipse.che.ide.ui.dialogs.CancelCallback;
import org.eclipse.che.ide.ui.dialogs.ConfirmCallback;
import org.eclipse.che.ide.ui.dialogs.DialogFactory;

import java.util.List;

import static org.eclipse.che.ide.api.notification.StatusNotification.Status.FAIL;
import static org.eclipse.che.ide.ext.java.shared.dto.refactoring.CreateRenameRefactoring.RenameType.COMPILATION_UNIT;
import static org.eclipse.che.ide.ext.java.shared.dto.refactoring.CreateRenameRefactoring.RenameType.JAVA_ELEMENT;
import static org.eclipse.che.ide.ext.java.shared.dto.refactoring.CreateRenameRefactoring.RenameType.PACKAGE;
import static org.eclipse.che.ide.ext.java.shared.dto.refactoring.RefactoringStatus.INFO;
import static org.eclipse.che.ide.ext.java.shared.dto.refactoring.RefactoringStatus.OK;

/**
 * The class that manages Move panel widget.
 *
 * @author Valeriy Svydenko
 */
@Singleton
public class RenamePresenter implements ActionDelegate {
    private final RenameView                         view;
    private final SimilarNamesConfigurationPresenter similarNamesConfigurationPresenter;
    private final JavaLocalizationConstant           locale;
    private final RefactoringUpdater                 refactoringUpdater;
    private final EditorAgent                        editorAgent;
    private final NotificationManager                notificationManager;
    private final AppContext                         appContext;
    private final PreviewPresenter                   previewPresenter;
    private final DtoFactory                         dtoFactory;
    private final RefactoringServiceClient           refactorService;
    private final DialogFactory                      dialogFactory;

    private RenameRefactoringSession renameRefactoringSession;
    private RefactorInfo             refactorInfo;

    @Inject
    public RenamePresenter(RenameView view,
                           SimilarNamesConfigurationPresenter similarNamesConfigurationPresenter,
                           JavaLocalizationConstant locale,
                           EditorAgent editorAgent,
                           RefactoringUpdater refactoringUpdater,
                           AppContext appContext,
                           NotificationManager notificationManager,
                           PreviewPresenter previewPresenter,
                           RefactoringServiceClient refactorService,
                           DtoFactory dtoFactory,
                           DialogFactory dialogFactory) {
        this.view = view;
        this.similarNamesConfigurationPresenter = similarNamesConfigurationPresenter;
        this.locale = locale;
        this.refactoringUpdater = refactoringUpdater;
        this.editorAgent = editorAgent;
        this.notificationManager = notificationManager;
        this.view.setDelegate(this);
        this.appContext = appContext;
        this.previewPresenter = previewPresenter;
        this.refactorService = refactorService;
        this.dtoFactory = dtoFactory;
        this.dialogFactory = dialogFactory;
    }

    /**
     * Show Rename window with the special information.
     *
     * @param refactorInfo
     *         information about the rename operation
     */
    public void show(RefactorInfo refactorInfo) {
        this.refactorInfo = refactorInfo;
        final CreateRenameRefactoring createRenameRefactoring = createRenameRefactoringDto(refactorInfo);

        Promise<RenameRefactoringSession> createRenamePromise = refactorService.createRenameRefactoring(createRenameRefactoring);
        createRenamePromise.then(new Operation<RenameRefactoringSession>() {
            @Override
            public void apply(RenameRefactoringSession session) throws OperationException {
                show(session);
            }
        }).catchError(new Operation<PromiseError>() {
            @Override
            public void apply(PromiseError arg) throws OperationException {
                notificationManager.notify(locale.failedToRename(), arg.getMessage(), FAIL, true);
            }
        });
    }

    /**
     * Show Rename window with the special information.
     *
     * @param renameRefactoringSession
     *         data of current refactoring session
     */
    public void show(RenameRefactoringSession renameRefactoringSession) {
        this.renameRefactoringSession = renameRefactoringSession;
        prepareWizard();

        switch (renameRefactoringSession.getWizardType()) {
            case COMPILATION_UNIT:
                view.setTitle(locale.renameCompilationUnitTitle());
                view.setVisiblePatternsPanel(true);
                view.setVisibleFullQualifiedNamePanel(true);
                view.setVisibleSimilarlyVariablesPanel(true);
                break;
            case PACKAGE:
                view.setTitle(locale.renamePackageTitle());
                view.setVisiblePatternsPanel(true);
                view.setVisibleFullQualifiedNamePanel(true);
                view.setVisibleRenameSubpackagesPanel(true);
                break;
            case TYPE:
                view.setTitle(locale.renameTypeTitle());
                view.setVisiblePatternsPanel(true);
                view.setVisibleFullQualifiedNamePanel(true);
                view.setVisibleSimilarlyVariablesPanel(true);
                break;
            case FIELD:
                view.setTitle(locale.renameFieldTitle());
                view.setVisiblePatternsPanel(true);
                break;
            case ENUM_CONSTANT:
                view.setTitle(locale.renameEnumTitle());
                view.setVisiblePatternsPanel(true);
                break;
            case TYPE_PARAMETER:
                view.setTitle(locale.renameTypeVariableTitle());
                break;
            case METHOD:
                view.setTitle(locale.renameMethodTitle());
                view.setVisibleKeepOriginalPanel(true);
                break;
            case LOCAL_VARIABLE:
                view.setTitle(locale.renameLocalVariableTitle());
                break;
            default:
        }

        view.show();
    }

    /** {@inheritDoc} */
    @Override
    public void onPreviewButtonClicked() {
        showPreview();
    }

    /** {@inheritDoc} */
    @Override
    public void onAcceptButtonClicked() {
        applyChanges();
    }

    /** {@inheritDoc} */
    @Override
    public void onCancelButtonClicked() {
        EditorPartPresenter activeEditor = editorAgent.getActiveEditor();
        if (activeEditor instanceof TextEditor) {
            ((TextEditor)activeEditor).setFocus();
        }
    }

    /** {@inheritDoc} */
    @Override
    public void validateName() {
        ValidateNewName validateNewName = dtoFactory.createDto(ValidateNewName.class);
        validateNewName.setSessionId(renameRefactoringSession.getSessionId());
        validateNewName.setNewName(view.getNewName());

        refactorService.validateNewName(validateNewName).then(new Operation<RefactoringStatus>() {
            @Override
            public void apply(RefactoringStatus arg) throws OperationException {
                switch (arg.getSeverity()) {
                    case OK:
                        view.setEnableAcceptButton(true);
                        view.setEnablePreviewButton(true);
                        view.clearErrorLabel();
                        break;
                    case INFO:
                        view.setEnableAcceptButton(true);
                        view.setEnablePreviewButton(true);
                        view.showStatusMessage(arg);
                        break;
                    default:
                        view.setEnableAcceptButton(false);
                        view.setEnablePreviewButton(false);
                        view.showErrorMessage(arg);
                        break;
                }
            }
        }).catchError(new Operation<PromiseError>() {
            @Override
            public void apply(PromiseError arg) throws OperationException {
                notificationManager.notify(locale.failedToRename(), arg.getMessage(), FAIL, true);
            }
        });
    }

    private void prepareWizard() {
        view.clearErrorLabel();
        view.setOldName(renameRefactoringSession.getOldName());
        view.setVisiblePatternsPanel(false);
        view.setVisibleFullQualifiedNamePanel(false);
        view.setVisibleKeepOriginalPanel(false);
        view.setVisibleRenameSubpackagesPanel(false);
        view.setVisibleSimilarlyVariablesPanel(false);
        view.setEnableAcceptButton(false);
        view.setEnablePreviewButton(false);
    }

    private void showPreview() {
        RefactoringSession session = dtoFactory.createDto(RefactoringSession.class);
        session.setSessionId(renameRefactoringSession.getSessionId());

        prepareRenameChanges(session).then(new Operation<ChangeCreationResult>() {
            @Override
            public void apply(ChangeCreationResult arg) throws OperationException {
                if (arg.isCanShowPreviewPage() || arg.getStatus().getSeverity() <= 3) {
                    previewPresenter.show(renameRefactoringSession.getSessionId(), refactorInfo);
                    previewPresenter.setTitle(locale.renameItemTitle());
                    view.hide();
                } else {
                    view.showErrorMessage(arg.getStatus());
                }
            }
        }).catchError(new Operation<PromiseError>() {
            @Override
            public void apply(PromiseError arg) throws OperationException {
                notificationManager.notify(locale.failedToRename(), arg.getMessage(), FAIL, true);
            }
        });
    }

    private void applyChanges() {
        final RefactoringSession session = dtoFactory.createDto(RefactoringSession.class);
        session.setSessionId(renameRefactoringSession.getSessionId());

        prepareRenameChanges(session).then(new Operation<ChangeCreationResult>() {
            @Override
            public void apply(ChangeCreationResult arg) throws OperationException {
                int severityCode = arg.getStatus().getSeverity();

                switch (severityCode) {
                    case 2:
                    case 3:
                        showWarningDialog(session, arg);
                        break;
                    case 4:
                        if (!arg.isCanShowPreviewPage()) {
                            view.showErrorMessage(arg.getStatus());
                        }
                        break;
                    default:
                        applyRefactoring(session);
                }
            }
        }).catchError(new Operation<PromiseError>() {
            @Override
            public void apply(PromiseError arg) throws OperationException {
                notificationManager.notify(locale.failedToRename(), arg.getMessage(), FAIL, true);
            }
        });
    }

    private void showWarningDialog(final RefactoringSession session, ChangeCreationResult changeCreationResult) {
        List<RefactoringStatusEntry> entries = changeCreationResult.getStatus().getEntries();

        dialogFactory.createConfirmDialog(locale.warningOperationTitle(),
                                          entries.isEmpty() ? locale.warningOperationContent() : entries.get(0).getMessage(),
                                          locale.renameRename(),
                                          locale.buttonCancel(),
                                          new ConfirmCallback() {
                                              @Override
                                              public void accepted() {
                                                  applyRefactoring(session);
                                              }
                                          },
                                          new CancelCallback() {
                                              @Override
                                              public void cancelled() {
                                              }
                                          }).show();
    }

    private void applyRefactoring(RefactoringSession session) {
        refactorService.applyRefactoring(session).then(new Operation<RefactoringResult>() {
            @Override
            public void apply(RefactoringResult arg) throws OperationException {
                if (arg.getSeverity() == OK) {
                    view.hide();
                    refactoringUpdater.updateAfterRefactoring(refactorInfo, arg.getChanges());
                } else {
                    view.showErrorMessage(arg);
                }
            }
        });
    }

    private Promise<ChangeCreationResult> prepareRenameChanges(final RefactoringSession session) {
        RenameSettings renameSettings = createRenameSettingsDto(session);

        return refactorService.setRenameSettings(renameSettings).thenPromise(new Function<Void, Promise<ChangeCreationResult>>() {
            @Override
            public Promise<ChangeCreationResult> apply(Void arg) throws FunctionException {
                return refactorService.createChange(session);
            }
        });
    }

    private RenameSettings createRenameSettingsDto(RefactoringSession session) {
        RenameSettings renameSettings = dtoFactory.createDto(RenameSettings.class);
        renameSettings.setSessionId(session.getSessionId());
        renameSettings.setDelegateUpdating(view.isUpdateDelegateUpdating());
        if (view.isUpdateDelegateUpdating()) {
            renameSettings.setDeprecateDelegates(view.isUpdateMarkDeprecated());
        }
        renameSettings.setUpdateSubpackages(view.isUpdateSubpackages());
        renameSettings.setUpdateReferences(view.isUpdateReferences());
        renameSettings.setUpdateQualifiedNames(view.isUpdateQualifiedNames());
        if (view.isUpdateQualifiedNames()) {
            renameSettings.setFilePatterns(view.getFilePatterns());
        }
        renameSettings.setUpdateTextualMatches(view.isUpdateTextualOccurrences());
        renameSettings.setUpdateSimilarDeclarations(view.isUpdateSimilarlyVariables());
        if (view.isUpdateSimilarlyVariables()) {
            renameSettings.setMachStrategy(similarNamesConfigurationPresenter.getMachStrategy().getValue());
        }

        return renameSettings;
    }

    private CreateRenameRefactoring createRenameRefactoringDto(RefactorInfo refactorInfo) {
        CreateRenameRefactoring dto = dtoFactory.createDto(CreateRenameRefactoring.class);

        dto.setRefactorLightweight(false);

        if (refactorInfo == null) {
            dto.setType(JAVA_ELEMENT);
            dto.setPath(JavaSourceFolderUtil.getFQNForFile(editorAgent.getActiveEditor().getEditorInput().getFile()));
            dto.setOffset(((TextEditor)editorAgent.getActiveEditor()).getCursorOffset());
        } else {
            Object selectedElement = refactorInfo.getSelectedItems().get(0);
            if (selectedElement instanceof JavaFileNode) {
                dto.setPath(JavaSourceFolderUtil.getFQNForFile((JavaFileNode)selectedElement));
                dto.setType(COMPILATION_UNIT);
            } else if (selectedElement instanceof PackageNode) {
                dto.setPath(((PackageNode)selectedElement).getStorablePath());
                dto.setType(PACKAGE);
            }
        }

        String projectPath = appContext.getCurrentProject().getProjectConfig().getPath();
        dto.setProjectPath(projectPath);

        return dto;
    }

}