src/org/nbgit/GitProgressSupport.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.net.URISyntaxException;
  45 import java.util.logging.Level;
  46 import javax.swing.JComponent;
  47 import org.netbeans.api.progress.ProgressHandle;
  48 import org.netbeans.api.progress.ProgressHandleFactory;
  49 import org.openide.util.Cancellable;
  50 import org.openide.util.Exceptions;
  51 import org.openide.util.NbBundle;
  52 import org.openide.util.RequestProcessor;
  53 import org.openide.util.TaskListener;
  54 import org.spearce.jgit.transport.URIish;
  55
  56 /**
  57  *
  58  * @author alexbcoles
  59  * @author Tomas Stupka
  60  */
  61 public abstract class GitProgressSupport implements Runnable, Cancellable {
  62
  63     private Cancellable delegate;
  64     private volatile boolean canceled;
  65     private ProgressHandle progressHandle = null;
  66     private String displayName = ""; // NOI18N
  67     private OutputLogger logger;
  68     private String repositoryRoot;
  69     private RequestProcessor.Task task;
  70
  71     public RequestProcessor.Task start(RequestProcessor rp, String repositoryRoot, String displayName) {
  72         setDisplayName(displayName);
  73         this.repositoryRoot = repositoryRoot;
  74         startProgress();
  75         setProgressQueued();
  76         task = rp.post(this);
  77         task.addTaskListener(new TaskListener() {
  78
  79             public void taskFinished(org.openide.util.Task task) {
  80                 delegate = null;
  81             }
  82         });
  83         return task;
  84     }
  85
  86     public JComponent getProgressComponent() {
  87         return ProgressHandleFactory.createProgressComponent(getProgressHandle());
  88     }
  89
  90     public void setRepositoryRoot(String repositoryRoot) {
  91         this.repositoryRoot = repositoryRoot;
  92         logger = null;
  93     }
  94
  95     public void run() {
  96         setProgress();
  97         performIntern();
  98     }
  99
 100     protected void performIntern() {
 101         try {
 102             Git.LOG.log(Level.FINE, "Start - {0}", displayName); // NOI18N
 103
 104             if (!canceled) {
 105                 perform();
 106             }
 107             Git.LOG.log(Level.FINE, "End - {0}", displayName); // NOI18N
 108
 109         } finally {
 110             finnishProgress();
 111             if (logger != null) {
 112                 logger.closeLog();
 113             }
 114         }
 115     }
 116
 117     protected abstract void perform();
 118
 119     public synchronized boolean isCanceled() {
 120         return canceled;
 121     }
 122
 123     public synchronized boolean cancel() {
 124         if (canceled) {
 125             return false;
 126         }
 127         if (task != null) {
 128             task.cancel();
 129         }
 130         if (delegate != null) {
 131             delegate.cancel();
 132         }
 133         Git.getInstance().clearRequestProcessor(repositoryRoot);
 134         getProgressHandle().finish();
 135         canceled = true;
 136         return true;
 137     }
 138
 139     void setCancellableDelegate(Cancellable cancellable) {
 140         this.delegate = cancellable;
 141     }
 142
 143     public void setDisplayName(String displayName) {
 144         this.displayName = displayName;
 145         setProgress();
 146     }
 147
 148     private void setProgressQueued() {
 149         if (progressHandle != null) {
 150             progressHandle.progress(NbBundle.getMessage(GitProgressSupport.class, "LBL_Queued", displayName));
 151         }
 152     }
 153
 154     private void setProgress() {
 155         if (progressHandle != null) {
 156             progressHandle.progress(displayName);
 157         }
 158     }
 159
 160     protected String getDisplayName() {
 161         return displayName;
 162     }
 163
 164     protected ProgressHandle getProgressHandle() {
 165         if (progressHandle == null) {
 166             progressHandle = ProgressHandleFactory.createHandle(displayName, this);
 167         }
 168         return progressHandle;
 169     }
 170
 171     protected void startProgress() {
 172         getProgressHandle().start();
 173     }
 174
 175     protected void finnishProgress() {
 176         getProgressHandle().finish();
 177     }
 178
 179     public OutputLogger getLogger() {
 180         if (logger == null) {
 181             logger = OutputLogger.getLogger(repositoryRoot);
 182         }
 183         return logger;
 184     }
 185
 186     public URIish getRepositoryRoot() {
 187         try {
 188             return new URIish(repositoryRoot);
 189         } catch (URISyntaxException ex) {
 190             return new URIish();
 191         }
 192     }
 193 }