View Javadoc
1   /*
2    * Copyright (C) 2008-2009, Google Inc.
3    * Copyright (C) 2009, Mykola Nikishov <mn@mn.com.ua>
4    * Copyright (C) 2008, Shawn O. Pearce <spearce@spearce.org>
5    * and other copyright owners as documented in the project's IP log.
6    *
7    * This program and the accompanying materials are made available
8    * under the terms of the Eclipse Distribution License v1.0 which
9    * accompanies this distribution, is reproduced below, and is
10   * available at http://www.eclipse.org/org/documents/edl-v10.php
11   *
12   * All rights reserved.
13   *
14   * Redistribution and use in source and binary forms, with or
15   * without modification, are permitted provided that the following
16   * conditions are met:
17   *
18   * - Redistributions of source code must retain the above copyright
19   *   notice, this list of conditions and the following disclaimer.
20   *
21   * - Redistributions in binary form must reproduce the above
22   *   copyright notice, this list of conditions and the following
23   *   disclaimer in the documentation and/or other materials provided
24   *   with the distribution.
25   *
26   * - Neither the name of the Eclipse Foundation, Inc. nor the
27   *   names of its contributors may be used to endorse or promote
28   *   products derived from this software without specific prior
29   *   written permission.
30   *
31   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
32   * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
33   * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
34   * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
35   * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
36   * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
37   * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
38   * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
39   * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
40   * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
41   * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
42   * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
43   * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
44   */
45  
46  package org.eclipse.jgit.pgm;
47  
48  import java.io.IOException;
49  import java.text.MessageFormat;
50  import java.util.List;
51  
52  import org.eclipse.jgit.api.FetchCommand;
53  import org.eclipse.jgit.api.Git;
54  import org.eclipse.jgit.api.errors.GitAPIException;
55  import org.eclipse.jgit.lib.Constants;
56  import org.eclipse.jgit.lib.SubmoduleConfig.FetchRecurseSubmodulesMode;
57  import org.eclipse.jgit.lib.TextProgressMonitor;
58  import org.eclipse.jgit.pgm.internal.CLIText;
59  import org.eclipse.jgit.transport.FetchResult;
60  import org.eclipse.jgit.transport.RefSpec;
61  import org.eclipse.jgit.transport.TagOpt;
62  import org.kohsuke.args4j.Argument;
63  import org.kohsuke.args4j.Option;
64  
65  @Command(common = true, usage = "usage_updateRemoteRefsFromAnotherRepository")
66  class Fetch extends AbstractFetchCommand implements FetchCommand.Callback {
67  	@Option(name = "--timeout", metaVar = "metaVar_seconds", usage = "usage_abortConnectionIfNoActivity")
68  	int timeout = -1;
69  
70  	@Option(name = "--fsck", usage = "usage_performFsckStyleChecksOnReceive")
71  	private Boolean fsck;
72  
73  	@Option(name = "--no-fsck")
74  	void nofsck(@SuppressWarnings("unused") final boolean ignored) {
75  		fsck = Boolean.FALSE;
76  	}
77  
78  	@Option(name = "--prune", usage = "usage_pruneStaleTrackingRefs")
79  	private Boolean prune;
80  
81  	@Option(name = "--dry-run")
82  	private boolean dryRun;
83  
84  	@Option(name = "--thin", usage = "usage_fetchThinPack")
85  	private Boolean thin;
86  
87  	@Option(name = "--no-thin")
88  	void nothin(@SuppressWarnings("unused") final boolean ignored) {
89  		thin = Boolean.FALSE;
90  	}
91  
92  	@Option(name = "--quiet", usage = "usage_quiet")
93  	private Boolean quiet;
94  
95  	@Option(name = "--tags", usage="usage_tags", aliases = { "-t" })
96  	private Boolean tags;
97  
98  	@Option(name = "--no-tags", usage = "usage_notags", aliases = { "-n" })
99  	void notags(@SuppressWarnings("unused")
100 	final boolean ignored) {
101 		tags = Boolean.FALSE;
102 	}
103 
104 	@Option(name = "--force", usage = "usage_forcedFetch", aliases = { "-f" })
105 	private Boolean force;
106 
107 	private FetchRecurseSubmodulesMode recurseSubmodules;
108 
109 	@Option(name = "--recurse-submodules", usage = "usage_recurseSubmodules")
110 	void recurseSubmodules(String mode) {
111 		if (mode == null || mode.isEmpty()) {
112 			recurseSubmodules = FetchRecurseSubmodulesMode.YES;
113 		} else {
114 			for (FetchRecurseSubmodulesMode m : FetchRecurseSubmodulesMode
115 					.values()) {
116 				if (m.matchConfigValue(mode)) {
117 					recurseSubmodules = m;
118 					return;
119 				}
120 			}
121 			throw die(MessageFormat
122 					.format(CLIText.get().invalidRecurseSubmodulesMode, mode));
123 		}
124 	}
125 
126 	@Option(name = "--no-recurse-submodules", usage = "usage_noRecurseSubmodules")
127 	void noRecurseSubmodules(@SuppressWarnings("unused")
128 	final boolean ignored) {
129 		recurseSubmodules = FetchRecurseSubmodulesMode.NO;
130 	}
131 
132 	@Argument(index = 0, metaVar = "metaVar_uriish")
133 	private String remote = Constants.DEFAULT_REMOTE_NAME;
134 
135 	@Argument(index = 1, metaVar = "metaVar_refspec")
136 	private List<RefSpec> toget;
137 
138 	/** {@inheritDoc} */
139 	@Override
140 	protected void run() {
141 		try (Gitit.html#Git">Git git = new Git(db)) {
142 			FetchCommand fetch = git.fetch();
143 			if (fsck != null) {
144 				fetch.setCheckFetchedObjects(fsck.booleanValue());
145 			}
146 			if (prune != null) {
147 				fetch.setRemoveDeletedRefs(prune.booleanValue());
148 			}
149 			if (toget != null) {
150 				fetch.setRefSpecs(toget);
151 			}
152 			if (tags != null) {
153 				fetch.setTagOpt(tags.booleanValue() ? TagOpt.FETCH_TAGS
154 						: TagOpt.NO_TAGS);
155 			}
156 			if (0 <= timeout) {
157 				fetch.setTimeout(timeout);
158 			}
159 			fetch.setDryRun(dryRun);
160 			fetch.setRemote(remote);
161 			if (thin != null) {
162 				fetch.setThin(thin.booleanValue());
163 			}
164 			if (quiet == null || !quiet.booleanValue()) {
165 				fetch.setProgressMonitor(new TextProgressMonitor(errw));
166 			}
167 			fetch.setRecurseSubmodules(recurseSubmodules).setCallback(this);
168 			if (force != null) {
169 				fetch.setForceUpdate(force.booleanValue());
170 			}
171 
172 			FetchResult result = fetch.call();
173 			if (result.getTrackingRefUpdates().isEmpty()
174 					&& result.submoduleResults().isEmpty()) {
175 				return;
176 			}
177 			showFetchResult(result);
178 		} catch (GitAPIException | IOException e) {
179 			throw die(e.getMessage(), e);
180 		}
181 	}
182 
183 	/** {@inheritDoc} */
184 	@Override
185 	public void fetchingSubmodule(String name) {
186 		try {
187 			outw.println(MessageFormat.format(CLIText.get().fetchingSubmodule,
188 					name));
189 			outw.flush();
190 		} catch (IOException e) {
191 			// ignore
192 		}
193 	}
194 }