1 /*
2 * Copyright (C) 2011, GitHub 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 package org.eclipse.jgit.api;
44
45 import java.io.IOException;
46 import java.util.ArrayList;
47 import java.util.Collection;
48 import java.util.HashMap;
49 import java.util.Map;
50
51 import org.eclipse.jgit.api.errors.GitAPIException;
52 import org.eclipse.jgit.api.errors.JGitInternalException;
53 import org.eclipse.jgit.errors.ConfigInvalidException;
54 import org.eclipse.jgit.lib.Constants;
55 import org.eclipse.jgit.lib.ObjectId;
56 import org.eclipse.jgit.lib.Repository;
57 import org.eclipse.jgit.submodule.SubmoduleStatus;
58 import org.eclipse.jgit.submodule.SubmoduleStatusType;
59 import org.eclipse.jgit.submodule.SubmoduleWalk;
60 import org.eclipse.jgit.treewalk.filter.PathFilterGroup;
61
62 /**
63 * A class used to execute a submodule status command.
64 *
65 * @see <a href=
66 * "http://www.kernel.org/pub/software/scm/git/docs/git-submodule.html"
67 * >Git documentation about submodules</a>
68 */
69 public class SubmoduleStatusCommand extends
70 GitCommand<Map<String, SubmoduleStatus>> {
71
72 private final Collection<String> paths;
73
74 /**
75 * Constructor for SubmoduleStatusCommand.
76 *
77 * @param repo
78 * a {@link org.eclipse.jgit.lib.Repository} object.
79 */
80 public SubmoduleStatusCommand(Repository repo) {
81 super(repo);
82 paths = new ArrayList<>();
83 }
84
85 /**
86 * Add repository-relative submodule path to limit status reporting to
87 *
88 * @param path
89 * (with <code>/</code> as separator)
90 * @return this command
91 */
92 public SubmoduleStatusCommand addPath(String path) {
93 paths.add(path);
94 return this;
95 }
96
97 /** {@inheritDoc} */
98 @Override
99 public Map<String, SubmoduleStatus> call() throws GitAPIException {
100 checkCallable();
101
102 try (SubmoduleWalk generator = SubmoduleWalk.forIndex(repo)) {
103 if (!paths.isEmpty())
104 generator.setFilter(PathFilterGroup.createFromStrings(paths));
105 Map<String, SubmoduleStatus> statuses = new HashMap<>();
106 while (generator.next()) {
107 SubmoduleStatus status = getStatus(generator);
108 statuses.put(status.getPath(), status);
109 }
110 return statuses;
111 } catch (IOException e) {
112 throw new JGitInternalException(e.getMessage(), e);
113 } catch (ConfigInvalidException e) {
114 throw new JGitInternalException(e.getMessage(), e);
115 }
116 }
117
118 private SubmoduleStatus getStatus(SubmoduleWalk generator)
119 throws IOException, ConfigInvalidException {
120 ObjectId id = generator.getObjectId();
121 String path = generator.getPath();
122
123 // Report missing if no path in .gitmodules file
124 if (generator.getModulesPath() == null)
125 return new SubmoduleStatus(SubmoduleStatusType.MISSING, path, id);
126
127 // Report uninitialized if no URL in config file
128 if (generator.getConfigUrl() == null)
129 return new SubmoduleStatus(SubmoduleStatusType.UNINITIALIZED, path,
130 id);
131
132 // Report uninitialized if no submodule repository
133 ObjectId headId = null;
134 try (Repository subRepo = generator.getRepository()) {
135 if (subRepo == null) {
136 return new SubmoduleStatus(SubmoduleStatusType.UNINITIALIZED,
137 path, id);
138 }
139
140 headId = subRepo.resolve(Constants.HEAD);
141 }
142
143 // Report uninitialized if no HEAD commit in submodule repository
144 if (headId == null)
145 return new SubmoduleStatus(SubmoduleStatusType.UNINITIALIZED, path,
146 id, headId);
147
148 // Report checked out if HEAD commit is different than index commit
149 if (!headId.equals(id))
150 return new SubmoduleStatus(SubmoduleStatusType.REV_CHECKED_OUT,
151 path, id, headId);
152
153 // Report initialized if HEAD commit is the same as the index commit
154 return new SubmoduleStatus(SubmoduleStatusType.INITIALIZED, path, id,
155 headId);
156 }
157 }