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.ConfigConstants;
55 import org.eclipse.jgit.lib.Constants;
56 import org.eclipse.jgit.lib.Ref;
57 import org.eclipse.jgit.lib.Repository;
58 import org.eclipse.jgit.lib.StoredConfig;
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 sync command.
64 *
65 * This will set the remote URL in a submodule's repository to the current value
66 * in the .gitmodules file.
67 *
68 * @see <a href=
69 * "http://www.kernel.org/pub/software/scm/git/docs/git-submodule.html"
70 * >Git documentation about submodules</a>
71 */
72 public class SubmoduleSyncCommand extends GitCommand<Map<String, String>> {
73
74 private final Collection<String> paths;
75
76 /**
77 * Constructor for SubmoduleSyncCommand.
78 *
79 * @param repo
80 * a {@link org.eclipse.jgit.lib.Repository} object.
81 */
82 public SubmoduleSyncCommand(final Repository repo) {
83 super(repo);
84 paths = new ArrayList<>();
85 }
86
87 /**
88 * Add repository-relative submodule path to synchronize
89 *
90 * @param path
91 * (with <code>/</code> as separator)
92 * @return this command
93 */
94 public SubmoduleSyncCommand addPath(final String path) {
95 paths.add(path);
96 return this;
97 }
98
99 /**
100 * Get branch that HEAD currently points to
101 *
102 * @param subRepo
103 * a {@link org.eclipse.jgit.lib.Repository} object.
104 * @return shortened branch name, null on failures
105 * @throws java.io.IOException
106 */
107 protected String getHeadBranch(final Repository subRepo) throws IOException {
108 Ref head = subRepo.exactRef(Constants.HEAD);
109 if (head != null && head.isSymbolic())
110 return Repository.shortenRefName(head.getLeaf().getName());
111 else
112 return null;
113 }
114
115 /** {@inheritDoc} */
116 @Override
117 public Map<String, String> call() throws GitAPIException {
118 checkCallable();
119
120 try (SubmoduleWalk generator = SubmoduleWalk.forIndex(repo)) {
121 if (!paths.isEmpty())
122 generator.setFilter(PathFilterGroup.createFromStrings(paths));
123 Map<String, String> synced = new HashMap<>();
124 StoredConfig config = repo.getConfig();
125 while (generator.next()) {
126 String remoteUrl = generator.getRemoteUrl();
127 if (remoteUrl == null)
128 continue;
129
130 String path = generator.getPath();
131 config.setString(ConfigConstants.CONFIG_SUBMODULE_SECTION,
132 path, ConfigConstants.CONFIG_KEY_URL, remoteUrl);
133 synced.put(path, remoteUrl);
134
135 Repository subRepo = generator.getRepository();
136 if (subRepo == null)
137 continue;
138
139 StoredConfig subConfig;
140 String branch;
141 try {
142 subConfig = subRepo.getConfig();
143 // Get name of remote associated with current branch and
144 // fall back to default remote name as last resort
145 branch = getHeadBranch(subRepo);
146 String remote = null;
147 if (branch != null)
148 remote = subConfig.getString(
149 ConfigConstants.CONFIG_BRANCH_SECTION, branch,
150 ConfigConstants.CONFIG_KEY_REMOTE);
151 if (remote == null)
152 remote = Constants.DEFAULT_REMOTE_NAME;
153
154 subConfig.setString(ConfigConstants.CONFIG_REMOTE_SECTION,
155 remote, ConfigConstants.CONFIG_KEY_URL, remoteUrl);
156 subConfig.save();
157 } finally {
158 subRepo.close();
159 }
160 }
161 if (!synced.isEmpty())
162 config.save();
163 return synced;
164 } catch (IOException e) {
165 throw new JGitInternalException(e.getMessage(), e);
166 } catch (ConfigInvalidException e) {
167 throw new JGitInternalException(e.getMessage(), e);
168 }
169 }
170 }