You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

SubmoduleSyncCommand.java 5.2KB

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