View Javadoc
1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one
3    * or more contributor license agreements.  See the NOTICE file
4    * distributed with this work for additional information
5    * regarding copyright ownership.  The ASF licenses this file
6    * to you under the Apache License, Version 2.0 (the
7    * "License"); you may not use this file except in compliance
8    * with the License.  You may obtain a copy of the License at
9    *
10   *   http://www.apache.org/licenses/LICENSE-2.0
11   *
12   * Unless required by applicable law or agreed to in writing,
13   * software distributed under the License is distributed on an
14   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15   * KIND, either express or implied.  See the License for the
16   * specific language governing permissions and limitations
17   * under the License.
18   */
19  package org.apache.maven.shared.release.scm;
20  
21  import javax.inject.Inject;
22  import javax.inject.Named;
23  import javax.inject.Singleton;
24  
25  import java.util.concurrent.atomic.AtomicReference;
26  
27  import org.apache.maven.scm.manager.NoSuchScmProviderException;
28  import org.apache.maven.scm.manager.ScmManager;
29  import org.apache.maven.scm.provider.ScmProvider;
30  import org.apache.maven.scm.provider.ScmProviderRepository;
31  import org.apache.maven.scm.provider.ScmProviderRepositoryWithHost;
32  import org.apache.maven.scm.provider.svn.repository.SvnScmProviderRepository;
33  import org.apache.maven.scm.repository.ScmRepository;
34  import org.apache.maven.scm.repository.ScmRepositoryException;
35  import org.apache.maven.settings.Server;
36  import org.apache.maven.settings.Settings;
37  import org.apache.maven.shared.release.config.ReleaseDescriptor;
38  import org.apache.maven.shared.release.util.MavenCrypto;
39  import org.apache.maven.shared.release.util.MavenCrypto.MavenCryptoException;
40  import org.slf4j.Logger;
41  import org.slf4j.LoggerFactory;
42  
43  import static java.util.Objects.requireNonNull;
44  
45  /**
46   * Tool that gets a configured SCM repository from release configuration.
47   *
48   * @author <a href="mailto:brett@apache.org">Brett Porter</a>
49   */
50  @Singleton
51  @Named
52  public class DefaultScmRepositoryConfigurator implements ScmRepositoryConfigurator {
53      private final Logger logger = LoggerFactory.getLogger(getClass());
54  
55      private final AtomicReference<ScmManager> scmManager;
56  
57      private final MavenCrypto mavenCrypto;
58  
59      @Inject
60      public DefaultScmRepositoryConfigurator(ScmManager scmManager, MavenCrypto mavenCrypto) {
61          this.scmManager = new AtomicReference<>(requireNonNull(scmManager));
62          this.mavenCrypto = requireNonNull(mavenCrypto);
63      }
64  
65      /**
66       * For testing purposes only!
67       */
68      public void setScmManager(ScmManager scmManager) {
69          this.scmManager.set(scmManager);
70      }
71  
72      @Override
73      public ScmRepository getConfiguredRepository(ReleaseDescriptor releaseDescriptor, Settings settings)
74              throws ScmRepositoryException, NoSuchScmProviderException {
75          String url = releaseDescriptor.getScmSourceUrl();
76          return getConfiguredRepository(url, releaseDescriptor, settings);
77      }
78  
79      @Override
80      public ScmRepository getConfiguredRepository(String url, ReleaseDescriptor releaseDescriptor, Settings settings)
81              throws ScmRepositoryException, NoSuchScmProviderException {
82          String username = releaseDescriptor.getScmUsername();
83          String password = releaseDescriptor.getScmPassword();
84          String privateKey = releaseDescriptor.getScmPrivateKey();
85          String passphrase = releaseDescriptor.getScmPrivateKeyPassPhrase();
86  
87          ScmRepository repository = scmManager.get().makeScmRepository(url);
88  
89          ScmProviderRepository scmRepo = repository.getProviderRepository();
90  
91          // MRELEASE-76
92          scmRepo.setPersistCheckout(false);
93  
94          if (settings != null) {
95              Server server = null;
96  
97              if (releaseDescriptor.getScmId() != null) {
98                  server = settings.getServer(releaseDescriptor.getScmId());
99              }
100 
101             if (server == null && repository.getProviderRepository() instanceof ScmProviderRepositoryWithHost) {
102                 ScmProviderRepositoryWithHost repositoryWithHost =
103                         (ScmProviderRepositoryWithHost) repository.getProviderRepository();
104                 String host = repositoryWithHost.getHost();
105 
106                 int port = repositoryWithHost.getPort();
107 
108                 if (port > 0) {
109                     host += ":" + port;
110                 }
111 
112                 // TODO: this is a bit dodgy - id is not host, but since we don't have a <host> field we make an
113                 // assumption
114                 server = settings.getServer(host);
115             }
116 
117             if (server != null) {
118                 if (username == null) {
119                     username = server.getUsername();
120                 }
121 
122                 if (password == null) {
123                     password = decrypt(server.getPassword(), server.getId());
124                 }
125 
126                 if (privateKey == null) {
127                     privateKey = server.getPrivateKey();
128                 }
129 
130                 if (passphrase == null) {
131                     passphrase = decrypt(server.getPassphrase(), server.getId());
132                 }
133             }
134         }
135 
136         if (!(username == null || username.isEmpty())) {
137             scmRepo.setUser(username);
138         }
139         if (!(password == null || password.isEmpty())) {
140             scmRepo.setPassword(password);
141         }
142 
143         if (scmRepo instanceof ScmProviderRepositoryWithHost) {
144             ScmProviderRepositoryWithHost repositoryWithHost = (ScmProviderRepositoryWithHost) scmRepo;
145             if (!(privateKey == null || privateKey.isEmpty())) {
146                 repositoryWithHost.setPrivateKey(privateKey);
147             }
148 
149             if (!(passphrase == null || passphrase.isEmpty())) {
150                 repositoryWithHost.setPassphrase(passphrase);
151             }
152         }
153 
154         if ("svn".equals(repository.getProvider())) {
155             SvnScmProviderRepository svnRepo = (SvnScmProviderRepository) repository.getProviderRepository();
156 
157             String tagBase = releaseDescriptor.getScmTagBase();
158             if (!(tagBase == null || tagBase.isEmpty())) {
159                 svnRepo.setTagBase(tagBase);
160             }
161 
162             String branchBase = releaseDescriptor.getScmBranchBase();
163             if (!(branchBase == null || branchBase.isEmpty())) {
164                 svnRepo.setBranchBase(branchBase);
165             }
166         }
167 
168         return repository;
169     }
170 
171     private String decrypt(String str, String server) {
172         try {
173             return mavenCrypto.decrypt(str);
174         } catch (MavenCryptoException e) {
175             String msg = "Failed to decrypt password/passphrase for server " + server + ", using auth token as is: "
176                     + e.getMessage();
177             if (logger.isDebugEnabled()) {
178                 logger.warn(msg, e);
179             } else {
180                 logger.warn(msg);
181             }
182             return str;
183         }
184     }
185 
186     @Override
187     public ScmProvider getRepositoryProvider(ScmRepository repository) throws NoSuchScmProviderException {
188         return scmManager.get().getProviderByRepository(repository);
189     }
190 }