Skip to content

Commit

Permalink
Fix #195 License names with slashes generate illegal filenames when in
Browse files Browse the repository at this point in the history
organizeLicensesByDependencies mode
  • Loading branch information
ppalaga committed Feb 1, 2019
1 parent ef027fc commit 4b6ec05
Show file tree
Hide file tree
Showing 7 changed files with 127 additions and 6 deletions.
1 change: 1 addition & 0 deletions src/it/ISSUE-195/invoker.properties
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
invoker.goals = clean license:download-licenses -Dlicense.organizeLicensesByDependencies=true
53 changes: 53 additions & 0 deletions src/it/ISSUE-195/pom.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
<modelVersion>4.0.0</modelVersion>

<groupId>org.codehaus.mojo.license</groupId>
<artifactId>ISSUE-195</artifactId>
<version>1.0-SNAPSHOT</version>
<name>Integration Test ISSUE-195</name>
<url>http://maven.apache.org</url>
<description>
ISSUE-195
</description>

<dependencies>
<dependency>
<groupId>commons-logging</groupId>
<artifactId>commons-logging</artifactId>
<version>1.0</version>
</dependency>
<dependency>
<groupId>javax.activation</groupId>
<artifactId>javax.activation-api</artifactId>
<version>1.2.0</version>
</dependency>
</dependencies>

<build>
<plugins>
<plugin>
<groupId>org.codehaus.mojo</groupId>
<artifactId>license-maven-plugin</artifactId>
<version>@pom.version@</version>
<executions>
<execution>
<goals>
<goal>download-licenses</goal>
</goals>
</execution>
</executions>
<configuration>
<licenseUrlReplacements>
<licenseUrlReplacement>
<regexp>https://github.com/javaee/activation/blob/master/LICENSE.txt</regexp>
<replacement>https://raw.githubusercontent.com/javaee/activation/master/LICENSE.txt</replacement>
</licenseUrlReplacement>
</licenseUrlReplacements>
</configuration>
</plugin>
</plugins>
</build>
</project>
25 changes: 25 additions & 0 deletions src/it/ISSUE-195/postbuild.groovy
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
/*
* #%L
* License Maven Plugin
* %%
* Copyright (C) 2008 - 2011 CodeLutin, Codehaus, Tony Chemit, Tony chemit
* %%
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Lesser Public License for more details.
*
* You should have received a copy of the GNU General Lesser Public
* License along with this program. If not, see
* <http://www.gnu.org/licenses/lgpl-3.0.html>.
* #L%
*/

assert new File(basedir, 'target/generated-resources/licenses.xml').exists()
assert new File(basedir, 'target/generated-resources/licenses/commons-logging.commons-logging_apache_license_2.0.txt').exists()
assert new File(basedir, 'target/generated-resources/licenses/javax.activation.javax.activation-api_cddl_gplv2+ce.txt').exists()
14 changes: 14 additions & 0 deletions src/it/ISSUE-195/src/license/licenses.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
<licenseSummary>
<dependencies>
<dependency>
<groupId>commons-logging</groupId>
<artifactId>commons-logging</artifactId>
<licenses>
<license>
<name>Apache License 2.0</name>
<url>http://www.apache.org/licenses/LICENSE-2.0.txt</url>
</license>
</licenses>
</dependency>
</dependencies>
</licenseSummary>
15 changes: 15 additions & 0 deletions src/it/ISSUE-195/src/main/java/org/codehaus/mojo/HelloWorld.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
package org.codehaus.mojo;

public class HelloWorld
{

/**
* @param args
*/
public static void main( String[] args )
{
// TODO Auto-generated method stub

}

}
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,7 @@
import java.util.Comparator;
import java.util.HashMap;
import java.util.List;
import java.util.Locale;
import java.util.Map;
import java.util.Set;
import java.util.SortedMap;
Expand Down Expand Up @@ -737,7 +738,7 @@ private String getLicenseFileName( ProjectLicenseInfo depProject, final URL lice
licenseFileName = String.format( "%s.%s%s", depProject.getGroupId(), depProject.getArtifactId(),
licenseName != null
? "_" + licenseName
: "" ).toLowerCase().replaceAll( "\\s+", "_" );
: "" );
}
else
{
Expand All @@ -756,10 +757,11 @@ private String getLicenseFileName( ProjectLicenseInfo depProject, final URL lice
// This means it isn't a valid file extension, so append the default
licenseFileName = licenseFileName + defaultExtension;
}

// Force lower case so we don't end up with multiple copies of the same license
licenseFileName = licenseFileName.toLowerCase();
}

// sanitize
licenseFileName = licenseFileName.toLowerCase( Locale.US ).replaceAll( "[\\\\/\\s]+", "_" );

return licenseFileName;
}

Expand Down Expand Up @@ -811,7 +813,7 @@ private void downloadLicenses( ProjectLicenseInfo depProject )
if ( !downloadedLicenseURLs.containsKey( licenseUrl ) || organizeLicensesByDependencies )
{
licenseOutputFile = LicenseDownloader.downloadLicense( licenseUrl, proxyLoginPasswordEncoded,
licenseOutputFile );
licenseOutputFile, getLog() );
downloadedLicenseURLs.put( licenseUrl, licenseOutputFile );
}
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,8 @@
import java.net.URL;
import java.net.URLConnection;

import org.apache.maven.plugin.logging.Log;

/**
* Utilities for downloading remote license files.
*
Expand All @@ -54,10 +56,11 @@ public class LicenseDownloader
* @param licenseUrlString the URL
* @param loginPassword the credentials part for the URL, can be {@code null}
* @param outputFile a hint where to store the license file
* @param log
* @return the path to the file where the downloaded license file was stored
* @throws IOException
*/
public static File downloadLicense( String licenseUrlString, String loginPassword, File outputFile )
public static File downloadLicense( String licenseUrlString, String loginPassword, File outputFile, Log log )
throws IOException
{
if ( licenseUrlString == null || licenseUrlString.length() == 0 )
Expand All @@ -72,6 +75,8 @@ public static File downloadLicense( String licenseUrlString, String loginPasswor
{
int status = ( (HttpURLConnection) connection ).getResponseCode();

log.debug( String.format( "Got HTTP response %d for URL '%s'", status, licenseUrlString ) );

redirect = HttpURLConnection.HTTP_MOVED_TEMP == status || HttpURLConnection.HTTP_MOVED_PERM == status
|| HttpURLConnection.HTTP_SEE_OTHER == status;
}
Expand All @@ -84,6 +89,12 @@ public static File downloadLicense( String licenseUrlString, String loginPasswor
// open the new connnection again
connection = newConnection( newUrl, loginPassword );

if ( connection instanceof HttpURLConnection )
{
int status = ( (HttpURLConnection) connection ).getResponseCode();
log.debug( String.format( "Got HTTP response %d for URL '%s'", status, licenseUrlString ) );
}

}

try ( InputStream licenseInputStream = connection.getInputStream() )
Expand Down

0 comments on commit 4b6ec05

Please sign in to comment.