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.rat.report.claim.util;
20
21 import java.io.File;
22 import java.io.IOException;
23
24 import org.apache.rat.analysis.UnknownLicense;
25 import org.apache.rat.annotation.AbstractLicenseAppender;
26 import org.apache.rat.annotation.ApacheV2LicenseAppender;
27 import org.apache.rat.api.Document;
28 import org.apache.rat.api.RatException;
29 import org.apache.rat.report.AbstractReport;
30
31 /**
32 * A Report that adds licenses text to files.
33 */
34 public class LicenseAddingReport extends AbstractReport {
35 /** The license appender used to update files */
36 private final AbstractLicenseAppender appender;
37
38 /**
39 * Creates a LicenseAddingReport that inserts the copyright message and may overwrite the files.
40 * @param copyrightMsg The message to insert into the files. May be {@code null}.
41 * @param overwrite if {@code true} will overwrite the files rather than create {@code .new} files.
42 */
43 public LicenseAddingReport(final String copyrightMsg, final boolean overwrite) {
44 appender = copyrightMsg == null ? new ApacheV2LicenseAppender()
45 : new ApacheV2LicenseAppender(copyrightMsg);
46 appender.setOverwrite(overwrite);
47 }
48
49 @Override
50 public void report(final Document document) throws RatException {
51 if (document.getMetaData().licenses().anyMatch(lic -> lic.equals(UnknownLicense.INSTANCE))) {
52 final File file = new File(document.getName().getName());
53 if (file.isFile()) {
54 try {
55 appender.append(file);
56 } catch (IOException e) {
57 throw new RatException(e.getMessage(), e);
58 }
59 }
60 }
61 }
62 }