View Javadoc
1   /*
2    * Copyright (C) 2008-2010, Google Inc.
3    * and other copyright owners as documented in the project's IP log.
4    *
5    * This program and the accompanying materials are made available
6    * under the terms of the Eclipse Distribution License v1.0 which
7    * accompanies this distribution, is reproduced below, and is
8    * available at http://www.eclipse.org/org/documents/edl-v10.php
9    *
10   * All rights reserved.
11   *
12   * Redistribution and use in source and binary forms, with or
13   * without modification, are permitted provided that the following
14   * conditions are met:
15   *
16   * - Redistributions of source code must retain the above copyright
17   *   notice, this list of conditions and the following disclaimer.
18   *
19   * - Redistributions in binary form must reproduce the above
20   *   copyright notice, this list of conditions and the following
21   *   disclaimer in the documentation and/or other materials provided
22   *   with the distribution.
23   *
24   * - Neither the name of the Eclipse Foundation, Inc. nor the
25   *   names of its contributors may be used to endorse or promote
26   *   products derived from this software without specific prior
27   *   written permission.
28   *
29   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
30   * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
31   * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
32   * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
33   * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
34   * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
35   * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
36   * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
37   * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
38   * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
39   * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
40   * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
41   * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
42   */
43  
44  package org.eclipse.jgit.pgm;
45  
46  import java.io.File;
47  import java.io.IOException;
48  import java.text.MessageFormat;
49  import java.util.Collection;
50  
51  import org.eclipse.jgit.api.CloneCommand;
52  import org.eclipse.jgit.api.Git;
53  import org.eclipse.jgit.api.errors.InvalidRemoteException;
54  import org.eclipse.jgit.lib.AnyObjectId;
55  import org.eclipse.jgit.lib.Constants;
56  import org.eclipse.jgit.lib.TextProgressMonitor;
57  import org.eclipse.jgit.pgm.internal.CLIText;
58  import org.eclipse.jgit.transport.URIish;
59  import org.eclipse.jgit.util.SystemReader;
60  import org.kohsuke.args4j.Argument;
61  import org.kohsuke.args4j.Option;
62  
63  @Command(common = true, usage = "usage_cloneRepositoryIntoNewDir")
64  class Clone extends AbstractFetchCommand implements CloneCommand.Callback {
65  	@Option(name = "--origin", aliases = { "-o" }, metaVar = "metaVar_remoteName", usage = "usage_useNameInsteadOfOriginToTrackUpstream")
66  	private String remoteName = Constants.DEFAULT_REMOTE_NAME;
67  
68  	@Option(name = "--branch", aliases = { "-b" }, metaVar = "metaVar_branchName", usage = "usage_checkoutBranchAfterClone")
69  	private String branch;
70  
71  	@Option(name = "--no-checkout", aliases = { "-n" }, usage = "usage_noCheckoutAfterClone")
72  	private boolean noCheckout;
73  
74  	@Option(name = "--bare", usage = "usage_bareClone")
75  	private boolean isBare;
76  
77  	@Option(name = "--quiet", usage = "usage_quiet")
78  	private Boolean quiet;
79  
80  	@Option(name = "--recurse-submodules", usage = "usage_recurseSubmodules")
81  	private boolean cloneSubmodules;
82  
83  	@Argument(index = 0, required = true, metaVar = "metaVar_uriish")
84  	private String sourceUri;
85  
86  	@Argument(index = 1, metaVar = "metaVar_directory")
87  	private String localName;
88  
89  	/** {@inheritDoc} */
90  	@Override
91  	protected final boolean requiresRepository() {
92  		return false;
93  	}
94  
95  	/** {@inheritDoc} */
96  	@Override
97  	protected void run() throws Exception {
98  		if (localName != null && gitdir != null)
99  			throw die(CLIText.get().conflictingUsageOf_git_dir_andArguments);
100 
101 		final URIish uri = new URIish(sourceUri);
102 		File localNameF;
103 		if (localName == null) {
104 			try {
105 				localName = uri.getHumanishName();
106 				if (isBare) {
107 					localName = localName + Constants.DOT_GIT_EXT;
108 				}
109 				localNameF = new File(SystemReader.getInstance().getProperty(
110 						Constants.OS_USER_DIR), localName);
111 			} catch (IllegalArgumentException e) {
112 				throw die(MessageFormat.format(
113 						CLIText.get().cannotGuessLocalNameFrom, sourceUri), e);
114 			}
115 		} else
116 			localNameF = new File(localName);
117 
118 		if (branch == null)
119 			branch = Constants.HEAD;
120 
121 		CloneCommand command = Git.cloneRepository();
122 		command.setURI(sourceUri).setRemote(remoteName).setBare(isBare)
123 				.setNoCheckout(noCheckout).setBranch(branch)
124 				.setCloneSubmodules(cloneSubmodules);
125 
126 		command.setGitDir(gitdir == null ? null : new File(gitdir));
127 		command.setDirectory(localNameF);
128 		boolean msgs = quiet == null || !quiet.booleanValue();
129 		if (msgs) {
130 			command.setProgressMonitor(new TextProgressMonitor(errw))
131 					.setCallback(this);
132 			outw.println(MessageFormat.format(
133 					CLIText.get().cloningInto, localName));
134 			outw.flush();
135 		}
136 		try {
137 			db = command.call().getRepository();
138 			if (msgs && db.resolve(Constants.HEAD) == null)
139 				outw.println(CLIText.get().clonedEmptyRepository);
140 		} catch (InvalidRemoteException e) {
141 			throw die(MessageFormat.format(CLIText.get().doesNotExist,
142 					sourceUri));
143 		} finally {
144 			if (db != null)
145 				db.close();
146 		}
147 		if (msgs) {
148 			outw.println();
149 			outw.flush();
150 		}
151 	}
152 
153 	/** {@inheritDoc} */
154 	@Override
155 	public void initializedSubmodules(Collection<String> submodules) {
156 		try {
157 			for (String submodule : submodules) {
158 				outw.println(MessageFormat
159 						.format(CLIText.get().submoduleRegistered, submodule));
160 			}
161 			outw.flush();
162 		} catch (IOException e) {
163 			// ignore
164 		}
165 	}
166 
167 	/** {@inheritDoc} */
168 	@Override
169 	public void cloningSubmodule(String path) {
170 		try {
171 			outw.println(MessageFormat.format(
172 					CLIText.get().cloningInto, path));
173 			outw.flush();
174 		} catch (IOException e) {
175 			// ignore
176 		}
177 	}
178 
179 	/** {@inheritDoc} */
180 	@Override
181 	public void checkingOut(AnyObjectId commit, String path) {
182 		try {
183 			outw.println(MessageFormat.format(CLIText.get().checkingOut,
184 					path, commit.getName()));
185 			outw.flush();
186 		} catch (IOException e) {
187 			// ignore
188 		}
189 	}
190 }