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.eclipse.aether.internal.impl.synccontext.named;
20  
21  import java.util.Collection;
22  import java.util.stream.Collectors;
23  
24  import org.eclipse.aether.RepositorySystemSession;
25  import org.eclipse.aether.artifact.Artifact;
26  import org.eclipse.aether.metadata.Metadata;
27  import org.eclipse.aether.util.ConfigUtils;
28  import org.eclipse.aether.util.StringDigestUtil;
29  
30  import static java.util.Objects.requireNonNull;
31  
32  /**
33   * Wrapping {@link NameMapper}, that wraps another {@link NameMapper} and hashes resulting strings. It makes use of
34   * fact that (proper) Hash will create unique fixed length string for each different input string (so injection still
35   * stands). This mapper produces file system friendly names. Supports different "depths" (0-4 inclusive) where the
36   * name will contain 0 to 4 level deep directories.
37   * <p>
38   * This mapper is usable in any scenario, but intent was to produce more "compact" name mapper for file locking.
39   *
40   * @since 1.9.0
41   */
42  public class HashingNameMapper implements NameMapper {
43      private static final String CONFIG_PROP_DEPTH = "aether.syncContext.named.hashing.depth";
44  
45      private final NameMapper delegate;
46  
47      public HashingNameMapper(final NameMapper delegate) {
48          this.delegate = requireNonNull(delegate);
49      }
50  
51      @Override
52      public boolean isFileSystemFriendly() {
53          return true; // hashes delegated strings, so whatever it wrapped, it does not come through
54      }
55  
56      @Override
57      public Collection<String> nameLocks(
58              RepositorySystemSession session,
59              Collection<? extends Artifact> artifacts,
60              Collection<? extends Metadata> metadatas) {
61          final int depth = ConfigUtils.getInteger(session, 2, CONFIG_PROP_DEPTH);
62          if (depth < 0 || depth > 4) {
63              throw new IllegalArgumentException("allowed depth value is between 0 and 4 (inclusive)");
64          }
65          return delegate.nameLocks(session, artifacts, metadatas).stream()
66                  .map(n -> hashName(n, depth))
67                  .collect(Collectors.toList());
68      }
69  
70      private String hashName(final String name, final int depth) {
71          String hashedName = StringDigestUtil.sha1(name);
72          if (depth == 0) {
73              return hashedName;
74          }
75          StringBuilder prefix = new StringBuilder("");
76          int i = 0;
77          while (i < hashedName.length() && i / 2 < depth) {
78              prefix.append(hashedName, i, i + 2).append("/");
79              i += 2;
80          }
81          return prefix.append(hashedName).toString();
82      }
83  }