1 /*
2 * The MIT License (MIT)
3 *
4 * Copyright (c) 2013-2026 The Coveralls Maven Plugin Project Contributors:
5 * https://github.com/hazendaz/coveralls-maven-plugin/graphs/contributors
6 *
7 * Permission is hereby granted, free of charge, to any person obtaining a copy
8 * of this software and associated documentation files (the "Software"), to deal
9 * in the Software without restriction, including without limitation the rights
10 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11 * copies of the Software, and to permit persons to whom the Software is
12 * furnished to do so, subject to the following conditions:
13 *
14 * The above copyright notice and this permission notice shall be included in
15 * all copies or substantial portions of the Software.
16 *
17 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
23 * THE SOFTWARE.
24 */
25 package org.eluder.coveralls.maven.plugin.source;
26
27 import java.io.IOException;
28 import java.io.InputStream;
29 import java.net.URI;
30 import java.nio.charset.Charset;
31
32 import org.eluder.coveralls.maven.plugin.domain.Source;
33 import org.eluder.coveralls.maven.plugin.util.Sha512DigestInputStream;
34
35 /**
36 * The Class AbstractSourceLoader.
37 */
38 public abstract class AbstractSourceLoader implements SourceLoader {
39
40 /** The source encoding. */
41 private final Charset sourceEncoding;
42
43 /** The directory prefix. */
44 private final String directoryPrefix;
45
46 /**
47 * Instantiates a new abstract source loader.
48 *
49 * @param base
50 * the base
51 * @param sourceBase
52 * the source base
53 * @param sourceEncoding
54 * the source encoding
55 */
56 protected AbstractSourceLoader(final URI base, final URI sourceBase, final Charset sourceEncoding) {
57 this.sourceEncoding = sourceEncoding;
58 this.directoryPrefix = base.relativize(sourceBase).toString();
59 }
60
61 @Override
62 public Source load(final String sourceFile) throws IOException {
63 final var stream = this.locate(sourceFile);
64 if (stream == null) {
65 return null;
66 }
67 try (var ds = new Sha512DigestInputStream(stream)) {
68 final var source = new String(ds.readAllBytes(), this.getSourceEncoding());
69 return new Source(this.getFileName(sourceFile), source, ds.getDigestHex());
70 }
71 }
72
73 /**
74 * Gets the source encoding.
75 *
76 * @return the source encoding
77 */
78 protected Charset getSourceEncoding() {
79 return this.sourceEncoding;
80 }
81
82 /**
83 * Gets the file name.
84 *
85 * @param sourceFile
86 * the source file
87 *
88 * @return the file name
89 */
90 protected String getFileName(final String sourceFile) {
91 return this.directoryPrefix + sourceFile;
92 }
93
94 /**
95 * Locate.
96 *
97 * @param sourceFile
98 * the source file
99 *
100 * @return the input stream
101 *
102 * @throws IOException
103 * Signals that an I/O exception has occurred.
104 */
105 protected abstract InputStream locate(String sourceFile) throws IOException;
106 }