View Javadoc
1   /*
2    * Copyright (C) 2011, 2017 Chris Aniszczyk <caniszczyk@gmail.com>
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  package org.eclipse.jgit.api;
44  
45  import java.io.File;
46  import java.io.IOException;
47  import java.net.URISyntaxException;
48  import java.text.MessageFormat;
49  import java.util.ArrayList;
50  import java.util.Collection;
51  import java.util.List;
52  
53  import org.eclipse.jgit.annotations.Nullable;
54  import org.eclipse.jgit.api.errors.GitAPIException;
55  import org.eclipse.jgit.api.errors.InvalidRemoteException;
56  import org.eclipse.jgit.api.errors.JGitInternalException;
57  import org.eclipse.jgit.dircache.DirCache;
58  import org.eclipse.jgit.dircache.DirCacheCheckout;
59  import org.eclipse.jgit.errors.IncorrectObjectTypeException;
60  import org.eclipse.jgit.errors.MissingObjectException;
61  import org.eclipse.jgit.internal.JGitText;
62  import org.eclipse.jgit.lib.AnyObjectId;
63  import org.eclipse.jgit.lib.BranchConfig.BranchRebaseMode;
64  import org.eclipse.jgit.lib.ConfigConstants;
65  import org.eclipse.jgit.lib.Constants;
66  import org.eclipse.jgit.lib.NullProgressMonitor;
67  import org.eclipse.jgit.lib.ObjectId;
68  import org.eclipse.jgit.lib.ProgressMonitor;
69  import org.eclipse.jgit.lib.Ref;
70  import org.eclipse.jgit.lib.RefUpdate;
71  import org.eclipse.jgit.lib.Repository;
72  import org.eclipse.jgit.revwalk.RevCommit;
73  import org.eclipse.jgit.revwalk.RevWalk;
74  import org.eclipse.jgit.submodule.SubmoduleWalk;
75  import org.eclipse.jgit.transport.FetchResult;
76  import org.eclipse.jgit.transport.RefSpec;
77  import org.eclipse.jgit.transport.RemoteConfig;
78  import org.eclipse.jgit.transport.TagOpt;
79  import org.eclipse.jgit.transport.URIish;
80  import org.eclipse.jgit.util.FileUtils;
81  import org.eclipse.jgit.util.FS;
82  
83  /**
84   * Clone a repository into a new working directory
85   *
86   * @see <a href="http://www.kernel.org/pub/software/scm/git/docs/git-clone.html"
87   *      >Git documentation about Clone</a>
88   */
89  public class CloneCommand extends TransportCommand<CloneCommand, Git> {
90  
91  	private String uri;
92  
93  	private File directory;
94  
95  	private File gitDir;
96  
97  	private boolean bare;
98  
99  	private FS fs;
100 
101 	private String remote = Constants.DEFAULT_REMOTE_NAME;
102 
103 	private String branch = Constants.HEAD;
104 
105 	private ProgressMonitor monitor = NullProgressMonitor.INSTANCE;
106 
107 	private boolean cloneAllBranches;
108 
109 	private boolean cloneSubmodules;
110 
111 	private boolean noCheckout;
112 
113 	private Collection<String> branchesToClone;
114 
115 	private Callback callback;
116 
117 	private boolean directoryExistsInitially;
118 
119 	private boolean gitDirExistsInitially;
120 
121 	/**
122 	 * Callback for status of clone operation.
123 	 *
124 	 * @since 4.8
125 	 */
126 	public interface Callback {
127 		/**
128 		 * Notify initialized submodules.
129 		 *
130 		 * @param submodules
131 		 *            the submodules
132 		 *
133 		 */
134 		void initializedSubmodules(Collection<String> submodules);
135 
136 		/**
137 		 * Notify starting to clone a submodule.
138 		 *
139 		 * @param path
140 		 *            the submodule path
141 		 */
142 		void cloningSubmodule(String path);
143 
144 		/**
145 		 * Notify checkout of commit
146 		 *
147 		 * @param commit
148 		 *            the id of the commit being checked out
149 		 * @param path
150 		 *            the submodule path
151 		 */
152 		void checkingOut(AnyObjectId commit, String path);
153 	}
154 
155 	/**
156 	 * Create clone command with no repository set
157 	 */
158 	public CloneCommand() {
159 		super(null);
160 	}
161 
162 	/**
163 	 * Get the git directory. This is primarily used for tests.
164 	 *
165 	 * @return the git directory
166 	 */
167 	@Nullable
168 	File getDirectory() {
169 		return directory;
170 	}
171 
172 	/**
173 	 * {@inheritDoc}
174 	 * <p>
175 	 * Executes the {@code Clone} command.
176 	 *
177 	 * The Git instance returned by this command needs to be closed by the
178 	 * caller to free resources held by the underlying {@link Repository}
179 	 * instance. It is recommended to call this method as soon as you don't need
180 	 * a reference to this {@link Git} instance and the underlying
181 	 * {@link Repository} instance anymore.
182 	 */
183 	@Override
184 	public Git call() throws GitAPIException, InvalidRemoteException,
185 			org.eclipse.jgit.api.errors.TransportException {
186 		URIish u = null;
187 		try {
188 			u = new URIish(uri);
189 			verifyDirectories(u);
190 		} catch (URISyntaxException e) {
191 			throw new InvalidRemoteException(
192 					MessageFormat.format(JGitText.get().invalidURL, uri));
193 		}
194 		@SuppressWarnings("resource") // Closed by caller
195 		Repository repository = init();
196 		FetchResult fetchResult = null;
197 		Thread cleanupHook = new Thread(() -> cleanup());
198 		Runtime.getRuntime().addShutdownHook(cleanupHook);
199 		try {
200 			fetchResult = fetch(repository, u);
201 		} catch (IOException ioe) {
202 			if (repository != null) {
203 				repository.close();
204 			}
205 			cleanup();
206 			throw new JGitInternalException(ioe.getMessage(), ioe);
207 		} catch (URISyntaxException e) {
208 			if (repository != null) {
209 				repository.close();
210 			}
211 			cleanup();
212 			throw new InvalidRemoteException(MessageFormat.format(
213 					JGitText.get().invalidRemote, remote));
214 		} catch (GitAPIException | RuntimeException e) {
215 			if (repository != null) {
216 				repository.close();
217 			}
218 			cleanup();
219 			throw e;
220 		} finally {
221 			Runtime.getRuntime().removeShutdownHook(cleanupHook);
222 		}
223 		if (!noCheckout) {
224 			try {
225 				checkout(repository, fetchResult);
226 			} catch (IOException ioe) {
227 				repository.close();
228 				throw new JGitInternalException(ioe.getMessage(), ioe);
229 			} catch (GitAPIException | RuntimeException e) {
230 				repository.close();
231 				throw e;
232 			}
233 		}
234 		return new Git(repository, true);
235 	}
236 
237 	private static boolean isNonEmptyDirectory(File dir) {
238 		if (dir != null && dir.exists()) {
239 			File[] files = dir.listFiles();
240 			return files != null && files.length != 0;
241 		}
242 		return false;
243 	}
244 
245 	void verifyDirectories(URIish u) {
246 		if (directory == null && gitDir == null) {
247 			directory = new File(u.getHumanishName() + (bare ? Constants.DOT_GIT_EXT : "")); //$NON-NLS-1$
248 		}
249 		directoryExistsInitially = directory != null && directory.exists();
250 		gitDirExistsInitially = gitDir != null && gitDir.exists();
251 		validateDirs(directory, gitDir, bare);
252 		if (isNonEmptyDirectory(directory)) {
253 			throw new JGitInternalException(MessageFormat.format(
254 					JGitText.get().cloneNonEmptyDirectory, directory.getName()));
255 		}
256 		if (isNonEmptyDirectory(gitDir)) {
257 			throw new JGitInternalException(MessageFormat.format(
258 					JGitText.get().cloneNonEmptyDirectory, gitDir.getName()));
259 		}
260 	}
261 
262 	private Repository init() throws GitAPIException {
263 		InitCommand command = Git.init();
264 		command.setBare(bare);
265 		if (fs != null) {
266 			command.setFs(fs);
267 		}
268 		if (directory != null) {
269 			command.setDirectory(directory);
270 		}
271 		if (gitDir != null) {
272 			command.setGitDir(gitDir);
273 		}
274 		return command.call().getRepository();
275 	}
276 
277 	private FetchResult fetch(Repository clonedRepo, URIish u)
278 			throws URISyntaxException,
279 			org.eclipse.jgit.api.errors.TransportException, IOException,
280 			GitAPIException {
281 		// create the remote config and save it
282 		RemoteConfig config = new RemoteConfig(clonedRepo.getConfig(), remote);
283 		config.addURI(u);
284 
285 		final String dst = (bare ? Constants.R_HEADS : Constants.R_REMOTES
286 				+ config.getName() + "/") + "*"; //$NON-NLS-1$//$NON-NLS-2$
287 		RefSpec refSpec = new RefSpec();
288 		refSpec = refSpec.setForceUpdate(true);
289 		refSpec = refSpec.setSourceDestination(Constants.R_HEADS + "*", dst); //$NON-NLS-1$
290 
291 		config.addFetchRefSpec(refSpec);
292 		config.update(clonedRepo.getConfig());
293 
294 		clonedRepo.getConfig().save();
295 
296 		// run the fetch command
297 		FetchCommand command = new FetchCommand(clonedRepo);
298 		command.setRemote(remote);
299 		command.setProgressMonitor(monitor);
300 		command.setTagOpt(TagOpt.FETCH_TAGS);
301 		configure(command);
302 
303 		List<RefSpec> specs = calculateRefSpecs(dst);
304 		command.setRefSpecs(specs);
305 
306 		return command.call();
307 	}
308 
309 	private List<RefSpec> calculateRefSpecs(String dst) {
310 		RefSpec wcrs = new RefSpec();
311 		wcrs = wcrs.setForceUpdate(true);
312 		wcrs = wcrs.setSourceDestination(Constants.R_HEADS + "*", dst); //$NON-NLS-1$
313 		List<RefSpec> specs = new ArrayList<>();
314 		if (cloneAllBranches)
315 			specs.add(wcrs);
316 		else if (branchesToClone != null
317 				&& branchesToClone.size() > 0) {
318 			for (String selectedRef : branchesToClone)
319 				if (wcrs.matchSource(selectedRef))
320 					specs.add(wcrs.expandFromSource(selectedRef));
321 		}
322 		return specs;
323 	}
324 
325 	private void checkout(Repository clonedRepo, FetchResult result)
326 			throws MissingObjectException, IncorrectObjectTypeException,
327 			IOException, GitAPIException {
328 
329 		Ref head = null;
330 		if (branch.equals(Constants.HEAD)) {
331 			Ref foundBranch = findBranchToCheckout(result);
332 			if (foundBranch != null)
333 				head = foundBranch;
334 		}
335 		if (head == null) {
336 			head = result.getAdvertisedRef(branch);
337 			if (head == null)
338 				head = result.getAdvertisedRef(Constants.R_HEADS + branch);
339 			if (head == null)
340 				head = result.getAdvertisedRef(Constants.R_TAGS + branch);
341 		}
342 
343 		if (head == null || head.getObjectId() == null)
344 			return; // TODO throw exception?
345 
346 		if (head.getName().startsWith(Constants.R_HEADS)) {
347 			final RefUpdate newHead = clonedRepo.updateRef(Constants.HEAD);
348 			newHead.disableRefLog();
349 			newHead.link(head.getName());
350 			addMergeConfig(clonedRepo, head);
351 		}
352 
353 		final RevCommit commit = parseCommit(clonedRepo, head);
354 
355 		boolean detached = !head.getName().startsWith(Constants.R_HEADS);
356 		RefUpdate u = clonedRepo.updateRef(Constants.HEAD, detached);
357 		u.setNewObjectId(commit.getId());
358 		u.forceUpdate();
359 
360 		if (!bare) {
361 			DirCache dc = clonedRepo.lockDirCache();
362 			DirCacheCheckout co = new DirCacheCheckout(clonedRepo, dc,
363 					commit.getTree());
364 			co.setProgressMonitor(monitor);
365 			co.checkout();
366 			if (cloneSubmodules)
367 				cloneSubmodules(clonedRepo);
368 		}
369 	}
370 
371 	private void cloneSubmodules(Repository clonedRepo) throws IOException,
372 			GitAPIException {
373 		SubmoduleInitCommand init = new SubmoduleInitCommand(clonedRepo);
374 		Collection<String> submodules = init.call();
375 		if (submodules.isEmpty()) {
376 			return;
377 		}
378 		if (callback != null) {
379 			callback.initializedSubmodules(submodules);
380 		}
381 
382 		SubmoduleUpdateCommand update = new SubmoduleUpdateCommand(clonedRepo);
383 		configure(update);
384 		update.setProgressMonitor(monitor);
385 		update.setCallback(callback);
386 		if (!update.call().isEmpty()) {
387 			SubmoduleWalk walk = SubmoduleWalk.forIndex(clonedRepo);
388 			while (walk.next()) {
389 				try (Repository subRepo = walk.getRepository()) {
390 					if (subRepo != null) {
391 						cloneSubmodules(subRepo);
392 					}
393 				}
394 			}
395 		}
396 	}
397 
398 	private Ref findBranchToCheckout(FetchResult result) {
399 		final Ref idHEAD = result.getAdvertisedRef(Constants.HEAD);
400 		ObjectId headId = idHEAD != null ? idHEAD.getObjectId() : null;
401 		if (headId == null) {
402 			return null;
403 		}
404 
405 		Ref master = result.getAdvertisedRef(Constants.R_HEADS
406 				+ Constants.MASTER);
407 		ObjectId objectId = master != null ? master.getObjectId() : null;
408 		if (headId.equals(objectId)) {
409 			return master;
410 		}
411 
412 		Ref foundBranch = null;
413 		for (Ref r : result.getAdvertisedRefs()) {
414 			final String n = r.getName();
415 			if (!n.startsWith(Constants.R_HEADS))
416 				continue;
417 			if (headId.equals(r.getObjectId())) {
418 				foundBranch = r;
419 				break;
420 			}
421 		}
422 		return foundBranch;
423 	}
424 
425 	private void addMergeConfig(Repository clonedRepo, Ref head)
426 			throws IOException {
427 		String branchName = Repository.shortenRefName(head.getName());
428 		clonedRepo.getConfig().setString(ConfigConstants.CONFIG_BRANCH_SECTION,
429 				branchName, ConfigConstants.CONFIG_KEY_REMOTE, remote);
430 		clonedRepo.getConfig().setString(ConfigConstants.CONFIG_BRANCH_SECTION,
431 				branchName, ConfigConstants.CONFIG_KEY_MERGE, head.getName());
432 		String autosetupRebase = clonedRepo.getConfig().getString(
433 				ConfigConstants.CONFIG_BRANCH_SECTION, null,
434 				ConfigConstants.CONFIG_KEY_AUTOSETUPREBASE);
435 		if (ConfigConstants.CONFIG_KEY_ALWAYS.equals(autosetupRebase)
436 				|| ConfigConstants.CONFIG_KEY_REMOTE.equals(autosetupRebase))
437 			clonedRepo.getConfig().setEnum(
438 					ConfigConstants.CONFIG_BRANCH_SECTION, branchName,
439 					ConfigConstants.CONFIG_KEY_REBASE, BranchRebaseMode.REBASE);
440 		clonedRepo.getConfig().save();
441 	}
442 
443 	private RevCommit parseCommit(Repository clonedRepo, Ref ref)
444 			throws MissingObjectException, IncorrectObjectTypeException,
445 			IOException {
446 		final RevCommit commit;
447 		try (RevWalk rw = new RevWalk(clonedRepo)) {
448 			commit = rw.parseCommit(ref.getObjectId());
449 		}
450 		return commit;
451 	}
452 
453 	/**
454 	 * Set the URI to clone from
455 	 *
456 	 * @param uri
457 	 *            the URI to clone from, or {@code null} to unset the URI. The
458 	 *            URI must be set before {@link #call} is called.
459 	 * @return this instance
460 	 */
461 	public CloneCommand setURI(String uri) {
462 		this.uri = uri;
463 		return this;
464 	}
465 
466 	/**
467 	 * The optional directory associated with the clone operation. If the
468 	 * directory isn't set, a name associated with the source uri will be used.
469 	 *
470 	 * @see URIish#getHumanishName()
471 	 * @param directory
472 	 *            the directory to clone to, or {@code null} if the directory
473 	 *            name should be taken from the source uri
474 	 * @return this instance
475 	 * @throws java.lang.IllegalStateException
476 	 *             if the combination of directory, gitDir and bare is illegal.
477 	 *             E.g. if for a non-bare repository directory and gitDir point
478 	 *             to the same directory of if for a bare repository both
479 	 *             directory and gitDir are specified
480 	 */
481 	public CloneCommand setDirectory(File directory) {
482 		validateDirs(directory, gitDir, bare);
483 		this.directory = directory;
484 		return this;
485 	}
486 
487 	/**
488 	 * Set the repository meta directory (.git)
489 	 *
490 	 * @param gitDir
491 	 *            the repository meta directory, or {@code null} to choose one
492 	 *            automatically at clone time
493 	 * @return this instance
494 	 * @throws java.lang.IllegalStateException
495 	 *             if the combination of directory, gitDir and bare is illegal.
496 	 *             E.g. if for a non-bare repository directory and gitDir point
497 	 *             to the same directory of if for a bare repository both
498 	 *             directory and gitDir are specified
499 	 * @since 3.6
500 	 */
501 	public CloneCommand setGitDir(File gitDir) {
502 		validateDirs(directory, gitDir, bare);
503 		this.gitDir = gitDir;
504 		return this;
505 	}
506 
507 	/**
508 	 * Set whether the cloned repository shall be bare
509 	 *
510 	 * @param bare
511 	 *            whether the cloned repository is bare or not
512 	 * @return this instance
513 	 * @throws java.lang.IllegalStateException
514 	 *             if the combination of directory, gitDir and bare is illegal.
515 	 *             E.g. if for a non-bare repository directory and gitDir point
516 	 *             to the same directory of if for a bare repository both
517 	 *             directory and gitDir are specified
518 	 */
519 	public CloneCommand setBare(boolean bare) throws IllegalStateException {
520 		validateDirs(directory, gitDir, bare);
521 		this.bare = bare;
522 		return this;
523 	}
524 
525 	/**
526 	 * Set the file system abstraction to be used for repositories created by
527 	 * this command.
528 	 *
529 	 * @param fs
530 	 *            the abstraction.
531 	 * @return {@code this} (for chaining calls).
532 	 * @since 4.10
533 	 */
534 	public CloneCommand setFs(FS fs) {
535 		this.fs = fs;
536 		return this;
537 	}
538 
539 	/**
540 	 * The remote name used to keep track of the upstream repository for the
541 	 * clone operation. If no remote name is set, the default value of
542 	 * <code>Constants.DEFAULT_REMOTE_NAME</code> will be used.
543 	 *
544 	 * @see Constants#DEFAULT_REMOTE_NAME
545 	 * @param remote
546 	 *            name that keeps track of the upstream repository.
547 	 *            {@code null} means to use DEFAULT_REMOTE_NAME.
548 	 * @return this instance
549 	 */
550 	public CloneCommand setRemote(String remote) {
551 		if (remote == null) {
552 			remote = Constants.DEFAULT_REMOTE_NAME;
553 		}
554 		this.remote = remote;
555 		return this;
556 	}
557 
558 	/**
559 	 * Set the initial branch
560 	 *
561 	 * @param branch
562 	 *            the initial branch to check out when cloning the repository.
563 	 *            Can be specified as ref name (<code>refs/heads/master</code>),
564 	 *            branch name (<code>master</code>) or tag name
565 	 *            (<code>v1.2.3</code>). The default is to use the branch
566 	 *            pointed to by the cloned repository's HEAD and can be
567 	 *            requested by passing {@code null} or <code>HEAD</code>.
568 	 * @return this instance
569 	 */
570 	public CloneCommand setBranch(String branch) {
571 		if (branch == null) {
572 			branch = Constants.HEAD;
573 		}
574 		this.branch = branch;
575 		return this;
576 	}
577 
578 	/**
579 	 * The progress monitor associated with the clone operation. By default,
580 	 * this is set to <code>NullProgressMonitor</code>
581 	 *
582 	 * @see NullProgressMonitor
583 	 * @param monitor
584 	 *            a {@link org.eclipse.jgit.lib.ProgressMonitor}
585 	 * @return {@code this}
586 	 */
587 	public CloneCommand setProgressMonitor(ProgressMonitor monitor) {
588 		if (monitor == null) {
589 			monitor = NullProgressMonitor.INSTANCE;
590 		}
591 		this.monitor = monitor;
592 		return this;
593 	}
594 
595 	/**
596 	 * Set whether all branches have to be fetched
597 	 *
598 	 * @param cloneAllBranches
599 	 *            true when all branches have to be fetched (indicates wildcard
600 	 *            in created fetch refspec), false otherwise.
601 	 * @return {@code this}
602 	 */
603 	public CloneCommand setCloneAllBranches(boolean cloneAllBranches) {
604 		this.cloneAllBranches = cloneAllBranches;
605 		return this;
606 	}
607 
608 	/**
609 	 * Set whether to clone submodules
610 	 *
611 	 * @param cloneSubmodules
612 	 *            true to initialize and update submodules. Ignored when
613 	 *            {@link #setBare(boolean)} is set to true.
614 	 * @return {@code this}
615 	 */
616 	public CloneCommand setCloneSubmodules(boolean cloneSubmodules) {
617 		this.cloneSubmodules = cloneSubmodules;
618 		return this;
619 	}
620 
621 	/**
622 	 * Set branches to clone
623 	 *
624 	 * @param branchesToClone
625 	 *            collection of branches to clone. Ignored when allSelected is
626 	 *            true. Must be specified as full ref names (e.g.
627 	 *            <code>refs/heads/master</code>).
628 	 * @return {@code this}
629 	 */
630 	public CloneCommand setBranchesToClone(Collection<String> branchesToClone) {
631 		this.branchesToClone = branchesToClone;
632 		return this;
633 	}
634 
635 	/**
636 	 * Set whether to skip checking out a branch
637 	 *
638 	 * @param noCheckout
639 	 *            if set to <code>true</code> no branch will be checked out
640 	 *            after the clone. This enhances performance of the clone
641 	 *            command when there is no need for a checked out branch.
642 	 * @return {@code this}
643 	 */
644 	public CloneCommand setNoCheckout(boolean noCheckout) {
645 		this.noCheckout = noCheckout;
646 		return this;
647 	}
648 
649 	/**
650 	 * Register a progress callback.
651 	 *
652 	 * @param callback
653 	 *            the callback
654 	 * @return {@code this}
655 	 * @since 4.8
656 	 */
657 	public CloneCommand setCallback(Callback callback) {
658 		this.callback = callback;
659 		return this;
660 	}
661 
662 	private static void validateDirs(File directory, File gitDir, boolean bare)
663 			throws IllegalStateException {
664 		if (directory != null) {
665 			if (directory.exists() && !directory.isDirectory()) {
666 				throw new IllegalStateException(MessageFormat.format(
667 						JGitText.get().initFailedDirIsNoDirectory, directory));
668 			}
669 			if (gitDir != null && gitDir.exists() && !gitDir.isDirectory()) {
670 				throw new IllegalStateException(MessageFormat.format(
671 						JGitText.get().initFailedGitDirIsNoDirectory,
672 						gitDir));
673 			}
674 			if (bare) {
675 				if (gitDir != null && !gitDir.equals(directory))
676 					throw new IllegalStateException(MessageFormat.format(
677 							JGitText.get().initFailedBareRepoDifferentDirs,
678 							gitDir, directory));
679 			} else {
680 				if (gitDir != null && gitDir.equals(directory))
681 					throw new IllegalStateException(MessageFormat.format(
682 							JGitText.get().initFailedNonBareRepoSameDirs,
683 							gitDir, directory));
684 			}
685 		}
686 	}
687 
688 	private void cleanup() {
689 		try {
690 			if (directory != null) {
691 				if (!directoryExistsInitially) {
692 					FileUtils.delete(directory, FileUtils.RECURSIVE
693 							| FileUtils.SKIP_MISSING | FileUtils.IGNORE_ERRORS);
694 				} else {
695 					deleteChildren(directory);
696 				}
697 			}
698 			if (gitDir != null) {
699 				if (!gitDirExistsInitially) {
700 					FileUtils.delete(gitDir, FileUtils.RECURSIVE
701 							| FileUtils.SKIP_MISSING | FileUtils.IGNORE_ERRORS);
702 				} else {
703 					deleteChildren(directory);
704 				}
705 			}
706 		} catch (IOException e) {
707 			// Ignore; this is a best-effort cleanup in error cases, and
708 			// IOException should not be raised anyway
709 		}
710 	}
711 
712 	private void deleteChildren(File file) throws IOException {
713 		File[] files = file.listFiles();
714 		if (files == null) {
715 			return;
716 		}
717 		for (File child : files) {
718 			FileUtils.delete(child, FileUtils.RECURSIVE | FileUtils.SKIP_MISSING
719 					| FileUtils.IGNORE_ERRORS);
720 		}
721 	}
722 }