platform/vcs-impl/src/com/intellij/openapi/vcs/changes/VetoSavingCommittingDocumentsAdapter.java

   1 /*
   2  * Copyright 2000-2009 JetBrains s.r.o.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  * http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 /*
  18  * Created by IntelliJ IDEA.
  19  * User: yole
  20  * Date: 05.09.2006
  21  * Time: 20:07:21
  22  */
  23 package com.intellij.openapi.vcs.changes;
  24
  25 import com.intellij.AppTopics;
  26 import com.intellij.openapi.application.ApplicationManager;
  27 import com.intellij.openapi.components.ApplicationComponent;
  28 import com.intellij.openapi.editor.Document;
  29 import com.intellij.openapi.fileEditor.*;
  30 import com.intellij.openapi.project.Project;
  31 import com.intellij.openapi.ui.Messages;
  32 import com.intellij.openapi.util.io.FileUtil;
  33 import com.intellij.openapi.vfs.VirtualFile;
  34 import org.jetbrains.annotations.NonNls;
  35 import org.jetbrains.annotations.NotNull;
  36
  37 import java.util.ArrayList;
  38 import java.util.Collections;
  39 import java.util.List;
  40
  41 public class VetoSavingCommittingDocumentsAdapter implements ApplicationComponent, FileDocumentSynchronizationVetoListener {
  42   private static final Object SAVE_DENIED = new Object();
  43
  44   private final FileDocumentManager myFileDocumentManager;
  45
  46   public VetoSavingCommittingDocumentsAdapter(final FileDocumentManager fileDocumentManager) {
  47     myFileDocumentManager = fileDocumentManager;
  48   }
  49
  50   public void beforeDocumentSaving(Document document) throws VetoDocumentSavingException {
  51     final Object beingCommitted = document.getUserData(ChangeListManagerImpl.DOCUMENT_BEING_COMMITTED_KEY);
  52     if (beingCommitted == SAVE_DENIED) {
  53       throw new VetoDocumentSavingException();
  54     }
  55     if (beingCommitted instanceof Project) {
  56       boolean allowSave = showAllowSaveDialog((Project) beingCommitted, Collections.singletonList(document));
  57       if (!allowSave) {
  58         throw new VetoDocumentSavingException();
  59       }
  60     }
  61   }
  62
  63
  64   public void beforeFileContentReload(VirtualFile file, Document document) throws VetoDocumentReloadException {
  65   }
  66
  67   @NonNls @NotNull
  68   public String getComponentName() {
  69     return "VetoSavingComittingDocumentsAdapter";
  70   }
  71
  72   public void initComponent() {
  73     myFileDocumentManager.addFileDocumentSynchronizationVetoer(this);
  74     ApplicationManager.getApplication().getMessageBus().connect().subscribe(AppTopics.FILE_DOCUMENT_SYNC, new FileDocumentManagerAdapter() {
  75       @Override
  76       public void beforeAllDocumentsSaving() {
  77         List<Document> documentsToWarn = new ArrayList<Document>();
  78         final Document[] unsavedDocuments = myFileDocumentManager.getUnsavedDocuments();
  79         Project commitOwnerProject = null;
  80         for (Document unsavedDocument : unsavedDocuments) {
  81           final Object data = unsavedDocument.getUserData(ChangeListManagerImpl.DOCUMENT_BEING_COMMITTED_KEY);
  82           if (data instanceof Project) {
  83             commitOwnerProject = (Project) data;
  84             documentsToWarn.add(unsavedDocument);
  85           }
  86         }
  87         if (!documentsToWarn.isEmpty()) {
  88           boolean allowSave = showAllowSaveDialog(commitOwnerProject, documentsToWarn);
  89           for (Document document : documentsToWarn) {
  90             document.putUserData(ChangeListManagerImpl.DOCUMENT_BEING_COMMITTED_KEY, allowSave ? null : SAVE_DENIED);
  91           }
  92         }
  93       }
  94     });
  95   }
  96
  97   public void disposeComponent() {
  98     myFileDocumentManager.removeFileDocumentSynchronizationVetoer(this);
  99   }
 100
 101   private boolean showAllowSaveDialog(Project project, List<Document> documentsToWarn) {
 102     StringBuilder messageBuilder = new StringBuilder("The following " + (documentsToWarn.size() == 1 ? "file is" : "files are") +
 103                                                      " currently being committed to the VCS. " +
 104                                                      "Saving now could cause inconsistent data to be committed.\n");
 105     for (Document document : documentsToWarn) {
 106       final VirtualFile file = myFileDocumentManager.getFile(document);
 107       messageBuilder.append(FileUtil.toSystemDependentName(file.getPath())).append("\n");
 108     }
 109     messageBuilder.append("Save the ").append(documentsToWarn.size() == 1 ? "file" : "files").append(" now?");
 110
 111     int rc = Messages.showDialog(project, messageBuilder.toString(), "Save Files During Commit", new String[] { "Save Now", "Postpone Save" },
 112                                  0, Messages.getQuestionIcon());
 113     return rc == 0;
 114   }
 115 }