April 2010 - Maven-license-plugin-commits - mailman.cloud.codelutin.com

r1719 - in trunk/src: it/update-header-file it/update-header-file/src/license main/java/org/nuiton/license/plugin main/java/org/nuiton/license/plugin/header main/java/org/nuiton/license/plugin/header/transformer main/java/org/nuiton/license/plugin/model main/mdo test/java/org/nuiton/license/plugin test/java/org/nuiton/license/plugin/header test/java/org/nuiton/license/plugin/header/transformer
by tchemit＠users.nuiton.org April 8, 2010

April 8, 2010

Author: tchemit Date: 2010-04-08 19:55:28 +0200 (Thu, 08 Apr 2010) New Revision: 1719 Log: continue update-file-header mojo (just need to rebox (comment) updated header) Added: trunk/src/main/java/org/nuiton/license/plugin/header/FileHeader.java trunk/src/main/java/org/nuiton/license/plugin/header/FileHeaderFilter.java trunk/src/main/java/org/nuiton/license/plugin/header/FileHeaderProcessor.java trunk/src/main/java/org/nuiton/license/plugin/header/transformer/ trunk/src/main/java/org/nuiton/license/plugin/header/transformer/AbstractFileHeaderTransformer.java trunk/src/main/java/org/nuiton/license/plugin/header/transformer/AptFileHeaderTransformer.java trunk/src/main/java/org/nuiton/license/plugin/header/transformer/FileHeaderTransformer.java trunk/src/main/java/org/nuiton/license/plugin/header/transformer/JavaFileHeaderTransformer.java trunk/src/main/java/org/nuiton/license/plugin/header/transformer/PropertiesFileHeaderTransformer.java trunk/src/main/java/org/nuiton/license/plugin/header/transformer/XmlFileHeaderTransformer.java trunk/src/test/java/org/nuiton/license/plugin/header/ trunk/src/test/java/org/nuiton/license/plugin/header/transformer/ trunk/src/test/java/org/nuiton/license/plugin/header/transformer/AbstractFileHeaderTransformerTest.java Modified: trunk/src/it/update-header-file/pom.xml trunk/src/it/update-header-file/src/license/project.xml trunk/src/main/java/org/nuiton/license/plugin/AddLicenseFileMojo.java trunk/src/main/java/org/nuiton/license/plugin/AddThirdPartyFileMojo.java trunk/src/main/java/org/nuiton/license/plugin/UpdateHeaderFileMojo.java trunk/src/main/java/org/nuiton/license/plugin/UpdateHeaderMojo.java trunk/src/main/java/org/nuiton/license/plugin/model/LicenseRepository.java trunk/src/main/mdo/descriptor.mdo Modified: trunk/src/it/update-header-file/pom.xml =================================================================== --- trunk/src/it/update-header-file/pom.xml 2010-04-07 10:21:25 UTC (rev 1718) +++ trunk/src/it/update-header-file/pom.xml 2010-04-08 17:55:28 UTC (rev 1719) @@ -3,59 +3,64 @@ 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> + <modelVersion>4.0.0</modelVersion> -  -  -  +  +  +  - <groupId>org.nuiton.license.test</groupId> - <artifactId>test-update-header-file</artifactId> - <version>@pom.version@</version> + <groupId>org.nuiton.license.test</groupId> + <artifactId>test-update-header-file</artifactId> + <version>@pom.version@</version> -  -  -  +  +  +  - <name>License Test :: update-header-file</name> + <name>License Test :: update-header-file</name> -  -  -  +  +  +  - <packaging>jar</packaging> + <packaging>jar</packaging> - <build> + <inceptionYear>2010</inceptionYear> + + <properties> + <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding> + </properties> + <build> - <plugins> + <plugins> - <plugin> - <groupId>org.nuiton</groupId> - <artifactId>maven-license-plugin</artifactId> - <version>@pom.version@</version> - <configuration> - <verbose>true</verbose> - </configuration> - <executions> - <execution> - <id>first</id> - <goals> - <goal>update-header-file</goal> - </goals> - <phase>process-sources</phase> - </execution> - <execution> -  - <id>second</id> - <goals> - <goal>update-header-file</goal> - </goals> - <phase>compile</phase> - </execution> - </executions> - </plugin> - </plugins> - </build> + <plugin> + <groupId>org.nuiton</groupId> + <artifactId>maven-license-plugin</artifactId> + <version>@pom.version@</version> + <configuration> + <verbose>true</verbose> + </configuration> + <executions> + <execution> + <id>first</id> + <goals> + <goal>update-header-file</goal> + </goals> + <phase>process-sources</phase> + </execution> + <execution> +  + <id>second</id> + <goals> + <goal>update-header-file</goal> + </goals> + <phase>compile</phase> + </execution> + </executions> + </plugin> + </plugins> + </build> </project> Modified: trunk/src/it/update-header-file/src/license/project.xml =================================================================== --- trunk/src/it/update-header-file/src/license/project.xml 2010-04-07 10:21:25 UTC (rev 1718) +++ trunk/src/it/update-header-file/src/license/project.xml 2010-04-08 17:55:28 UTC (rev 1719) @@ -8,7 +8,7 @@ <licenseName>gpl_v3</licenseName> <fileSets> <fileSet> - <headerType>license-java</headerType> + <headerType>java</headerType> <basedir>src/main/java</basedir> <includes> <include>**/*.java</include> Modified: trunk/src/main/java/org/nuiton/license/plugin/AddLicenseFileMojo.java =================================================================== --- trunk/src/main/java/org/nuiton/license/plugin/AddLicenseFileMojo.java 2010-04-07 10:21:25 UTC (rev 1718) +++ trunk/src/main/java/org/nuiton/license/plugin/AddLicenseFileMojo.java 2010-04-08 17:55:28 UTC (rev 1719) @@ -179,7 +179,7 @@ File destFile = PluginHelper.getFile( outputDirectory, "META-INF", getProject().getArtifactId() + "-" + - licenseFile.getName() + licenseFile.getName() ); copyFile(licenseFile, destFile); } Modified: trunk/src/main/java/org/nuiton/license/plugin/AddThirdPartyFileMojo.java =================================================================== --- trunk/src/main/java/org/nuiton/license/plugin/AddThirdPartyFileMojo.java 2010-04-07 10:21:25 UTC (rev 1718) +++ trunk/src/main/java/org/nuiton/license/plugin/AddThirdPartyFileMojo.java 2010-04-08 17:55:28 UTC (rev 1719) @@ -229,7 +229,7 @@ copyFile(thirdPartyFile, new File( outputDirectory, "META-INF" + File.separator + getProject().getArtifactId() + - "-" + thirdPartyFile.getName()) + "-" + thirdPartyFile.getName()) ); } addResourceDir(outputDirectory, "**/*.txt"); @@ -259,7 +259,7 @@ // this dependency is not included, so do not treate it if (isVerbose()) { getLog().info("do not include this dependency " + - node.toNodeString()); + node.toNodeString()); } return; } @@ -285,7 +285,7 @@ for (Object o : licenses) { if (o == null) { getLog().warn("could not acquire the license for " - + artifactName); + + artifactName); continue; } License license = (License) o; @@ -310,7 +310,7 @@ protected String buildGroupedLicenses(LicenseMap licenseMap) { StringBuilder sb = new StringBuilder(); sb.append("List of third-party dependencies grouped by " + - "their license type."); + "their license type."); for (String licenseName : licenseMap.keySet()) { sb.append("\n\n").append(licenseName).append(" : "); Modified: trunk/src/main/java/org/nuiton/license/plugin/UpdateHeaderFileMojo.java =================================================================== --- trunk/src/main/java/org/nuiton/license/plugin/UpdateHeaderFileMojo.java 2010-04-07 10:21:25 UTC (rev 1718) +++ trunk/src/main/java/org/nuiton/license/plugin/UpdateHeaderFileMojo.java 2010-04-08 17:55:28 UTC (rev 1719) @@ -1,19 +1,23 @@ package org.nuiton.license.plugin; +import org.apache.commons.lang.StringUtils; import org.apache.maven.plugin.MojoFailureException; -import org.codehaus.plexus.velocity.VelocityComponent; -import org.nuiton.license.plugin.header.generator.HeaderGenerator; +import org.nuiton.license.plugin.header.FileHeader; +import org.nuiton.license.plugin.header.FileHeaderFilter; +import org.nuiton.license.plugin.header.FileHeaderProcessor; +import org.nuiton.license.plugin.header.transformer.FileHeaderTransformer; +import org.nuiton.license.plugin.model.License; import org.nuiton.license.plugin.model.LicenseStore; import org.nuiton.license.plugin.model.project.FileSet; import org.nuiton.license.plugin.model.project.LicenseProject; import org.nuiton.license.plugin.model.project.LicenseSet; import org.nuiton.license.plugin.model.project.io.xpp3.LicenseProjectXpp3Reader; +import org.nuiton.plugin.PluginHelper; import java.io.File; import java.io.FileReader; -import java.util.Arrays; -import java.util.List; -import java.util.Map; +import java.io.IOException; +import java.util.*; /** * The goal to update (or add) the licence header on some files. @@ -68,15 +72,6 @@ */ protected String projectName; -// /** -// * Le type de license a appliquer. -// * -// * @parameter expression="${license.licenseName}" -// * @required -// * @since 2.1 -// */ -// protected String licenseName; - /** * To specify an external licenses repository resolver (says the base url * of the repository). @@ -86,12 +81,11 @@ */ protected String licenseResolver; - /** * A flag to keep a backup of every modified file. * * @parameter expression="${license.keepBackup}" default-value="false" - * @since 1.0.0 + * @since 2.1 */ protected boolean keepBackup; @@ -99,7 +93,7 @@ * A flag to skip the goal. * * @parameter expression="${skipUpdateHeader}" default-value="false" - * @since 1.0.3 + * @since 2.1 */ protected boolean skipUpdateHeader; @@ -107,25 +101,18 @@ * A flag to test plugin but modify no file. * * @parameter expression="${dryRun}" default-value="false" - * @since 1.0.3 + * @since 2.1 */ protected boolean dryRun; /** - * Velocity Component. + * All available header transformers. * - * @component roleHint="maven-license-plugin" - * @since 2.0.0 + * @component role="org.nuiton.license.plugin.header.transformer.FileHeaderTransformer" + * @since 2.1 */ - protected VelocityComponent velocity; + protected Map<String, FileHeaderTransformer> transformers; - /** - * All available generators. - * - * @component role="org.nuiton.license.plugin.header.generator.HeaderGenerator" - */ - protected Map<String, HeaderGenerator> _generators; - /** timestamp used for generation */ protected long timestamp; @@ -136,8 +123,22 @@ protected LicenseProject licenseProject; @Override + protected boolean checkSkip() { + if (skipUpdateHeader) { + getLog().info("skip flag is on, will skip goal."); + return false; + } + return super.checkSkip(); + } + + @Override protected void init() throws Exception { + if (skipUpdateHeader) { + return; + } + timestamp = System.nanoTime(); + // init licenses store licenseStore = createLicenseStore(licenseResolver); @@ -149,41 +150,185 @@ reader.close(); } - List<String> licenseNames = Arrays.asList(licenseStore.getLicenseNames()); + // check that license project is sane (known licenses + header types) + // + populate default license name in LicenseSet (with main License) + validateProjectfile(licenseProject, licenseStore, transformers); - // check licenses is known - String mainLicense = licenseProject.getMainLicense(); - if (licenseStore.getLicense(mainLicense) == null) { - throw new MojoFailureException( - "main license '" + mainLicense + - "' is unknown, use one of " + licenseNames); - } - for (LicenseSet licenseSet : licenseProject.getLicenseSets()) { - // check license name - String licenseName = licenseSet.getLicenseName(); - if (licenseStore.getLicense(licenseName) == null) { - throw new MojoFailureException( - "license '" + licenseName + - "' is unknown, use one of " + licenseNames); + } + + @Override + protected void doAction() throws Exception { + + // create a file header processor which updates license content only + FileHeaderProcessor processor = new FileHeaderProcessor() { + + @Override + public FileHeaderFilter newFilter(FileHeader header, FileHeaderTransformer transformer) { + return new FileHeaderFilter(header, transformer) { + @Override + protected String treateHeader(String ch) { + + // unbox comment + String unbox = transformer.unboxComent(ch); + + // obtain current license of file + + FileHeader fileHeader = transformer.toFileHeader(unbox); + + // updates license + fileHeader.setLicense(header.getLicense()); + + // build new brut header (with no boxing) + + String newHeader = transformer.toString(fileHeader); + + //TODO-TC-20100408 must box header with comment prefix + + // box with process tag + newHeader = transformer.boxProcessTag(newHeader); + + if (getLog().isDebugEnabled()) { + getLog().debug("new Header =\n" + newHeader); + } + return newHeader; + } + }; } + }; - // check header types (for each file set) + for (LicenseSet licenseSet : licenseProject.getLicenseSets()) { + String licenseName = licenseSet.getLicenseName(); + License license = licenseStore.getLicense(licenseName); + + // file header to use if no header is found on a file + FileHeader defaultFileHeader = buildDefaultFileHeader( + license, + getProjectName(), + getInceptionYear(), + getOrganizationName(), + getEncoding() + ); + + processor.setHeader(defaultFileHeader); + for (FileSet fileSet : licenseSet.getFileSets()) { - String headerType = fileSet.getHeaderType(); - if (!_generators.containsKey(headerType)) { - throw new MojoFailureException( - "headerType '" + headerType + - "' is unknown, use one of " + _generators.keySet()); + File basedir = new File(getProject().getBasedir(), fileSet.getBasedir()); + List<String> includes = fileSet.getIncludes(); + if (includes.isEmpty()) { + + // it means include all + includes.add("**/*"); } + List<String> excludes = fileSet.getExcludes(); + + Map<File, String[]> filestoTreate = new TreeMap<File, String[]>(); + getFilesToTreateForRoots( + includes.toArray(new String[includes.size()]), + excludes.isEmpty() ? null : + excludes.toArray(new String[excludes.size()]), + Arrays.asList(basedir.getAbsolutePath()), + filestoTreate, + null + ); + FileHeaderTransformer transformer = + transformers.get(fileSet.getHeaderType()); + processor.setTransformer(transformer); + + updateHeader(processor, filestoTreate); } } } - @Override - protected void doAction() throws Exception { + public void updateHeader(FileHeaderProcessor processor, + Map<File, String[]> filestoTreate) throws IOException { + + FileHeaderTransformer transformer = processor.getTransformer(); + FileHeader header = processor.getHeader(); + + String defaultHeaderContent = transformer.toString(header); + getLog().debug("default header :\n" + defaultHeaderContent); + + String defaultFullHeaderContent = transformer.boxProcessTag(defaultHeaderContent); + getLog().info("default header (process tag boxed) :\n" + defaultFullHeaderContent); + + defaultFullHeaderContent = transformer.boxComment(defaultFullHeaderContent); + getLog().info("default header to use :\n" + defaultFullHeaderContent); + + for (Map.Entry<File, String[]> entry : filestoTreate.entrySet()) { + File basedir = entry.getKey(); + getLog().info("start entry \n" + basedir); + String[] paths = entry.getValue(); + getLog().info(paths.length + " file(s) to treate."); + for (String path : paths) { + File file = new File(basedir, path); + updateFile(processor, file, defaultFullHeaderContent); + } + } } + public void updateFile(FileHeaderProcessor processor, + File file, + String defaultFullHeaderContent) throws IOException { + getLog().info("scan file " + file); + + if (isVerbose()) { + getLog().info("process file " + file); + } + + // file where to writeFile result + File processFile = new File(file.getAbsolutePath() + "_" + + timestamp); + + try { + processor.process(file, processFile); + boolean foundLicenseHeader = processor.isTouched(); + + if (!foundLicenseHeader) { + if (processor.isDetectHeader()) { + getLog().warn( + "skip file " + file + + " (no license footer tag found : '##%*' !)"); + } else { + + // no license header found in file, add it + getLog().info("adding license header on file " + file); + String content = PluginHelper.readAsString( + file, + getEncoding() + ); + content = defaultFullHeaderContent + content; + if (!dryRun) { + writeFile(processFile, content, getEncoding()); + } + } + } + + if (keepBackup && !dryRun) { + File backupFile = new File(file.getAbsolutePath() + "~"); + if (isVerbose()) { + getLog().debug("backup original file " + file); + } + renameFile(file, backupFile); + } + if (dryRun) { + deleteFile(processFile); + } else { + renameFile(processFile, file); + + } + + } catch (Exception e) { + getLog().warn( + "skip file " + file + " (could not process " + + "for reason : " + e.getMessage() + ")"); + deleteFile(processFile); + } finally { + // toujours cleaner les états du filtre du processeur + processor.reset(); + } + } + public long getTimestamp() { return timestamp; } @@ -192,10 +337,6 @@ return projectName; } -// public String getLicenseName() { -// return licenseName; -// } - public String getInceptionYear() { return inceptionYear; } @@ -240,12 +381,72 @@ this.inceptionYear = inceptionYear; } -// public void setLicenseName(String licenseName) { -// this.licenseName = licenseName; -// } - public void setOrganizationName(String organizationName) { this.organizationName = organizationName; } + protected void validateProjectfile( + LicenseProject licenseProject, + LicenseStore licenseStore, + Map<String, FileHeaderTransformer> transformers) + throws MojoFailureException { + + List<String> licenseNames = Arrays.asList(licenseStore.getLicenseNames()); + + // check licenses is known + String mainLicense = licenseProject.getMainLicense(); + if (licenseStore.getLicense(mainLicense) == null) { + throw new MojoFailureException( + "main license '" + mainLicense + + "' is unknown, use one of " + licenseNames); + } + for (LicenseSet licenseSet : licenseProject.getLicenseSets()) { + + String licenseName = licenseSet.getLicenseName(); + if (StringUtils.isEmpty(licenseName)) { + + // use the main license + licenseSet.setLicenseName(mainLicense); + } else { + + // check license name + if (licenseStore.getLicense(licenseName) == null) { + throw new MojoFailureException( + "license '" + licenseName + + "' is unknown, use one of " + licenseNames); + } + } + + // check header types (for each file set) + for (FileSet fileSet : licenseSet.getFileSets()) { + String headerType = fileSet.getHeaderType(); + if (!transformers.containsKey(headerType)) { + throw new MojoFailureException( + "headerType '" + headerType + + "' is unknown, use one of " + transformers.keySet()); + } + } + } + } + + protected FileHeader buildDefaultFileHeader(License license, + String projectName, + String inceptionYear, + String copyrightHolder, + String encoding) throws IOException { + FileHeader result = new FileHeader(); + result.setDescription(projectName); + result.setLicense(license.getHeaderContent(encoding)); + Integer firstYear = Integer.valueOf(inceptionYear); + result.setCopyrightFirstYear(firstYear); + Calendar cal = Calendar.getInstance(); + cal.setTime(new Date()); + Integer lastYear = cal.get(Calendar.YEAR); + if (firstYear.equals(lastYear)) { + result.setCopyrightLastYear(lastYear); + } + result.setCopyrightHolder(copyrightHolder); + return result; + } + } Modified: trunk/src/main/java/org/nuiton/license/plugin/UpdateHeaderMojo.java =================================================================== --- trunk/src/main/java/org/nuiton/license/plugin/UpdateHeaderMojo.java 2010-04-07 10:21:25 UTC (rev 1718) +++ trunk/src/main/java/org/nuiton/license/plugin/UpdateHeaderMojo.java 2010-04-08 17:55:28 UTC (rev 1719) @@ -353,16 +353,8 @@ // recuperation de la license a utiliser licenseStore = createLicenseStore(licenseResolver); - + License license = licenseStore.getLicense(licenseName); -// -// LicenseRepository factory = -// LicenseRepositoryFactory.newLicenseRepository( -// true, -// true, -// licenseResolver -// ); -// License license = factory.getLicense(licenseName); if (isVerbose()) { getLog().info("config - use license " + license.getName()); Added: trunk/src/main/java/org/nuiton/license/plugin/header/FileHeader.java =================================================================== --- trunk/src/main/java/org/nuiton/license/plugin/header/FileHeader.java (rev 0) +++ trunk/src/main/java/org/nuiton/license/plugin/header/FileHeader.java 2010-04-08 17:55:28 UTC (rev 1719) @@ -0,0 +1,133 @@ +package org.nuiton.license.plugin.header; + +/** + * Contract of a file header. + * + * A header has thre sections like in this example : + * + * <pre> + * Description + * %-- + * Copyright (C) firstYear[ - lastYear] holder + * %-- + * License + * </pre> + * + * @author tchemit <chemit(a)codelutin.com> + * @since 2.1 + */ +public class FileHeader { + + /** Copyright to string format */ + protected static final String COPYRIGHT_TO_STRING_FORMAT = "Copyright (C) %1$s %2$s"; + + /** Description of the project or module to add in header */ + protected String description; + + /** Copyright holder */ + protected String copyrightHolder; + + /** Copyright first year of application */ + protected Integer copyrightFirstYear; + + /** + * Copyright last year of application (can be nullif copyright is + * only on one year). + */ + protected Integer copyrightLastYear; + + /** License used in the header. */ + protected String license; + + /** + * @return the project name, or nay other common informations for all + * files of a project (or module) + */ + public String getDescription() { + return description; + } + + /** @return the copyright holder */ + public String getCopyrightHolder() { + return copyrightHolder; + } + + /** @return the first year of the copyright */ + public Integer getCopyrightFirstYear() { + return copyrightFirstYear; + } + + /** + * @return the last year of the copyright (if copyright affects only one + * year, can be equals to the {@link #getCopyrightFirstYear()}). + */ + public Integer getCopyrightLastYear() { + return copyrightLastYear; + } + + /** + * Produces a string representation of the copyright. + * + * If copyright acts on one year : + * <pre> + * Copyright (C) 2010 Holder + * </pre> + * + * If copyright acts on more than one year : + * <pre> + * Copyright (C) 2010 - 2012 Holder + * </pre> + * + * @return the String representation of the copyright + */ + public String getCopyright() { + String copyright; + if (getCopyrightLastYear() == null) { + + // copyright on one year + copyright = String.format( + COPYRIGHT_TO_STRING_FORMAT, + getCopyrightFirstYear(), + getCopyrightHolder() + ); + } else { + + // copyright on more than one year + copyright = String.format( + COPYRIGHT_TO_STRING_FORMAT, + getCopyrightFirstYear() + " - " + + getCopyrightLastYear(), + getCopyrightHolder() + ); + } + return copyright; + } + + /** + * @return the license content (this is not the fully license content, + * but just a per file license resume) + */ + public String getLicense() { + return license; + } + + public void setDescription(String description) { + this.description = description; + } + + public void setCopyrightHolder(String copyrightHolder) { + this.copyrightHolder = copyrightHolder; + } + + public void setCopyrightFirstYear(Integer copyrightFirstYear) { + this.copyrightFirstYear = copyrightFirstYear; + } + + public void setCopyrightLastYear(Integer copyrightLastYear) { + this.copyrightLastYear = copyrightLastYear; + } + + public void setLicense(String license) { + this.license = license; + } +} Property changes on: trunk/src/main/java/org/nuiton/license/plugin/header/FileHeader.java ___________________________________________________________________ Added: svn:keywords + "Author Date Id Revision HeadURL Added: trunk/src/main/java/org/nuiton/license/plugin/header/FileHeaderFilter.java =================================================================== --- trunk/src/main/java/org/nuiton/license/plugin/header/FileHeaderFilter.java (rev 0) +++ trunk/src/main/java/org/nuiton/license/plugin/header/FileHeaderFilter.java 2010-04-08 17:55:28 UTC (rev 1719) @@ -0,0 +1,100 @@ +package org.nuiton.license.plugin.header; + +import org.apache.commons.logging.Log; +import org.apache.commons.logging.LogFactory; +import org.nuiton.license.plugin.header.transformer.FileHeaderTransformer; +import org.nuiton.processor.filters.DefaultFilter; + +/** + * TODO + * + * @author tchemit <chemit(a)codelutin.com> + * @since 2.1 + */ +public abstract class FileHeaderFilter extends DefaultFilter { + + /** to use log facility, just put in your code: log.info(\"...\"); */ + static private final Log log = LogFactory.getLog(FileHeaderFilter.class); + + /** flag pour indiquer si la licence a ete trouvee entre le header et le footer */ + protected boolean touched; + + /** flag pour indiquer si on a rencontree le header du filtre */ + protected boolean detectHeader; + + protected FileHeader header; + + protected FileHeaderTransformer transformer; + + protected abstract String treateHeader(String ch); + + public FileHeaderFilter(FileHeader header, FileHeaderTransformer transformer) { + this.header = header; + this.transformer = transformer; + } + + @Override + protected String performInFilter(String ch) { + if (log.isDebugEnabled()) { + log.debug(ch); + } + if (touched) { + // on autorise pas deux process de la licence dans un fichier java + throw new IllegalStateException("Can only have one file header start tag : " + getHeader()); + } + if (getMatchIndexFor(ch, getHeader()) == NOT_FOUND) { + + // the header was detected, mark file to be touched + touched = true; + + // update header + String newHeader = treateHeader(ch); + return newHeader; + } + // ce cas arrive lorsque l'on a parcouru tout le fichier avec detection + // de la balise header mais sans balise footer + // et on arrive dans cette methode dans le flush du filter + return ch; + } + + @Override + protected String performOutFilter(String ch) { + if (log.isDebugEnabled()) { + log.debug(ch); + } + return ch; + } + + @Override + protected String getHeader() { + return transformer.getProcessStartTag(); + } + + @Override + protected String getFooter() { + return transformer.getProcessEndTag(); + } + + @Override + protected void changeState(State newState) { + super.changeState(newState); + if (newState == State.SEARCH_FOOTER) { + // on a decouvert un header + detectHeader = true; + } + } + + public boolean isTouched() { + return touched; + } + + public boolean isDetectHeader() { + return detectHeader; + } + + public void reset() { + touched = false; + detectHeader = false; + state = State.SEARCH_HEADER; + } +} \ No newline at end of file Property changes on: trunk/src/main/java/org/nuiton/license/plugin/header/FileHeaderFilter.java ___________________________________________________________________ Added: svn:keywords + "Author Date Id Revision HeadURL Added: trunk/src/main/java/org/nuiton/license/plugin/header/FileHeaderProcessor.java =================================================================== --- trunk/src/main/java/org/nuiton/license/plugin/header/FileHeaderProcessor.java (rev 0) +++ trunk/src/main/java/org/nuiton/license/plugin/header/FileHeaderProcessor.java 2010-04-08 17:55:28 UTC (rev 1719) @@ -0,0 +1,105 @@ +package org.nuiton.license.plugin.header; + +import org.nuiton.license.plugin.header.transformer.FileHeaderTransformer; +import org.nuiton.processor.Processor; + +import java.io.File; +import java.io.FileReader; +import java.io.FileWriter; +import java.io.IOException; + +/** + * TODO + * + * @author tchemit <chemit(a)codelutin.com> + * @since 2.1 + */ +public abstract class FileHeaderProcessor extends Processor { + + /** file header */ + protected FileHeader header; + + protected FileHeaderTransformer transformer; + + /** internal filter */ + protected FileHeaderFilter filter; + + public abstract FileHeaderFilter newFilter(FileHeader header, FileHeaderTransformer transformer); + + public FileHeaderProcessor() { + } + + /** + * @return {@code true} if processed file was modified (says the header was + * fully found and updating), {@code false} otherwise + * @see FileHeaderFilter#isTouched() + */ + public boolean isTouched() { + return filter != null && filter.isTouched(); + } + + /** + * @return {@code true} if header of header was detected + * @see FileHeaderFilter#isDetectHeader() + */ + public boolean isDetectHeader() { + return filter != null && filter.isDetectHeader(); + } + + public void process(File filein, File fileout) throws IOException { + if (header == null) { + throw new IllegalStateException("no file header sets."); + } + if (transformer == null) { + throw new IllegalStateException("no file header transformer sets."); + } + if (filter == null) { + setFilter(newFilter(header, transformer)); + } + FileReader input = new FileReader(filein); + try { + FileWriter output = new FileWriter(fileout); + try { + process(input, output); + } finally { + output.close(); + } + } finally { + input.close(); + } + } + + public FileHeader getHeader() { + return header; + } + + public void setHeader(FileHeader header) { + this.header = header; + filter = null; + } + + public FileHeaderTransformer getTransformer() { + return transformer; + } + + public void setTransformer(FileHeaderTransformer transformer) { + this.transformer = transformer; + filter = null; + } +// +// protected FileHeaderFilter getFilter() { +// return filter; +// } + + public void setFilter(FileHeaderFilter filter) { + this.filter = filter; + setInputFilter(filter); + } + + + public void reset() { + if (filter != null) { + filter.reset(); + } + } +} Property changes on: trunk/src/main/java/org/nuiton/license/plugin/header/FileHeaderProcessor.java ___________________________________________________________________ Added: svn:keywords + "Author Date Id Revision HeadURL Added: trunk/src/main/java/org/nuiton/license/plugin/header/transformer/AbstractFileHeaderTransformer.java =================================================================== --- trunk/src/main/java/org/nuiton/license/plugin/header/transformer/AbstractFileHeaderTransformer.java (rev 0) +++ trunk/src/main/java/org/nuiton/license/plugin/header/transformer/AbstractFileHeaderTransformer.java 2010-04-08 17:55:28 UTC (rev 1719) @@ -0,0 +1,282 @@ +package org.nuiton.license.plugin.header.transformer; + +import org.nuiton.license.plugin.header.FileHeader; + +import java.util.regex.Matcher; +import java.util.regex.Pattern; + +/** + * Abstract implementation of {@link FileHeaderTransformer} which does NOT deal + * with the boxing-unboxing part, but just with transformation methods, since + * they are common to any transformer. + * + * Concrete implementation should just has to deal with to boxing stuff. + * + * @author tchemit <chemit(a)codelutin.com> + * @since 2.1 + */ +public abstract class AbstractFileHeaderTransformer implements FileHeaderTransformer { + + /** + * pattern of the copyright string representation : + * <ul> + * <li>group(1) is Copyright prefix</li> + * <li>group(2) is Copyright first year</li> + * <li>group(3) is Copyright last year with prefix (can be null)</li> + * <li>group(4) is Copyright last year (can be null)</li> + * <li>group(5) is Copyright holder</li> + * </ul> + */ + protected static final Pattern COPYRIGHT_PATTERN = + Pattern.compile( + "(.[^\\d]+)?\\s(\\d{4})?(\\s+-\\s+(\\d{4})?){0,1}\\s+(.+)?" + ); + + public static final char LINE_SEPARATOR = '\n'; + + /** name of transformer */ + protected String name; + + /** description of transfomer */ + protected String description; + + /** section delimiter */ + protected String sectionDelimiter = DEFAULT_SECTION_DELIMITER; + + /** start process tag */ + protected String processStartTag = DEFAULT_PROCESS_START_TAG; + + /** end process tag */ + protected String processEndTag = DEFAULT_PROCESS_END_TAG; + + /** comment start tag */ + protected String commentStartTag; + + /** comment end tag */ + protected String commentEndTag; + + /** comment line prefix (to add for header content) */ + protected String commentLinePrefix; + + protected AbstractFileHeaderTransformer() { + + } + + protected AbstractFileHeaderTransformer(String name, + String description, + String commentStartTag, + String commentEndTag, + String commentLinePrefix) { + this.name = name; + this.description = description; + this.commentStartTag = commentStartTag; + this.commentEndTag = commentEndTag; + this.commentLinePrefix = commentLinePrefix; + } + + protected AbstractFileHeaderTransformer(String commentStartTag, + String commentEndTag, + String commentLinePrefix) { + this.commentStartTag = commentStartTag; + this.commentEndTag = commentEndTag; + this.commentLinePrefix = commentLinePrefix; + } + + @Override + public String getName() { + return name; + } + + @Override + public void setName(String name) { + this.name = name; + } + + @Override + public String getDescription() { + return description; + } + + @Override + public void setDescription(String description) { + this.description = description; + } + + @Override + public String getSectionDelimiter() { + return sectionDelimiter; + } + + @Override + public void setSectionDelimiter(String sectionDelimiter) { + this.sectionDelimiter = sectionDelimiter; + } + + @Override + public String getProcessStartTag() { + return processStartTag; + } + + @Override + public void setProcessStartTag(String processStartTag) { + this.processStartTag = processStartTag; + } + + @Override + public String getProcessEndTag() { + return processEndTag; + } + + @Override + public void setProcessEndTag(String processEndTag) { + this.processEndTag = processEndTag; + } + + @Override + public String getCommentStartTag() { + return commentStartTag; + } + + @Override + public void setCommentStartTag(String commentStartTag) { + this.commentStartTag = commentStartTag; + } + + @Override + public String getCommentEndTag() { + return commentEndTag; + } + + @Override + public void setCommentEndTag(String commentEndTag) { + this.commentEndTag = commentEndTag; + } + + @Override + public String getCommentLinePrefix() { + return commentLinePrefix; + } + + @Override + public void setCommentLinePrefix(String commentLinePrefix) { + this.commentLinePrefix = commentLinePrefix; + } + + @Override + public FileHeader toFileHeader(String header) { + FileHeader model = new FileHeader(); + + String[] sections = header.split(getSectionDelimiter()); + if (sections.length != 3) { + throw new IllegalStateException( + "could not find 3 sections in\n" + header); + } + + // first section is the description + String description = sections[0].trim(); + model.setDescription(description); + + // second section is the copyright + String copyright = sections[1].trim(); + Matcher matcher = COPYRIGHT_PATTERN.matcher(copyright); + if (!matcher.matches()) { + throw new IllegalStateException( + "copyright [" + copyright + "] is not valid"); + } + String firstYear = matcher.group(2); + String lastYear = matcher.group(4); + String holder = matcher.group(5); + model.setCopyrightFirstYear(Integer.valueOf(firstYear.trim())); + if (lastYear != null) { + model.setCopyrightLastYear(Integer.valueOf(lastYear.trim())); + } + model.setCopyrightHolder(holder.trim()); + + // third section is the license + String license = sections[2].trim(); + model.setLicense(license); + return model; + } + + @Override + public String toString(FileHeader model) { + StringBuilder buffer = new StringBuilder(); + + String sectionDelimiter = LINE_SEPARATOR + getSectionDelimiter() + + LINE_SEPARATOR; + + // add description section + buffer.append(model.getDescription().trim()); + buffer.append(sectionDelimiter); + + // add copyright section + buffer.append(model.getCopyright().trim()); + buffer.append(sectionDelimiter); + + // add license section + buffer.append(model.getLicense().trim()).append(LINE_SEPARATOR); + return buffer.toString(); + } + + @Override + public String boxComment(String header) { + StringBuilder buffer = new StringBuilder(); + buffer.append(getCommentStartTag()).append(LINE_SEPARATOR); + for (String line : header.split(LINE_SEPARATOR + "")) { + buffer.append(getCommentLinePrefix()); + buffer.append(line); + buffer.append(LINE_SEPARATOR); + } + buffer.append(getCommentEndTag()).append(LINE_SEPARATOR); + return buffer.toString(); + } + + @Override + public String unboxComent(String header) { + StringBuilder buffer = new StringBuilder(); + int prefixLength = getCommentLinePrefix().length(); + for (String line : header.split(LINE_SEPARATOR + "")) { + if (line.isEmpty() || + line.contains(getCommentStartTag()) || + line.contains(getCommentEndTag())) { + + // not be unboxed, but just skipped + continue; + } + int index = line.indexOf(getCommentLinePrefix()); + if (index > -1) { + + // remove comment prefix + line = line.substring(index + prefixLength); + } + buffer.append(line).append(LINE_SEPARATOR); + } + return buffer.toString(); + } + + + @Override + public String boxProcessTag(String header) { + StringBuilder buffer = new StringBuilder(); + buffer.append(getProcessStartTag()).append(LINE_SEPARATOR); + buffer.append(header.trim()).append(LINE_SEPARATOR); + buffer.append(getProcessEndTag()).append(LINE_SEPARATOR); + return buffer.toString(); + } + + @Override + public String unboxProcessTag(String boxedHeader) { + StringBuilder buffer = new StringBuilder(); + for (String line : boxedHeader.split(LINE_SEPARATOR + "")) { + if (line.isEmpty() || + line.contains(getProcessStartTag()) || + line.contains(getProcessEndTag())) { + + // not be unboxed, but just skipped + continue; + } + buffer.append(line).append(LINE_SEPARATOR); + } + return buffer.toString(); + } +} Property changes on: trunk/src/main/java/org/nuiton/license/plugin/header/transformer/AbstractFileHeaderTransformer.java ___________________________________________________________________ Added: svn:keywords + "Author Date Id Revision HeadURL Added: trunk/src/main/java/org/nuiton/license/plugin/header/transformer/AptFileHeaderTransformer.java =================================================================== --- trunk/src/main/java/org/nuiton/license/plugin/header/transformer/AptFileHeaderTransformer.java (rev 0) +++ trunk/src/main/java/org/nuiton/license/plugin/header/transformer/AptFileHeaderTransformer.java 2010-04-08 17:55:28 UTC (rev 1719) @@ -0,0 +1,30 @@ +package org.nuiton.license.plugin.header.transformer; + +/** + * Implementation of {@link FileHeaderTransformer} for apt format. + * + * @author tchemit <chemit(a)codelutin.com> + * @plexus.component role-hint="apt" + * @since 2.1 + */ +public class AptFileHeaderTransformer extends AbstractFileHeaderTransformer { + + public static final String NAME = "apt"; + + public static final String DESCRIPTION = "header transformer with apt comment style"; + + public static final String COMMENT_LINE_PREFIX = "~~~ "; + + public static final String COMMENT_START_TAG = "\n"; + + public static final String COMMENT_END_TAG = "\n"; + + public AptFileHeaderTransformer() { + super(NAME, + DESCRIPTION, + COMMENT_START_TAG, + COMMENT_END_TAG, + COMMENT_LINE_PREFIX + ); + } +} Property changes on: trunk/src/main/java/org/nuiton/license/plugin/header/transformer/AptFileHeaderTransformer.java ___________________________________________________________________ Added: svn:keywords + "Author Date Id Revision HeadURL Added: trunk/src/main/java/org/nuiton/license/plugin/header/transformer/FileHeaderTransformer.java =================================================================== --- trunk/src/main/java/org/nuiton/license/plugin/header/transformer/FileHeaderTransformer.java (rev 0) +++ trunk/src/main/java/org/nuiton/license/plugin/header/transformer/FileHeaderTransformer.java 2010-04-08 17:55:28 UTC (rev 1719) @@ -0,0 +1,169 @@ +package org.nuiton.license.plugin.header.transformer; + +import org.nuiton.license.plugin.header.FileHeader; + +/** + * Contract to transform a file header to {@link org.nuiton.license.plugin.header.FileHeader} in both way : + * + * <ul> + * <li>Obtain a object representation of a file header from a existing file + * (String to FileHeader).</li> + * <li>Obtain the file header to inject in a file from a FileHeader (to update + * or create a file header from the file header model). + * </ul> + * + * Moreover the contract offers tow method to box and unbox a String + * representation of a header content : + * <ul> + * <li>{@link #boxComment(String)}</li> + * <li>{@link #unboxComent(String)}</li> + * </ul> + * + * @author tchemit <chemit(a)codelutin.com> + * @since 2.1 + */ +public interface FileHeaderTransformer { + + /** Plexus component role */ + String ROLE_NAME = FileHeaderTransformer.class.getName(); + + /** default section delimiter */ + String DEFAULT_SECTION_DELIMITER = "%--"; + + /** default process start tag */ + String DEFAULT_PROCESS_START_TAG = "#%L"; + + /** default process end tag */ + String DEFAULT_PROCESS_END_TAG = "#L%"; + + /** @return the name of the transformer */ + String getName(); + + /** @return the description of the transformer */ + String getDescription(); + + /** + * Obtains the process tag which indicates the begin of the header content. + * + * By default, (says if you do not explicitly invoke the + * {@link #setProcessStartTag(String)} method), will use the + * {@link #DEFAULT_PROCESS_START_TAG} + * + * @return the starting header tag + */ + String getProcessStartTag(); + + /** + * Obtain the process tag which indiciates the end of the header content. + * + * By default, (says if you do not explicitly invoke the + * {@link #setProcessEndTag(String)} method), will use the + * {@link #DEFAULT_PROCESS_END_TAG}. + * + * @return the ending header tag + */ + String getProcessEndTag(); + + /** + * The pattern used to separate sections of the header. + * + * By default, (says if you do not explicitly invoke the + * {@link #setSectionDelimiter(String)} method), will use the + * {@link #DEFAULT_SECTION_DELIMITER}. + * + * @return the delimiter used to separate sections in the header. + */ + String getSectionDelimiter(); + + String getCommentStartTag(); + + String getCommentEndTag(); + + String getCommentLinePrefix(); + + void setName(String name); + + void setDescription(String description); + + /** + * Sets the header section delimiter. + * + * By default, will use the {@link #DEFAULT_SECTION_DELIMITER}. + * + * @param headerSectionDelimiter the new delimiter + */ + void setSectionDelimiter(String headerSectionDelimiter); + + /** + * Changes the process start tag. + * + * @param tag the new start tag + */ + void setProcessStartTag(String tag); + + /** + * Changes the process end tag. + * + * @param tag the new endtag + */ + void setProcessEndTag(String tag); + + void setCommentStartTag(String commentStartTag); + + void setCommentEndTag(String commentEndTag); + + void setCommentLinePrefix(String commentLinePrefix); + + /** + * Box the given {@code header} in a comment. + * + * @param header the header content WITHOUT any comment boxing + * @return the header content WITH comment boxing + */ + String boxComment(String header); + + /** + * Unbox the given boxed {@code boxedHeader} to obtain the header content. + * + * @param boxedHeader the boxed header + * @return the unboxed header. + */ + String unboxComent(String boxedHeader); + + /** + * Box the given {@code header} between process tags. + * + * @param header the header content WITHOUT any comment boxing + * @return the header content boxed between process tags + * @see #getProcessStartTag() + * @see #getProcessEndTag() + */ + String boxProcessTag(String header); + + /** + * Unbox the process tag on the given boxed {@code boxedHeader} to obtain + * the brute header content. + * + * @param boxedHeader the boxed header + * @return the brute header content. + * @see #getProcessStartTag() + * @see #getProcessEndTag() + */ + String unboxProcessTag(String boxedHeader); + + /** + * Build a {@link org.nuiton.license.plugin.header.FileHeader} from an UNBOXED header content. + * + * @param header unboxed header content + * @return The model of the header content + */ + FileHeader toFileHeader(String header); + + /** + * Build a UNBOXED header content from the given {@code model}. + * + * @param model the model of the file header + * @return the UNBOXED header content + */ + String toString(FileHeader model); +} Property changes on: trunk/src/main/java/org/nuiton/license/plugin/header/transformer/FileHeaderTransformer.java ___________________________________________________________________ Added: svn:keywords + "Author Date Id Revision HeadURL Added: trunk/src/main/java/org/nuiton/license/plugin/header/transformer/JavaFileHeaderTransformer.java =================================================================== --- trunk/src/main/java/org/nuiton/license/plugin/header/transformer/JavaFileHeaderTransformer.java (rev 0) +++ trunk/src/main/java/org/nuiton/license/plugin/header/transformer/JavaFileHeaderTransformer.java 2010-04-08 17:55:28 UTC (rev 1719) @@ -0,0 +1,30 @@ +package org.nuiton.license.plugin.header.transformer; + +/** + * Implementation of {@link FileHeaderTransformer} for java format. + * + * @author tchemit <chemit(a)codelutin.com> + * @plexus.component role-hint="java" + * @since 2.1 + */ +public class JavaFileHeaderTransformer extends AbstractFileHeaderTransformer { + + public static final String NAME = "java"; + + public static final String DESCRIPTION = "header transformer with java comment style"; + + public static final String COMMENT_LINE_PREFIX = " * "; + + public static final String COMMENT_START_TAG = "/*"; + + public static final String COMMENT_END_TAG = " */"; + + public JavaFileHeaderTransformer() { + super(NAME, + DESCRIPTION, + COMMENT_START_TAG, + COMMENT_END_TAG, + COMMENT_LINE_PREFIX + ); + } +} \ No newline at end of file Property changes on: trunk/src/main/java/org/nuiton/license/plugin/header/transformer/JavaFileHeaderTransformer.java ___________________________________________________________________ Added: svn:keywords + "Author Date Id Revision HeadURL Added: trunk/src/main/java/org/nuiton/license/plugin/header/transformer/PropertiesFileHeaderTransformer.java =================================================================== --- trunk/src/main/java/org/nuiton/license/plugin/header/transformer/PropertiesFileHeaderTransformer.java (rev 0) +++ trunk/src/main/java/org/nuiton/license/plugin/header/transformer/PropertiesFileHeaderTransformer.java 2010-04-08 17:55:28 UTC (rev 1719) @@ -0,0 +1,30 @@ +package org.nuiton.license.plugin.header.transformer; + +/** + * Implementation of {@link FileHeaderTransformer} for properties format. + * + * @author tchemit <chemit(a)codelutin.com> + * @plexus.component role-hint="properties" + * @since 2.1 + */ +public class PropertiesFileHeaderTransformer extends AbstractFileHeaderTransformer { + + public static final String NAME = "properties"; + + public static final String DESCRIPTION = "header transformer with properties file comment style"; + + public static final String COMMENT_LINE_PREFIX = "# "; + + public static final String COMMENT_START_TAG = "###############################################################################"; + + public static final String COMMENT_END_TAG = "###############################################################################"; + + public PropertiesFileHeaderTransformer() { + super(NAME, + DESCRIPTION, + COMMENT_START_TAG, + COMMENT_END_TAG, + COMMENT_LINE_PREFIX + ); + } +} \ No newline at end of file Property changes on: trunk/src/main/java/org/nuiton/license/plugin/header/transformer/PropertiesFileHeaderTransformer.java ___________________________________________________________________ Added: svn:keywords + "Author Date Id Revision HeadURL Added: trunk/src/main/java/org/nuiton/license/plugin/header/transformer/XmlFileHeaderTransformer.java =================================================================== --- trunk/src/main/java/org/nuiton/license/plugin/header/transformer/XmlFileHeaderTransformer.java (rev 0) +++ trunk/src/main/java/org/nuiton/license/plugin/header/transformer/XmlFileHeaderTransformer.java 2010-04-08 17:55:28 UTC (rev 1719) @@ -0,0 +1,30 @@ +package org.nuiton.license.plugin.header.transformer; + +/** + * Implementation of {@link FileHeaderTransformer} for xml format. + * + * @author tchemit <chemit(a)codelutin.com> + * @plexus.component role-hint="xml" + * @since 2.1 + */ +public class XmlFileHeaderTransformer extends AbstractFileHeaderTransformer { + + public static final String NAME = "xml"; + + public static final String DESCRIPTION = "header transformer with xml comment style"; + + public static final String COMMENT_LINE_PREFIX = " "; + + public static final String COMMENT_START_TAG = ""; + + public XmlFileHeaderTransformer() { + super(NAME, + DESCRIPTION, + COMMENT_START_TAG, + COMMENT_END_TAG, + COMMENT_LINE_PREFIX + ); + } +} \ No newline at end of file Property changes on: trunk/src/main/java/org/nuiton/license/plugin/header/transformer/XmlFileHeaderTransformer.java ___________________________________________________________________ Added: svn:keywords + "Author Date Id Revision HeadURL Modified: trunk/src/main/java/org/nuiton/license/plugin/model/LicenseRepository.java =================================================================== --- trunk/src/main/java/org/nuiton/license/plugin/model/LicenseRepository.java 2010-04-07 10:21:25 UTC (rev 1718) +++ trunk/src/main/java/org/nuiton/license/plugin/model/LicenseRepository.java 2010-04-08 17:55:28 UTC (rev 1719) @@ -124,7 +124,7 @@ } return result.toArray(new String[result.size()]); } - + public License[] getLicenses() { checkInit("getLicenses"); return licenses.toArray(new License[licenses.size()]); Modified: trunk/src/main/mdo/descriptor.mdo =================================================================== --- trunk/src/main/mdo/descriptor.mdo 2010-04-07 10:21:25 UTC (rev 1718) +++ trunk/src/main/mdo/descriptor.mdo 2010-04-08 17:55:28 UTC (rev 1719) @@ -10,11 +10,11 @@ Maven License Plugin relies on the provided project descriptors to dictate its execution. Although there are already prefabricated descriptors available - for use, they can only suffice some of the common assembly requirements. + for use, they can only suffice some of the common license requirements. - So in order for you to customize the way the License Plugin creates your - assemblies, you need to know how to use the License project Descriptor. + So in order for you to customize the way the License Plugin updates your + licenses, you need to know how to use the License project Descriptor. This descriptor specifies the type of licenses to apply for some defined @@ -45,8 +45,10 @@ <required>true</required> <type>String</type> <description> - The main license of the project (or module). The LICENSE.txt will + <![CDATA[ + The main license of the project (or module). The LICENSE.txt will contains the content of this license. + ]]> </description> </field> <field> @@ -66,7 +68,7 @@ </fields> </class> - <class> + <class> <name>LicenseSet</name> <description> <![CDATA[ @@ -79,8 +81,13 @@ <name>licenseName</name> <version>1.0.0+</version> <type>String</type> - <required>true</required> - <description>The license to apply in this set.</description> +  + <description> + <![CDATA[ + The license to apply in this set. If not fill, will use + the main license. + ]]> + </description> </field> <field> <name>fileSets</name> @@ -91,8 +98,8 @@ </association> <description> <![CDATA[ - Specifies file sets to include in the license set. A fileSet is specified - by providing one or more of <licenseSet> subelements. + Specifies file sets to include in the license set. A fileSet is + specified by providing one or more of <licenseSet> subelements. ]]> </description> </field> @@ -103,10 +110,10 @@ <name>FileSet</name> <version>1.0.0+</version> <description> - <![CDATA[ + <![CDATA[ A fileSet allows the inclusion of groups of files into the license set and defines also the type of header to generate. - ]]> + ]]> </description> <fields> <field> @@ -114,7 +121,8 @@ <version>1.0.0+</version> <type>String</type> <required>true</required> - <description>The type of header to generate (or updates).</description> + <description>The type of header to generate (or updates). + </description> </field> <field> <name>useDefaultExcludes</name> @@ -122,8 +130,10 @@ <type>boolean</type> <defaultValue>true</defaultValue> <description> - Whether standard exclusion patterns, such as those matching CVS and Subversion - metadata files, should be used when calculating the files affected by this set. + Whether standard exclusion patterns, such as those matching CVS and + Subversion + metadata files, should be used when calculating the files affected + by this set. For backward compatibility, the default value is true. (Since 2.2) </description> </field> Added: trunk/src/test/java/org/nuiton/license/plugin/header/transformer/AbstractFileHeaderTransformerTest.java =================================================================== --- trunk/src/test/java/org/nuiton/license/plugin/header/transformer/AbstractFileHeaderTransformerTest.java (rev 0) +++ trunk/src/test/java/org/nuiton/license/plugin/header/transformer/AbstractFileHeaderTransformerTest.java 2010-04-08 17:55:28 UTC (rev 1719) @@ -0,0 +1,251 @@ +package org.nuiton.license.plugin.header.transformer; + +import org.junit.After; +import org.junit.Assert; +import org.junit.Before; +import org.junit.Test; +import org.nuiton.license.plugin.header.FileHeader; + +import java.util.regex.Matcher; + +import static org.nuiton.license.plugin.header.transformer.AbstractFileHeaderTransformer.COPYRIGHT_PATTERN; +import static org.nuiton.license.plugin.header.transformer.AbstractFileHeaderTransformer.DEFAULT_PROCESS_END_TAG; +import static org.nuiton.license.plugin.header.transformer.AbstractFileHeaderTransformer.DEFAULT_PROCESS_START_TAG; +import static org.nuiton.license.plugin.header.transformer.AbstractFileHeaderTransformer.DEFAULT_SECTION_DELIMITER; +import static org.nuiton.license.plugin.header.transformer.AbstractFileHeaderTransformer.LINE_SEPARATOR; +import static org.nuiton.license.plugin.header.transformer.JavaFileHeaderTransformer.*; + +/** + * Tests the {@link AbstractFileHeaderTransformer}. + * + * @author tchemit <chemit(a)codelutin.com> + * @since 2.1 + */ +public class AbstractFileHeaderTransformerTest { + + FileHeaderTransformer transformer; + + FileHeader model1, model2; + + @Before + public void setUp() throws Exception { + transformer = new JavaFileHeaderTransformer(); + + model1 = new FileHeader(); + model1.setDescription("Description"); + model1.setCopyrightFirstYear(2010); + model1.setCopyrightLastYear(null); + model1.setCopyrightHolder("Tony"); + model1.setLicense("License"); + + model2 = new FileHeader(); + model2.setDescription("Description2"); + model2.setCopyrightFirstYear(2010); + model2.setCopyrightLastYear(2012); + model2.setCopyrightHolder("Tony2"); + model2.setLicense("License2"); + } + + @After + public void tearDown() throws Exception { + transformer = null; + model1 = null; + model2 = null; + } + + @Test + public void testCopyrightPattern() throws Exception { + String actual; + Matcher matcher; + String prefix; + String firstYear; + String lastYear; + String holder; + + actual = "Copyright (C) 2010 Tony"; + matcher = COPYRIGHT_PATTERN.matcher(actual); + Assert.assertTrue(matcher.matches()); + Assert.assertEquals(5, matcher.groupCount()); + prefix = matcher.group(1); + Assert.assertEquals("Copyright (C)", prefix); + firstYear = matcher.group(2); + Assert.assertEquals("2010", firstYear); + lastYear = matcher.group(4); + Assert.assertEquals(null, lastYear); + holder = matcher.group(5); + Assert.assertEquals("Tony", holder); + + actual = "Copyright (C) 2010 - 2012 Tony"; + matcher = COPYRIGHT_PATTERN.matcher(actual); + Assert.assertTrue(matcher.matches()); + Assert.assertEquals(5, matcher.groupCount()); + prefix = matcher.group(1); + Assert.assertEquals("Copyright (C)", prefix); + firstYear = matcher.group(2); + Assert.assertEquals("2010", firstYear); + lastYear = matcher.group(4); + Assert.assertEquals("2012", lastYear); + holder = matcher.group(5); + Assert.assertEquals("Tony", holder); + } + + @Test + public void testToFileHeader() throws Exception { + String header; + FileHeader model; + + header = "Description" + LINE_SEPARATOR + + DEFAULT_SECTION_DELIMITER + LINE_SEPARATOR + + "Copyright (C) 2010 Tony" + LINE_SEPARATOR + + DEFAULT_SECTION_DELIMITER + LINE_SEPARATOR + + "License"; + model = transformer.toFileHeader(header); + Assert.assertNotNull(model); + assertEquals(model1, model); + + header = "Description2" + LINE_SEPARATOR + + DEFAULT_SECTION_DELIMITER + LINE_SEPARATOR + + "Copyright (C) 2010 - 2012 Tony2" + LINE_SEPARATOR + + DEFAULT_SECTION_DELIMITER + LINE_SEPARATOR + + "License2"; + model = transformer.toFileHeader(header); + Assert.assertNotNull(model); + assertEquals(model2, model); + } + + @Test + public void testToString() throws Exception { + String header; + + header = transformer.toString(model1); + Assert.assertEquals("Description" + LINE_SEPARATOR + + DEFAULT_SECTION_DELIMITER + LINE_SEPARATOR + + "Copyright (C) 2010 Tony" + LINE_SEPARATOR + + DEFAULT_SECTION_DELIMITER + LINE_SEPARATOR + + "License" + LINE_SEPARATOR, + header + ); + + header = transformer.toString(model2); + Assert.assertEquals("Description2" + LINE_SEPARATOR + + DEFAULT_SECTION_DELIMITER + LINE_SEPARATOR + + "Copyright (C) 2010 - 2012 Tony2" + LINE_SEPARATOR + + DEFAULT_SECTION_DELIMITER + LINE_SEPARATOR + + "License2" + LINE_SEPARATOR, + header + ); + } + + @Test + public void testBoxProcessTag() throws Exception { + String header; + String boxedHeader; + + header = transformer.toString(model1); + boxedHeader = transformer.boxProcessTag(header); + Assert.assertEquals(DEFAULT_PROCESS_START_TAG + LINE_SEPARATOR + + "Description" + LINE_SEPARATOR + + DEFAULT_SECTION_DELIMITER + LINE_SEPARATOR + + "Copyright (C) 2010 Tony" + LINE_SEPARATOR + + DEFAULT_SECTION_DELIMITER + LINE_SEPARATOR + + "License" + LINE_SEPARATOR + + DEFAULT_PROCESS_END_TAG + LINE_SEPARATOR, + boxedHeader + ); + + header = transformer.toString(model2); + boxedHeader = transformer.boxProcessTag(header); + Assert.assertEquals(DEFAULT_PROCESS_START_TAG + LINE_SEPARATOR + + "Description2" + LINE_SEPARATOR + + DEFAULT_SECTION_DELIMITER + LINE_SEPARATOR + + "Copyright (C) 2010 - 2012 Tony2" + LINE_SEPARATOR + + DEFAULT_SECTION_DELIMITER + LINE_SEPARATOR + + "License2" + LINE_SEPARATOR + + DEFAULT_PROCESS_END_TAG + LINE_SEPARATOR, + boxedHeader + ); + } + + + @Test + public void testUnboxProcessTag() throws Exception { + String header; + String boxedHeader; + String unboxedHeader; + + header = transformer.toString(model1); + boxedHeader = transformer.boxProcessTag(header); + unboxedHeader = transformer.unboxProcessTag(boxedHeader); + + Assert.assertEquals(header, unboxedHeader); + + header = transformer.toString(model2); + boxedHeader = transformer.boxProcessTag(header); + unboxedHeader = transformer.unboxProcessTag(boxedHeader); + + Assert.assertEquals(header, unboxedHeader); + } + + @Test + public void testBoxComment() throws Exception { + String header; + String boxedHeader; + + header = transformer.toString(model1); + boxedHeader = transformer.boxComment(header); + + Assert.assertEquals( + COMMENT_START_TAG + LINE_SEPARATOR + + COMMENT_LINE_PREFIX + "Description" + LINE_SEPARATOR + + COMMENT_LINE_PREFIX + DEFAULT_SECTION_DELIMITER + LINE_SEPARATOR + + COMMENT_LINE_PREFIX + "Copyright (C) 2010 Tony" + LINE_SEPARATOR + + COMMENT_LINE_PREFIX + DEFAULT_SECTION_DELIMITER + LINE_SEPARATOR + + COMMENT_LINE_PREFIX + "License" + LINE_SEPARATOR + + COMMENT_END_TAG + LINE_SEPARATOR, + boxedHeader + ); + + header = transformer.toString(model2); + boxedHeader = transformer.boxComment(header); + Assert.assertEquals( + COMMENT_START_TAG + LINE_SEPARATOR + + COMMENT_LINE_PREFIX + "Description2" + LINE_SEPARATOR + + COMMENT_LINE_PREFIX + DEFAULT_SECTION_DELIMITER + LINE_SEPARATOR + + COMMENT_LINE_PREFIX + "Copyright (C) 2010 - 2012 Tony2" + LINE_SEPARATOR + + COMMENT_LINE_PREFIX + DEFAULT_SECTION_DELIMITER + LINE_SEPARATOR + + COMMENT_LINE_PREFIX + "License2" + LINE_SEPARATOR + + COMMENT_END_TAG + LINE_SEPARATOR, + boxedHeader + ); + } + + @Test + public void testUnboxComment() throws Exception { + String header; + String boxedHeader; + String unboxedHeader; + + header = transformer.toString(model1); + boxedHeader = transformer.boxComment(header); + unboxedHeader = transformer.unboxComent(boxedHeader); + + Assert.assertEquals(header, unboxedHeader); + + header = transformer.toString(model2); + boxedHeader = transformer.boxComment(header); + unboxedHeader = transformer.unboxComent(boxedHeader); + + Assert.assertEquals(header, unboxedHeader); + } + + public static void assertEquals(FileHeader model, FileHeader model2) { + Assert.assertEquals(model.getDescription(), model2.getDescription()); + Assert.assertEquals(model.getCopyrightFirstYear(), + model2.getCopyrightFirstYear()); + Assert.assertEquals(model.getCopyrightLastYear(), + model2.getCopyrightLastYear()); + Assert.assertEquals(model.getCopyrightHolder(), + model2.getCopyrightHolder()); + Assert.assertEquals(model.getLicense(), model2.getLicense()); + } +} Property changes on: trunk/src/test/java/org/nuiton/license/plugin/header/transformer/AbstractFileHeaderTransformerTest.java ___________________________________________________________________ Added: svn:keywords + "Author Date Id Revision HeadURL

1 0

April 7, 2010

Author: tchemit Date: 2010-04-07 12:21:25 +0200 (Wed, 07 Apr 2010) New Revision: 1718 Log: add skeleton integration test + improve test Added: trunk/src/it/settings.xml trunk/src/it/update-header-file/LICENSE.txt trunk/src/it/update-header-file/README.txt trunk/src/it/update-header-file/changelog.txt trunk/src/it/update-header-file/invoker.properties trunk/src/it/update-header-file/pom.xml trunk/src/it/update-header-file/src/ trunk/src/it/update-header-file/src/license/ trunk/src/it/update-header-file/src/license/project.xml trunk/src/it/update-header-file/src/main/ trunk/src/it/update-header-file/src/main/java/ trunk/src/it/update-header-file/src/main/java/org/ trunk/src/it/update-header-file/src/main/java/org/nuiton/ trunk/src/it/update-header-file/src/main/java/org/nuiton/license/ trunk/src/it/update-header-file/src/main/java/org/nuiton/license/plugin/ trunk/src/it/update-header-file/src/main/java/org/nuiton/license/plugin/test/ trunk/src/it/update-header-file/src/main/java/org/nuiton/license/plugin/test/MyBean.java trunk/src/it/update-header-file/verify.groovy Modified: trunk/pom.xml trunk/src/main/java/org/nuiton/license/plugin/AbstractLicenseMojo.java trunk/src/main/java/org/nuiton/license/plugin/UpdateHeaderFileMojo.java trunk/src/main/java/org/nuiton/license/plugin/model/License.java trunk/src/main/java/org/nuiton/license/plugin/model/LicenseRepository.java trunk/src/main/java/org/nuiton/license/plugin/model/LicenseStore.java trunk/src/test/java/org/nuiton/license/plugin/AddLicenseFileMojoTest.java trunk/src/test/java/org/nuiton/license/plugin/model/LicenseRepositoryTest.java trunk/src/test/java/org/nuiton/license/plugin/model/LicenseStoreTest.java Modified: trunk/pom.xml =================================================================== --- trunk/pom.xml 2010-04-06 21:35:23 UTC (rev 1717) +++ trunk/pom.xml 2010-04-07 10:21:25 UTC (rev 1718) @@ -446,9 +446,10 @@ <profiles> -  </configuration> <executions> <execution> @@ -474,7 +476,7 @@ </plugin> </plugins> </build> - </profile--> + </profile> </profiles> Added: trunk/src/it/settings.xml =================================================================== --- trunk/src/it/settings.xml (rev 0) +++ trunk/src/it/settings.xml 2010-04-07 10:21:25 UTC (rev 1718) @@ -0,0 +1,56 @@ +<?xml version="1.0" encoding="UTF-8"?> + + + +<settings> + + <profiles> + <profile> + <id>it-repo</id> + <activation> + <activeByDefault>true</activeByDefault> + </activation> + <repositories> + <repository> + <id>local.central</id> + <url>file:///@localRepository@</url> + <releases> + <enabled>true</enabled> + </releases> + <snapshots> + <enabled>true</enabled> + </snapshots> + </repository> + </repositories> + <pluginRepositories> + <pluginRepository> + <id>local.central</id> + <url>file:///@localRepository@</url> + <releases> + <enabled>true</enabled> + </releases> + <snapshots> + <enabled>true</enabled> + </snapshots> + </pluginRepository> + </pluginRepositories> + </profile> + </profiles> +</settings> Added: trunk/src/it/update-header-file/LICENSE.txt =================================================================== --- trunk/src/it/update-header-file/LICENSE.txt (rev 0) +++ trunk/src/it/update-header-file/LICENSE.txt 2010-04-07 10:21:25 UTC (rev 1718) @@ -0,0 +1,166 @@ + GNU LESSER GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/> + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + + This version of the GNU Lesser General Public License incorporates +the terms and conditions of version 3 of the GNU General Public +License, supplemented by the additional permissions listed below. + + 0. Additional Definitions. + + As used herein, "this License" refers to version 3 of the GNU Lesser +General Public License, and the "GNU GPL" refers to version 3 of the GNU +General Public License. + + "The Library" refers to a covered work governed by this License, +other than an Application or a Combined Work as defined below. + + An "Application" is any work that makes use of an interface provided +by the Library, but which is not otherwise based on the Library. +Defining a subclass of a class defined by the Library is deemed a mode +of using an interface provided by the Library. + + A "Combined Work" is a work produced by combining or linking an +Application with the Library. The particular version of the Library +with which the Combined Work was made is also called the "Linked +Version". + + The "Minimal Corresponding Source" for a Combined Work means the +Corresponding Source for the Combined Work, excluding any source code +for portions of the Combined Work that, considered in isolation, are +based on the Application, and not on the Linked Version. + + The "Corresponding Application Code" for a Combined Work means the +object code and/or source code for the Application, including any data +and utility programs needed for reproducing the Combined Work from the +Application, but excluding the System Libraries of the Combined Work. + + 1. Exception to Section 3 of the GNU GPL. + + You may convey a covered work under sections 3 and 4 of this License +without being bound by section 3 of the GNU GPL. + + 2. Conveying Modified Versions. + + If you modify a copy of the Library, and, in your modifications, a +facility refers to a function or data to be supplied by an Application +that uses the facility (other than as an argument passed when the +facility is invoked), then you may convey a copy of the modified +version: + + a) under this License, provided that you make a good faith effort to + ensure that, in the event an Application does not supply the + function or data, the facility still operates, and performs + whatever part of its purpose remains meaningful, or + + b) under the GNU GPL, with none of the additional permissions of + this License applicable to that copy. + + 3. Object Code Incorporating Material from Library Header Files. + + The object code form of an Application may incorporate material from +a header file that is part of the Library. You may convey such object +code under terms of your choice, provided that, if the incorporated +material is not limited to numerical parameters, data structure +layouts and accessors, or small macros, inline functions and templates +(ten or fewer lines in length), you do both of the following: + + a) Give prominent notice with each copy of the object code that the + Library is used in it and that the Library and its use are + covered by this License. + + b) Accompany the object code with a copy of the GNU GPL and this license + document. + + 4. Combined Works. + + You may convey a Combined Work under terms of your choice that, +taken together, effectively do not restrict modification of the +portions of the Library contained in the Combined Work and reverse +engineering for debugging such modifications, if you also do each of +the following: + + a) Give prominent notice with each copy of the Combined Work that + the Library is used in it and that the Library and its use are + covered by this License. + + b) Accompany the Combined Work with a copy of the GNU GPL and this license + document. + + c) For a Combined Work that displays copyright notices during + execution, include the copyright notice for the Library among + these notices, as well as a reference directing the user to the + copies of the GNU GPL and this license document. + + d) Do one of the following: + + 0) Convey the Minimal Corresponding Source under the terms of this + License, and the Corresponding Application Code in a form + suitable for, and under terms that permit, the user to + recombine or relink the Application with a modified version of + the Linked Version to produce a modified Combined Work, in the + manner specified by section 6 of the GNU GPL for conveying + Corresponding Source. + + 1) Use a suitable shared library mechanism for linking with the + Library. A suitable mechanism is one that (a) uses at run time + a copy of the Library already present on the user's computer + system, and (b) will operate properly with a modified version + of the Library that is interface-compatible with the Linked + Version. + + e) Provide Installation Information, but only if you would otherwise + be required to provide such information under section 6 of the + GNU GPL, and only to the extent that such information is + necessary to install and execute a modified version of the + Combined Work produced by recombining or relinking the + Application with a modified version of the Linked Version. (If + you use option 4d0, the Installation Information must accompany + the Minimal Corresponding Source and Corresponding Application + Code. If you use option 4d1, you must provide the Installation + Information in the manner specified by section 6 of the GNU GPL + for conveying Corresponding Source.) + + 5. Combined Libraries. + + You may place library facilities that are a work based on the +Library side by side in a single library together with other library +facilities that are not Applications and are not covered by this +License, and convey such a combined library under terms of your +choice, if you do both of the following: + + a) Accompany the combined library with a copy of the same work based + on the Library, uncombined with any other library facilities, + conveyed under the terms of this License. + + b) Give prominent notice with the combined library that part of it + is a work based on the Library, and explaining where to find the + accompanying uncombined form of the same work. + + 6. Revised Versions of the GNU Lesser General Public License. + + The Free Software Foundation may publish revised and/or new versions +of the GNU Lesser General Public License from time to time. Such new +versions will be similar in spirit to the present version, but may +differ in detail to address new problems or concerns. + + Each version is given a distinguishing version number. If the +Library as you received it specifies that a certain numbered version +of the GNU Lesser General Public License "or any later version" +applies to it, you have the option of following the terms and +conditions either of that published version or of any later version +published by the Free Software Foundation. If the Library as you +received it does not specify a version number of the GNU Lesser +General Public License, you may choose any version of the GNU Lesser +General Public License ever published by the Free Software Foundation. + + If the Library as you received it specifies that a proxy can decide +whether future versions of the GNU Lesser General Public License shall +apply, that proxy's public statement of acceptance of any version is +permanent authorization for you to choose that version for the +Library. + Added: trunk/src/it/update-header-file/README.txt =================================================================== --- trunk/src/it/update-header-file/README.txt (rev 0) +++ trunk/src/it/update-header-file/README.txt 2010-04-07 10:21:25 UTC (rev 1718) @@ -0,0 +1,2 @@ +To test parserJava on a new project (says a project with no i18n translations) +At the end we should have in target/generated-sources/i18n getters detected. Added: trunk/src/it/update-header-file/changelog.txt =================================================================== --- trunk/src/it/update-header-file/changelog.txt (rev 0) +++ trunk/src/it/update-header-file/changelog.txt 2010-04-07 10:21:25 UTC (rev 1718) @@ -0,0 +1 @@ +see the changelog of org.nuiton:i18n project. \ No newline at end of file Added: trunk/src/it/update-header-file/invoker.properties =================================================================== --- trunk/src/it/update-header-file/invoker.properties (rev 0) +++ trunk/src/it/update-header-file/invoker.properties 2010-04-07 10:21:25 UTC (rev 1718) @@ -0,0 +1,21 @@ +# A comma or space separated list of goals/phases to execute, may +# specify an empty list to execute the default goal of the IT project +invoker.goals=clean compile + +# Optionally, a list of goals to run during further invocations of Maven +#invoker.goals.2=${project.groupId}:${project.artifactId}:${project.version}:run + +# A comma or space separated list of profiles to activate +#invoker.profiles=run-all run-once + +# The value for the environment variable MAVEN_OPTS +#invoker.mavenOpts=-Dfile.encoding=UTF-16 -Xms32m -Xmx256m + +# Possible values are "fail-fast" (default), "fail-at-end" and "fail-never" +invoker.failureBehavior=fail-at-end + +# The expected result of the build, possible values are "success" (default) and "failure" +#invoker.buildResult=success + +# A boolean value controlling the -N flag, defaults to "false" +#invoker.nonRecursive=false Added: trunk/src/it/update-header-file/pom.xml =================================================================== --- trunk/src/it/update-header-file/pom.xml (rev 0) +++ trunk/src/it/update-header-file/pom.xml 2010-04-07 10:21:25 UTC (rev 1718) @@ -0,0 +1,62 @@ +<?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.nuiton.license.test</groupId> + <artifactId>test-update-header-file</artifactId> + <version>@pom.version@</version> + +  +  +  + + <name>License Test :: update-header-file</name> + +  +  +  + + <packaging>jar</packaging> + + <build> + + <plugins> + + <plugin> + <groupId>org.nuiton</groupId> + <artifactId>maven-license-plugin</artifactId> + <version>@pom.version@</version> + <configuration> + <verbose>true</verbose> + </configuration> + <executions> + <execution> + <id>first</id> + <goals> + <goal>update-header-file</goal> + </goals> + <phase>process-sources</phase> + </execution> + <execution> +  + <id>second</id> + <goals> + <goal>update-header-file</goal> + </goals> + <phase>compile</phase> + </execution> + </executions> + </plugin> + </plugins> + </build> + +</project> + + Added: trunk/src/it/update-header-file/src/license/project.xml =================================================================== --- trunk/src/it/update-header-file/src/license/project.xml (rev 0) +++ trunk/src/it/update-header-file/src/license/project.xml 2010-04-07 10:21:25 UTC (rev 1718) @@ -0,0 +1,20 @@ +<?xml version='1.0' encoding='UTF-8'?> +<project xmlns="http://maven-site.nuiton.org/maven-license-plugin/1.0.0" + xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" + xsi:schemaLocation="http://maven-site.nuiton.org/maven-license-plugin/1.0.0 http://maven-site.nuiton.org/maven-license-plugin/licenseProject-1.0.0.xsd"> + <mainLicense>gpl_v3</mainLicense> + <licenseSets> + <licenseSet> + <licenseName>gpl_v3</licenseName> + <fileSets> + <fileSet> + <headerType>license-java</headerType> + <basedir>src/main/java</basedir> + <includes> + <include>**/*.java</include> + </includes> + </fileSet> + </fileSets> + </licenseSet> + </licenseSets> +</project> Added: trunk/src/it/update-header-file/src/main/java/org/nuiton/license/plugin/test/MyBean.java =================================================================== --- trunk/src/it/update-header-file/src/main/java/org/nuiton/license/plugin/test/MyBean.java (rev 0) +++ trunk/src/it/update-header-file/src/main/java/org/nuiton/license/plugin/test/MyBean.java 2010-04-07 10:21:25 UTC (rev 1718) @@ -0,0 +1,4 @@ +package org.nuiton.license.plugin.test; + +public class MyBean { +} Property changes on: trunk/src/it/update-header-file/src/main/java/org/nuiton/license/plugin/test/MyBean.java ___________________________________________________________________ Added: svn:keywords + "Author Date Id Revision HeadURL Added: trunk/src/it/update-header-file/verify.groovy =================================================================== --- trunk/src/it/update-header-file/verify.groovy (rev 0) +++ trunk/src/it/update-header-file/verify.groovy 2010-04-07 10:21:25 UTC (rev 1718) @@ -0,0 +1,8 @@ + +file = new File(basedir, 'src/main/java/org/nuiton/license/plugin/test/MyBean.java'); +assert file.exists(); + +content = file.text; +//assert content.contains( 'Copyright' ); + +return true; Modified: trunk/src/main/java/org/nuiton/license/plugin/AbstractLicenseMojo.java =================================================================== --- trunk/src/main/java/org/nuiton/license/plugin/AbstractLicenseMojo.java 2010-04-06 21:35:23 UTC (rev 1717) +++ trunk/src/main/java/org/nuiton/license/plugin/AbstractLicenseMojo.java 2010-04-07 10:21:25 UTC (rev 1718) @@ -77,7 +77,10 @@ store.addJarRepository(); if (extraResolver != null) { for (String s : extraResolver) { - store.addRepository(s); + if (s != null && !s.trim().isEmpty()) { + getLog().info("adding extra resolver " + s); + store.addRepository(s); + } } } store.init(); Modified: trunk/src/main/java/org/nuiton/license/plugin/UpdateHeaderFileMojo.java =================================================================== --- trunk/src/main/java/org/nuiton/license/plugin/UpdateHeaderFileMojo.java 2010-04-06 21:35:23 UTC (rev 1717) +++ trunk/src/main/java/org/nuiton/license/plugin/UpdateHeaderFileMojo.java 2010-04-07 10:21:25 UTC (rev 1718) @@ -15,7 +15,6 @@ import java.util.List; import java.util.Map; - /** * The goal to update (or add) the licence header on some files. * @@ -69,14 +68,14 @@ */ protected String projectName; - /** - * Le type de license a appliquer. - * - * @parameter expression="${license.licenseName}" - * @required - * @since 2.1 - */ - protected String licenseName; +// /** +// * Le type de license a appliquer. +// * +// * @parameter expression="${license.licenseName}" +// * @required +// * @since 2.1 +// */ +// protected String licenseName; /** * To specify an external licenses repository resolver (says the base url @@ -193,9 +192,9 @@ return projectName; } - public String getLicenseName() { - return licenseName; - } +// public String getLicenseName() { +// return licenseName; +// } public String getInceptionYear() { return inceptionYear; @@ -241,9 +240,9 @@ this.inceptionYear = inceptionYear; } - public void setLicenseName(String licenseName) { - this.licenseName = licenseName; - } +// public void setLicenseName(String licenseName) { +// this.licenseName = licenseName; +// } public void setOrganizationName(String organizationName) { this.organizationName = organizationName; Modified: trunk/src/main/java/org/nuiton/license/plugin/model/License.java =================================================================== --- trunk/src/main/java/org/nuiton/license/plugin/model/License.java 2010-04-06 21:35:23 UTC (rev 1717) +++ trunk/src/main/java/org/nuiton/license/plugin/model/License.java 2010-04-07 10:21:25 UTC (rev 1718) @@ -87,8 +87,10 @@ } public String getLicenseContent(String encoding) throws IOException { - if (licenseURL == null) { - throw new IllegalStateException("no licenseURL defined, can not obtain license content in " + this); + if (baseURL == null) { + throw new IllegalStateException( + "no baseURL defined, can not obtain license content in " + + this); } Reader r = new BufferedReader( @@ -102,7 +104,9 @@ public String getHeaderContent(String encoding) throws IOException { if (baseURL == null) { - throw new IllegalStateException("no baseURL defined, can not obtain header content in " + this); + throw new IllegalStateException( + "no baseURL defined, can not obtain header content in " + + this); } Reader r = new BufferedReader( new InputStreamReader(getHeaderURL().openStream(), encoding)); Modified: trunk/src/main/java/org/nuiton/license/plugin/model/LicenseRepository.java =================================================================== --- trunk/src/main/java/org/nuiton/license/plugin/model/LicenseRepository.java 2010-04-06 21:35:23 UTC (rev 1717) +++ trunk/src/main/java/org/nuiton/license/plugin/model/LicenseRepository.java 2010-04-07 10:21:25 UTC (rev 1718) @@ -85,7 +85,7 @@ if (!checkExists(definitionURL)) { throw new IllegalArgumentException( - "no licenses.properties found withurl [" + + "no licenses.properties found with url [" + definitionURL + "] for resolver " + this); } Properties p = new Properties(); @@ -102,8 +102,11 @@ license.setDescription(licenseDescription); license.setBaseURL(licenseURL); if (log.isInfoEnabled()) { - log.info("Adding license " + license); + log.info("register " + license.getDescription()); } + if (log.isDebugEnabled()) { + log.debug(license); + } licenses.add(license); } licenses = Collections.unmodifiableList(licenses); Modified: trunk/src/main/java/org/nuiton/license/plugin/model/LicenseStore.java =================================================================== --- trunk/src/main/java/org/nuiton/license/plugin/model/LicenseStore.java 2010-04-06 21:35:23 UTC (rev 1717) +++ trunk/src/main/java/org/nuiton/license/plugin/model/LicenseStore.java 2010-04-07 10:21:25 UTC (rev 1718) @@ -128,7 +128,7 @@ } if (log.isInfoEnabled()) { - log.info("Adding a license repository " + repository); + log.info("Adding a license repository " + repository.getBaseURL()); } repositories.add(repository); } Modified: trunk/src/test/java/org/nuiton/license/plugin/AddLicenseFileMojoTest.java =================================================================== --- trunk/src/test/java/org/nuiton/license/plugin/AddLicenseFileMojoTest.java 2010-04-06 21:35:23 UTC (rev 1717) +++ trunk/src/test/java/org/nuiton/license/plugin/AddLicenseFileMojoTest.java 2010-04-07 10:21:25 UTC (rev 1718) @@ -65,7 +65,8 @@ AddLicenseFileMojo mojo = getMojo(); - long t0 = mojo.getLicenseFile().lastModified(); + File licenseFile = mojo.getLicenseFile(); + long t0 = licenseFile.lastModified(); // always assume pom is older than any file // since we can not ensure order of copy test resources @@ -74,7 +75,7 @@ // then executing the mojo, will do NOT change the licence file mojo.execute(); - long t1 = mojo.getLicenseFile().lastModified(); + long t1 = licenseFile.lastModified(); assertEquals(t0, t1); @@ -82,7 +83,7 @@ mojo.setForce(true); mojo.execute(); - t1 = mojo.getLicenseFile().lastModified(); + t1 = licenseFile.lastModified(); assertTrue(t1 > t0); } @@ -92,7 +93,8 @@ AddLicenseFileMojo mojo = getMojo(); - long t0 = mojo.getLicenseFile().lastModified(); + File licenseFile = mojo.getLicenseFile(); + long t0 = licenseFile.lastModified(); // always assume pom is older than any file // since we can not ensure order of copy test resources @@ -101,7 +103,7 @@ // then executing the mojo, will do NOT change the licence file mojo.execute(); - long t1 = mojo.getLicenseFile().lastModified(); + long t1 = licenseFile.lastModified(); assertEquals(t0, t1); @@ -109,7 +111,7 @@ mojo.setForce(true); mojo.execute(); - t1 = mojo.getLicenseFile().lastModified(); + t1 = licenseFile.lastModified(); assertTrue(t1 > t0); } Modified: trunk/src/test/java/org/nuiton/license/plugin/model/LicenseRepositoryTest.java =================================================================== --- trunk/src/test/java/org/nuiton/license/plugin/model/LicenseRepositoryTest.java 2010-04-06 21:35:23 UTC (rev 1717) +++ trunk/src/test/java/org/nuiton/license/plugin/model/LicenseRepositoryTest.java 2010-04-07 10:21:25 UTC (rev 1718) @@ -41,5 +41,9 @@ License license = repository.getLicense(licenseName); Assert.assertNotNull(license); } + + for (String licenseName : repository.getLicenseNames()) { + Assert.assertTrue(LicenseStoreTest.DEFAULT_LICENSES.contains(licenseName)); + } } } Modified: trunk/src/test/java/org/nuiton/license/plugin/model/LicenseStoreTest.java =================================================================== --- trunk/src/test/java/org/nuiton/license/plugin/model/LicenseStoreTest.java 2010-04-06 21:35:23 UTC (rev 1717) +++ trunk/src/test/java/org/nuiton/license/plugin/model/LicenseStoreTest.java 2010-04-07 10:21:25 UTC (rev 1718) @@ -61,5 +61,10 @@ Assert.assertNotNull(license1); Assert.assertEquals(license, license1); } + + + for (String licenseName : store.getLicenseNames()) { + Assert.assertTrue(LicenseStoreTest.DEFAULT_LICENSES.contains(licenseName)); + } } }

1 0

r1717 - trunk
by tchemit＠users.nuiton.org April 6, 2010

April 6, 2010

Author: tchemit Date: 2010-04-06 23:35:23 +0200 (Tue, 06 Apr 2010) New Revision: 1717 Log: include xsd in site Modified: trunk/pom.xml Modified: trunk/pom.xml =================================================================== --- trunk/pom.xml 2010-04-06 21:22:18 UTC (rev 1716) +++ trunk/pom.xml 2010-04-06 21:35:23 UTC (rev 1717) @@ -375,6 +375,31 @@ </executions> </plugin> + <plugin> + <artifactId>maven-antrun-plugin</artifactId> +  + <version>1.2</version> + <executions> +  + <execution> + <id>copy licenProject.xsd</id> + <phase>pre-site</phase> + <configuration> + <tasks> + <copy verbose="${maven.verbose}" + failonerror="false" + overwrite="false" + file="target/generated-site/xsd/licenseProject-1.0.0.xsd" + tofile="target/site/licenseProject-1.0.0.xsd"/> + </tasks> + </configuration> + <goals> + <goal>run</goal> + </goals> + </execution> + </executions> + </plugin> + </plugins> <pluginManagement>

1 0

r1716 - in trunk/src/main: java/org/nuiton/license/plugin java/org/nuiton/license/plugin/model mdo
by tchemit＠users.nuiton.org April 6, 2010

April 6, 2010

Author: tchemit Date: 2010-04-06 23:22:18 +0200 (Tue, 06 Apr 2010) New Revision: 1716 Log: - add headertype on each file set - add getLicenNames on LicenRepository and LicenseStore - check license anmes and header types before execution of mojo Modified: trunk/src/main/java/org/nuiton/license/plugin/UpdateHeaderFileMojo.java trunk/src/main/java/org/nuiton/license/plugin/model/LicenseRepository.java trunk/src/main/java/org/nuiton/license/plugin/model/LicenseStore.java trunk/src/main/mdo/descriptor.mdo Modified: trunk/src/main/java/org/nuiton/license/plugin/UpdateHeaderFileMojo.java =================================================================== --- trunk/src/main/java/org/nuiton/license/plugin/UpdateHeaderFileMojo.java 2010-04-06 20:51:06 UTC (rev 1715) +++ trunk/src/main/java/org/nuiton/license/plugin/UpdateHeaderFileMojo.java 2010-04-06 21:22:18 UTC (rev 1716) @@ -4,12 +4,15 @@ import org.codehaus.plexus.velocity.VelocityComponent; import org.nuiton.license.plugin.header.generator.HeaderGenerator; import org.nuiton.license.plugin.model.LicenseStore; +import org.nuiton.license.plugin.model.project.FileSet; import org.nuiton.license.plugin.model.project.LicenseProject; import org.nuiton.license.plugin.model.project.LicenseSet; import org.nuiton.license.plugin.model.project.io.xpp3.LicenseProjectXpp3Reader; import java.io.File; import java.io.FileReader; +import java.util.Arrays; +import java.util.List; import java.util.Map; @@ -118,23 +121,24 @@ protected VelocityComponent velocity; /** - * All available generators + * All available generators. * * @component role="org.nuiton.license.plugin.header.generator.HeaderGenerator" */ protected Map<String, HeaderGenerator> _generators; - /** le timestamp utilise pour la generation */ + /** timestamp used for generation */ protected long timestamp; /** store of licenses */ protected LicenseStore licenseStore; - /** descriptor of project. */ + /** descriptor of project */ protected LicenseProject licenseProject; @Override protected void init() throws Exception { + // init licenses store licenseStore = createLicenseStore(licenseResolver); @@ -145,15 +149,35 @@ } finally { reader.close(); } - // check main license is known + + List<String> licenseNames = Arrays.asList(licenseStore.getLicenseNames()); + + // check licenses is known String mainLicense = licenseProject.getMainLicense(); - if (!_generators.containsKey(mainLicense)) { + if (licenseStore.getLicense(mainLicense) == null) { throw new MojoFailureException( - "main license " + mainLicense + - " is unknown, use one of " + _generators.keySet()); + "main license '" + mainLicense + + "' is unknown, use one of " + licenseNames); } - for (LicenseSet set : licenseProject.getLicenseSets()) { - set.getLicenseName(); + for (LicenseSet licenseSet : licenseProject.getLicenseSets()) { + + // check license name + String licenseName = licenseSet.getLicenseName(); + if (licenseStore.getLicense(licenseName) == null) { + throw new MojoFailureException( + "license '" + licenseName + + "' is unknown, use one of " + licenseNames); + } + + // check header types (for each file set) + for (FileSet fileSet : licenseSet.getFileSets()) { + String headerType = fileSet.getHeaderType(); + if (!_generators.containsKey(headerType)) { + throw new MojoFailureException( + "headerType '" + headerType + + "' is unknown, use one of " + _generators.keySet()); + } + } } } Modified: trunk/src/main/java/org/nuiton/license/plugin/model/LicenseRepository.java =================================================================== --- trunk/src/main/java/org/nuiton/license/plugin/model/LicenseRepository.java 2010-04-06 20:51:06 UTC (rev 1715) +++ trunk/src/main/java/org/nuiton/license/plugin/model/LicenseRepository.java 2010-04-06 21:22:18 UTC (rev 1716) @@ -113,6 +113,15 @@ } } + public String[] getLicenseNames() { + checkInit("getLicenseNames"); + List<String> result = new ArrayList<String>(licenses.size()); + for (License license : this) { + result.add(license.getName()); + } + return result.toArray(new String[result.size()]); + } + public License[] getLicenses() { checkInit("getLicenses"); return licenses.toArray(new License[licenses.size()]); Modified: trunk/src/main/java/org/nuiton/license/plugin/model/LicenseStore.java =================================================================== --- trunk/src/main/java/org/nuiton/license/plugin/model/LicenseStore.java 2010-04-06 20:51:06 UTC (rev 1715) +++ trunk/src/main/java/org/nuiton/license/plugin/model/LicenseStore.java 2010-04-06 21:22:18 UTC (rev 1716) @@ -49,6 +49,17 @@ return repositories; } + public String[] getLicenseNames() { + checkInit("getLicenseNames"); + List<String> result = new ArrayList<String>(); + for (LicenseRepository repository : this) { + for (License license : repository) { + result.add(license.getName()); + } + } + return result.toArray(new String[result.size()]); + } + public License[] getLicenses() { checkInit("getLicenses"); List<License> result = new ArrayList<License>(); Modified: trunk/src/main/mdo/descriptor.mdo =================================================================== --- trunk/src/main/mdo/descriptor.mdo 2010-04-06 20:51:06 UTC (rev 1715) +++ trunk/src/main/mdo/descriptor.mdo 2010-04-06 21:22:18 UTC (rev 1716) @@ -70,7 +70,7 @@ <name>LicenseSet</name> <description> <![CDATA[ - A licenseSet represent one license to apply to one or more filesets. + A licenseSet represents one license to apply to one or more filesets. ]]> </description> <version>1.0.0+</version> @@ -80,9 +80,7 @@ <version>1.0.0+</version> <type>String</type> <required>true</required> - <description> - The license to apply in this set. - </description> + <description>The license to apply in this set.</description> </field> <field> <name>fileSets</name> @@ -105,10 +103,20 @@ <name>FileSet</name> <version>1.0.0+</version> <description> - A fileSet allows the inclusion of groups of files into the license set. + <![CDATA[ + A fileSet allows the inclusion of groups of files into the license set + and defines also the type of header to generate. + ]]> </description> <fields> <field> + <name>headerType</name> + <version>1.0.0+</version> + <type>String</type> + <required>true</required> + <description>The type of header to generate (or updates).</description> + </field> + <field> <name>useDefaultExcludes</name> <version>1.0.0+</version> <type>boolean</type>

1 0

r1715 - in trunk/src/main: java/org/nuiton/license/plugin mdo
by tchemit＠users.nuiton.org April 6, 2010

April 6, 2010

Author: tchemit Date: 2010-04-06 22:51:06 +0200 (Tue, 06 Apr 2010) New Revision: 1715 Log: clean pom + begin of use of Project descriptor Modified: trunk/src/main/java/org/nuiton/license/plugin/UpdateHeaderFileMojo.java trunk/src/main/mdo/descriptor.mdo Modified: trunk/src/main/java/org/nuiton/license/plugin/UpdateHeaderFileMojo.java =================================================================== --- trunk/src/main/java/org/nuiton/license/plugin/UpdateHeaderFileMojo.java 2010-04-06 20:46:18 UTC (rev 1714) +++ trunk/src/main/java/org/nuiton/license/plugin/UpdateHeaderFileMojo.java 2010-04-06 20:51:06 UTC (rev 1715) @@ -1,9 +1,11 @@ package org.nuiton.license.plugin; +import org.apache.maven.plugin.MojoFailureException; import org.codehaus.plexus.velocity.VelocityComponent; import org.nuiton.license.plugin.header.generator.HeaderGenerator; import org.nuiton.license.plugin.model.LicenseStore; import org.nuiton.license.plugin.model.project.LicenseProject; +import org.nuiton.license.plugin.model.project.LicenseSet; import org.nuiton.license.plugin.model.project.io.xpp3.LicenseProjectXpp3Reader; import java.io.File; @@ -143,6 +145,16 @@ } finally { reader.close(); } + // check main license is known + String mainLicense = licenseProject.getMainLicense(); + if (!_generators.containsKey(mainLicense)) { + throw new MojoFailureException( + "main license " + mainLicense + + " is unknown, use one of " + _generators.keySet()); + } + for (LicenseSet set : licenseProject.getLicenseSets()) { + set.getLicenseName(); + } } @Override Modified: trunk/src/main/mdo/descriptor.mdo =================================================================== --- trunk/src/main/mdo/descriptor.mdo 2010-04-06 20:46:18 UTC (rev 1714) +++ trunk/src/main/mdo/descriptor.mdo 2010-04-06 20:51:06 UTC (rev 1715) @@ -77,7 +77,7 @@ <fields> <field> <name>licenseName</name> - <version>1.1.0+</version> + <version>1.0.0+</version> <type>String</type> <required>true</required> <description> @@ -110,7 +110,7 @@ <fields> <field> <name>useDefaultExcludes</name> - <version>1.1.0+</version> + <version>1.0.0+</version> <type>boolean</type> <defaultValue>true</defaultValue> <description>

1 0

r1714 - in trunk: . src/main/java/org/nuiton/license/plugin
by tchemit＠users.nuiton.org April 6, 2010

April 6, 2010

Author: tchemit Date: 2010-04-06 22:46:18 +0200 (Tue, 06 Apr 2010) New Revision: 1714 Log: clean pom + begin of use of Project descriptor Modified: trunk/pom.xml trunk/src/main/java/org/nuiton/license/plugin/UpdateHeaderFileMojo.java Modified: trunk/pom.xml =================================================================== --- trunk/pom.xml 2010-04-06 19:42:20 UTC (rev 1713) +++ trunk/pom.xml 2010-04-06 20:46:18 UTC (rev 1714) @@ -382,11 +382,6 @@ <plugin> <artifactId>maven-site-plugin</artifactId> -  -  -  -  -  <dependencies> <dependency> <groupId>org.nuiton.jrst</groupId> Modified: trunk/src/main/java/org/nuiton/license/plugin/UpdateHeaderFileMojo.java =================================================================== --- trunk/src/main/java/org/nuiton/license/plugin/UpdateHeaderFileMojo.java 2010-04-06 19:42:20 UTC (rev 1713) +++ trunk/src/main/java/org/nuiton/license/plugin/UpdateHeaderFileMojo.java 2010-04-06 20:46:18 UTC (rev 1714) @@ -3,7 +3,11 @@ import org.codehaus.plexus.velocity.VelocityComponent; import org.nuiton.license.plugin.header.generator.HeaderGenerator; import org.nuiton.license.plugin.model.LicenseStore; +import org.nuiton.license.plugin.model.project.LicenseProject; +import org.nuiton.license.plugin.model.project.io.xpp3.LicenseProjectXpp3Reader; +import java.io.File; +import java.io.FileReader; import java.util.Map; @@ -24,11 +28,20 @@ public class UpdateHeaderFileMojo extends AbstractLicenseMojo { /** + * The project license descriptor file. + * + * @parameter expression="${license.descriptor}" default-value="src/license/project.xml" + * @required + * @since 2.1 + */ + protected File descriptor; + + /** * l'annee de creation du module (sera place dans le header) * * @parameter expression="${license.inceptionYear}" default-value="${project.inceptionYear}" * @required - * @since 1.0.0 + * @since 2.1 */ protected String inceptionYear; @@ -38,7 +51,7 @@ * @parameter expression="${license.organizationName}" * default-value="${project.organization.name}" * @required - * @since 1.0.0 + * @since 2.1 */ protected String organizationName; @@ -47,7 +60,7 @@ * * @parameter expression="${license.projectName}" default-value="${project.name}" * @required - * @since 1.0.0 + * @since 2.1 */ protected String projectName; @@ -56,7 +69,7 @@ * * @parameter expression="${license.licenseName}" * @required - * @since 1.0.0 + * @since 2.1 */ protected String licenseName; @@ -69,6 +82,7 @@ */ protected String licenseResolver; + /** * A flag to keep a backup of every modified file. * @@ -114,10 +128,21 @@ /** store of licenses */ protected LicenseStore licenseStore; + /** descriptor of project. */ + protected LicenseProject licenseProject; + @Override protected void init() throws Exception { // init licenses store licenseStore = createLicenseStore(licenseResolver); + + // load project descriptor + FileReader reader = new FileReader(descriptor); + try { + licenseProject = new LicenseProjectXpp3Reader().read(reader); + } finally { + reader.close(); + } } @Override

1 0

r1713 - trunk/src/test/java/org/nuiton/license/plugin
by tchemit＠users.nuiton.org April 6, 2010

April 6, 2010

Author: tchemit Date: 2010-04-06 21:42:20 +0200 (Tue, 06 Apr 2010) New Revision: 1713 Log: remove onsolote package Removed: trunk/src/test/java/org/nuiton/license/plugin/repository/

1 0

r1712 - in trunk: . src/main src/main/mdo src/main/resources src/main/resources/license
by tchemit＠users.nuiton.org April 6, 2010

April 6, 2010

Author: tchemit Date: 2010-04-06 21:28:25 +0200 (Tue, 06 Apr 2010) New Revision: 1712 Log: use modello to generate project license descriptor file Added: trunk/src/main/mdo/ trunk/src/main/mdo/descriptor.mdo trunk/src/main/resources/licenseProjects/ Modified: trunk/pom.xml trunk/src/main/resources/license/defaultHeader.vm Modified: trunk/pom.xml =================================================================== --- trunk/pom.xml 2010-04-06 16:44:13 UTC (rev 1711) +++ trunk/pom.xml 2010-04-06 19:28:25 UTC (rev 1712) @@ -1,5 +1,7 @@ <?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"> +<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> @@ -12,7 +14,7 @@ <artifactId>mavenpom4redmine</artifactId> <version>2.0.7</version> </parent> - + <artifactId>maven-license-plugin</artifactId> <version>2.1-SNAPSHOT</version> @@ -248,7 +250,8 @@ <name>Maven License Plugin</name> <description> - Plugin pour mettre à jour l'en-tête des fichiers (avec la license choisie) + Plugin pour mettre à jour l'en-tête des fichiers (avec la license + choisie) dans un module maven 2. </description> <inceptionYear>2008</inceptionYear> @@ -274,9 +277,15 @@  <scm> - <connection>scm:svn:http://svn.nuiton.org/svn/maven-license-plugin/trunk</connection> - <developerConnection>scm:svn:http://svn.nuiton.org/svn/maven-license-plugin/trunk</developerConnection> - <url>http://www.nuiton.org/repositories/browse/maven-license-plugin/trunk</url> + <connection> + scm:svn:http://svn.nuiton.org/svn/maven-license-plugin/trunk + </connection> + <developerConnection> + scm:svn:http://svn.nuiton.org/svn/maven-license-plugin/trunk + </developerConnection> + <url> + http://www.nuiton.org/repositories/browse/maven-license-plugin/trunk + </url> </scm>  @@ -289,6 +298,7 @@ <processor.version>1.0.2</processor.version> <helper.version>1.2.3-SNAPSHOT</helper.version> + <mdoVersion>1.0.0</mdoVersion>  <siteLocales>en</siteLocales> @@ -299,6 +309,48 @@ <plugins> +  + <plugin> + <groupId>org.codehaus.modello</groupId> + <artifactId>modello-maven-plugin</artifactId> + <version>1.0</version> + <configuration> + <version>${mdoVersion}</version> + <lineLength>80</lineLength> + <useJava5>true</useJava5> + </configuration> + <executions> + <execution> + <id>mdo</id> + <phase>generate-sources</phase> + <goals> + <goal>xpp3-reader</goal> + <goal>xpp3-writer</goal> + <goal>java</goal> + <goal>xsd</goal> + </goals> + <configuration> + <models> + <model>src/main/mdo/descriptor.mdo</model> + </models> + </configuration> + </execution> + <execution> + <id>mdo-site</id> + <phase>pre-site</phase> + <goals> + <goal>xdoc</goal> + <goal>xsd</goal> + </goals> + <configuration> + <models> + <model>src/main/mdo/descriptor.mdo</model> + </models> + </configuration> + </execution> + </executions> + </plugin> +  <plugin> <groupId>org.codehaus.plexus</groupId> @@ -331,10 +383,10 @@ <plugin> <artifactId>maven-site-plugin</artifactId>  - <configuration> - <locales>${siteLocales}</locales> - <generateSitemap>true</generateSitemap> - </configuration> +  +  +  +  <dependencies> <dependency> <groupId>org.nuiton.jrst</groupId> @@ -362,7 +414,7 @@ <artifactId>maven-plugin-plugin</artifactId> <version>2.5.1</version> </plugin> - + <plugin> <groupId>org.codehaus.mojo</groupId> <artifactId>cobertura-maven-plugin</artifactId> Added: trunk/src/main/mdo/descriptor.mdo =================================================================== --- trunk/src/main/mdo/descriptor.mdo (rev 0) +++ trunk/src/main/mdo/descriptor.mdo 2010-04-06 19:28:25 UTC (rev 1712) @@ -0,0 +1,183 @@ +<?xml version="1.0"?> + +<model xsd.namespace="http://maven-site.nuiton.org/maven-license-plugin/1.0.0" + xsd.targetNamespace="http://maven-site.nuiton.org/maven-license-plugin/1.0.0"> + + <id>licenseProject</id> + <name>LicenseProject</name> + <description> + <![CDATA[ + + Maven License Plugin relies on the provided project descriptors to dictate + its execution. Although there are already prefabricated descriptors available + for use, they can only suffice some of the common assembly requirements. + + + So in order for you to customize the way the License Plugin creates your + assemblies, you need to know how to use the License project Descriptor. + + + This descriptor specifies the type of licenses to apply for some defined + filesets. + + ]]> + </description> + <defaults> + <default> + <key>package</key> + <value>org.nuiton.license.plugin.model.project</value> + </default> + </defaults> + <classes> + <class rootElement="true" xml.tagName="project"> + <name>LicenseProject</name> + <description> + <![CDATA[ + An license project defines a collection of files to be reacted by the + plugin (says update header). + ]]> + </description> + <version>1.0.0+</version> + <fields> + <field> + <name>mainLicense</name> + <version>1.0.0+</version> + <required>true</required> + <type>String</type> + <description> + The main license of the project (or module). The LICENSE.txt will + contains the content of this license. + </description> + </field> + <field> + <name>licenseSets</name> + <version>1.0.0+</version> + <association> + <type>LicenseSet</type> + <multiplicity>*</multiplicity> + </association> + <description> + <![CDATA[ + Specifies licenses to apply on a project. A licenseSet is specified + by providing one or more of <licenseSet> subelements. + ]]> + </description> + </field> + </fields> + </class> + + <class> + <name>LicenseSet</name> + <description> + <![CDATA[ + A licenseSet represent one license to apply to one or more filesets. + ]]> + </description> + <version>1.0.0+</version> + <fields> + <field> + <name>licenseName</name> + <version>1.1.0+</version> + <type>String</type> + <required>true</required> + <description> + The license to apply in this set. + </description> + </field> + <field> + <name>fileSets</name> + <version>1.0.0+</version> + <association> + <type>FileSet</type> + <multiplicity>*</multiplicity> + </association> + <description> + <![CDATA[ + Specifies file sets to include in the license set. A fileSet is specified + by providing one or more of <licenseSet> subelements. + ]]> + </description> + </field> + </fields> + </class> + + <class> + <name>FileSet</name> + <version>1.0.0+</version> + <description> + A fileSet allows the inclusion of groups of files into the license set. + </description> + <fields> + <field> + <name>useDefaultExcludes</name> + <version>1.1.0+</version> + <type>boolean</type> + <defaultValue>true</defaultValue> + <description> + Whether standard exclusion patterns, such as those matching CVS and Subversion + metadata files, should be used when calculating the files affected by this set. + For backward compatibility, the default value is true. (Since 2.2) + </description> + </field> + <field> + <name>basedir</name> + <version>1.0.0+</version> + <type>String</type> + <description> + Sets the basedir directory relative to the root + of the root directory of the assembly. For example, + "log" will put the specified files in the log directory. + </description> + </field> + <field> + <name>includes</name> + <version>1.0.0+</version> + <association> + <type>String</type> + <multiplicity>*</multiplicity> + </association> + <description> + <![CDATA[ + When <include> subelements are present, they define a set of + files and directory to include. If none is present, then + <includes> represents all valid values. + ]]> + </description> + </field> + <field> + <name>excludes</name> + <version>1.0.0+</version> + <association> + <type>String</type> + <multiplicity>*</multiplicity> + </association> + <description> + <![CDATA[ + When <exclude> subelements are present, they define a set of + files and directory to exclude. If none is present, then + <excludes> represents no exclusions. + ]]> + </description> + </field> + <field> + <name>lineEnding</name> + <version>1.0.0+</version> + <type>String</type> + <description> + <![CDATA[ + Sets the line-endings of the files in this fileSet. + Valid values: + <ul> + <li>"keep" - Preserve all line endings</li> + <li>"unix" - Use Unix-style line endings</li> + <li>"lf" - Use a single line-feed line endings</li> + <li>"dos" - Use DOS-style line endings</li> + <li>"crlf" - Use Carraige-return, line-feed line endings</li> + </ul> + ]]> + </description> + </field> + </fields> + </class> + </classes> +</model> Modified: trunk/src/main/resources/license/defaultHeader.vm =================================================================== --- trunk/src/main/resources/license/defaultHeader.vm 2010-04-06 16:44:13 UTC (rev 1711) +++ trunk/src/main/resources/license/defaultHeader.vm 2010-04-06 19:28:25 UTC (rev 1712) @@ -1,4 +1,5 @@ $projectName +-- Copyright (C) $inceptionYear $organizationName - +-- $licenseContent

1 0

r1711 - trunk/src/main/java/org/nuiton/license/plugin
by tchemit＠users.nuiton.org April 6, 2010

April 6, 2010

Author: tchemit Date: 2010-04-06 18:44:13 +0200 (Tue, 06 Apr 2010) New Revision: 1711 Log: delete repository package + introduce model package + move new licenses (was in wrong package) Removed: trunk/src/main/java/org/nuiton/license/plugin/repository/

1 0

r1710 - in trunk/src: main/java/org/nuiton/license/plugin main/java/org/nuiton/license/plugin/model main/java/org/nuiton/license/plugin/repository main/resources/META-INF/licenses main/resources/META-INF/licenses/agpl_v3 main/resources/META-INF/licenses/fdl_v1_3 main/resources/license test/java/org/nuiton/license/plugin test/java/org/nuiton/license/plugin/model
by tchemit＠users.nuiton.org April 6, 2010

April 6, 2010

Author: tchemit Date: 2010-04-06 18:43:34 +0200 (Tue, 06 Apr 2010) New Revision: 1710 Log: delete repository package + introduce model package + move new licenses (was in wrong package) Added: trunk/src/main/java/org/nuiton/license/plugin/model/ trunk/src/main/java/org/nuiton/license/plugin/model/License.java trunk/src/main/java/org/nuiton/license/plugin/model/LicenseRepository.java trunk/src/main/java/org/nuiton/license/plugin/model/LicenseStore.java trunk/src/main/resources/META-INF/licenses/agpl_v3/ trunk/src/main/resources/META-INF/licenses/agpl_v3/header.txt trunk/src/main/resources/META-INF/licenses/agpl_v3/license.txt trunk/src/main/resources/META-INF/licenses/fdl_v1_3/ trunk/src/main/resources/META-INF/licenses/fdl_v1_3/header.txt trunk/src/main/resources/META-INF/licenses/fdl_v1_3/license.txt trunk/src/test/java/org/nuiton/license/plugin/model/ trunk/src/test/java/org/nuiton/license/plugin/model/LicenseRepositoryTest.java trunk/src/test/java/org/nuiton/license/plugin/model/LicenseStoreTest.java Removed: trunk/src/main/java/org/nuiton/license/plugin/repository/License.java trunk/src/main/java/org/nuiton/license/plugin/repository/LicenseDefinition.java trunk/src/main/java/org/nuiton/license/plugin/repository/LicenseRepository.java trunk/src/main/java/org/nuiton/license/plugin/repository/LicenseRepositoryFactory.java trunk/src/main/java/org/nuiton/license/plugin/repository/LicenseStore.java trunk/src/main/resources/license/agpl_v3/ trunk/src/main/resources/license/fdl_v1_3/ Modified: trunk/src/main/java/org/nuiton/license/plugin/AbstractLicenseMojo.java trunk/src/main/java/org/nuiton/license/plugin/AddLicenseFileMojo.java trunk/src/main/java/org/nuiton/license/plugin/LicenseListMojo.java trunk/src/main/java/org/nuiton/license/plugin/UpdateHeaderFileMojo.java trunk/src/main/java/org/nuiton/license/plugin/UpdateHeaderMojo.java trunk/src/main/resources/META-INF/licenses/licenses.properties Modified: trunk/src/main/java/org/nuiton/license/plugin/AbstractLicenseMojo.java =================================================================== --- trunk/src/main/java/org/nuiton/license/plugin/AbstractLicenseMojo.java 2010-04-06 16:21:34 UTC (rev 1709) +++ trunk/src/main/java/org/nuiton/license/plugin/AbstractLicenseMojo.java 2010-04-06 16:43:34 UTC (rev 1710) @@ -2,7 +2,7 @@ import org.apache.maven.plugin.MojoExecutionException; import org.apache.maven.project.MavenProject; -import org.nuiton.license.plugin.repository.LicenseStore; +import org.nuiton.license.plugin.model.LicenseStore; import org.nuiton.plugin.AbstractPlugin; import java.io.IOException; Modified: trunk/src/main/java/org/nuiton/license/plugin/AddLicenseFileMojo.java =================================================================== --- trunk/src/main/java/org/nuiton/license/plugin/AddLicenseFileMojo.java 2010-04-06 16:21:34 UTC (rev 1709) +++ trunk/src/main/java/org/nuiton/license/plugin/AddLicenseFileMojo.java 2010-04-06 16:43:34 UTC (rev 1710) @@ -20,8 +20,8 @@ */ package org.nuiton.license.plugin; -import org.nuiton.license.plugin.repository.License; -import org.nuiton.license.plugin.repository.LicenseStore; +import org.nuiton.license.plugin.model.License; +import org.nuiton.license.plugin.model.LicenseStore; import org.nuiton.plugin.PluginHelper; import java.io.File; @@ -140,15 +140,6 @@ LicenseStore licenseStore = createLicenseStore(extraResolver); license = licenseStore.getLicense(licenseName); -// LicenseRepository factory = -// LicenseRepositoryFactory.newLicenseRepository( -// true, -// true, -// extraResolver -// ); -// -// license = factory.getLicense(licenseName); - if (licenseFilename == null || licenseFilename.isEmpty()) { licenseFilename = licenseName; } Modified: trunk/src/main/java/org/nuiton/license/plugin/LicenseListMojo.java =================================================================== --- trunk/src/main/java/org/nuiton/license/plugin/LicenseListMojo.java 2010-04-06 16:21:34 UTC (rev 1709) +++ trunk/src/main/java/org/nuiton/license/plugin/LicenseListMojo.java 2010-04-06 16:43:34 UTC (rev 1710) @@ -22,8 +22,8 @@ import org.apache.maven.plugin.MojoExecutionException; import org.apache.maven.plugin.MojoFailureException; -import org.nuiton.license.plugin.repository.License; -import org.nuiton.license.plugin.repository.LicenseStore; +import org.nuiton.license.plugin.model.License; +import org.nuiton.license.plugin.model.LicenseStore; import java.io.IOException; @@ -86,48 +86,11 @@ } catch (IOException ex) { throw new MojoExecutionException( "could not instanciate license with name " + - licenseName + " for reason " + ex.getMessage(), ex); + licenseName + " for reason " + ex.getMessage(), ex); } } } getLog().info(buffer.toString()); -// LicenseRepository factory; -// try { -// factory = LicenseRepositoryFactory.newLicenseRepository( -// true, -// true, -// extraResolver -// ); -// } catch (IllegalArgumentException ex) { -// throw new MojoExecutionException( -// "could not obtain the license repository", ex); -// } catch (IOException ex) { -// throw new MojoExecutionException( -// "could not obtain the license repository", ex); -// } -// -// for (LicenseDefinition entry : factory.getDefinitions()) { -// String licenseName = entry.getName(); -// buffer.append(" * "); -// buffer.append(licenseName); -// buffer.append(" : "); -// buffer.append(entry.getDescription()); -// buffer.append('\n'); -// if (detail) { -// try { -// -// License license = factory.getLicense(licenseName); -// buffer.append("\n"); -// buffer.append(license.getHeaderContent(encoding)); -// buffer.append("\n\n"); -// } catch (IOException ex) { -// throw new MojoExecutionException( -// "could not instanciate license with name " + -// licenseName + " for reason " + ex.getMessage(), ex); -// } -// } -// } -// getLog().info(buffer.toString()); } } Modified: trunk/src/main/java/org/nuiton/license/plugin/UpdateHeaderFileMojo.java =================================================================== --- trunk/src/main/java/org/nuiton/license/plugin/UpdateHeaderFileMojo.java 2010-04-06 16:21:34 UTC (rev 1709) +++ trunk/src/main/java/org/nuiton/license/plugin/UpdateHeaderFileMojo.java 2010-04-06 16:43:34 UTC (rev 1710) @@ -1,13 +1,9 @@ package org.nuiton.license.plugin; -import org.apache.maven.project.MavenProject; import org.codehaus.plexus.velocity.VelocityComponent; import org.nuiton.license.plugin.header.generator.HeaderGenerator; -import org.nuiton.plugin.AbstractPlugin; -import org.nuiton.plugin.PluginHelper; +import org.nuiton.license.plugin.model.LicenseStore; -import java.util.Arrays; -import java.util.List; import java.util.Map; @@ -65,8 +61,17 @@ protected String licenseName; /** - * Un flag pour conserver un backup des fichiers modifies. + * To specify an external licenses repository resolver (says the base url + * of the repository). * + * @parameter expression="${license.licenseResolver}" + * @since 2.1 + */ + protected String licenseResolver; + + /** + * A flag to keep a backup of every modified file. + * * @parameter expression="${license.keepBackup}" default-value="false" * @since 1.0.0 */ @@ -106,74 +111,79 @@ /** le timestamp utilise pour la generation */ protected long timestamp; + /** store of licenses */ + protected LicenseStore licenseStore; + @Override protected void init() throws Exception { + // init licenses store + licenseStore = createLicenseStore(licenseResolver); } @Override protected void doAction() throws Exception { } + public long getTimestamp() { + return timestamp; + } + + public String getProjectName() { + return projectName; + } + + public String getLicenseName() { + return licenseName; + } + + public String getInceptionYear() { + return inceptionYear; + } + + public String getOrganizationName() { + return organizationName; + } + + public boolean isKeepBackup() { + return keepBackup; + } + public boolean isDryRun() { return dryRun; } + public boolean isSkipUpdateHeader() { + return skipUpdateHeader; + } + public void setDryRun(boolean dryRun) { this.dryRun = dryRun; } - public boolean isKeepBackup() { - return keepBackup; - } - public void setKeepBackup(boolean keepBackup) { this.keepBackup = keepBackup; } - public long getTimestamp() { - return timestamp; - } - public void setTimestamp(long timestamp) { this.timestamp = timestamp; } - public String getProjectName() { - return projectName; - } - public void setProjectName(String projectName) { this.projectName = projectName; } - public boolean isSkipUpdateHeader() { - return skipUpdateHeader; - } - public void setSkipUpdateHeader(boolean skipUpdateHeader) { this.skipUpdateHeader = skipUpdateHeader; } - public String getInceptionYear() { - return inceptionYear; - } - public void setInceptionYear(String inceptionYear) { this.inceptionYear = inceptionYear; } - public String getLicenseName() { - return licenseName; - } - public void setLicenseName(String licenseName) { this.licenseName = licenseName; } - public String getOrganizationName() { - return organizationName; - } - public void setOrganizationName(String organizationName) { this.organizationName = organizationName; } Modified: trunk/src/main/java/org/nuiton/license/plugin/UpdateHeaderMojo.java =================================================================== --- trunk/src/main/java/org/nuiton/license/plugin/UpdateHeaderMojo.java 2010-04-06 16:21:34 UTC (rev 1709) +++ trunk/src/main/java/org/nuiton/license/plugin/UpdateHeaderMojo.java 2010-04-06 16:43:34 UTC (rev 1710) @@ -27,8 +27,8 @@ import org.apache.velocity.context.Context; import org.codehaus.plexus.velocity.VelocityComponent; import org.nuiton.license.plugin.header.generator.HeaderGenerator; -import org.nuiton.license.plugin.repository.License; -import org.nuiton.license.plugin.repository.LicenseStore; +import org.nuiton.license.plugin.model.License; +import org.nuiton.license.plugin.model.LicenseStore; import org.nuiton.plugin.PluginHelper; import org.nuiton.processor.LicenseProcessor; Copied: trunk/src/main/java/org/nuiton/license/plugin/model/License.java (from rev 1709, trunk/src/main/java/org/nuiton/license/plugin/repository/License.java) =================================================================== --- trunk/src/main/java/org/nuiton/license/plugin/model/License.java (rev 0) +++ trunk/src/main/java/org/nuiton/license/plugin/model/License.java 2010-04-06 16:43:34 UTC (rev 1710) @@ -0,0 +1,150 @@ +/* + * *##% + * Maven License Plugin + * Copyright (C) 2008 - 2010 CodeLutin + * + * 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>. + * ##%* + */ +package org.nuiton.license.plugin.model; + +import org.apache.commons.lang.builder.ToStringBuilder; +import org.apache.commons.lang.builder.ToStringStyle; +import org.codehaus.plexus.util.IOUtil; +import org.nuiton.plugin.PluginHelper; + +import java.io.BufferedReader; +import java.io.IOException; +import java.io.InputStreamReader; +import java.io.Reader; +import java.net.URL; + +/** + * The model of a license. + * + * @author chemit + */ +public class License { + + public static final String LICENSE_HEADER_FILE = "header.txt"; + + public static final String LICENSE_CONTENT_FILE = "license.txt"; + + /** base url of license (directory where to find license files) */ + protected URL baseURL; + + /** the name of the licenses (ex lgpl-3.0) */ + protected String name; + + /** the description of the license */ + protected String description; + + /** url of the license's content */ + protected URL licenseURL; + + /** url of the license header's content */ + protected URL headerURL; + + public License() { + } + + public String getName() { + return name; + } + + public URL getLicenseURL() { + if (licenseURL == null) { + licenseURL = PluginHelper.getUrl(getBaseURL(), LICENSE_CONTENT_FILE); + } + return licenseURL; + } + + public URL getHeaderURL() { + if (headerURL == null) { + headerURL = PluginHelper.getUrl(getBaseURL(), LICENSE_HEADER_FILE); + } + return headerURL; + } + + public String getDescription() { + return description; + } + + public URL getBaseURL() { + return baseURL; + } + + public String getLicenseContent(String encoding) throws IOException { + if (licenseURL == null) { + throw new IllegalStateException("no licenseURL defined, can not obtain license content in " + this); + } + + Reader r = new BufferedReader( + new InputStreamReader(getLicenseURL().openStream(), encoding)); + try { + return IOUtil.toString(r); + } finally { + r.close(); + } + } + + public String getHeaderContent(String encoding) throws IOException { + if (baseURL == null) { + throw new IllegalStateException("no baseURL defined, can not obtain header content in " + this); + } + Reader r = new BufferedReader( + new InputStreamReader(getHeaderURL().openStream(), encoding)); + try { + return IOUtil.toString(r); + } finally { + r.close(); + } + } + + public void setName(String name) { + this.name = name; + } + +// @Deprecated +// public void setLicenseURL(URL licenseURL) { +// this.licenseURL = licenseURL; +// } +// +// @Deprecated +// public void setHeaderURL(URL headerURL) { +// this.headerURL = headerURL; +// } + + public void setDescription(String description) { + this.description = description; + } + + public void setBaseURL(URL baseURL) { + this.baseURL = baseURL; + } + + @Override + public String toString() { + ToStringBuilder builder = new ToStringBuilder( + this, + ToStringStyle.MULTI_LINE_STYLE + ); + builder.append("name", name); + builder.append("description", description); + builder.append("licenseURL", getLicenseURL()); + builder.append("headerURL", getHeaderURL()); + return builder.toString(); + } +} Property changes on: trunk/src/main/java/org/nuiton/license/plugin/model/License.java ___________________________________________________________________ Added: svn:keywords + "Author Date Id Revision HeadURL Copied: trunk/src/main/java/org/nuiton/license/plugin/model/LicenseRepository.java (from rev 1709, trunk/src/main/java/org/nuiton/license/plugin/repository/LicenseRepository.java) =================================================================== --- trunk/src/main/java/org/nuiton/license/plugin/model/LicenseRepository.java (rev 0) +++ trunk/src/main/java/org/nuiton/license/plugin/model/LicenseRepository.java 2010-04-06 16:43:34 UTC (rev 1710) @@ -0,0 +1,264 @@ +/* + * *##% + * Maven License Plugin + * Copyright (C) 2008 - 2010 CodeLutin + * + * 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>. + * ##%* + */ +package org.nuiton.license.plugin.model; + +import org.apache.commons.logging.Log; +import org.apache.commons.logging.LogFactory; +import org.nuiton.plugin.PluginHelper; + +import java.io.IOException; +import java.net.URL; +import java.net.URLConnection; +import java.util.*; +import java.util.Map.Entry; + +/** + * @author chemit + * @since 1.0.3 + */ +public class LicenseRepository implements Iterable<License> { + + /** Logger */ + private static final Log log = LogFactory.getLog(LicenseRepository.class); + + public static final String REPOSITORY_DEFINITION_FILE = "licenses.properties"; + + /** the base url of the licenses repository */ + protected URL baseURL; + + /** licenses of this repository */ + protected List<License> licenses; + + /** + * flag to known if repository was init (pass to {@code true} when invoking + * the method {@link #load()}). + */ + protected boolean init; + + public LicenseRepository() { + } + + public URL getBaseURL() { + return baseURL; + } + + public void setBaseURL(URL baseURL) { + checkNotInit("setBaseURL"); + this.baseURL = baseURL; + } + + public void load() throws IOException { + checkNotInit("load"); + try { + if (baseURL == null || baseURL.toString().trim().isEmpty()) { + throw new IllegalStateException( + "no baseURL defined in " + this); + } + + URL definitionURL = PluginHelper.getUrl( + getBaseURL(), + REPOSITORY_DEFINITION_FILE + ); + if (licenses != null) { + licenses.clear(); + } else { + licenses = new ArrayList<License>(); + } + + if (!checkExists(definitionURL)) { + throw new IllegalArgumentException( + "no licenses.properties found withurl [" + + definitionURL + "] for resolver " + this); + } + Properties p = new Properties(); + p.load(definitionURL.openStream()); + + for (Entry<Object, Object> entry : p.entrySet()) { + String licenseName = (String) entry.getKey(); + licenseName = licenseName.trim().toLowerCase(); + String licenseDescription = (String) entry.getValue(); + URL licenseURL = PluginHelper.getUrl(baseURL, licenseName); + + License license = new License(); + license.setName(licenseName); + license.setDescription(licenseDescription); + license.setBaseURL(licenseURL); + if (log.isInfoEnabled()) { + log.info("Adding license " + license); + } + licenses.add(license); + } + licenses = Collections.unmodifiableList(licenses); + } finally { + // mark repository as available + init = true; + } + } + + public License[] getLicenses() { + checkInit("getLicenses"); + return licenses.toArray(new License[licenses.size()]); + } + + public License getLicense(String licenseName) { + checkInit("getLicense"); + if (licenseName == null || licenseName.trim().isEmpty()) { + throw new IllegalArgumentException( + "licenceName can not be null, nor empty"); + } + + License license = null; + for (License l : this) { + if (licenseName.equals(l.getName())) { + // got it + license = l; + break; + } + } + return license; + } + + @Override + public Iterator<License> iterator() { + checkInit("iterator"); + return licenses.iterator(); + } + + protected boolean checkExists(URL url) throws IOException { + URLConnection openConnection = url.openConnection(); + return openConnection.getContentLength() > 0; + } + + protected void checkInit(String operation) throws IllegalStateException { + if (!init) { + throw new IllegalStateException( + "repository " + this + " was not init, operation [" + + operation + "] not possible."); + } + } + + protected void checkNotInit(String operation) throws IllegalStateException { + if (init) { + throw new IllegalStateException( + "repository " + this + "was init, operation [" + + operation + "+] not possible."); + } + } + +// /** next repository (can be {@code null}). */ +// @Deprecated +// protected LicenseRepository next; +// +// @Deprecated +// protected List<LicenseDefinition> definitions; +// +// @Deprecated +// protected final Map<LicenseDefinition, License> cache; +// +// @Deprecated +// public void reload() throws IOException { +// init = false; +// load(); +// } + +// @Deprecated +// public static URL getUrl(URL baseUrl, +// String suffix) throws IllegalArgumentException { +// return PluginHelper.getUrl(baseUrl, suffix); +// } +// +// @Deprecated +// public LicenseRepository appendRepository(LicenseRepository next) { +// LicenseRepository lastRepository = getLastRepository(); +// lastRepository.next = next; +// return next; +// } +// +// @Deprecated +// public List<LicenseDefinition> getAllDefinitions() { +// LicenseRepository[] repos = getAllRepositories(); +// List<LicenseDefinition> result = +// new ArrayList<LicenseDefinition>(repos.length); +// for (LicenseRepository repo : repos) { +// result.addAll(repo.definitions); +// } +// return result; +// } +// +// public List<LicenseDefinition> getDefinitions() { +// return definitions; +// } +// +// public LicenseDefinition getDefinition(String licenseName) { +// checkInit("getDefinition"); +// if (licenseName == null || licenseName.trim().isEmpty()) { +// throw new IllegalArgumentException( +// "licenceName can not be null, nor empty"); +// } +// licenseName = licenseName.trim().toLowerCase(); +// LicenseDefinition definition = null; +// for (LicenseDefinition d : definitions) { +// if (licenseName.equals(d.getName())) { +// definition = d; +// break; +// } +// } +// if (definition == null && next != null) { +// definition = next.getDefinition(licenseName); +// } +// return definition; +// } +// +// @Deprecated +// protected LicenseRepository getLastRepository() { +// LicenseRepository last = next == null ? this : next.getLastRepository(); +// return last; +// } +// +// @Deprecated +// protected LicenseRepository[] getAllRepositories() { +// List<LicenseRepository> list = new ArrayList<LicenseRepository>(); +// LicenseRepository repo = this; +// while (repo != null) { +// list.add(repo); +// repo = repo.next; +// } +// return list.toArray(new LicenseRepository[list.size()]); +// } +// +// @Deprecated +// protected void checkNotInit() throws IllegalStateException { +// if (init) { +// throw new IllegalStateException( +// "license repository " + this + +// " was already initialize..."); +// } +// } +// +// @Deprecated +// protected void checkInit() throws IllegalStateException { +// if (!init) { +// throw new IllegalStateException( +// "repository " + this + " is not init, use the load " + +// "method before any license request"); +// } +// } +} Property changes on: trunk/src/main/java/org/nuiton/license/plugin/model/LicenseRepository.java ___________________________________________________________________ Added: svn:keywords + "Author Date Id Revision HeadURL Copied: trunk/src/main/java/org/nuiton/license/plugin/model/LicenseStore.java (from rev 1709, trunk/src/main/java/org/nuiton/license/plugin/repository/LicenseStore.java) =================================================================== --- trunk/src/main/java/org/nuiton/license/plugin/model/LicenseStore.java (rev 0) +++ trunk/src/main/java/org/nuiton/license/plugin/model/LicenseStore.java 2010-04-06 16:43:34 UTC (rev 1710) @@ -0,0 +1,136 @@ +package org.nuiton.license.plugin.model; + +import org.apache.commons.logging.Log; +import org.apache.commons.logging.LogFactory; + +import java.io.IOException; +import java.net.URL; +import java.util.ArrayList; +import java.util.Iterator; +import java.util.List; + +/** + * The {@code LicenseStore} offers {@link License} coming from different {@link + * LicenseRepository}. + * + * @author tchemit <chemit(a)codelutin.com> + * @since 2.1 + */ +public class LicenseStore implements Iterable<LicenseRepository> { + + /** Logger */ + private static final Log log = LogFactory.getLog(LicenseStore.class); + + /** class-path directory where is the licenses repository */ + public static final String JAR_LICENSE_REPOSITORY = "/META-INF/licenses"; + + /** list of available license repositories */ + protected List<LicenseRepository> repositories; + + /** flag to know if store was init */ + protected boolean init; + + public void init() throws IOException { + checkNotInit("init"); + try { + if (repositories == null) { + // adding the default class-path repository + addJarRepository(); + } + for (LicenseRepository r : this) { + r.load(); + } + } finally { + init = true; + } + } + + public List<LicenseRepository> getRepositories() { + return repositories; + } + + public License[] getLicenses() { + checkInit("getLicenses"); + List<License> result = new ArrayList<License>(); + if (repositories != null) { + for (LicenseRepository repository : this) { + for (License license : repository) { + result.add(license); + } + } + } + return result.toArray(new License[result.size()]); + } + + public License getLicense(String licenseName) { + checkInit("getLicense"); + Iterator<LicenseRepository> itr = iterator(); + License result = null; + while (itr.hasNext()) { + LicenseRepository licenseRepository = itr.next(); + License license = licenseRepository.getLicense(licenseName); + if (license != null) { + result = license; + break; + } + } + if (result == null && log.isDebugEnabled()) { + log.debug("could not find license named '" + licenseName + "'"); + } + return result; + } + + public void addRepository(String extraResolver) throws IOException { + addRepository(new URL(extraResolver)); + } + + public void addRepository(URL baseURL) throws IOException { + checkNotInit("addRepository"); + LicenseRepository repository = new LicenseRepository(); + repository.setBaseURL(baseURL); + if (log.isDebugEnabled()) { + log.debug("Adding a license repository " + repository); + } + addRepository(repository); + } + + public void addJarRepository() throws IOException { + checkNotInit("addJarRepository"); + URL baseURL = getClass().getResource(JAR_LICENSE_REPOSITORY); + LicenseRepository repository = new LicenseRepository(); + repository.setBaseURL(baseURL); + if (log.isDebugEnabled()) { + log.debug("Adding a jar license repository " + repository); + } + addRepository(repository); + } + + @Override + public Iterator<LicenseRepository> iterator() { + return getRepositories().iterator(); + } + + protected void addRepository(LicenseRepository repository) { + checkNotInit("addRepository"); + if (repositories == null) { + repositories = new ArrayList<LicenseRepository>(); + + } + if (log.isInfoEnabled()) { + log.info("Adding a license repository " + repository); + } + repositories.add(repository); + } + + protected void checkInit(String operation) throws IllegalStateException { + if (!init) { + throw new IllegalStateException("store was not init, operation [" + operation + "] not possible."); + } + } + + protected void checkNotInit(String operation) throws IllegalStateException { + if (init) { + throw new IllegalStateException("store was init, operation [" + operation + "+] not possible."); + } + } +} Property changes on: trunk/src/main/java/org/nuiton/license/plugin/model/LicenseStore.java ___________________________________________________________________ Added: svn:keywords + "Author Date Id Revision HeadURL Deleted: trunk/src/main/java/org/nuiton/license/plugin/repository/License.java =================================================================== --- trunk/src/main/java/org/nuiton/license/plugin/repository/License.java 2010-04-06 16:21:34 UTC (rev 1709) +++ trunk/src/main/java/org/nuiton/license/plugin/repository/License.java 2010-04-06 16:43:34 UTC (rev 1710) @@ -1,150 +0,0 @@ -/* - * *##% - * Maven License Plugin - * Copyright (C) 2008 - 2010 CodeLutin - * - * 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>. - * ##%* - */ -package org.nuiton.license.plugin.repository; - -import org.apache.commons.lang.builder.ToStringBuilder; -import org.apache.commons.lang.builder.ToStringStyle; -import org.codehaus.plexus.util.IOUtil; -import org.nuiton.plugin.PluginHelper; - -import java.io.BufferedReader; -import java.io.IOException; -import java.io.InputStreamReader; -import java.io.Reader; -import java.net.URL; - -/** - * The model of a license. - * - * @author chemit - */ -public class License { - - public static final String LICENSE_HEADER_FILE = "header.txt"; - - public static final String LICENSE_CONTENT_FILE = "license.txt"; - - /** base url of license (directory where to find license files) */ - protected URL baseURL; - - /** the name of the licenses (ex lgpl-3.0) */ - protected String name; - - /** the description of the license */ - protected String description; - - /** url of the license's content */ - protected URL licenseURL; - - /** url of the license header's content */ - protected URL headerURL; - - public License() { - } - - public String getName() { - return name; - } - - public URL getLicenseURL() { - if (licenseURL == null) { - licenseURL = PluginHelper.getUrl(getBaseURL(), LICENSE_CONTENT_FILE); - } - return licenseURL; - } - - public URL getHeaderURL() { - if (headerURL == null) { - headerURL = PluginHelper.getUrl(getBaseURL(), LICENSE_HEADER_FILE); - } - return headerURL; - } - - public String getDescription() { - return description; - } - - public URL getBaseURL() { - return baseURL; - } - - public String getLicenseContent(String encoding) throws IOException { - if (licenseURL == null) { - throw new IllegalStateException("no licenseURL defined, can not obtain license content in " + this); - } - - Reader r = new BufferedReader( - new InputStreamReader(getLicenseURL().openStream(), encoding)); - try { - return IOUtil.toString(r); - } finally { - r.close(); - } - } - - public String getHeaderContent(String encoding) throws IOException { - if (baseURL == null) { - throw new IllegalStateException("no baseURL defined, can not obtain header content in " + this); - } - Reader r = new BufferedReader( - new InputStreamReader(getHeaderURL().openStream(), encoding)); - try { - return IOUtil.toString(r); - } finally { - r.close(); - } - } - - public void setName(String name) { - this.name = name; - } - -// @Deprecated -// public void setLicenseURL(URL licenseURL) { -// this.licenseURL = licenseURL; -// } -// -// @Deprecated -// public void setHeaderURL(URL headerURL) { -// this.headerURL = headerURL; -// } - - public void setDescription(String description) { - this.description = description; - } - - public void setBaseURL(URL baseURL) { - this.baseURL = baseURL; - } - - @Override - public String toString() { - ToStringBuilder builder = new ToStringBuilder( - this, - ToStringStyle.MULTI_LINE_STYLE - ); - builder.append("name", name); - builder.append("description", description); - builder.append("licenseURL", getLicenseURL()); - builder.append("headerURL", getHeaderURL()); - return builder.toString(); - } -} Deleted: trunk/src/main/java/org/nuiton/license/plugin/repository/LicenseDefinition.java =================================================================== --- trunk/src/main/java/org/nuiton/license/plugin/repository/LicenseDefinition.java 2010-04-06 16:21:34 UTC (rev 1709) +++ trunk/src/main/java/org/nuiton/license/plugin/repository/LicenseDefinition.java 2010-04-06 16:43:34 UTC (rev 1710) @@ -1,86 +0,0 @@ -/* - * *##% - * Maven License Plugin - * Copyright (C) 2008 - 2010 CodeLutin - * - * 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>. - * ##%* - */ -package org.nuiton.license.plugin.repository; - -import org.apache.commons.lang.builder.ToStringBuilder; -import org.apache.commons.lang.builder.ToStringStyle; -import org.nuiton.plugin.PluginHelper; - -import java.io.IOException; -import java.net.URL; - -/** - * Model of a license definition in a license repository. - * - * @since 1.0.3 - * @deprecated since 2.1, prefer use directly the {@link License} class instead. - */ -@Deprecated -public class LicenseDefinition { - - public static final String LICENSE_HEADER_FILE = "header.txt"; - - public static final String LICENSE_CONTENT_FILE = "license.txt"; - - protected URL baseURL; - - protected String name; - - protected String description; - - public LicenseDefinition(URL baseURL, String name, String description) { - this.baseURL = baseURL; - this.name = name; - this.description = description; - } - - public URL getBaseURL() { - return baseURL; - } - - public String getDescription() { - return description; - } - - public String getName() { - return name; - } - - public URL getLicenseURL() throws IOException { - return PluginHelper.getUrl(baseURL, LICENSE_CONTENT_FILE); - } - - public URL getHeaderURL() throws IOException { - return PluginHelper.getUrl(baseURL, LICENSE_HEADER_FILE); - } - - @Override - public String toString() { - ToStringBuilder builder = new ToStringBuilder( - this, - ToStringStyle.MULTI_LINE_STYLE - ); - builder.append("name", name); - builder.append("description", description); - builder.append("baseURL", baseURL); - return builder.toString(); - } -} Deleted: trunk/src/main/java/org/nuiton/license/plugin/repository/LicenseRepository.java =================================================================== --- trunk/src/main/java/org/nuiton/license/plugin/repository/LicenseRepository.java 2010-04-06 16:21:34 UTC (rev 1709) +++ trunk/src/main/java/org/nuiton/license/plugin/repository/LicenseRepository.java 2010-04-06 16:43:34 UTC (rev 1710) @@ -1,264 +0,0 @@ -/* - * *##% - * Maven License Plugin - * Copyright (C) 2008 - 2010 CodeLutin - * - * 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>. - * ##%* - */ -package org.nuiton.license.plugin.repository; - -import org.apache.commons.logging.Log; -import org.apache.commons.logging.LogFactory; -import org.nuiton.plugin.PluginHelper; - -import java.io.IOException; -import java.net.URL; -import java.net.URLConnection; -import java.util.*; -import java.util.Map.Entry; - -/** - * @author chemit - * @since 1.0.3 - */ -public class LicenseRepository implements Iterable<License> { - - /** Logger */ - private static final Log log = LogFactory.getLog(LicenseRepository.class); - - public static final String REPOSITORY_DEFINITION_FILE = "licenses.properties"; - - /** the base url of the licenses repository */ - protected URL baseURL; - - /** licenses of this repository */ - protected List<License> licenses; - - /** - * flag to known if repository was init (pass to {@code true} when invoking - * the method {@link #load()}). - */ - protected boolean init; - - public LicenseRepository() { - } - - public URL getBaseURL() { - return baseURL; - } - - public void setBaseURL(URL baseURL) { - checkNotInit("setBaseURL"); - this.baseURL = baseURL; - } - - public void load() throws IOException { - checkNotInit("load"); - try { - if (baseURL == null || baseURL.toString().trim().isEmpty()) { - throw new IllegalStateException( - "no baseURL defined in " + this); - } - - URL definitionURL = PluginHelper.getUrl( - getBaseURL(), - REPOSITORY_DEFINITION_FILE - ); - if (licenses != null) { - licenses.clear(); - } else { - licenses = new ArrayList<License>(); - } - - if (!checkExists(definitionURL)) { - throw new IllegalArgumentException( - "no licenses.properties found withurl [" + - definitionURL + "] for resolver " + this); - } - Properties p = new Properties(); - p.load(definitionURL.openStream()); - - for (Entry<Object, Object> entry : p.entrySet()) { - String licenseName = (String) entry.getKey(); - licenseName = licenseName.trim().toLowerCase(); - String licenseDescription = (String) entry.getValue(); - URL licenseURL = PluginHelper.getUrl(baseURL, licenseName); - - License license = new License(); - license.setName(licenseName); - license.setDescription(licenseDescription); - license.setBaseURL(licenseURL); - if (log.isInfoEnabled()) { - log.info("Adding license " + license); - } - licenses.add(license); - } - licenses = Collections.unmodifiableList(licenses); - } finally { - // mark repository as available - init = true; - } - } - - public License[] getLicenses() { - checkInit("getLicenses"); - return licenses.toArray(new License[licenses.size()]); - } - - public License getLicense(String licenseName) { - checkInit("getLicense"); - if (licenseName == null || licenseName.trim().isEmpty()) { - throw new IllegalArgumentException( - "licenceName can not be null, nor empty"); - } - - License license = null; - for (License l : this) { - if (licenseName.equals(l.getName())) { - // got it - license = l; - break; - } - } - return license; - } - - @Override - public Iterator<License> iterator() { - checkInit("iterator"); - return licenses.iterator(); - } - - protected boolean checkExists(URL url) throws IOException { - URLConnection openConnection = url.openConnection(); - return openConnection.getContentLength() > 0; - } - - protected void checkInit(String operation) throws IllegalStateException { - if (!init) { - throw new IllegalStateException( - "repository " + this + " was not init, operation [" + - operation + "] not possible."); - } - } - - protected void checkNotInit(String operation) throws IllegalStateException { - if (init) { - throw new IllegalStateException( - "repository " + this + "was init, operation [" + - operation + "+] not possible."); - } - } - -// /** next repository (can be {@code null}). */ -// @Deprecated -// protected LicenseRepository next; -// -// @Deprecated -// protected List<LicenseDefinition> definitions; -// -// @Deprecated -// protected final Map<LicenseDefinition, License> cache; -// -// @Deprecated -// public void reload() throws IOException { -// init = false; -// load(); -// } - -// @Deprecated -// public static URL getUrl(URL baseUrl, -// String suffix) throws IllegalArgumentException { -// return PluginHelper.getUrl(baseUrl, suffix); -// } -// -// @Deprecated -// public LicenseRepository appendRepository(LicenseRepository next) { -// LicenseRepository lastRepository = getLastRepository(); -// lastRepository.next = next; -// return next; -// } -// -// @Deprecated -// public List<LicenseDefinition> getAllDefinitions() { -// LicenseRepository[] repos = getAllRepositories(); -// List<LicenseDefinition> result = -// new ArrayList<LicenseDefinition>(repos.length); -// for (LicenseRepository repo : repos) { -// result.addAll(repo.definitions); -// } -// return result; -// } -// -// public List<LicenseDefinition> getDefinitions() { -// return definitions; -// } -// -// public LicenseDefinition getDefinition(String licenseName) { -// checkInit("getDefinition"); -// if (licenseName == null || licenseName.trim().isEmpty()) { -// throw new IllegalArgumentException( -// "licenceName can not be null, nor empty"); -// } -// licenseName = licenseName.trim().toLowerCase(); -// LicenseDefinition definition = null; -// for (LicenseDefinition d : definitions) { -// if (licenseName.equals(d.getName())) { -// definition = d; -// break; -// } -// } -// if (definition == null && next != null) { -// definition = next.getDefinition(licenseName); -// } -// return definition; -// } -// -// @Deprecated -// protected LicenseRepository getLastRepository() { -// LicenseRepository last = next == null ? this : next.getLastRepository(); -// return last; -// } -// -// @Deprecated -// protected LicenseRepository[] getAllRepositories() { -// List<LicenseRepository> list = new ArrayList<LicenseRepository>(); -// LicenseRepository repo = this; -// while (repo != null) { -// list.add(repo); -// repo = repo.next; -// } -// return list.toArray(new LicenseRepository[list.size()]); -// } -// -// @Deprecated -// protected void checkNotInit() throws IllegalStateException { -// if (init) { -// throw new IllegalStateException( -// "license repository " + this + -// " was already initialize..."); -// } -// } -// -// @Deprecated -// protected void checkInit() throws IllegalStateException { -// if (!init) { -// throw new IllegalStateException( -// "repository " + this + " is not init, use the load " + -// "method before any license request"); -// } -// } -} Deleted: trunk/src/main/java/org/nuiton/license/plugin/repository/LicenseRepositoryFactory.java =================================================================== --- trunk/src/main/java/org/nuiton/license/plugin/repository/LicenseRepositoryFactory.java 2010-04-06 16:21:34 UTC (rev 1709) +++ trunk/src/main/java/org/nuiton/license/plugin/repository/LicenseRepositoryFactory.java 2010-04-06 16:43:34 UTC (rev 1710) @@ -1,137 +0,0 @@ -/* - * *##% - * Maven License Plugin - * Copyright (C) 2008 - 2010 CodeLutin - * - * 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>. - * ##%* - */ -package org.nuiton.license.plugin.repository; - -import org.apache.commons.logging.Log; -import org.apache.commons.logging.LogFactory; - -import java.io.IOException; -import java.net.URL; -import java.util.ArrayList; -import java.util.List; - -/** - * @author chemit - * @since 1.0.3 - * @deprecated since 2.1, prefer use now a {@link LicenseStore}. - */ -@Deprecated -public class LicenseRepositoryFactory { - -// /** class-path directory where is the licenses repository */ -// public static final String JAR_LICENSE_REPOSITORY = "/META-INF/licenses"; -// -// /** to use log facility, just put in your code: log.info(\"...\"); */ -// static private final Log log = LogFactory.getLog(LicenseRepositoryFactory.class); - -// /** -// * Obtain a new repository. -// * -// * @param useJarRepository flag to use at first a jar repository -// * @param load flag to load the repository -// * @param extraResolvers extra baseURLs to defined extra license resolver -// * @return the instanciate and ready to use license repository -// * @throws IOException if any problem while acquiring license repository -// * @deprecated since 2.1, prefer use the {@link LicenseStore} api. -// */ -// @Deprecated -// public static LicenseRepository newLicenseRepository( -// boolean useJarRepository, -// boolean load, -// String... extraResolvers) throws IOException { -// -// List<URL> baseURLs = new ArrayList<URL>(); -// if (extraResolvers != null) { -// for (String exUrl : extraResolvers) { -// if (exUrl == null) { -// // skpi null url -// continue; -// } -// URL url; -// try { -// url = new URL(exUrl); -// } catch (Exception e) { -// if (log.isDebugEnabled()) { -// log.warn("could not convert url [" + exUrl + -// "], for reason " + e.getMessage()); -// } else { -// log.warn("could not convert url [" + exUrl + -// "], for reason " + e.getMessage()); -// } -// log.warn("will skip the url [" + exUrl + "]"); -// continue; -// } -// baseURLs.add(url); -// } -// } -// if (!useJarRepository && baseURLs.isEmpty()) { -// log.warn("no repository to create!"); -// // no repository to create -// return null; -// } -// -// LicenseRepository result = null; -// LicenseRepository current = null; -// if (useJarRepository) { -// current = result = newJarLicenseRepository(false); -// } -// -// for (URL baseURL : baseURLs) { -// if (baseURL != null && !baseURL.toString().trim().isEmpty()) { -// LicenseRepository r = new LicenseRepository(); -// r.setBaseURL(baseURL); -// if (current == null) { -// // no previous repository to chain -// result = r; -// -// } else { -// // chain to previous repository -// current.appendRepository(r); -// } -// // new repository to chain -// current = r; -// } -// } -// if (load) { -// result.load(); -// } -// return result; -// } - -// /** -// * @param load {@code true} if repository should be loaded -// * @return the license repository coming for class-path -// * @throws IOException if any pb while loading repository (if asked) -// * @deprecated since 2.1, prefer use the {@link LicenseStore} api. -// */ -// @Deprecated -// public static LicenseRepository newJarLicenseRepository(boolean load) throws IOException { -// LicenseRepository result = new LicenseRepository(); -// // the first repository is always a jar repository -// URL baseURL = LicenseRepositoryFactory.class.getResource( -// JAR_LICENSE_REPOSITORY); -// result.setBaseURL(baseURL); -// if (load) { -// result.load(); -// } -// return result; -// } -} Deleted: trunk/src/main/java/org/nuiton/license/plugin/repository/LicenseStore.java =================================================================== --- trunk/src/main/java/org/nuiton/license/plugin/repository/LicenseStore.java 2010-04-06 16:21:34 UTC (rev 1709) +++ trunk/src/main/java/org/nuiton/license/plugin/repository/LicenseStore.java 2010-04-06 16:43:34 UTC (rev 1710) @@ -1,136 +0,0 @@ -package org.nuiton.license.plugin.repository; - -import org.apache.commons.logging.Log; -import org.apache.commons.logging.LogFactory; - -import java.io.IOException; -import java.net.URL; -import java.util.ArrayList; -import java.util.Iterator; -import java.util.List; - -/** - * The {@code LicenseStore} offers {@link License} coming from different {@link - * LicenseRepository}. - * - * @author tchemit <chemit(a)codelutin.com> - * @since 2.1 - */ -public class LicenseStore implements Iterable<LicenseRepository> { - - /** Logger */ - private static final Log log = LogFactory.getLog(LicenseStore.class); - - /** class-path directory where is the licenses repository */ - public static final String JAR_LICENSE_REPOSITORY = "/META-INF/licenses"; - - /** list of available license repositories */ - protected List<LicenseRepository> repositories; - - /** flag to know if store was init */ - protected boolean init; - - public void init() throws IOException { - checkNotInit("init"); - try { - if (repositories == null) { - // adding the default class-path repository - addJarRepository(); - } - for (LicenseRepository r : this) { - r.load(); - } - } finally { - init = true; - } - } - - public List<LicenseRepository> getRepositories() { - return repositories; - } - - public License[] getLicenses() { - checkInit("getLicenses"); - List<License> result = new ArrayList<License>(); - if (repositories != null) { - for (LicenseRepository repository : this) { - for (License license : repository) { - result.add(license); - } - } - } - return result.toArray(new License[result.size()]); - } - - public License getLicense(String licenseName) { - checkInit("getLicense"); - Iterator<LicenseRepository> itr = iterator(); - License result = null; - while (itr.hasNext()) { - LicenseRepository licenseRepository = itr.next(); - License license = licenseRepository.getLicense(licenseName); - if (license != null) { - result = license; - break; - } - } - if (result == null && log.isDebugEnabled()) { - log.debug("could not find license named '" + licenseName + "'"); - } - return result; - } - - public void addRepository(String extraResolver) throws IOException { - addRepository(new URL(extraResolver)); - } - - public void addRepository(URL baseURL) throws IOException { - checkNotInit("addRepository"); - LicenseRepository repository = new LicenseRepository(); - repository.setBaseURL(baseURL); - if (log.isDebugEnabled()) { - log.debug("Adding a license repository " + repository); - } - addRepository(repository); - } - - public void addJarRepository() throws IOException { - checkNotInit("addJarRepository"); - URL baseURL = getClass().getResource(JAR_LICENSE_REPOSITORY); - LicenseRepository repository = new LicenseRepository(); - repository.setBaseURL(baseURL); - if (log.isDebugEnabled()) { - log.debug("Adding a jar license repository " + repository); - } - addRepository(repository); - } - - @Override - public Iterator<LicenseRepository> iterator() { - return getRepositories().iterator(); - } - - protected void addRepository(LicenseRepository repository) { - checkNotInit("addRepository"); - if (repositories == null) { - repositories = new ArrayList<LicenseRepository>(); - - } - if (log.isInfoEnabled()) { - log.info("Adding a license repository " + repository); - } - repositories.add(repository); - } - - protected void checkInit(String operation) throws IllegalStateException { - if (!init) { - throw new IllegalStateException("store was not init, operation [" + operation + "] not possible."); - } - } - - protected void checkNotInit(String operation) throws IllegalStateException { - if (init) { - throw new IllegalStateException("store was init, operation [" + operation + "+] not possible."); - } - } -} Copied: trunk/src/main/resources/META-INF/licenses/agpl_v3/header.txt (from rev 1709, trunk/src/main/resources/license/agpl_v3/header.txt) =================================================================== --- trunk/src/main/resources/META-INF/licenses/agpl_v3/header.txt (rev 0) +++ trunk/src/main/resources/META-INF/licenses/agpl_v3/header.txt 2010-04-06 16:43:34 UTC (rev 1710) @@ -0,0 +1,12 @@ +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU Affero 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 Public License for more details. + +You should have received a copy of the GNU Affero General Public License +along with this program. If not, see <http://www.gnu.org/licenses/>. \ No newline at end of file Copied: trunk/src/main/resources/META-INF/licenses/agpl_v3/license.txt (from rev 1709, trunk/src/main/resources/license/agpl_v3/license.txt) =================================================================== --- trunk/src/main/resources/META-INF/licenses/agpl_v3/license.txt (rev 0) +++ trunk/src/main/resources/META-INF/licenses/agpl_v3/license.txt 2010-04-06 16:43:34 UTC (rev 1710) @@ -0,0 +1,661 @@ + GNU AFFERO GENERAL PUBLIC LICENSE + Version 3, 19 November 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/> + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU Affero General Public License is a free, copyleft license for +software and other kinds of works, specifically designed to ensure +cooperation with the community in the case of network server software. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +our General Public Licenses are intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + Developers that use our General Public Licenses protect your rights +with two steps: (1) assert copyright on the software, and (2) offer +you this License which gives you legal permission to copy, distribute +and/or modify the software. + + A secondary benefit of defending all users' freedom is that +improvements made in alternate versions of the program, if they +receive widespread use, become available for other developers to +incorporate. Many developers of free software are heartened and +encouraged by the resulting cooperation. However, in the case of +software used on network servers, this result may fail to come about. +The GNU General Public License permits making a modified version and +letting the public access it on a server without ever releasing its +source code to the public. + + The GNU Affero General Public License is designed specifically to +ensure that, in such cases, the modified source code becomes available +to the community. It requires the operator of a network server to +provide the source code of the modified version running there to the +users of that server. Therefore, public use of a modified version, on +a publicly accessible server, gives the public access to the source +code of the modified version. + + An older license, called the Affero General Public License and +published by Affero, was designed to accomplish similar goals. This is +a different license, not a version of the Affero GPL, but Affero has +released a new version of the Affero GPL which permits relicensing under +this license. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU Affero General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Remote Network Interaction; Use with the GNU General Public License. + + Notwithstanding any other provision of this License, if you modify the +Program, your modified version must prominently offer all users +interacting with it remotely through a computer network (if your version +supports such interaction) an opportunity to receive the Corresponding +Source of your version by providing access to the Corresponding Source +from a network server at no charge, through some standard or customary +means of facilitating copying of software. This Corresponding Source +shall include the Corresponding Source for any work covered by version 3 +of the GNU General Public License that is incorporated pursuant to the +following paragraph. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the work with which it is combined will remain governed by version +3 of the GNU General Public License. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU Affero General Public License from time to time. Such new versions +will be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU Affero General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU Affero General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU Affero General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + <one line to give the program's name and a brief idea of what it does.> + Copyright (C) <year> <name of author> + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU Affero 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 Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see <http://www.gnu.org/licenses/>. + +Also add information on how to contact you by electronic and paper mail. + + If your software can interact with users remotely through a computer +network, you should also make sure that it provides a way for users to +get its source. For example, if your program is a web application, its +interface could display a "Source" link that leads users to an archive +of the code. There are many ways you could offer source, and different +solutions will be better for different programs; see section 13 for the +specific requirements. + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU AGPL, see +<http://www.gnu.org/licenses/>. \ No newline at end of file Copied: trunk/src/main/resources/META-INF/licenses/fdl_v1_3/header.txt (from rev 1709, trunk/src/main/resources/license/fdl_v1_3/header.txt) =================================================================== --- trunk/src/main/resources/META-INF/licenses/fdl_v1_3/header.txt (rev 0) +++ trunk/src/main/resources/META-INF/licenses/fdl_v1_3/header.txt 2010-04-06 16:43:34 UTC (rev 1710) @@ -0,0 +1,12 @@ +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU Free Documentation License as published by +the Free Software Foundation, either version 1.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 Public License for more details. + +You should have received a copy of the GNU Free Documentation License +along with this program. If not, see <http://www.gnu.org/licenses/>. \ No newline at end of file Copied: trunk/src/main/resources/META-INF/licenses/fdl_v1_3/license.txt (from rev 1709, trunk/src/main/resources/license/fdl_v1_3/license.txt) =================================================================== --- trunk/src/main/resources/META-INF/licenses/fdl_v1_3/license.txt (rev 0) +++ trunk/src/main/resources/META-INF/licenses/fdl_v1_3/license.txt 2010-04-06 16:43:34 UTC (rev 1710) @@ -0,0 +1,451 @@ + + GNU Free Documentation License + Version 1.3, 3 November 2008 + + + Copyright (C) 2000, 2001, 2002, 2007, 2008 Free Software Foundation, Inc. + <http://fsf.org/> + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + +0. PREAMBLE + +The purpose of this License is to make a manual, textbook, or other +functional and useful document "free" in the sense of freedom: to +assure everyone the effective freedom to copy and redistribute it, +with or without modifying it, either commercially or noncommercially. +Secondarily, this License preserves for the author and publisher a way +to get credit for their work, while not being considered responsible +for modifications made by others. + +This License is a kind of "copyleft", which means that derivative +works of the document must themselves be free in the same sense. It +complements the GNU General Public License, which is a copyleft +license designed for free software. + +We have designed this License in order to use it for manuals for free +software, because free software needs free documentation: a free +program should come with manuals providing the same freedoms that the +software does. But this License is not limited to software manuals; +it can be used for any textual work, regardless of subject matter or +whether it is published as a printed book. We recommend this License +principally for works whose purpose is instruction or reference. + + +1. APPLICABILITY AND DEFINITIONS + +This License applies to any manual or other work, in any medium, that +contains a notice placed by the copyright holder saying it can be +distributed under the terms of this License. Such a notice grants a +world-wide, royalty-free license, unlimited in duration, to use that +work under the conditions stated herein. The "Document", below, +refers to any such manual or work. Any member of the public is a +licensee, and is addressed as "you". You accept the license if you +copy, modify or distribute the work in a way requiring permission +under copyright law. + +A "Modified Version" of the Document means any work containing the +Document or a portion of it, either copied verbatim, or with +modifications and/or translated into another language. + +A "Secondary Section" is a named appendix or a front-matter section of +the Document that deals exclusively with the relationship of the +publishers or authors of the Document to the Document's overall +subject (or to related matters) and contains nothing that could fall +directly within that overall subject. (Thus, if the Document is in +part a textbook of mathematics, a Secondary Section may not explain +any mathematics.) The relationship could be a matter of historical +connection with the subject or with related matters, or of legal, +commercial, philosophical, ethical or political position regarding +them. + +The "Invariant Sections" are certain Secondary Sections whose titles +are designated, as being those of Invariant Sections, in the notice +that says that the Document is released under this License. If a +section does not fit the above definition of Secondary then it is not +allowed to be designated as Invariant. The Document may contain zero +Invariant Sections. If the Document does not identify any Invariant +Sections then there are none. + +The "Cover Texts" are certain short passages of text that are listed, +as Front-Cover Texts or Back-Cover Texts, in the notice that says that +the Document is released under this License. A Front-Cover Text may +be at most 5 words, and a Back-Cover Text may be at most 25 words. + +A "Transparent" copy of the Document means a machine-readable copy, +represented in a format whose specification is available to the +general public, that is suitable for revising the document +straightforwardly with generic text editors or (for images composed of +pixels) generic paint programs or (for drawings) some widely available +drawing editor, and that is suitable for input to text formatters or +for automatic translation to a variety of formats suitable for input +to text formatters. A copy made in an otherwise Transparent file +format whose markup, or absence of markup, has been arranged to thwart +or discourage subsequent modification by readers is not Transparent. +An image format is not Transparent if used for any substantial amount +of text. A copy that is not "Transparent" is called "Opaque". + +Examples of suitable formats for Transparent copies include plain +ASCII without markup, Texinfo input format, LaTeX input format, SGML +or XML using a publicly available DTD, and standard-conforming simple +HTML, PostScript or PDF designed for human modification. Examples of +transparent image formats include PNG, XCF and JPG. Opaque formats +include proprietary formats that can be read and edited only by +proprietary word processors, SGML or XML for which the DTD and/or +processing tools are not generally available, and the +machine-generated HTML, PostScript or PDF produced by some word +processors for output purposes only. + +The "Title Page" means, for a printed book, the title page itself, +plus such following pages as are needed to hold, legibly, the material +this License requires to appear in the title page. For works in +formats which do not have any title page as such, "Title Page" means +the text near the most prominent appearance of the work's title, +preceding the beginning of the body of the text. + +The "publisher" means any person or entity that distributes copies of +the Document to the public. + +A section "Entitled XYZ" means a named subunit of the Document whose +title either is precisely XYZ or contains XYZ in parentheses following +text that translates XYZ in another language. (Here XYZ stands for a +specific section name mentioned below, such as "Acknowledgements", +"Dedications", "Endorsements", or "History".) To "Preserve the Title" +of such a section when you modify the Document means that it remains a +section "Entitled XYZ" according to this definition. + +The Document may include Warranty Disclaimers next to the notice which +states that this License applies to the Document. These Warranty +Disclaimers are considered to be included by reference in this +License, but only as regards disclaiming warranties: any other +implication that these Warranty Disclaimers may have is void and has +no effect on the meaning of this License. + +2. VERBATIM COPYING + +You may copy and distribute the Document in any medium, either +commercially or noncommercially, provided that this License, the +copyright notices, and the license notice saying this License applies +to the Document are reproduced in all copies, and that you add no +other conditions whatsoever to those of this License. You may not use +technical measures to obstruct or control the reading or further +copying of the copies you make or distribute. However, you may accept +compensation in exchange for copies. If you distribute a large enough +number of copies you must also follow the conditions in section 3. + +You may also lend copies, under the same conditions stated above, and +you may publicly display copies. + + +3. COPYING IN QUANTITY + +If you publish printed copies (or copies in media that commonly have +printed covers) of the Document, numbering more than 100, and the +Document's license notice requires Cover Texts, you must enclose the +copies in covers that carry, clearly and legibly, all these Cover +Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on +the back cover. Both covers must also clearly and legibly identify +you as the publisher of these copies. The front cover must present +the full title with all words of the title equally prominent and +visible. You may add other material on the covers in addition. +Copying with changes limited to the covers, as long as they preserve +the title of the Document and satisfy these conditions, can be treated +as verbatim copying in other respects. + +If the required texts for either cover are too voluminous to fit +legibly, you should put the first ones listed (as many as fit +reasonably) on the actual cover, and continue the rest onto adjacent +pages. + +If you publish or distribute Opaque copies of the Document numbering +more than 100, you must either include a machine-readable Transparent +copy along with each Opaque copy, or state in or with each Opaque copy +a computer-network location from which the general network-using +public has access to download using public-standard network protocols +a complete Transparent copy of the Document, free of added material. +If you use the latter option, you must take reasonably prudent steps, +when you begin distribution of Opaque copies in quantity, to ensure +that this Transparent copy will remain thus accessible at the stated +location until at least one year after the last time you distribute an +Opaque copy (directly or through your agents or retailers) of that +edition to the public. + +It is requested, but not required, that you contact the authors of the +Document well before redistributing any large number of copies, to +give them a chance to provide you with an updated version of the +Document. + + +4. MODIFICATIONS + +You may copy and distribute a Modified Version of the Document under +the conditions of sections 2 and 3 above, provided that you release +the Modified Version under precisely this License, with the Modified +Version filling the role of the Document, thus licensing distribution +and modification of the Modified Version to whoever possesses a copy +of it. In addition, you must do these things in the Modified Version: + +A. Use in the Title Page (and on the covers, if any) a title distinct + from that of the Document, and from those of previous versions + (which should, if there were any, be listed in the History section + of the Document). You may use the same title as a previous version + if the original publisher of that version gives permission. +B. List on the Title Page, as authors, one or more persons or entities + responsible for authorship of the modifications in the Modified + Version, together with at least five of the principal authors of the + Document (all of its principal authors, if it has fewer than five), + unless they release you from this requirement. +C. State on the Title page the name of the publisher of the + Modified Version, as the publisher. +D. Preserve all the copyright notices of the Document. +E. Add an appropriate copyright notice for your modifications + adjacent to the other copyright notices. +F. Include, immediately after the copyright notices, a license notice + giving the public permission to use the Modified Version under the + terms of this License, in the form shown in the Addendum below. +G. Preserve in that license notice the full lists of Invariant Sections + and required Cover Texts given in the Document's license notice. +H. Include an unaltered copy of this License. +I. Preserve the section Entitled "History", Preserve its Title, and add + to it an item stating at least the title, year, new authors, and + publisher of the Modified Version as given on the Title Page. If + there is no section Entitled "History" in the Document, create one + stating the title, year, authors, and publisher of the Document as + given on its Title Page, then add an item describing the Modified + Version as stated in the previous sentence. +J. Preserve the network location, if any, given in the Document for + public access to a Transparent copy of the Document, and likewise + the network locations given in the Document for previous versions + it was based on. These may be placed in the "History" section. + You may omit a network location for a work that was published at + least four years before the Document itself, or if the original + publisher of the version it refers to gives permission. +K. For any section Entitled "Acknowledgements" or "Dedications", + Preserve the Title of the section, and preserve in the section all + the substance and tone of each of the contributor acknowledgements + and/or dedications given therein. +L. Preserve all the Invariant Sections of the Document, + unaltered in their text and in their titles. Section numbers + or the equivalent are not considered part of the section titles. +M. Delete any section Entitled "Endorsements". Such a section + may not be included in the Modified Version. +N. Do not retitle any existing section to be Entitled "Endorsements" + or to conflict in title with any Invariant Section. +O. Preserve any Warranty Disclaimers. + +If the Modified Version includes new front-matter sections or +appendices that qualify as Secondary Sections and contain no material +copied from the Document, you may at your option designate some or all +of these sections as invariant. To do this, add their titles to the +list of Invariant Sections in the Modified Version's license notice. +These titles must be distinct from any other section titles. + +You may add a section Entitled "Endorsements", provided it contains +nothing but endorsements of your Modified Version by various +parties--for example, statements of peer review or that the text has +been approved by an organization as the authoritative definition of a +standard. + +You may add a passage of up to five words as a Front-Cover Text, and a +passage of up to 25 words as a Back-Cover Text, to the end of the list +of Cover Texts in the Modified Version. Only one passage of +Front-Cover Text and one of Back-Cover Text may be added by (or +through arrangements made by) any one entity. If the Document already +includes a cover text for the same cover, previously added by you or +by arrangement made by the same entity you are acting on behalf of, +you may not add another; but you may replace the old one, on explicit +permission from the previous publisher that added the old one. + +The author(s) and publisher(s) of the Document do not by this License +give permission to use their names for publicity for or to assert or +imply endorsement of any Modified Version. + + +5. COMBINING DOCUMENTS + +You may combine the Document with other documents released under this +License, under the terms defined in section 4 above for modified +versions, provided that you include in the combination all of the +Invariant Sections of all of the original documents, unmodified, and +list them all as Invariant Sections of your combined work in its +license notice, and that you preserve all their Warranty Disclaimers. + +The combined work need only contain one copy of this License, and +multiple identical Invariant Sections may be replaced with a single +copy. If there are multiple Invariant Sections with the same name but +different contents, make the title of each such section unique by +adding at the end of it, in parentheses, the name of the original +author or publisher of that section if known, or else a unique number. +Make the same adjustment to the section titles in the list of +Invariant Sections in the license notice of the combined work. + +In the combination, you must combine any sections Entitled "History" +in the various original documents, forming one section Entitled +"History"; likewise combine any sections Entitled "Acknowledgements", +and any sections Entitled "Dedications". You must delete all sections +Entitled "Endorsements". + + +6. COLLECTIONS OF DOCUMENTS + +You may make a collection consisting of the Document and other +documents released under this License, and replace the individual +copies of this License in the various documents with a single copy +that is included in the collection, provided that you follow the rules +of this License for verbatim copying of each of the documents in all +other respects. + +You may extract a single document from such a collection, and +distribute it individually under this License, provided you insert a +copy of this License into the extracted document, and follow this +License in all other respects regarding verbatim copying of that +document. + + +7. AGGREGATION WITH INDEPENDENT WORKS + +A compilation of the Document or its derivatives with other separate +and independent documents or works, in or on a volume of a storage or +distribution medium, is called an "aggregate" if the copyright +resulting from the compilation is not used to limit the legal rights +of the compilation's users beyond what the individual works permit. +When the Document is included in an aggregate, this License does not +apply to the other works in the aggregate which are not themselves +derivative works of the Document. + +If the Cover Text requirement of section 3 is applicable to these +copies of the Document, then if the Document is less than one half of +the entire aggregate, the Document's Cover Texts may be placed on +covers that bracket the Document within the aggregate, or the +electronic equivalent of covers if the Document is in electronic form. +Otherwise they must appear on printed covers that bracket the whole +aggregate. + + +8. TRANSLATION + +Translation is considered a kind of modification, so you may +distribute translations of the Document under the terms of section 4. +Replacing Invariant Sections with translations requires special +permission from their copyright holders, but you may include +translations of some or all Invariant Sections in addition to the +original versions of these Invariant Sections. You may include a +translation of this License, and all the license notices in the +Document, and any Warranty Disclaimers, provided that you also include +the original English version of this License and the original versions +of those notices and disclaimers. In case of a disagreement between +the translation and the original version of this License or a notice +or disclaimer, the original version will prevail. + +If a section in the Document is Entitled "Acknowledgements", +"Dedications", or "History", the requirement (section 4) to Preserve +its Title (section 1) will typically require changing the actual +title. + + +9. TERMINATION + +You may not copy, modify, sublicense, or distribute the Document +except as expressly provided under this License. Any attempt +otherwise to copy, modify, sublicense, or distribute it is void, and +will automatically terminate your rights under this License. + +However, if you cease all violation of this License, then your license +from a particular copyright holder is reinstated (a) provisionally, +unless and until the copyright holder explicitly and finally +terminates your license, and (b) permanently, if the copyright holder +fails to notify you of the violation by some reasonable means prior to +60 days after the cessation. + +Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + +Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, receipt of a copy of some or all of the same material does +not give you any rights to use it. + + +10. FUTURE REVISIONS OF THIS LICENSE + +The Free Software Foundation may publish new, revised versions of the +GNU Free Documentation License from time to time. Such new versions +will be similar in spirit to the present version, but may differ in +detail to address new problems or concerns. See +http://www.gnu.org/copyleft/. + +Each version of the License is given a distinguishing version number. +If the Document specifies that a particular numbered version of this +License "or any later version" applies to it, you have the option of +following the terms and conditions either of that specified version or +of any later version that has been published (not as a draft) by the +Free Software Foundation. If the Document does not specify a version +number of this License, you may choose any version ever published (not +as a draft) by the Free Software Foundation. If the Document +specifies that a proxy can decide which future versions of this +License can be used, that proxy's public statement of acceptance of a +version permanently authorizes you to choose that version for the +Document. + +11. RELICENSING + +"Massive Multiauthor Collaboration Site" (or "MMC Site") means any +World Wide Web server that publishes copyrightable works and also +provides prominent facilities for anybody to edit those works. A +public wiki that anybody can edit is an example of such a server. A +"Massive Multiauthor Collaboration" (or "MMC") contained in the site +means any set of copyrightable works thus published on the MMC site. + +"CC-BY-SA" means the Creative Commons Attribution-Share Alike 3.0 +license published by Creative Commons Corporation, a not-for-profit +corporation with a principal place of business in San Francisco, +California, as well as future copyleft versions of that license +published by that same organization. + +"Incorporate" means to publish or republish a Document, in whole or in +part, as part of another Document. + +An MMC is "eligible for relicensing" if it is licensed under this +License, and if all works that were first published under this License +somewhere other than this MMC, and subsequently incorporated in whole or +in part into the MMC, (1) had no cover texts or invariant sections, and +(2) were thus incorporated prior to November 1, 2008. + +The operator of an MMC Site may republish an MMC contained in the site +under CC-BY-SA on the same site at any time before August 1, 2009, +provided the MMC is eligible for relicensing. + + +ADDENDUM: How to use this License for your documents + +To use this License in a document you have written, include a copy of +the License in the document and put the following copyright and +license notices just after the title page: + + Copyright (c) YEAR YOUR NAME. + Permission is granted to copy, distribute and/or modify this document + under the terms of the GNU Free Documentation License, Version 1.3 + or any later version published by the Free Software Foundation; + with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. + A copy of the license is included in the section entitled "GNU + Free Documentation License". + +If you have Invariant Sections, Front-Cover Texts and Back-Cover Texts, +replace the "with...Texts." line with this: + + with the Invariant Sections being LIST THEIR TITLES, with the + Front-Cover Texts being LIST, and with the Back-Cover Texts being LIST. + +If you have Invariant Sections without Cover Texts, or some other +combination of the three, merge those two alternatives to suit the +situation. + +If your document contains nontrivial examples of program code, we +recommend releasing these examples in parallel under your choice of +free software license, such as the GNU General Public License, +to permit their use in free software. \ No newline at end of file Modified: trunk/src/main/resources/META-INF/licenses/licenses.properties =================================================================== --- trunk/src/main/resources/META-INF/licenses/licenses.properties 2010-04-06 16:21:34 UTC (rev 1709) +++ trunk/src/main/resources/META-INF/licenses/licenses.properties 2010-04-06 16:43:34 UTC (rev 1710) @@ -1,7 +1,7 @@ -fdl_v1_3=Free Documentation License Version 1.3 agpl_v3=GNU Affero General Public License version 3.0 apache_v2=License Apache version 3.0 cddl_v1=COMMON DEVELOPMENT AND DISTRIBUTION LICENSE (CDDL) Version 1.0 +fdl_v1_3=Free Documentation License Version 1.3 gpl_v1=License gpl version 1.0 gpl_v2=License gpl version 2.0 gpl_v3=License gpl version 3.0 Copied: trunk/src/test/java/org/nuiton/license/plugin/model/LicenseRepositoryTest.java (from rev 1709, trunk/src/test/java/org/nuiton/license/plugin/repository/LicenseRepositoryTest.java) =================================================================== --- trunk/src/test/java/org/nuiton/license/plugin/model/LicenseRepositoryTest.java (rev 0) +++ trunk/src/test/java/org/nuiton/license/plugin/model/LicenseRepositoryTest.java 2010-04-06 16:43:34 UTC (rev 1710) @@ -0,0 +1,45 @@ +package org.nuiton.license.plugin.model; + +import org.junit.Assert; +import org.junit.Before; +import org.junit.Test; + +import java.io.IOException; +import java.net.URL; + +/** + * Tests {@link LicenseRepository}. + * + * @author tchemit <chemit(a)codelutin.com> + * @since 2.1 + */ +public class LicenseRepositoryTest { + + protected LicenseRepository repository; + + @Before + public void setUp() { + repository = null; + } + + @Test + public void testJarRepository() throws IOException { + + repository = new LicenseRepository(); + URL baseURL = getClass().getResource( + LicenseStore.JAR_LICENSE_REPOSITORY + ); + repository.setBaseURL(baseURL); + repository.load(); + + License[] licenses = repository.getLicenses(); + Assert.assertNotNull(licenses); + Assert.assertEquals(LicenseStoreTest.DEFAULT_LICENSES.size(), + licenses.length); + + for (String licenseName : LicenseStoreTest.DEFAULT_LICENSES) { + License license = repository.getLicense(licenseName); + Assert.assertNotNull(license); + } + } +} Property changes on: trunk/src/test/java/org/nuiton/license/plugin/model/LicenseRepositoryTest.java ___________________________________________________________________ Added: svn:keywords + "Author Date Id Revision HeadURL Copied: trunk/src/test/java/org/nuiton/license/plugin/model/LicenseStoreTest.java (from rev 1709, trunk/src/test/java/org/nuiton/license/plugin/repository/LicenseStoreTest.java) =================================================================== --- trunk/src/test/java/org/nuiton/license/plugin/model/LicenseStoreTest.java (rev 0) +++ trunk/src/test/java/org/nuiton/license/plugin/model/LicenseStoreTest.java 2010-04-06 16:43:34 UTC (rev 1710) @@ -0,0 +1,65 @@ +package org.nuiton.license.plugin.model; + +import org.junit.Assert; +import org.junit.Before; +import org.junit.Test; + +import java.io.IOException; +import java.util.Arrays; +import java.util.List; + +/** + * Tests {@link LicenseStore}. + * + * @author tchemit <chemit(a)codelutin.com> + * @since 2.1 + */ +public class LicenseStoreTest { + + public static final List<String> DEFAULT_LICENSES = Arrays.asList( + "agpl_v3", + "apache_v2", + "cddl_v1", + "fdl_v1_3", + "gpl_v1", + "gpl_v2", + "gpl_v3", + "lgpl_v2_1", + "lgpl_v3", + "mit" + ); + + protected LicenseStore store; + + @Before + public void setUp() { + store = null; + } + + @Test + public void testJarRepository() throws IOException { + + store = new LicenseStore(); + store.init(); + + List<LicenseRepository> repositories = store.getRepositories(); + Assert.assertNotNull(repositories); + Assert.assertEquals(1, repositories.size()); + LicenseRepository repository = repositories.get(0); + + License[] licenses1 = repository.getLicenses(); + License[] licenses = store.getLicenses(); + Assert.assertNotNull(licenses); + Assert.assertNotNull(licenses1); + Assert.assertEquals(DEFAULT_LICENSES.size(), licenses.length); + Assert.assertEquals(DEFAULT_LICENSES.size(), licenses1.length); + + for (String licenseName : DEFAULT_LICENSES) { + License license = repository.getLicense(licenseName); + License license1 = store.getLicense(licenseName); + Assert.assertNotNull(license); + Assert.assertNotNull(license1); + Assert.assertEquals(license, license1); + } + } +} Property changes on: trunk/src/test/java/org/nuiton/license/plugin/model/LicenseStoreTest.java ___________________________________________________________________ Added: svn:keywords + "Author Date Id Revision HeadURL

1 0