org.spearce.jgit.pgm/src/org/spearce/jgit/pgm/Push.java

   1 /*
   2  * Copyright (C) 2008, Marek Zawirski <marek.zawirski@gmail.com>
   3  *
   4  * All rights reserved.
   5  *
   6  * Redistribution and use in source and binary forms, with or
   7  * without modification, are permitted provided that the following
   8  * conditions are met:
   9  *
  10  * - Redistributions of source code must retain the above copyright
  11  *   notice, this list of conditions and the following disclaimer.
  12  *
  13  * - Redistributions in binary form must reproduce the above
  14  *   copyright notice, this list of conditions and the following
  15  *   disclaimer in the documentation and/or other materials provided
  16  *   with the distribution.
  17  *
  18  * - Neither the name of the Git Development Community nor the
  19  *   names of its contributors may be used to endorse or promote
  20  *   products derived from this software without specific prior
  21  *   written permission.
  22  *
  23  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
  24  * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
  25  * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  26  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  27  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
  28  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  29  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  30  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  31  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  32  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  33  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  34  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
  35  * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  36  */
  37
  38 package org.spearce.jgit.pgm;
  39
  40 import java.util.ArrayList;
  41 import java.util.Collection;
  42 import java.util.List;
  43
  44 import org.kohsuke.args4j.Argument;
  45 import org.kohsuke.args4j.Option;
  46 import org.spearce.jgit.lib.Constants;
  47 import org.spearce.jgit.lib.Ref;
  48 import org.spearce.jgit.lib.TextProgressMonitor;
  49 import org.spearce.jgit.transport.PushResult;
  50 import org.spearce.jgit.transport.RefSpec;
  51 import org.spearce.jgit.transport.RemoteRefUpdate;
  52 import org.spearce.jgit.transport.Transport;
  53 import org.spearce.jgit.transport.URIish;
  54 import org.spearce.jgit.transport.RemoteRefUpdate.Status;
  55
  56 @Command(common = true, usage = "Update remote repository from local refs")
  57 class Push extends TextBuiltin {
  58         @Argument(index = 0, metaVar = "uri-ish")
  59         private String remote = "origin";
  60
  61         @Argument(index = 1, metaVar = "refspec")
  62         private final List<RefSpec> refSpecs = new ArrayList<RefSpec>();
  63
  64         @Option(name = "--all")
  65         void addAll(final boolean ignored) {
  66                 refSpecs.add(Transport.REFSPEC_PUSH_ALL);
  67         }
  68
  69         @Option(name = "--tags")
  70         void addTags(final boolean ignored) {
  71                 refSpecs.add(Transport.REFSPEC_TAGS);
  72         }
  73
  74         @Option(name = "--verbose", aliases = { "-v" })
  75         private boolean verbose = false;
  76
  77         @Option(name = "--thin")
  78         private boolean thin = Transport.DEFAULT_PUSH_THIN;
  79
  80         @Option(name = "--no-thin")
  81         void nothin(final boolean ignored) {
  82                 thin = false;
  83         }
  84
  85         @Option(name = "--force", aliases = { "-f" })
  86         private boolean force;
  87
  88         @Option(name = "--receive-pack", metaVar = "path")
  89         private String receivePack;
  90
  91         @Option(name = "--dry-run")
  92         private boolean dryRun;
  93
  94         private boolean shownURI;
  95
  96         @Override
  97         protected void run() throws Exception {
  98                 if (force) {
  99                         final List<RefSpec> orig = new ArrayList<RefSpec>(refSpecs);
 100                         refSpecs.clear();
 101                         for (final RefSpec spec : orig)
 102                                 refSpecs.add(spec.setForceUpdate(true));
 103                 }
 104
 105                 final List<Transport> transports = Transport.openAll(db, remote);
 106                 for (final Transport transport : transports) {
 107                         transport.setPushThin(thin);
 108                         if (receivePack != null)
 109                                 transport.setOptionReceivePack(receivePack);
 110                         transport.setDryRun(dryRun);
 111
 112                         final Collection<RemoteRefUpdate> toPush = transport
 113                                         .findRemoteRefUpdatesFor(refSpecs);
 114
 115                         final URIish uri = transport.getURI();
 116                         final PushResult result;
 117                         try {
 118                                 result = transport.push(new TextProgressMonitor(), toPush);
 119                         } finally {
 120                                 transport.close();
 121                         }
 122                         printPushResult(uri, result);
 123                 }
 124         }
 125
 126         private void printPushResult(final URIish uri,
 127                         final PushResult result) {
 128                 shownURI = false;
 129                 boolean everythingUpToDate = true;
 130
 131                 // at first, print up-to-date ones...
 132                 for (final RemoteRefUpdate rru : result.getRemoteUpdates()) {
 133                         if (rru.getStatus() == Status.UP_TO_DATE) {
 134                                 if (verbose)
 135                                         printRefUpdateResult(uri, result, rru);
 136                         } else
 137                                 everythingUpToDate = false;
 138                 }
 139
 140                 for (final RemoteRefUpdate rru : result.getRemoteUpdates()) {
 141                         // ...then successful updates...
 142                         if (rru.getStatus() == Status.OK)
 143                                 printRefUpdateResult(uri, result, rru);
 144                 }
 145
 146                 for (final RemoteRefUpdate rru : result.getRemoteUpdates()) {
 147                         // ...finally, others (problematic)
 148                         if (rru.getStatus() != Status.OK
 149                                         && rru.getStatus() != Status.UP_TO_DATE)
 150                                 printRefUpdateResult(uri, result, rru);
 151                 }
 152
 153                 if (everythingUpToDate)
 154                         out.println("Everything up-to-date");
 155         }
 156
 157         private void printRefUpdateResult(final URIish uri,
 158                         final PushResult result, final RemoteRefUpdate rru) {
 159                 if (!shownURI) {
 160                         shownURI = true;
 161                         out.format("To %s\n", uri);
 162                 }
 163
 164                 final String remoteName = rru.getRemoteName();
 165                 final String srcRef = rru.isDelete() ? null : rru.getSrcRef();
 166
 167                 switch (rru.getStatus()) {
 168                 case OK:
 169                         if (rru.isDelete())
 170                                 printUpdateLine('-', "[deleted]", null, remoteName, null);
 171                         else {
 172                                 final Ref oldRef = result.getAdvertisedRef(remoteName);
 173                                 if (oldRef == null) {
 174                                         final String summary;
 175                                         if (remoteName.startsWith(Constants.R_TAGS))
 176                                                 summary = "[new tag]";
 177                                         else
 178                                                 summary = "[new branch]";
 179                                         printUpdateLine('*', summary, srcRef, remoteName, null);
 180                                 } else {
 181                                         boolean fastForward = rru.isFastForward();
 182                                         final char flag = fastForward ? ' ' : '+';
 183                                         final String summary = oldRef.getObjectId().abbreviate(db)
 184                                                         .name()
 185                                                         + (fastForward ? ".." : "...")
 186                                                         + rru.getNewObjectId().abbreviate(db).name();
 187                                         final String message = fastForward ? null : "forced update";
 188                                         printUpdateLine(flag, summary, srcRef, remoteName, message);
 189                                 }
 190                         }
 191                         break;
 192
 193                 case NON_EXISTING:
 194                         printUpdateLine('X', "[no match]", null, remoteName, null);
 195                         break;
 196
 197                 case REJECTED_NODELETE:
 198                         printUpdateLine('!', "[rejected]", null, remoteName,
 199                                         "remote side does not support deleting refs");
 200                         break;
 201
 202                 case REJECTED_NONFASTFORWARD:
 203                         printUpdateLine('!', "[rejected]", srcRef, remoteName,
 204                                         "non-fast forward");
 205                         break;
 206
 207                 case REJECTED_REMOTE_CHANGED:
 208                         final String message = "remote ref object changed - is not expected one "
 209                                         + rru.getExpectedOldObjectId().abbreviate(db).name();
 210                         printUpdateLine('!', "[rejected]", srcRef, remoteName, message);
 211                         break;
 212
 213                 case REJECTED_OTHER_REASON:
 214                         printUpdateLine('!', "[remote rejected]", srcRef, remoteName, rru
 215                                         .getMessage());
 216                         break;
 217
 218                 case UP_TO_DATE:
 219                         if (verbose)
 220                                 printUpdateLine('=', "[up to date]", srcRef, remoteName, null);
 221                         break;
 222
 223                 case NOT_ATTEMPTED:
 224                 case AWAITING_REPORT:
 225                         printUpdateLine('?', "[unexpected push-process behavior]", srcRef,
 226                                         remoteName, rru.getMessage());
 227                         break;
 228                 }
 229         }
 230
 231         private void printUpdateLine(final char flag, final String summary,
 232                         final String srcRef, final String destRef, final String message) {
 233                 out.format(" %c %-17s", flag, summary);
 234
 235                 if (srcRef != null)
 236                         out.format(" %s ->", abbreviateRef(srcRef, true));
 237                 out.format(" %s", abbreviateRef(destRef, true));
 238
 239                 if (message != null)
 240                         out.format(" (%s)", message);
 241
 242                 out.println();
 243         }
 244 }