View Javadoc
1   /*
2    * Copyright (C) 2010, Chris Aniszczyk <caniszczyk@gmail.com>
3    * Copyright (C) 2008, Marek Zawirski <marek.zawirski@gmail.com>
4    * and other copyright owners as documented in the project's IP log.
5    *
6    * This program and the accompanying materials are made available
7    * under the terms of the Eclipse Distribution License v1.0 which
8    * accompanies this distribution, is reproduced below, and is
9    * available at http://www.eclipse.org/org/documents/edl-v10.php
10   *
11   * All rights reserved.
12   *
13   * Redistribution and use in source and binary forms, with or
14   * without modification, are permitted provided that the following
15   * conditions are met:
16   *
17   * - Redistributions of source code must retain the above copyright
18   *   notice, this list of conditions and the following disclaimer.
19   *
20   * - Redistributions in binary form must reproduce the above
21   *   copyright notice, this list of conditions and the following
22   *   disclaimer in the documentation and/or other materials provided
23   *   with the distribution.
24   *
25   * - Neither the name of the Eclipse Foundation, Inc. nor the
26   *   names of its contributors may be used to endorse or promote
27   *   products derived from this software without specific prior
28   *   written permission.
29   *
30   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
31   * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
32   * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
33   * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
34   * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
35   * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
36   * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
37   * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
38   * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
39   * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
40   * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
41   * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
42   * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
43   */
44  
45  package org.eclipse.jgit.pgm;
46  
47  import static java.lang.Character.valueOf;
48  
49  import java.io.IOException;
50  import java.text.MessageFormat;
51  import java.util.ArrayList;
52  import java.util.List;
53  
54  import org.eclipse.jgit.api.Git;
55  import org.eclipse.jgit.api.PushCommand;
56  import org.eclipse.jgit.lib.Constants;
57  import org.eclipse.jgit.lib.ObjectId;
58  import org.eclipse.jgit.lib.ObjectReader;
59  import org.eclipse.jgit.lib.Ref;
60  import org.eclipse.jgit.lib.TextProgressMonitor;
61  import org.eclipse.jgit.pgm.internal.CLIText;
62  import org.eclipse.jgit.transport.PushResult;
63  import org.eclipse.jgit.transport.RefSpec;
64  import org.eclipse.jgit.transport.RemoteRefUpdate;
65  import org.eclipse.jgit.transport.RemoteRefUpdate.Status;
66  import org.eclipse.jgit.transport.Transport;
67  import org.eclipse.jgit.transport.URIish;
68  import org.kohsuke.args4j.Argument;
69  import org.kohsuke.args4j.Option;
70  
71  @Command(common = true, usage = "usage_UpdateRemoteRepositoryFromLocalRefs")
72  class Push extends TextBuiltin {
73  	@Option(name = "--timeout", metaVar = "metaVar_seconds", usage = "usage_abortConnectionIfNoActivity")
74  	int timeout = -1;
75  
76  	@Argument(index = 0, metaVar = "metaVar_uriish")
77  	private String remote = Constants.DEFAULT_REMOTE_NAME;
78  
79  	@Argument(index = 1, metaVar = "metaVar_refspec")
80  	private final List<RefSpec> refSpecs = new ArrayList<RefSpec>();
81  
82  	@Option(name = "--all")
83  	private boolean all;
84  
85  	@Option(name = "--atomic")
86  	private boolean atomic;
87  
88  	@Option(name = "--tags")
89  	private boolean tags;
90  
91  	@Option(name = "--verbose", aliases = { "-v" })
92  	private boolean verbose = false;
93  
94  	@Option(name = "--thin")
95  	private boolean thin = Transport.DEFAULT_PUSH_THIN;
96  
97  	@Option(name = "--no-thin")
98  	void nothin(@SuppressWarnings("unused") final boolean ignored) {
99  		thin = false;
100 	}
101 
102 	@Option(name = "--force", aliases = { "-f" })
103 	private boolean force;
104 
105 	@Option(name = "--receive-pack", metaVar = "metaVar_path")
106 	private String receivePack;
107 
108 	@Option(name = "--dry-run")
109 	private boolean dryRun;
110 
111 	private boolean shownURI;
112 
113 	@Override
114 	protected void run() throws Exception {
115 		try (Git git = new Git(db)) {
116 			PushCommand push = git.push();
117 			push.setDryRun(dryRun);
118 			push.setForce(force);
119 			push.setProgressMonitor(new TextProgressMonitor(errw));
120 			push.setReceivePack(receivePack);
121 			push.setRefSpecs(refSpecs);
122 			if (all)
123 				push.setPushAll();
124 			if (tags)
125 				push.setPushTags();
126 			push.setRemote(remote);
127 			push.setThin(thin);
128 			push.setAtomic(atomic);
129 			push.setTimeout(timeout);
130 			Iterable<PushResult> results = push.call();
131 			for (PushResult result : results) {
132 				try (ObjectReader reader = db.newObjectReader()) {
133 					printPushResult(reader, result.getURI(), result);
134 				}
135 			}
136 		}
137 	}
138 
139 	private void printPushResult(final ObjectReader reader, final URIish uri,
140 			final PushResult result) throws IOException {
141 		shownURI = false;
142 		boolean everythingUpToDate = true;
143 
144 		// at first, print up-to-date ones...
145 		for (final RemoteRefUpdate rru : result.getRemoteUpdates()) {
146 			if (rru.getStatus() == Status.UP_TO_DATE) {
147 				if (verbose)
148 					printRefUpdateResult(reader, uri, result, rru);
149 			} else
150 				everythingUpToDate = false;
151 		}
152 
153 		for (final RemoteRefUpdate rru : result.getRemoteUpdates()) {
154 			// ...then successful updates...
155 			if (rru.getStatus() == Status.OK)
156 				printRefUpdateResult(reader, uri, result, rru);
157 		}
158 
159 		for (final RemoteRefUpdate rru : result.getRemoteUpdates()) {
160 			// ...finally, others (problematic)
161 			if (rru.getStatus() != Status.OK
162 					&& rru.getStatus() != Status.UP_TO_DATE)
163 				printRefUpdateResult(reader, uri, result, rru);
164 		}
165 
166 		AbstractFetchCommand.showRemoteMessages(errw, result.getMessages());
167 		if (everythingUpToDate)
168 			outw.println(CLIText.get().everythingUpToDate);
169 	}
170 
171 	private void printRefUpdateResult(final ObjectReader reader,
172 			final URIish uri, final PushResult result, final RemoteRefUpdate rru)
173 			throws IOException {
174 		if (!shownURI) {
175 			shownURI = true;
176 			outw.println(MessageFormat.format(CLIText.get().pushTo, uri));
177 		}
178 
179 		final String remoteName = rru.getRemoteName();
180 		final String srcRef = rru.isDelete() ? null : rru.getSrcRef();
181 
182 		switch (rru.getStatus()) {
183 		case OK:
184 			if (rru.isDelete())
185 				printUpdateLine('-', "[deleted]", null, remoteName, null); //$NON-NLS-1$
186 			else {
187 				final Ref oldRef = result.getAdvertisedRef(remoteName);
188 				if (oldRef == null) {
189 					final String summary;
190 					if (remoteName.startsWith(Constants.R_TAGS))
191 						summary = "[new tag]"; //$NON-NLS-1$
192 					else
193 						summary = "[new branch]"; //$NON-NLS-1$
194 					printUpdateLine('*', summary, srcRef, remoteName, null);
195 				} else {
196 					boolean fastForward = rru.isFastForward();
197 					final char flag = fastForward ? ' ' : '+';
198 					final String summary = safeAbbreviate(reader, oldRef
199 							.getObjectId())
200 							+ (fastForward ? ".." : "...") //$NON-NLS-1$ //$NON-NLS-2$
201 							+ safeAbbreviate(reader, rru.getNewObjectId());
202 					final String message = fastForward ? null : CLIText.get().forcedUpdate;
203 					printUpdateLine(flag, summary, srcRef, remoteName, message);
204 				}
205 			}
206 			break;
207 
208 		case NON_EXISTING:
209 			printUpdateLine('X', "[no match]", null, remoteName, null); //$NON-NLS-1$
210 			break;
211 
212 		case REJECTED_NODELETE:
213 			printUpdateLine('!', "[rejected]", null, remoteName, //$NON-NLS-1$
214 					CLIText.get().remoteSideDoesNotSupportDeletingRefs);
215 			break;
216 
217 		case REJECTED_NONFASTFORWARD:
218 			printUpdateLine('!', "[rejected]", srcRef, remoteName, //$NON-NLS-1$
219 					CLIText.get().nonFastForward);
220 			break;
221 
222 		case REJECTED_REMOTE_CHANGED:
223 			final String message = MessageFormat.format(
224 					CLIText.get().remoteRefObjectChangedIsNotExpectedOne,
225 					safeAbbreviate(reader, rru.getExpectedOldObjectId()));
226 			printUpdateLine('!', "[rejected]", srcRef, remoteName, message); //$NON-NLS-1$
227 			break;
228 
229 		case REJECTED_OTHER_REASON:
230 			printUpdateLine('!', "[remote rejected]", srcRef, remoteName, rru //$NON-NLS-1$
231 					.getMessage());
232 			break;
233 
234 		case UP_TO_DATE:
235 			if (verbose)
236 				printUpdateLine('=', "[up to date]", srcRef, remoteName, null); //$NON-NLS-1$
237 			break;
238 
239 		case NOT_ATTEMPTED:
240 		case AWAITING_REPORT:
241 			printUpdateLine('?', "[unexpected push-process behavior]", srcRef, //$NON-NLS-1$
242 					remoteName, rru.getMessage());
243 			break;
244 		}
245 	}
246 
247 	private static String safeAbbreviate(ObjectReader reader, ObjectId id) {
248 		try {
249 			return reader.abbreviate(id).name();
250 		} catch (IOException cannotAbbreviate) {
251 			return id.name();
252 		}
253 	}
254 
255 	private void printUpdateLine(final char flag, final String summary,
256 			final String srcRef, final String destRef, final String message)
257 			throws IOException {
258 		outw.format(" %c %-17s", valueOf(flag), summary); //$NON-NLS-1$
259 
260 		if (srcRef != null)
261 			outw.format(" %s ->", abbreviateRef(srcRef, true)); //$NON-NLS-1$
262 		outw.format(" %s", abbreviateRef(destRef, true)); //$NON-NLS-1$
263 
264 		if (message != null)
265 			outw.format(" (%s)", message); //$NON-NLS-1$
266 
267 		outw.println();
268 	}
269 }