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 	@Option(name = "--push-option", aliases = { "-t" })
112 	private List<String> pushOptions = new ArrayList<>();
113 
114 	private boolean shownURI;
115 
116 	@Override
117 	protected void run() throws Exception {
118 		try (Git git = new Git(db)) {
119 			PushCommand push = git.push();
120 			push.setDryRun(dryRun);
121 			push.setForce(force);
122 			push.setProgressMonitor(new TextProgressMonitor(errw));
123 			push.setReceivePack(receivePack);
124 			push.setRefSpecs(refSpecs);
125 			if (all)
126 				push.setPushAll();
127 			if (tags)
128 				push.setPushTags();
129 			push.setRemote(remote);
130 			push.setThin(thin);
131 			push.setAtomic(atomic);
132 			push.setTimeout(timeout);
133 			if (!pushOptions.isEmpty()) {
134 				push.setPushOptions(pushOptions);
135 			}
136 			Iterable<PushResult> results = push.call();
137 			for (PushResult result : results) {
138 				try (ObjectReader reader = db.newObjectReader()) {
139 					printPushResult(reader, result.getURI(), result);
140 				}
141 			}
142 		}
143 	}
144 
145 	private void printPushResult(final ObjectReader reader, final URIish uri,
146 			final PushResult result) throws IOException {
147 		shownURI = false;
148 		boolean everythingUpToDate = true;
149 
150 		// at first, print up-to-date ones...
151 		for (final RemoteRefUpdate rru : result.getRemoteUpdates()) {
152 			if (rru.getStatus() == Status.UP_TO_DATE) {
153 				if (verbose)
154 					printRefUpdateResult(reader, uri, result, rru);
155 			} else
156 				everythingUpToDate = false;
157 		}
158 
159 		for (final RemoteRefUpdate rru : result.getRemoteUpdates()) {
160 			// ...then successful updates...
161 			if (rru.getStatus() == Status.OK)
162 				printRefUpdateResult(reader, uri, result, rru);
163 		}
164 
165 		for (final RemoteRefUpdate rru : result.getRemoteUpdates()) {
166 			// ...finally, others (problematic)
167 			if (rru.getStatus() != Status.OK
168 					&& rru.getStatus() != Status.UP_TO_DATE)
169 				printRefUpdateResult(reader, uri, result, rru);
170 		}
171 
172 		AbstractFetchCommand.showRemoteMessages(errw, result.getMessages());
173 		if (everythingUpToDate)
174 			outw.println(CLIText.get().everythingUpToDate);
175 	}
176 
177 	private void printRefUpdateResult(final ObjectReader reader,
178 			final URIish uri, final PushResult result, final RemoteRefUpdate rru)
179 			throws IOException {
180 		if (!shownURI) {
181 			shownURI = true;
182 			outw.println(MessageFormat.format(CLIText.get().pushTo, uri));
183 		}
184 
185 		final String remoteName = rru.getRemoteName();
186 		final String srcRef = rru.isDelete() ? null : rru.getSrcRef();
187 
188 		switch (rru.getStatus()) {
189 		case OK:
190 			if (rru.isDelete())
191 				printUpdateLine('-', "[deleted]", null, remoteName, null); //$NON-NLS-1$
192 			else {
193 				final Ref oldRef = result.getAdvertisedRef(remoteName);
194 				if (oldRef == null) {
195 					final String summary;
196 					if (remoteName.startsWith(Constants.R_TAGS))
197 						summary = "[new tag]"; //$NON-NLS-1$
198 					else
199 						summary = "[new branch]"; //$NON-NLS-1$
200 					printUpdateLine('*', summary, srcRef, remoteName, null);
201 				} else {
202 					boolean fastForward = rru.isFastForward();
203 					final char flag = fastForward ? ' ' : '+';
204 					final String summary = safeAbbreviate(reader, oldRef
205 							.getObjectId())
206 							+ (fastForward ? ".." : "...") //$NON-NLS-1$ //$NON-NLS-2$
207 							+ safeAbbreviate(reader, rru.getNewObjectId());
208 					final String message = fastForward ? null : CLIText.get().forcedUpdate;
209 					printUpdateLine(flag, summary, srcRef, remoteName, message);
210 				}
211 			}
212 			break;
213 
214 		case NON_EXISTING:
215 			printUpdateLine('X', "[no match]", null, remoteName, null); //$NON-NLS-1$
216 			break;
217 
218 		case REJECTED_NODELETE:
219 			printUpdateLine('!', "[rejected]", null, remoteName, //$NON-NLS-1$
220 					CLIText.get().remoteSideDoesNotSupportDeletingRefs);
221 			break;
222 
223 		case REJECTED_NONFASTFORWARD:
224 			printUpdateLine('!', "[rejected]", srcRef, remoteName, //$NON-NLS-1$
225 					CLIText.get().nonFastForward);
226 			break;
227 
228 		case REJECTED_REMOTE_CHANGED:
229 			final String message = MessageFormat.format(
230 					CLIText.get().remoteRefObjectChangedIsNotExpectedOne,
231 					safeAbbreviate(reader, rru.getExpectedOldObjectId()));
232 			printUpdateLine('!', "[rejected]", srcRef, remoteName, message); //$NON-NLS-1$
233 			break;
234 
235 		case REJECTED_OTHER_REASON:
236 			printUpdateLine('!', "[remote rejected]", srcRef, remoteName, rru //$NON-NLS-1$
237 					.getMessage());
238 			break;
239 
240 		case UP_TO_DATE:
241 			if (verbose)
242 				printUpdateLine('=', "[up to date]", srcRef, remoteName, null); //$NON-NLS-1$
243 			break;
244 
245 		case NOT_ATTEMPTED:
246 		case AWAITING_REPORT:
247 			printUpdateLine('?', "[unexpected push-process behavior]", srcRef, //$NON-NLS-1$
248 					remoteName, rru.getMessage());
249 			break;
250 		}
251 	}
252 
253 	private static String safeAbbreviate(ObjectReader reader, ObjectId id) {
254 		try {
255 			return reader.abbreviate(id).name();
256 		} catch (IOException cannotAbbreviate) {
257 			return id.name();
258 		}
259 	}
260 
261 	private void printUpdateLine(final char flag, final String summary,
262 			final String srcRef, final String destRef, final String message)
263 			throws IOException {
264 		outw.format(" %c %-17s", valueOf(flag), summary); //$NON-NLS-1$
265 
266 		if (srcRef != null)
267 			outw.format(" %s ->", abbreviateRef(srcRef, true)); //$NON-NLS-1$
268 		outw.format(" %s", abbreviateRef(destRef, true)); //$NON-NLS-1$
269 
270 		if (message != null)
271 			outw.format(" (%s)", message); //$NON-NLS-1$
272 
273 		outw.println();
274 	}
275 }