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.List;
49
50 import org.eclipse.jgit.api.errors.GitAPIException;
51 import org.eclipse.jgit.api.errors.JGitInternalException;
52 import org.eclipse.jgit.errors.ConfigInvalidException;
53 import org.eclipse.jgit.lib.ConfigConstants;
54 import org.eclipse.jgit.lib.Repository;
55 import org.eclipse.jgit.lib.StoredConfig;
56 import org.eclipse.jgit.submodule.SubmoduleWalk;
57 import org.eclipse.jgit.treewalk.filter.PathFilterGroup;
58
59 /**
60 * A class used to execute a submodule init command.
61 *
62 * This will copy the 'url' and 'update' fields from the working tree
63 * .gitmodules file to a repository's config file for each submodule not
64 * currently present in the repository's config file.
65 *
66 * @see <a href=
67 * "http://www.kernel.org/pub/software/scm/git/docs/git-submodule.html"
68 * >Git documentation about submodules</a>
69 */
70 public class SubmoduleInitCommand extends GitCommand<Collection<String>> {
71
72 private final Collection<String> paths;
73
74 /**
75 * Constructor for SubmoduleInitCommand.
76 *
77 * @param repo
78 * a {@link org.eclipse.jgit.lib.Repository} object.
79 */
80 public SubmoduleInitCommand(Repository repo) {
81 super(repo);
82 paths = new ArrayList<>();
83 }
84
85 /**
86 * Add repository-relative submodule path to initialize
87 *
88 * @param path
89 * (with <code>/</code> as separator)
90 * @return this command
91 */
92 public SubmoduleInitCommand addPath(String path) {
93 paths.add(path);
94 return this;
95 }
96
97 /** {@inheritDoc} */
98 @Override
99 public Collection<String> call() throws GitAPIException {
100 checkCallable();
101
102 try (SubmoduleWalk generator = SubmoduleWalk.forIndex(repo)) {
103 if (!paths.isEmpty())
104 generator.setFilter(PathFilterGroup.createFromStrings(paths));
105 StoredConfig config = repo.getConfig();
106 List<String> initialized = new ArrayList<>();
107 while (generator.next()) {
108 // Ignore entry if URL is already present in config file
109 if (generator.getConfigUrl() != null)
110 continue;
111
112 String path = generator.getPath();
113 String name = generator.getModuleName();
114 // Copy 'url' and 'update' fields from .gitmodules to config
115 // file
116 String url = generator.getRemoteUrl();
117 String update = generator.getModulesUpdate();
118 if (url != null)
119 config.setString(ConfigConstants.CONFIG_SUBMODULE_SECTION,
120 name, ConfigConstants.CONFIG_KEY_URL, url);
121 if (update != null)
122 config.setString(ConfigConstants.CONFIG_SUBMODULE_SECTION,
123 name, ConfigConstants.CONFIG_KEY_UPDATE, update);
124 if (url != null || update != null)
125 initialized.add(path);
126 }
127 // Save repository config if any values were updated
128 if (!initialized.isEmpty())
129 config.save();
130 return initialized;
131 } catch (IOException e) {
132 throw new JGitInternalException(e.getMessage(), e);
133 } catch (ConfigInvalidException e) {
134 throw new JGitInternalException(e.getMessage(), e);
135 }
136 }
137 }