src/org/nbgit/GitInterceptor.java

   1 /*
   2  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
   3  *
   4  * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
   5  *
   6  * The contents of this file are subject to the terms of either the GNU
   7  * General Public License Version 2 only ("GPL") or the Common
   8  * Development and Distribution License("CDDL") (collectively, the
   9  * "License"). You may not use this file except in compliance with the
  10  * License. You can obtain a copy of the License at
  11  * http://www.netbeans.org/cddl-gplv2.html
  12  * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
  13  * specific language governing permissions and limitations under the
  14  * License.  When distributing the software, include this License Header
  15  * Notice in each file and include the License file at
  16  * nbbuild/licenses/CDDL-GPL-2-CP.  Sun designates this
  17  * particular file as subject to the "Classpath" exception as provided
  18  * by Sun in the GPL Version 2 section of the License file that
  19  * accompanied this code. If applicable, add the following below the
  20  * License Header, with the fields enclosed by brackets [] replaced by
  21  * your own identifying information:
  22  * "Portions Copyrighted [year] [name of copyright owner]"
  23  *
  24  * Contributor(s):
  25  *
  26  * The Original Software is NetBeans. The Initial Developer of the Original
  27  * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
  28  * Microsystems, Inc. All Rights Reserved.
  29  * Portions Copyright 2008 Alexander Coles (Ikonoklastik Productions).
  30  *
  31  * If you wish your version of this file to be governed by only the CDDL
  32  * or only the GPL Version 2, indicate your decision by adding
  33  * "[Contributor] elects to include this software in this distribution
  34  * under the [CDDL or GPL Version 2] license." If you do not indicate a
  35  * single choice of license, a recipient has the option to distribute
  36  * your version of this file under either the CDDL, the GPL Version 2 or
  37  * to extend the choice of license to its licensees as provided above.
  38  * However, if you add GPL Version 2 code and therefore, elected the GPL
  39  * Version 2 license, then the option applies only if the new code is
  40  * made subject to such option by the copyright holder.
  41  */
  42 package org.nbgit;
  43
  44 import java.io.File;
  45 import java.io.IOException;
  46 import java.util.Collection;
  47 import java.util.Map;
  48 import java.util.concurrent.ConcurrentHashMap;
  49 import java.util.concurrent.ConcurrentLinkedQueue;
  50 import java.util.logging.Level;
  51 import javax.swing.SwingUtilities;
  52 import org.nbgit.util.GitCommand;
  53 import org.nbgit.util.GitIgnore;
  54 import org.nbgit.util.GitUtils;
  55 import org.netbeans.modules.versioning.spi.VCSInterceptor;
  56 import org.netbeans.modules.versioning.util.Utils;
  57 import org.openide.util.RequestProcessor;
  58
  59 /**
  60  * Listens on file system changes and reacts appropriately, mainly refreshing affected files' status.
  61  *
  62  * @author Maros Sandor
  63  */
  64 public class GitInterceptor extends VCSInterceptor {
  65
  66     private final StatusCache cache;
  67     private ConcurrentHashMap<File, File> dirsToDelete = new ConcurrentHashMap<File, File>();
  68     private ConcurrentLinkedQueue<File> filesToRefresh = new ConcurrentLinkedQueue<File>();
  69     private RequestProcessor.Task refreshTask;
  70     private static final RequestProcessor refresh = new RequestProcessor("GitRefresh", 1, true);
  71
  72     public GitInterceptor()
  73     {
  74         cache = Git.getInstance().getStatusCache();
  75         refreshTask = refresh.create(new RefreshTask());
  76     }
  77
  78     @Override
  79     public boolean beforeDelete(File file)
  80     {
  81         if (file == null)
  82             return true;
  83         if (GitUtils.isPartOfGitMetadata(file))
  84             return false;
  85
  86         // We track the deletion of top level directories
  87         if (file.isDirectory()) {
  88             for (File dir : dirsToDelete.keySet()) {
  89                 if (file.equals(dir.getParentFile()))
  90                     dirsToDelete.remove(dir);
  91             }
  92             if (GitIgnore.isSharable(file))
  93                 dirsToDelete.put(file, file);
  94         }
  95         return true;
  96     }
  97
  98     @Override
  99     public void doDelete(File file) throws IOException
 100     {
 101     }
 102
 103     @Override
 104     public void afterDelete(final File file)
 105     {
 106         Utils.post(new Runnable() {
 107
 108             public void run()
 109             {
 110                 fileDeletedImpl(file);
 111             }
 112
 113         });
 114     }
 115
 116     private void fileDeletedImpl(final File file)
 117     {
 118         if (file == null || !file.exists())
 119             return;
 120
 121         Git git = Git.getInstance();
 122         final File root = git.getTopmostManagedParent(file);
 123         RequestProcessor rp = null;
 124         if (root != null)
 125             rp = git.getRequestProcessor(root.getAbsolutePath());
 126
 127         if (file.isDirectory()) {
 128             file.delete();
 129             if (!dirsToDelete.remove(file, file))
 130                 return;
 131             if (root == null)
 132                 return;
 133             GitProgressSupport support = new GitProgressSupport() {
 134
 135                 public void perform()
 136                 {
 137                     GitCommand.doRemove(root, file, this.getLogger());
 138                     // We need to cache the status of all deleted files
 139                     Map<File, StatusInfo> interestingFiles = GitCommand.getInterestingStatus(root, file);
 140                     if (!interestingFiles.isEmpty()) {
 141                         Collection<File> files = interestingFiles.keySet();
 142
 143                         Map<File, Map<File, StatusInfo>> interestingDirs =
 144                             GitUtils.getInterestingDirs(interestingFiles, files);
 145
 146                         for (File tmpFile : files) {
 147                             if (this.isCanceled())
 148                                 return;
 149                             StatusInfo fi = interestingFiles.get(tmpFile);
 150
 151                             cache.refreshFileStatus(tmpFile, fi,
 152                                 interestingDirs.get(tmpFile.isDirectory() ? tmpFile : tmpFile.getParentFile()), true);
 153                         }
 154                     }
 155                 }
 156
 157             };
 158
 159             support.start(rp, root.getAbsolutePath(),
 160                 org.openide.util.NbBundle.getMessage(GitInterceptor.class, "MSG_Remove_Progress")); // NOI18N
 161         } else {
 162             // If we are deleting a parent directory of this file
 163             // skip the call to git remove as we will do it for the directory
 164             file.delete();
 165             if (root == null)
 166                 return;
 167             for (File dir : dirsToDelete.keySet()) {
 168                 File tmpFile = file.getParentFile();
 169                 while (tmpFile != null) {
 170                     if (tmpFile.equals(dir))
 171                         return;
 172                     tmpFile = tmpFile.getParentFile();
 173                 }
 174             }
 175             GitProgressSupport support = new GitProgressSupport() {
 176
 177                 public void perform()
 178                 {
 179                     GitCommand.doRemove(root, file, this.getLogger());
 180                     cache.refresh(file, StatusCache.REPOSITORY_STATUS_UNKNOWN);
 181                 }
 182
 183             };
 184             support.start(rp, root.getAbsolutePath(),
 185                 org.openide.util.NbBundle.getMessage(GitInterceptor.class, "MSG_Remove_Progress")); // NOI18N
 186         }
 187     }
 188
 189     @Override
 190     public boolean beforeMove(File from, File to)
 191     {
 192         if (from == null || to == null || to.exists())
 193             return true;
 194
 195         Git git = Git.getInstance();
 196         if (git.isManaged(from))
 197             return git.isManaged(to);
 198         return super.beforeMove(from, to);
 199     }
 200
 201     @Override
 202     public void doMove(final File from, final File to) throws IOException
 203     {
 204         if (from == null || to == null || to.exists())
 205             return;
 206
 207         if (SwingUtilities.isEventDispatchThread()) {
 208
 209             Git.LOG.log(Level.INFO, "Warning: launching external process in AWT", new Exception().fillInStackTrace()); // NOI18N
 210             final Throwable innerT[] = new Throwable[1];
 211             Runnable outOfAwt = new Runnable() {
 212
 213                 public void run()
 214                 {
 215                     try {
 216                         gitMoveImplementation(from, to);
 217                     } catch (Throwable t) {
 218                         innerT[0] = t;
 219                     }
 220                 }
 221
 222             };
 223
 224             Git.getInstance().getRequestProcessor().post(outOfAwt).waitFinished();
 225             if (innerT[0] != null)
 226                 if (innerT[0] instanceof IOException)
 227                     throw (IOException) innerT[0];
 228                 else if (innerT[0] instanceof RuntimeException)
 229                     throw (RuntimeException) innerT[0];
 230                 else if (innerT[0] instanceof Error)
 231                     throw (Error) innerT[0];
 232                 else
 233                     throw new IllegalStateException("Unexpected exception class: " + innerT[0]);
 234
 235         // end of hack
 236
 237         } else
 238             gitMoveImplementation(from, to);
 239     }
 240
 241     private void gitMoveImplementation(final File srcFile, final File dstFile) throws IOException
 242     {
 243         final Git git = Git.getInstance();
 244         final File root = git.getTopmostManagedParent(srcFile);
 245         if (root == null)
 246             return;
 247
 248         RequestProcessor rp = git.getRequestProcessor(root.getAbsolutePath());
 249
 250         Git.LOG.log(Level.FINE, "gitMoveImplementation(): File: {0} {1}", new Object[]{srcFile, dstFile}); // NOI18N
 251
 252         srcFile.renameTo(dstFile);
 253         Runnable moveImpl = new Runnable() {
 254
 255             public void run()
 256             {
 257                 OutputLogger logger = OutputLogger.getLogger(root.getAbsolutePath());
 258                 try {
 259                     if (dstFile.isDirectory()) {
 260                         GitCommand.doRenameAfter(root, srcFile, dstFile, logger);
 261                         return;
 262                     }
 263                     int status = GitCommand.getSingleStatus(root, srcFile).getStatus();
 264                     Git.LOG.log(Level.FINE, "gitMoveImplementation(): Status: {0} {1}", new Object[]{srcFile, status}); // NOI18N
 265                     if (status == StatusInfo.STATUS_NOTVERSIONED_NEWLOCALLY ||
 266                         status == StatusInfo.STATUS_NOTVERSIONED_EXCLUDED) {
 267                     } else if (status == StatusInfo.STATUS_VERSIONED_ADDEDLOCALLY) {
 268                         GitCommand.doRemove(root, srcFile, logger);
 269                         GitCommand.doAdd(root, dstFile, logger);
 270                     } else
 271                         GitCommand.doRenameAfter(root, srcFile, dstFile, logger);
 272                 } catch (Exception e) {
 273                     Git.LOG.log(Level.FINE, "Git failed to rename: File: {0} {1}", new Object[]{srcFile.getAbsolutePath(), dstFile.getAbsolutePath()}); // NOI18N
 274                 } finally {
 275                     logger.closeLog();
 276                 }
 277             }
 278
 279         };
 280
 281         rp.post(moveImpl);
 282     }
 283
 284     @Override
 285     public void afterMove(final File from, final File to)
 286     {
 287         Utils.post(new Runnable() {
 288
 289             public void run()
 290             {
 291                 fileMovedImpl(from, to);
 292             }
 293
 294         });
 295     }
 296
 297     private void fileMovedImpl(final File from, final File to)
 298     {
 299         if (from == null || to == null || !to.exists())
 300             return;
 301         if (to.isDirectory())
 302             return;
 303         Git git = Git.getInstance();
 304         final File root = git.getTopmostManagedParent(from);
 305         if (root == null)
 306             return;
 307
 308         RequestProcessor rp = git.getRequestProcessor(root.getAbsolutePath());
 309
 310         GitProgressSupport supportCreate = new GitProgressSupport() {
 311
 312             public void perform()
 313             {
 314                 cache.refresh(from, StatusCache.REPOSITORY_STATUS_UNKNOWN);
 315                 cache.refresh(to, StatusCache.REPOSITORY_STATUS_UNKNOWN);
 316             }
 317
 318         };
 319
 320         supportCreate.start(rp, root.getAbsolutePath(),
 321             org.openide.util.NbBundle.getMessage(GitInterceptor.class, "MSG_Move_Progress")); // NOI18N
 322     }
 323
 324     @Override
 325     public boolean beforeCreate(File file, boolean isDirectory)
 326     {
 327         return super.beforeCreate(file, isDirectory);
 328     }
 329
 330     @Override
 331     public void doCreate(File file, boolean isDirectory) throws IOException
 332     {
 333         super.doCreate(file, isDirectory);
 334     }
 335
 336     @Override
 337     public void afterCreate(final File file)
 338     {
 339         Utils.post(new Runnable() {
 340
 341             public void run()
 342             {
 343                 fileCreatedImpl(file);
 344             }
 345
 346         });
 347     }
 348
 349     private void fileCreatedImpl(final File file)
 350     {
 351         if (file.isDirectory())
 352             return;
 353         Git git = Git.getInstance();
 354         final File root = git.getTopmostManagedParent(file);
 355         if (root == null)
 356             return;
 357
 358         RequestProcessor rp = git.getRequestProcessor(root.getAbsolutePath());
 359
 360         GitProgressSupport supportCreate = new GitProgressSupport() {
 361
 362             public void perform()
 363             {
 364                 reScheduleRefresh(file);
 365             }
 366
 367         };
 368
 369         supportCreate.start(rp, root.getAbsolutePath(),
 370             org.openide.util.NbBundle.getMessage(GitInterceptor.class, "MSG_Create_Progress")); // NOI18N
 371     }
 372
 373     @Override
 374     public void afterChange(final File file)
 375     {
 376         Utils.post(new Runnable() {
 377
 378             public void run()
 379             {
 380                 fileChangedImpl(file);
 381             }
 382
 383         });
 384     }
 385
 386     private void fileChangedImpl(final File file)
 387     {
 388         if (file.isDirectory())
 389             return;
 390         Git git = Git.getInstance();
 391         final File root = git.getTopmostManagedParent(file);
 392         if (root == null)
 393             return;
 394
 395         RequestProcessor rp = git.getRequestProcessor(root.getAbsolutePath());
 396
 397         GitProgressSupport supportCreate = new GitProgressSupport() {
 398
 399             public void perform()
 400             {
 401                 Git.LOG.log(Level.FINE, "fileChangedImpl(): File: {0}", file); // NOI18N
 402                 reScheduleRefresh(file);
 403             }
 404
 405         };
 406
 407         supportCreate.start(rp, root.getAbsolutePath(),
 408             org.openide.util.NbBundle.getMessage(GitInterceptor.class, "MSG_Change_Progress")); // NOI18N
 409     }
 410
 411     private void reScheduleRefresh(File fileToRefresh)
 412     {
 413         // There is no point in refreshing the cache for ignored files.
 414         if (GitIgnore.isIgnored(fileToRefresh, false))
 415             return;
 416         if (!filesToRefresh.contains(fileToRefresh))
 417             if (!filesToRefresh.offer(fileToRefresh))
 418                 Git.LOG.log(Level.FINE, "reScheduleRefresh failed to add to filesToRefresh queue {0}", fileToRefresh);
 419         refreshTask.schedule(1000);
 420     }
 421
 422     private class RefreshTask implements Runnable {
 423
 424         public void run()
 425         {
 426             Thread.interrupted();
 427             File fileToRefresh = filesToRefresh.poll();
 428             if (fileToRefresh != null) {
 429                 cache.refresh(fileToRefresh, StatusCache.REPOSITORY_STATUS_UNKNOWN);
 430                 fileToRefresh = filesToRefresh.peek();
 431                 if (fileToRefresh != null)
 432                     refreshTask.schedule(0);
 433             }
 434         }
 435
 436     }
 437
 438 }