View Javadoc
1   /*
2    * Copyright (C) 2011, GitHub Inc. and others
3    *
4    * This program and the accompanying materials are made available under the
5    * terms of the Eclipse Distribution License v. 1.0 which is available at
6    * https://www.eclipse.org/org/documents/edl-v10.php.
7    *
8    * SPDX-License-Identifier: BSD-3-Clause
9    */
10  package org.eclipse.jgit.api;
11  
12  import java.io.IOException;
13  import java.util.ArrayList;
14  import java.util.Collection;
15  import java.util.HashMap;
16  import java.util.Map;
17  
18  import org.eclipse.jgit.api.errors.GitAPIException;
19  import org.eclipse.jgit.api.errors.JGitInternalException;
20  import org.eclipse.jgit.errors.ConfigInvalidException;
21  import org.eclipse.jgit.lib.Constants;
22  import org.eclipse.jgit.lib.ObjectId;
23  import org.eclipse.jgit.lib.Repository;
24  import org.eclipse.jgit.submodule.SubmoduleStatus;
25  import org.eclipse.jgit.submodule.SubmoduleStatusType;
26  import org.eclipse.jgit.submodule.SubmoduleWalk;
27  import org.eclipse.jgit.treewalk.filter.PathFilterGroup;
28  
29  /**
30   * A class used to execute a submodule status command.
31   *
32   * @see <a href=
33   *      "http://www.kernel.org/pub/software/scm/git/docs/git-submodule.html"
34   *      >Git documentation about submodules</a>
35   */
36  public class SubmoduleStatusCommand extends
37  		GitCommand<Map<String, SubmoduleStatus>> {
38  
39  	private final Collection<String> paths;
40  
41  	/**
42  	 * Constructor for SubmoduleStatusCommand.
43  	 *
44  	 * @param repo
45  	 *            a {@link org.eclipse.jgit.lib.Repository} object.
46  	 */
47  	public SubmoduleStatusCommand(Repository repo) {
48  		super(repo);
49  		paths = new ArrayList<>();
50  	}
51  
52  	/**
53  	 * Add repository-relative submodule path to limit status reporting to
54  	 *
55  	 * @param path
56  	 *            (with <code>/</code> as separator)
57  	 * @return this command
58  	 */
59  	public SubmoduleStatusCommand addPath(String path) {
60  		paths.add(path);
61  		return this;
62  	}
63  
64  	/** {@inheritDoc} */
65  	@Override
66  	public Map<String, SubmoduleStatus> call() throws GitAPIException {
67  		checkCallable();
68  
69  		try (SubmoduleWalk generator = SubmoduleWalk.forIndex(repo)) {
70  			if (!paths.isEmpty())
71  				generator.setFilter(PathFilterGroup.createFromStrings(paths));
72  			Map<String, SubmoduleStatus> statuses = new HashMap<>();
73  			while (generator.next()) {
74  				SubmoduleStatus status = getStatus(generator);
75  				statuses.put(status.getPath(), status);
76  			}
77  			return statuses;
78  		} catch (IOException | ConfigInvalidException e) {
79  			throw new JGitInternalException(e.getMessage(), e);
80  		}
81  	}
82  
83  	private SubmoduleStatus getStatus(SubmoduleWalk generator)
84  			throws IOException, ConfigInvalidException {
85  		ObjectId id = generator.getObjectId();
86  		String path = generator.getPath();
87  
88  		// Report missing if no path in .gitmodules file
89  		if (generator.getModulesPath() == null)
90  			return new SubmoduleStatus(SubmoduleStatusType.MISSING, path, id);
91  
92  		// Report uninitialized if no URL in config file
93  		if (generator.getConfigUrl() == null)
94  			return new SubmoduleStatus(SubmoduleStatusType.UNINITIALIZED, path,
95  					id);
96  
97  		// Report uninitialized if no submodule repository
98  		ObjectId headId = null;
99  		try (Repository subRepo = generator.getRepository()) {
100 			if (subRepo == null) {
101 				return new SubmoduleStatus(SubmoduleStatusType.UNINITIALIZED,
102 						path, id);
103 			}
104 
105 			headId = subRepo.resolve(Constants.HEAD);
106 		}
107 
108 		// Report uninitialized if no HEAD commit in submodule repository
109 		if (headId == null)
110 			return new SubmoduleStatus(SubmoduleStatusType.UNINITIALIZED, path,
111 					id, headId);
112 
113 		// Report checked out if HEAD commit is different than index commit
114 		if (!headId.equals(id))
115 			return new SubmoduleStatus(SubmoduleStatusType.REV_CHECKED_OUT,
116 					path, id, headId);
117 
118 		// Report initialized if HEAD commit is the same as the index commit
119 		return new SubmoduleStatus(SubmoduleStatusType.INITIALIZED, path, id,
120 				headId);
121 	}
122 }