├── .github ├── FUNDING.yaml └── workflows │ └── maven.yml ├── .gitignore ├── .mvn ├── extensions.xml ├── maven.config └── wrapper │ ├── MavenWrapperDownloader.java │ └── maven-wrapper.properties ├── .travis.yml ├── LICENSE ├── README.md ├── mvnw ├── mvnw.cmd ├── pom.xml ├── renovate.json └── src ├── main ├── java │ └── com │ │ └── akathist │ │ └── maven │ │ └── plugins │ │ └── launch4j │ │ ├── ClassPath.java │ │ ├── Jre.java │ │ ├── Launch4jMojo.java │ │ ├── MavenLog.java │ │ ├── Messages.java │ │ ├── SingleInstance.java │ │ ├── Splash.java │ │ ├── VersionInfo.java │ │ ├── generators │ │ ├── CopyrightGenerator.java │ │ └── Launch4jFileVersionGenerator.java │ │ └── tools │ │ └── ResourceIO.java ├── legal │ ├── LICENSE.txt │ ├── XStream.LICENSE.txt │ └── commons.LICENSE.txt └── resources │ ├── META-INF │ └── resources │ │ └── manifest-require_admin_rights-v1.xml │ ├── MOJO.md │ ├── README.adoc │ ├── TODO │ └── VERSIONINFO.md ├── site └── site.xml └── test ├── java └── com │ └── akathist │ └── maven │ └── plugins │ └── launch4j │ ├── Launch4jMojoTest.java │ ├── VersionInfoTest.java │ └── generators │ ├── CopyrightGeneratorTest.java │ └── Launch4jFileVersionGeneratorTest.java └── resources └── unit └── launch4j-config └── launch4j-full-plugin-config.xml /.github/FUNDING.yaml: -------------------------------------------------------------------------------- 1 | # These are supported funding model platforms 2 | 3 | github: [lukaszlenart] # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2] 4 | patreon: # Replace with a single Patreon username 5 | open_collective: # Replace with a single Open Collective username 6 | ko_fi: # Replace with a single Ko-fi username 7 | tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel 8 | community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry 9 | liberapay: # Replace with a single Liberapay username 10 | issuehunt: # Replace with a single IssueHunt username 11 | otechie: # Replace with a single Otechie username 12 | lfx_crowdfunding: # Replace with a single LFX Crowdfunding project-name e.g., cloud-foundry 13 | custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2'] 14 | -------------------------------------------------------------------------------- /.github/workflows/maven.yml: -------------------------------------------------------------------------------- 1 | # Licensed to the Apache Software Foundation (ASF) under one or more 2 | # contributor license agreements. See the NOTICE file distributed with 3 | # this work for additional information regarding copyright ownership. 4 | # The ASF licenses this file to You under the Apache License, Version 2.0 5 | # (the "License"); you may not use this file except in compliance with 6 | # the License. You may obtain a copy of the License at 7 | # 8 | # http://www.apache.org/licenses/LICENSE-2.0 9 | # 10 | # Unless required by applicable law or agreed to in writing, software 11 | # distributed under the License is distributed on an "AS IS" BASIS, 12 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | # See the License for the specific language governing permissions and 14 | # limitations under the License. 15 | 16 | name: Java CI 17 | 18 | on: 19 | pull_request: 20 | push: 21 | branches: 22 | - main 23 | workflow_dispatch: 24 | 25 | # Sets permissions of the GITHUB_TOKEN to allow to apply a label and merge 26 | # https://docs.github.com/en/code-security/dependabot/working-with-dependabot/automating-dependabot-with-github-actions 27 | permissions: 28 | contents: write 29 | issues: write 30 | pull-requests: write 31 | repository-projects: write 32 | 33 | concurrency: ci-${{ github.ref }} 34 | 35 | jobs: 36 | build: 37 | runs-on: ubuntu-latest 38 | strategy: 39 | matrix: 40 | java: [ 8, 11, 17 ] 41 | steps: 42 | - name: Checkout code 43 | uses: actions/checkout@v4.2.2 44 | - name: Set up cache 45 | uses: actions/cache@v4.2.3 46 | with: 47 | path: ~/.m2/repository 48 | key: ${{ runner.os }}-maven-${{ hashFiles('**/pom.xml') }} 49 | restore-keys: | 50 | ${{ runner.os }}-maven- 51 | - name: Set up JDK ${{ matrix.java }} 52 | uses: actions/setup-java@v4 53 | with: 54 | distribution: adopt 55 | java-version: ${{ matrix.java }} 56 | - name: Build with Maven on Java ${{ matrix.java }} 57 | run: mvn -V test -Ddoclint=all --file pom.xml --no-transfer-progress 58 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | *.ipr 2 | *.iml 3 | *.iws 4 | target/* 5 | .settings/* 6 | .project 7 | .classpath 8 | .factorypath 9 | /target 10 | .idea 11 | .java-version 12 | .mvn/wrapper/maven-wrapper.jar 13 | -------------------------------------------------------------------------------- /.mvn/extensions.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | fr.jcgay.maven 5 | maven-profiler 6 | 3.2 7 | 8 | 9 | -------------------------------------------------------------------------------- /.mvn/maven.config: -------------------------------------------------------------------------------- 1 | -Daether.checksums.algorithms=SHA-512,SHA-256,SHA-1,MD5 2 | -Daether.connector.smartChecksums=false 3 | -------------------------------------------------------------------------------- /.mvn/wrapper/MavenWrapperDownloader.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Licensed to the Apache Software Foundation (ASF) under one 3 | * or more contributor license agreements. See the NOTICE file 4 | * distributed with this work for additional information 5 | * regarding copyright ownership. The ASF licenses this file 6 | * to you under the Apache License, Version 2.0 (the 7 | * "License"); you may not use this file except in compliance 8 | * with the License. You may obtain a copy of the License at 9 | * 10 | * https://www.apache.org/licenses/LICENSE-2.0 11 | * 12 | * Unless required by applicable law or agreed to in writing, 13 | * software distributed under the License is distributed on an 14 | * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 15 | * KIND, either express or implied. See the License for the 16 | * specific language governing permissions and limitations 17 | * under the License. 18 | */ 19 | 20 | import java.io.IOException; 21 | import java.io.InputStream; 22 | import java.net.Authenticator; 23 | import java.net.PasswordAuthentication; 24 | import java.net.URI; 25 | import java.net.URL; 26 | import java.nio.file.Files; 27 | import java.nio.file.Path; 28 | import java.nio.file.Paths; 29 | import java.nio.file.StandardCopyOption; 30 | import java.util.concurrent.ThreadLocalRandom; 31 | 32 | public final class MavenWrapperDownloader { 33 | private static final String WRAPPER_VERSION = "3.3.2"; 34 | 35 | private static final boolean VERBOSE = Boolean.parseBoolean(System.getenv("MVNW_VERBOSE")); 36 | 37 | public static void main(String[] args) { 38 | log("Apache Maven Wrapper Downloader " + WRAPPER_VERSION); 39 | 40 | if (args.length != 2) { 41 | System.err.println(" - ERROR wrapperUrl or wrapperJarPath parameter missing"); 42 | System.exit(1); 43 | } 44 | 45 | try { 46 | log(" - Downloader started"); 47 | final URL wrapperUrl = URI.create(args[0]).toURL(); 48 | final String jarPath = args[1].replace("..", ""); // Sanitize path 49 | final Path wrapperJarPath = Paths.get(jarPath).toAbsolutePath().normalize(); 50 | downloadFileFromURL(wrapperUrl, wrapperJarPath); 51 | log("Done"); 52 | } catch (IOException e) { 53 | System.err.println("- Error downloading: " + e.getMessage()); 54 | if (VERBOSE) { 55 | e.printStackTrace(); 56 | } 57 | System.exit(1); 58 | } 59 | } 60 | 61 | private static void downloadFileFromURL(URL wrapperUrl, Path wrapperJarPath) 62 | throws IOException { 63 | log(" - Downloading to: " + wrapperJarPath); 64 | if (System.getenv("MVNW_USERNAME") != null && System.getenv("MVNW_PASSWORD") != null) { 65 | final String username = System.getenv("MVNW_USERNAME"); 66 | final char[] password = System.getenv("MVNW_PASSWORD").toCharArray(); 67 | Authenticator.setDefault(new Authenticator() { 68 | @Override 69 | protected PasswordAuthentication getPasswordAuthentication() { 70 | return new PasswordAuthentication(username, password); 71 | } 72 | }); 73 | } 74 | Path temp = wrapperJarPath 75 | .getParent() 76 | .resolve(wrapperJarPath.getFileName() + "." 77 | + Long.toUnsignedString(ThreadLocalRandom.current().nextLong()) + ".tmp"); 78 | try (InputStream inStream = wrapperUrl.openStream()) { 79 | Files.copy(inStream, temp, StandardCopyOption.REPLACE_EXISTING); 80 | Files.move(temp, wrapperJarPath, StandardCopyOption.REPLACE_EXISTING); 81 | } finally { 82 | Files.deleteIfExists(temp); 83 | } 84 | log(" - Downloader complete"); 85 | } 86 | 87 | private static void log(String msg) { 88 | if (VERBOSE) { 89 | System.out.println(msg); 90 | } 91 | } 92 | 93 | } 94 | -------------------------------------------------------------------------------- /.mvn/wrapper/maven-wrapper.properties: -------------------------------------------------------------------------------- 1 | # Licensed to the Apache Software Foundation (ASF) under one 2 | # or more contributor license agreements. See the NOTICE file 3 | # distributed with this work for additional information 4 | # regarding copyright ownership. The ASF licenses this file 5 | # to you under the Apache License, Version 2.0 (the 6 | # "License"); you may not use this file except in compliance 7 | # with the License. You may obtain a copy of the License at 8 | # 9 | # https://www.apache.org/licenses/LICENSE-2.0 10 | # 11 | # Unless required by applicable law or agreed to in writing, 12 | # software distributed under the License is distributed on an 13 | # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 14 | # KIND, either express or implied. See the License for the 15 | # specific language governing permissions and limitations 16 | # under the License. 17 | wrapperVersion=3.3.2 18 | distributionType=source 19 | distributionUrl=https://repo.maven.apache.org/maven2/org/apache/maven/apache-maven/3.9.9/apache-maven-3.9.9-bin.zip 20 | wrapperUrl=https://repo.maven.apache.org/maven2/org/apache/maven/wrapper/maven-wrapper/3.3.2/maven-wrapper-3.3.2.jar 21 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | language: java 2 | sudo: false 3 | 4 | cache: 5 | directories: 6 | - $HOME/.m2 7 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Maven Launch4j Plugin 1.0 2 | A plugin for using Launch4j in Maven projects. 3 | 4 | Copyright (c) 2006 Paul Jungwirth 5 | Copyright (c) 2011-2025 Lukasz Lenart 6 | 7 | This program is free software; you can redistribute it and/or modify 8 | it under the terms of the GNU General Public License as published by 9 | the Free Software Foundation; either version 3 of the License, or 10 | (at your option) any later version. 11 | 12 | This program is distributed in the hope that it will be useful, 13 | but WITHOUT ANY WARRANTY; without even the implied warranty of 14 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15 | GNU General Public License for more details. 16 | 17 | You should have received a copy of the GNU General Public License 18 | along with this program; if not, write to the Free Software 19 | Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA 20 | 21 | A complete copy of this license may be found in src/main/legal/LICENSE.txt of the source distribution. 22 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Launch4j Maven Plugin 2 | 3 | Originally hosted at http://9stmaryrd.com/tools/launch4j-maven-plugin/ 4 | 5 | [![GH Actions](https://github.com/lukaszlenart/launch4j-maven-plugin/actions/workflows/maven.yml/badge.svg)](https://github.com/lukaszlenart/launch4j-maven-plugin/actions/workflows/maven.yml) 6 | [![Maven Central](https://maven-badges.herokuapp.com/maven-central/com.akathist.maven.plugins.launch4j/launch4j-maven-plugin/badge.svg)](https://maven-badges.herokuapp.com/maven-central/com.akathist.maven.plugins.launch4j/launch4j-maven-plugin/) 7 | 8 | - [Documentation](#documentation) 9 | - [Version Notes](#version-notes) 10 | - [FAQ](#faq) 11 | 12 | # Documentation 13 | 14 | Please check [this](src/main/resources/README.adoc) document for more detailed info on how to use the plugin. 15 | Please also check [Launch4j's Configuration file](http://launch4j.sourceforge.net/docs.html#Configuration_file) page. 16 | The full list of all the parameters is available [here](src/main/resources/MOJO.md) 17 | 18 | **NOTE**: Since version 2.0.x this plugin requires to be used with Maven 3.6.x at least. 19 | 20 | # Version Notes 21 | 22 | Please check the [releases](../../releases) page for the exact versions notes 23 | 24 | ## Version notes 2.3.3 - 2023-03-11 25 | - updates maven wrapper to official 3.1.1, adds sha-512 & sha-256 checksums, adds a profiler extension, 26 | see PR [#252](../../pull/252) 27 | 28 | ## Version notes 2.3.2 - 2023-01-30 29 | - fixes broken Project Reports when running `maven-project-info-reports-plugin`, 30 | see Issue [#223](../../issues/223) and PR [#227](../../pull/227) 31 | 32 | ## Version notes 2.3.1 - 2023-01-16 33 | - logs only warnings instead of throwing exception, when cannot fulfill default values for `` 34 | (no configuration data required by the formula), see Issue [#213](../../issues/213) and PR [#216](../../pull/216) 35 | 36 | ## Version notes 2.3.0 - 2023-01-06 37 | - provides default values for plugin configuration, especially for ``, see Issue [#98](../../issues/98) 38 | - adds a `disableVersionInfoDefaults` parameter to be able to disable provided defaults, see PR [#205](../../pull/205) 39 | - adds documentation notes regarding a new defaults, see [VERSIONINFO.md](src/main/resources/VERSIONINFO.md) 40 | - throwing exceptions with detailed description of default values formula, when cannot fulfill default values 41 | (no configuration data for a formula), it helps plugin user with debugging what is wrong 42 | 43 | ## Version notes 2.2.0 - 2022-11-24 44 | - upgrades Launch4j to version 3.50 and adopts config to the bew requirements, see Issue [#199](../../issues/199) 45 | and PR [#200](../../pull/200) for more details what has to be changed 46 | 47 | ## Version notes 2.1.3 - 2022-10-24 48 | - allows to skip execution of the plugin using either `true` configuration option or `-DskipLaunch4j` property, 49 | see [#190](../../pull/190) 50 | 51 | ## Version notes 2.1.1 - 2021-05-04 52 | - creates parent folder if `outfile` was configured, see [#141](../../issues/141) 53 | 54 | ## Version notes 2.1.0 - 2021-05-04 55 | - upgrades Maven API to version 3.8.1 (it should be compatible with Maven 3.6.x), see [#132](../../pull/132), 56 | [#133](../../pull/133), [#134](../../pull/134), [#135](../../pull/135), [#136](../../pull/136) 57 | 58 | ## Version notes 2.0.1 - 2021-03-21 59 | - fixes problem with NPE, see [#128](../../issues/128) 60 | 61 | ## Version notes 2.0.0 - 2021-03-17 62 | **DO NOT USE THIS VERSION** 63 | - uses Launch4j version 3.14 (which requires Java 8), see [#126](../../pull/126) 64 | - switches to Java 8 as minimal supported version 65 | 66 | ## Version notes 1.7.25 67 | - creates parent directories of an obj file, see [#99](../../pull/99) 68 | 69 | ## Version notes 1.7.24 70 | - adds a `threadSafe` flag to the Mojo to properly mark that the plugin is thread safe, see [#72](../../issues/72) 71 | 72 | ## Version notes 1.7.23 73 | - adds a `parallelExecution` flag that will allow to run only one instance of the plugin in the given time, see [#72](../../issues/72) 74 | 75 | ## Version notes 1.7.22 76 | - upgrades to Launch4j version 3.12, see [#75](../../issues/75) 77 | 78 | ## Version notes 1.7.21 79 | - fixes issue with detecting OSX, see [#58](../../issues/58) 80 | 81 | ## Version notes 1.7.20 82 | - uses the `linux64` platform when run on 64-bit Linux, see [#59](../../pull/59) 83 | 84 | ## Version notes 1.7.19 85 | - upgrades to the version 3.11 of Launch4j 86 | 87 | ## Version notes 1.7.18 88 | - reverts changes introduced in **1.7.17**, see [#55](../../pull/55) 89 | 90 | ## Version notes 1.7.17 91 | - adds support for unwrapped jar, see [#55](../../pull/55) 92 | 93 | ## Version notes 1.7.16 94 | - detects different OSX versions to properly use proper binary bundle, see [#54](../../pull/54) 95 | 96 | ## Version notes 1.7.15 97 | - allows override some properties loaded from an external Launch4j config file, see [#49](../../issues/49) 98 | 99 | ## Version notes 1.7.14 100 | - fixes issue with setting `language`, see [#50](../../issues/50) 101 | 102 | ## Version notes 1.7.13 103 | - upgrades maven plugins to latest versions, see [#47](../../issues/47) 104 | 105 | ## Version notes 1.7.12 106 | - adds support for missing options, see [#45](../../issues/45) 107 | - `language` - please use one of the values as defined for the `` tag 108 | - `trademarks` - a free text used as a trademarks 109 | 110 | ## Version notes 1.7.11 111 | - upgrades to Launch4j version 3.9 112 | 113 | ## Version notes 1.7.10 114 | - fixes broken `` when not using `` 115 | 116 | ## Version notes 1.7.9 117 | - adds capability of loading Launch4j native configuration file 118 | ```xml 119 | 120 | ${project.basedir}/src/main/resources/my-app-config.xml 121 | 122 | ``` 123 | By default it will take from `${project.basedir}/src/main/resources/${project.artifactId}-launch4j.xml`. 124 | Plugin execution goal should be set to `install`. It's an optional configuration, you can either use your existing configuration as it was in previous version or use native **Launch4j** [config file](http://launch4j.sourceforge.net/docs.html#Configuration_file) via ``. 125 | 126 | ## Version notes 1.7.8 127 | - fixes issue with spaces in path to maven repository on non-Windows systems, see [#27](../../issues/27), [#28](../../issues/28) 128 | 129 | ## Version notes 1.7.7 130 | - once again fixes problem with including dependencies in scope `runtime` (now it should be the final solution), see [#5](../../issues/5) 131 | - adds support for `bundledJreAsFallback` and `bundledJre64Bit` properties, see [#23](../../issues/23) 132 | - upgrades Launch4j to 3.8.0, see [#21](../../issues/21) 133 | 134 | ## Version notes 1.7.6 135 | - fixes again problem with including dependencies in scope `runtime`, see [#5](../../issues/5) 136 | 137 | ## Version notes 1.7.5 138 | - allows add custom headers and libraries to working dir [#22](../../pull/22) 139 | 140 | ## Version notes 1.7.4 141 | - fixes type in default value for `outfile` parameter [#17](../../pull/17) 142 | 143 | ## Version notes 1.7.3 144 | - uses Maven annotation instead of JavaDoc parameters [#15](../../pull/15) 145 | - upgrades Maven plugins [#15](../../pull/15) 146 | - converts tabs to spaces [5b0619](../../commit/5b0619) 147 | 148 | ## Version notes 1.7.2 149 | - adds support for `restartOnCrash` Launch4j's option [#14](../../pull/14) 150 | 151 | ## Version notes 1.7.1 152 | - launch4j's `abeille` dependency was excluded [#11](../../pull/11) 153 | - versions of several plugins were updated [#11](../../pull/11) 154 | - tabs were converted to spaces [#11](../../pull/11) 155 | 156 | ## Version notes 1.7 157 | - uses the latest version of Launch4j (3.5.0) 158 | - contains support for `runtimeBits`, see [#6](../../issues/6) 159 | - ~~fixes problem with including dependencies in scope `runtime`, see [#5](../../issues/5)~~ 160 | 161 | ## Version notes 1.6 162 | - dropped Launch4j source and based on artifacts from Maven Central, see [#8](../../issues/8) 163 | - uses the latest version of Launch4j (3.4.0) 164 | - at least Java 1.7 is required 165 | 166 | # FAQ 167 | Q: I cannot build my project because `dsol-xml` dependency is missing? 168 | 169 | A: Add this repository to your `~/.m2/settings.xml` 170 | 171 | ```xml 172 | 173 | 174 | dsol-xml 175 | Simulation @ TU Delft 176 | http://simulation.tudelft.nl/maven/ 177 | 178 | 179 | ``` 180 | Q: Where can I find -SNAPSHOT builds? 181 | 182 | A: Use the Sonatype OSS repo 183 | 184 | ```xml 185 | 186 | 187 | sonatype-nexus-snapshots 188 | Sonatype Nexus Snapshots 189 | https://oss.sonatype.org/content/repositories/snapshots/ 190 | 191 | false 192 | 193 | 194 | true 195 | 196 | 197 | 198 | ``` 199 | 200 | Q: Can I use Launch4j on 64bit OS? 201 | 202 | A: Yes but you will have to install these libs to avoid problems: 203 | 204 | - lib32z1 205 | - lib32ncurses5 206 | - lib32bz2-1.0 (has been ia32-libs in older Ubuntu versions) 207 | - zlib.i686 208 | - ncurses-libs.i686 209 | - bzip2-libs.i686 210 | 211 | See [#4](../../issues/4) for more details. 212 | 213 | Q: How can I skip execution of the plugin? 214 | 215 | A: You can either use `true` configuration option or provide `-DskipLaunch4j` property to JVM 216 | 217 | See PR [#190](../../pull/190) for more details. 218 | -------------------------------------------------------------------------------- /mvnw: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | # ---------------------------------------------------------------------------- 3 | # Licensed to the Apache Software Foundation (ASF) under one 4 | # or more contributor license agreements. See the NOTICE file 5 | # distributed with this work for additional information 6 | # regarding copyright ownership. The ASF licenses this file 7 | # to you under the Apache License, Version 2.0 (the 8 | # "License"); you may not use this file except in compliance 9 | # with the License. You may obtain a copy of the License at 10 | # 11 | # https://www.apache.org/licenses/LICENSE-2.0 12 | # 13 | # Unless required by applicable law or agreed to in writing, 14 | # software distributed under the License is distributed on an 15 | # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16 | # KIND, either express or implied. See the License for the 17 | # specific language governing permissions and limitations 18 | # under the License. 19 | # ---------------------------------------------------------------------------- 20 | 21 | # ---------------------------------------------------------------------------- 22 | # Apache Maven Wrapper startup batch script, version 3.3.2 23 | # 24 | # Required ENV vars: 25 | # ------------------ 26 | # JAVA_HOME - location of a JDK home dir 27 | # 28 | # Optional ENV vars 29 | # ----------------- 30 | # MAVEN_OPTS - parameters passed to the Java VM when running Maven 31 | # e.g. to debug Maven itself, use 32 | # set MAVEN_OPTS=-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=8000 33 | # MAVEN_SKIP_RC - flag to disable loading of mavenrc files 34 | # ---------------------------------------------------------------------------- 35 | 36 | if [ -z "$MAVEN_SKIP_RC" ]; then 37 | 38 | if [ -f /usr/local/etc/mavenrc ]; then 39 | . /usr/local/etc/mavenrc 40 | fi 41 | 42 | if [ -f /etc/mavenrc ]; then 43 | . /etc/mavenrc 44 | fi 45 | 46 | if [ -f "$HOME/.mavenrc" ]; then 47 | . "$HOME/.mavenrc" 48 | fi 49 | 50 | fi 51 | 52 | # OS specific support. $var _must_ be set to either true or false. 53 | cygwin=false 54 | darwin=false 55 | mingw=false 56 | case "$(uname)" in 57 | CYGWIN*) cygwin=true ;; 58 | MINGW*) mingw=true ;; 59 | Darwin*) 60 | darwin=true 61 | # Use /usr/libexec/java_home if available, otherwise fall back to /Library/Java/Home 62 | # See https://developer.apple.com/library/mac/qa/qa1170/_index.html 63 | if [ -z "$JAVA_HOME" ]; then 64 | if [ -x "/usr/libexec/java_home" ]; then 65 | JAVA_HOME="$(/usr/libexec/java_home)" 66 | export JAVA_HOME 67 | else 68 | JAVA_HOME="/Library/Java/Home" 69 | export JAVA_HOME 70 | fi 71 | fi 72 | ;; 73 | esac 74 | 75 | if [ -z "$JAVA_HOME" ]; then 76 | if [ -r /etc/gentoo-release ]; then 77 | JAVA_HOME=$(java-config --jre-home) 78 | fi 79 | fi 80 | 81 | # For Cygwin, ensure paths are in UNIX format before anything is touched 82 | if $cygwin; then 83 | [ -n "$JAVA_HOME" ] \ 84 | && JAVA_HOME=$(cygpath --unix "$JAVA_HOME") 85 | [ -n "$CLASSPATH" ] \ 86 | && CLASSPATH=$(cygpath --path --unix "$CLASSPATH") 87 | fi 88 | 89 | # For Mingw, ensure paths are in UNIX format before anything is touched 90 | if $mingw; then 91 | [ -n "$JAVA_HOME" ] && [ -d "$JAVA_HOME" ] \ 92 | && JAVA_HOME="$( 93 | cd "$JAVA_HOME" || ( 94 | echo "cannot cd into $JAVA_HOME." >&2 95 | exit 1 96 | ) 97 | pwd 98 | )" 99 | fi 100 | 101 | if [ -z "$JAVA_HOME" ]; then 102 | javaExecutable="$(which javac)" 103 | if [ -n "$javaExecutable" ] && ! [ "$(expr "$javaExecutable" : '\([^ ]*\)')" = "no" ]; then 104 | # readlink(1) is not available as standard on Solaris 10. 105 | readLink=$(which readlink) 106 | if [ ! "$(expr "$readLink" : '\([^ ]*\)')" = "no" ]; then 107 | if $darwin; then 108 | javaHome="$(dirname "$javaExecutable")" 109 | javaExecutable="$(cd "$javaHome" && pwd -P)/javac" 110 | else 111 | javaExecutable="$(readlink -f "$javaExecutable")" 112 | fi 113 | javaHome="$(dirname "$javaExecutable")" 114 | javaHome=$(expr "$javaHome" : '\(.*\)/bin') 115 | JAVA_HOME="$javaHome" 116 | export JAVA_HOME 117 | fi 118 | fi 119 | fi 120 | 121 | if [ -z "$JAVACMD" ]; then 122 | if [ -n "$JAVA_HOME" ]; then 123 | if [ -x "$JAVA_HOME/jre/sh/java" ]; then 124 | # IBM's JDK on AIX uses strange locations for the executables 125 | JAVACMD="$JAVA_HOME/jre/sh/java" 126 | else 127 | JAVACMD="$JAVA_HOME/bin/java" 128 | fi 129 | else 130 | JAVACMD="$( 131 | \unset -f command 2>/dev/null 132 | \command -v java 133 | )" 134 | fi 135 | fi 136 | 137 | if [ ! -x "$JAVACMD" ]; then 138 | echo "Error: JAVA_HOME is not defined correctly." >&2 139 | echo " We cannot execute $JAVACMD" >&2 140 | exit 1 141 | fi 142 | 143 | if [ -z "$JAVA_HOME" ]; then 144 | echo "Warning: JAVA_HOME environment variable is not set." >&2 145 | fi 146 | 147 | # traverses directory structure from process work directory to filesystem root 148 | # first directory with .mvn subdirectory is considered project base directory 149 | find_maven_basedir() { 150 | if [ -z "$1" ]; then 151 | echo "Path not specified to find_maven_basedir" >&2 152 | return 1 153 | fi 154 | 155 | basedir="$1" 156 | wdir="$1" 157 | while [ "$wdir" != '/' ]; do 158 | if [ -d "$wdir"/.mvn ]; then 159 | basedir=$wdir 160 | break 161 | fi 162 | # workaround for JBEAP-8937 (on Solaris 10/Sparc) 163 | if [ -d "${wdir}" ]; then 164 | wdir=$( 165 | cd "$wdir/.." || exit 1 166 | pwd 167 | ) 168 | fi 169 | # end of workaround 170 | done 171 | printf '%s' "$( 172 | cd "$basedir" || exit 1 173 | pwd 174 | )" 175 | } 176 | 177 | # concatenates all lines of a file 178 | concat_lines() { 179 | if [ -f "$1" ]; then 180 | # Remove \r in case we run on Windows within Git Bash 181 | # and check out the repository with auto CRLF management 182 | # enabled. Otherwise, we may read lines that are delimited with 183 | # \r\n and produce $'-Xarg\r' rather than -Xarg due to word 184 | # splitting rules. 185 | tr -s '\r\n' ' ' <"$1" 186 | fi 187 | } 188 | 189 | log() { 190 | if [ "$MVNW_VERBOSE" = true ]; then 191 | printf '%s\n' "$1" 192 | fi 193 | } 194 | 195 | BASE_DIR=$(find_maven_basedir "$(dirname "$0")") 196 | if [ -z "$BASE_DIR" ]; then 197 | exit 1 198 | fi 199 | 200 | MAVEN_PROJECTBASEDIR=${MAVEN_BASEDIR:-"$BASE_DIR"} 201 | export MAVEN_PROJECTBASEDIR 202 | log "$MAVEN_PROJECTBASEDIR" 203 | 204 | ########################################################################################## 205 | # Extension to allow automatically downloading the maven-wrapper.jar from Maven-central 206 | # This allows using the maven wrapper in projects that prohibit checking in binary data. 207 | ########################################################################################## 208 | wrapperJarPath="$MAVEN_PROJECTBASEDIR/.mvn/wrapper/maven-wrapper.jar" 209 | if [ -r "$wrapperJarPath" ]; then 210 | log "Found $wrapperJarPath" 211 | else 212 | log "Couldn't find $wrapperJarPath, downloading it ..." 213 | 214 | if [ -n "$MVNW_REPOURL" ]; then 215 | wrapperUrl="$MVNW_REPOURL/org/apache/maven/wrapper/maven-wrapper/3.3.2/maven-wrapper-3.3.2.jar" 216 | else 217 | wrapperUrl="https://repo.maven.apache.org/maven2/org/apache/maven/wrapper/maven-wrapper/3.3.2/maven-wrapper-3.3.2.jar" 218 | fi 219 | while IFS="=" read -r key value; do 220 | # Remove '\r' from value to allow usage on windows as IFS does not consider '\r' as a separator ( considers space, tab, new line ('\n'), and custom '=' ) 221 | safeValue=$(echo "$value" | tr -d '\r') 222 | case "$key" in wrapperUrl) 223 | wrapperUrl="$safeValue" 224 | break 225 | ;; 226 | esac 227 | done <"$MAVEN_PROJECTBASEDIR/.mvn/wrapper/maven-wrapper.properties" 228 | log "Downloading from: $wrapperUrl" 229 | 230 | if $cygwin; then 231 | wrapperJarPath=$(cygpath --path --windows "$wrapperJarPath") 232 | fi 233 | 234 | if command -v wget >/dev/null; then 235 | log "Found wget ... using wget" 236 | [ "$MVNW_VERBOSE" = true ] && QUIET="" || QUIET="--quiet" 237 | if [ -z "$MVNW_USERNAME" ] || [ -z "$MVNW_PASSWORD" ]; then 238 | wget $QUIET "$wrapperUrl" -O "$wrapperJarPath" || rm -f "$wrapperJarPath" 239 | else 240 | wget $QUIET --http-user="$MVNW_USERNAME" --http-password="$MVNW_PASSWORD" "$wrapperUrl" -O "$wrapperJarPath" || rm -f "$wrapperJarPath" 241 | fi 242 | elif command -v curl >/dev/null; then 243 | log "Found curl ... using curl" 244 | [ "$MVNW_VERBOSE" = true ] && QUIET="" || QUIET="--silent" 245 | if [ -z "$MVNW_USERNAME" ] || [ -z "$MVNW_PASSWORD" ]; then 246 | curl $QUIET -o "$wrapperJarPath" "$wrapperUrl" -f -L || rm -f "$wrapperJarPath" 247 | else 248 | curl $QUIET --user "$MVNW_USERNAME:$MVNW_PASSWORD" -o "$wrapperJarPath" "$wrapperUrl" -f -L || rm -f "$wrapperJarPath" 249 | fi 250 | else 251 | log "Falling back to using Java to download" 252 | javaSource="$MAVEN_PROJECTBASEDIR/.mvn/wrapper/MavenWrapperDownloader.java" 253 | javaClass="$MAVEN_PROJECTBASEDIR/.mvn/wrapper/MavenWrapperDownloader.class" 254 | # For Cygwin, switch paths to Windows format before running javac 255 | if $cygwin; then 256 | javaSource=$(cygpath --path --windows "$javaSource") 257 | javaClass=$(cygpath --path --windows "$javaClass") 258 | fi 259 | if [ -e "$javaSource" ]; then 260 | if [ ! -e "$javaClass" ]; then 261 | log " - Compiling MavenWrapperDownloader.java ..." 262 | ("$JAVA_HOME/bin/javac" "$javaSource") 263 | fi 264 | if [ -e "$javaClass" ]; then 265 | log " - Running MavenWrapperDownloader.java ..." 266 | ("$JAVA_HOME/bin/java" -cp .mvn/wrapper MavenWrapperDownloader "$wrapperUrl" "$wrapperJarPath") || rm -f "$wrapperJarPath" 267 | fi 268 | fi 269 | fi 270 | fi 271 | ########################################################################################## 272 | # End of extension 273 | ########################################################################################## 274 | 275 | # If specified, validate the SHA-256 sum of the Maven wrapper jar file 276 | wrapperSha256Sum="" 277 | while IFS="=" read -r key value; do 278 | case "$key" in wrapperSha256Sum) 279 | wrapperSha256Sum=$value 280 | break 281 | ;; 282 | esac 283 | done <"$MAVEN_PROJECTBASEDIR/.mvn/wrapper/maven-wrapper.properties" 284 | if [ -n "$wrapperSha256Sum" ]; then 285 | wrapperSha256Result=false 286 | if command -v sha256sum >/dev/null; then 287 | if echo "$wrapperSha256Sum $wrapperJarPath" | sha256sum -c >/dev/null 2>&1; then 288 | wrapperSha256Result=true 289 | fi 290 | elif command -v shasum >/dev/null; then 291 | if echo "$wrapperSha256Sum $wrapperJarPath" | shasum -a 256 -c >/dev/null 2>&1; then 292 | wrapperSha256Result=true 293 | fi 294 | else 295 | echo "Checksum validation was requested but neither 'sha256sum' or 'shasum' are available." >&2 296 | echo "Please install either command, or disable validation by removing 'wrapperSha256Sum' from your maven-wrapper.properties." >&2 297 | exit 1 298 | fi 299 | if [ $wrapperSha256Result = false ]; then 300 | echo "Error: Failed to validate Maven wrapper SHA-256, your Maven wrapper might be compromised." >&2 301 | echo "Investigate or delete $wrapperJarPath to attempt a clean download." >&2 302 | echo "If you updated your Maven version, you need to update the specified wrapperSha256Sum property." >&2 303 | exit 1 304 | fi 305 | fi 306 | 307 | MAVEN_OPTS="$(concat_lines "$MAVEN_PROJECTBASEDIR/.mvn/jvm.config") $MAVEN_OPTS" 308 | 309 | # For Cygwin, switch paths to Windows format before running java 310 | if $cygwin; then 311 | [ -n "$JAVA_HOME" ] \ 312 | && JAVA_HOME=$(cygpath --path --windows "$JAVA_HOME") 313 | [ -n "$CLASSPATH" ] \ 314 | && CLASSPATH=$(cygpath --path --windows "$CLASSPATH") 315 | [ -n "$MAVEN_PROJECTBASEDIR" ] \ 316 | && MAVEN_PROJECTBASEDIR=$(cygpath --path --windows "$MAVEN_PROJECTBASEDIR") 317 | fi 318 | 319 | # Provide a "standardized" way to retrieve the CLI args that will 320 | # work with both Windows and non-Windows executions. 321 | MAVEN_CMD_LINE_ARGS="$MAVEN_CONFIG $*" 322 | export MAVEN_CMD_LINE_ARGS 323 | 324 | WRAPPER_LAUNCHER=org.apache.maven.wrapper.MavenWrapperMain 325 | 326 | # shellcheck disable=SC2086 # safe args 327 | exec "$JAVACMD" \ 328 | $MAVEN_OPTS \ 329 | $MAVEN_DEBUG_OPTS \ 330 | -classpath "$MAVEN_PROJECTBASEDIR/.mvn/wrapper/maven-wrapper.jar" \ 331 | "-Dmaven.multiModuleProjectDirectory=${MAVEN_PROJECTBASEDIR}" \ 332 | ${WRAPPER_LAUNCHER} $MAVEN_CONFIG "$@" 333 | -------------------------------------------------------------------------------- /mvnw.cmd: -------------------------------------------------------------------------------- 1 | @REM ---------------------------------------------------------------------------- 2 | @REM Licensed to the Apache Software Foundation (ASF) under one 3 | @REM or more contributor license agreements. See the NOTICE file 4 | @REM distributed with this work for additional information 5 | @REM regarding copyright ownership. The ASF licenses this file 6 | @REM to you under the Apache License, Version 2.0 (the 7 | @REM "License"); you may not use this file except in compliance 8 | @REM with the License. You may obtain a copy of the License at 9 | @REM 10 | @REM https://www.apache.org/licenses/LICENSE-2.0 11 | @REM 12 | @REM Unless required by applicable law or agreed to in writing, 13 | @REM software distributed under the License is distributed on an 14 | @REM "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 15 | @REM KIND, either express or implied. See the License for the 16 | @REM specific language governing permissions and limitations 17 | @REM under the License. 18 | @REM ---------------------------------------------------------------------------- 19 | 20 | @REM ---------------------------------------------------------------------------- 21 | @REM Apache Maven Wrapper startup batch script, version 3.3.2 22 | @REM 23 | @REM Required ENV vars: 24 | @REM JAVA_HOME - location of a JDK home dir 25 | @REM 26 | @REM Optional ENV vars 27 | @REM MAVEN_BATCH_ECHO - set to 'on' to enable the echoing of the batch commands 28 | @REM MAVEN_BATCH_PAUSE - set to 'on' to wait for a keystroke before ending 29 | @REM MAVEN_OPTS - parameters passed to the Java VM when running Maven 30 | @REM e.g. to debug Maven itself, use 31 | @REM set MAVEN_OPTS=-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=8000 32 | @REM MAVEN_SKIP_RC - flag to disable loading of mavenrc files 33 | @REM ---------------------------------------------------------------------------- 34 | 35 | @REM Begin all REM lines with '@' in case MAVEN_BATCH_ECHO is 'on' 36 | @echo off 37 | @REM set title of command window 38 | title %0 39 | @REM enable echoing by setting MAVEN_BATCH_ECHO to 'on' 40 | @if "%MAVEN_BATCH_ECHO%" == "on" echo %MAVEN_BATCH_ECHO% 41 | 42 | @REM set %HOME% to equivalent of $HOME 43 | if "%HOME%" == "" (set "HOME=%HOMEDRIVE%%HOMEPATH%") 44 | 45 | @REM Execute a user defined script before this one 46 | if not "%MAVEN_SKIP_RC%" == "" goto skipRcPre 47 | @REM check for pre script, once with legacy .bat ending and once with .cmd ending 48 | if exist "%USERPROFILE%\mavenrc_pre.bat" call "%USERPROFILE%\mavenrc_pre.bat" %* 49 | if exist "%USERPROFILE%\mavenrc_pre.cmd" call "%USERPROFILE%\mavenrc_pre.cmd" %* 50 | :skipRcPre 51 | 52 | @setlocal 53 | 54 | set ERROR_CODE=0 55 | 56 | @REM To isolate internal variables from possible post scripts, we use another setlocal 57 | @setlocal 58 | 59 | @REM ==== START VALIDATION ==== 60 | if not "%JAVA_HOME%" == "" goto OkJHome 61 | 62 | echo. >&2 63 | echo Error: JAVA_HOME not found in your environment. >&2 64 | echo Please set the JAVA_HOME variable in your environment to match the >&2 65 | echo location of your Java installation. >&2 66 | echo. >&2 67 | goto error 68 | 69 | :OkJHome 70 | if exist "%JAVA_HOME%\bin\java.exe" goto init 71 | 72 | echo. >&2 73 | echo Error: JAVA_HOME is set to an invalid directory. >&2 74 | echo JAVA_HOME = "%JAVA_HOME%" >&2 75 | echo Please set the JAVA_HOME variable in your environment to match the >&2 76 | echo location of your Java installation. >&2 77 | echo. >&2 78 | goto error 79 | 80 | @REM ==== END VALIDATION ==== 81 | 82 | :init 83 | 84 | @REM Find the project base dir, i.e. the directory that contains the folder ".mvn". 85 | @REM Fallback to current working directory if not found. 86 | 87 | set MAVEN_PROJECTBASEDIR=%MAVEN_BASEDIR% 88 | IF NOT "%MAVEN_PROJECTBASEDIR%"=="" goto endDetectBaseDir 89 | 90 | set EXEC_DIR=%CD% 91 | set WDIR=%EXEC_DIR% 92 | :findBaseDir 93 | IF EXIST "%WDIR%"\.mvn goto baseDirFound 94 | cd .. 95 | IF "%WDIR%"=="%CD%" goto baseDirNotFound 96 | set WDIR=%CD% 97 | goto findBaseDir 98 | 99 | :baseDirFound 100 | set MAVEN_PROJECTBASEDIR=%WDIR% 101 | cd "%EXEC_DIR%" 102 | goto endDetectBaseDir 103 | 104 | :baseDirNotFound 105 | set MAVEN_PROJECTBASEDIR=%EXEC_DIR% 106 | cd "%EXEC_DIR%" 107 | 108 | :endDetectBaseDir 109 | 110 | IF NOT EXIST "%MAVEN_PROJECTBASEDIR%\.mvn\jvm.config" goto endReadAdditionalConfig 111 | 112 | @setlocal EnableExtensions EnableDelayedExpansion 113 | for /F "usebackq delims=" %%a in ("%MAVEN_PROJECTBASEDIR%\.mvn\jvm.config") do set JVM_CONFIG_MAVEN_PROPS=!JVM_CONFIG_MAVEN_PROPS! %%a 114 | @endlocal & set JVM_CONFIG_MAVEN_PROPS=%JVM_CONFIG_MAVEN_PROPS% 115 | 116 | :endReadAdditionalConfig 117 | 118 | SET MAVEN_JAVA_EXE="%JAVA_HOME%\bin\java.exe" 119 | set WRAPPER_JAR="%MAVEN_PROJECTBASEDIR%\.mvn\wrapper\maven-wrapper.jar" 120 | set WRAPPER_LAUNCHER=org.apache.maven.wrapper.MavenWrapperMain 121 | 122 | set WRAPPER_URL="https://repo.maven.apache.org/maven2/org/apache/maven/wrapper/maven-wrapper/3.3.2/maven-wrapper-3.3.2.jar" 123 | 124 | FOR /F "usebackq tokens=1,2 delims==" %%A IN ("%MAVEN_PROJECTBASEDIR%\.mvn\wrapper\maven-wrapper.properties") DO ( 125 | IF "%%A"=="wrapperUrl" SET WRAPPER_URL=%%B 126 | ) 127 | 128 | @REM Extension to allow automatically downloading the maven-wrapper.jar from Maven-central 129 | @REM This allows using the maven wrapper in projects that prohibit checking in binary data. 130 | if exist %WRAPPER_JAR% ( 131 | if "%MVNW_VERBOSE%" == "true" ( 132 | echo Found %WRAPPER_JAR% 133 | ) 134 | ) else ( 135 | if not "%MVNW_REPOURL%" == "" ( 136 | SET WRAPPER_URL="%MVNW_REPOURL%/org/apache/maven/wrapper/maven-wrapper/3.3.2/maven-wrapper-3.3.2.jar" 137 | ) 138 | if "%MVNW_VERBOSE%" == "true" ( 139 | echo Couldn't find %WRAPPER_JAR%, downloading it ... 140 | echo Downloading from: %WRAPPER_URL% 141 | ) 142 | 143 | powershell -Command "&{"^ 144 | "$webclient = new-object System.Net.WebClient;"^ 145 | "if (-not ([string]::IsNullOrEmpty('%MVNW_USERNAME%') -and [string]::IsNullOrEmpty('%MVNW_PASSWORD%'))) {"^ 146 | "$webclient.Credentials = new-object System.Net.NetworkCredential('%MVNW_USERNAME%', '%MVNW_PASSWORD%');"^ 147 | "}"^ 148 | "[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12; $webclient.DownloadFile('%WRAPPER_URL%', '%WRAPPER_JAR%')"^ 149 | "}" 150 | if "%MVNW_VERBOSE%" == "true" ( 151 | echo Finished downloading %WRAPPER_JAR% 152 | ) 153 | ) 154 | @REM End of extension 155 | 156 | @REM If specified, validate the SHA-256 sum of the Maven wrapper jar file 157 | SET WRAPPER_SHA_256_SUM="" 158 | FOR /F "usebackq tokens=1,2 delims==" %%A IN ("%MAVEN_PROJECTBASEDIR%\.mvn\wrapper\maven-wrapper.properties") DO ( 159 | IF "%%A"=="wrapperSha256Sum" SET WRAPPER_SHA_256_SUM=%%B 160 | ) 161 | IF NOT %WRAPPER_SHA_256_SUM%=="" ( 162 | powershell -Command "&{"^ 163 | "Import-Module $PSHOME\Modules\Microsoft.PowerShell.Utility -Function Get-FileHash;"^ 164 | "$hash = (Get-FileHash \"%WRAPPER_JAR%\" -Algorithm SHA256).Hash.ToLower();"^ 165 | "If('%WRAPPER_SHA_256_SUM%' -ne $hash){"^ 166 | " Write-Error 'Error: Failed to validate Maven wrapper SHA-256, your Maven wrapper might be compromised.';"^ 167 | " Write-Error 'Investigate or delete %WRAPPER_JAR% to attempt a clean download.';"^ 168 | " Write-Error 'If you updated your Maven version, you need to update the specified wrapperSha256Sum property.';"^ 169 | " exit 1;"^ 170 | "}"^ 171 | "}" 172 | if ERRORLEVEL 1 goto error 173 | ) 174 | 175 | @REM Provide a "standardized" way to retrieve the CLI args that will 176 | @REM work with both Windows and non-Windows executions. 177 | set MAVEN_CMD_LINE_ARGS=%* 178 | 179 | %MAVEN_JAVA_EXE% ^ 180 | %JVM_CONFIG_MAVEN_PROPS% ^ 181 | %MAVEN_OPTS% ^ 182 | %MAVEN_DEBUG_OPTS% ^ 183 | -classpath %WRAPPER_JAR% ^ 184 | "-Dmaven.multiModuleProjectDirectory=%MAVEN_PROJECTBASEDIR%" ^ 185 | %WRAPPER_LAUNCHER% %MAVEN_CONFIG% %* 186 | if ERRORLEVEL 1 goto error 187 | goto end 188 | 189 | :error 190 | set ERROR_CODE=1 191 | 192 | :end 193 | @endlocal & set ERROR_CODE=%ERROR_CODE% 194 | 195 | if not "%MAVEN_SKIP_RC%"=="" goto skipRcPost 196 | @REM check for post script, once with legacy .bat ending and once with .cmd ending 197 | if exist "%USERPROFILE%\mavenrc_post.bat" call "%USERPROFILE%\mavenrc_post.bat" 198 | if exist "%USERPROFILE%\mavenrc_post.cmd" call "%USERPROFILE%\mavenrc_post.cmd" 199 | :skipRcPost 200 | 201 | @REM pause the script if MAVEN_BATCH_PAUSE is set to 'on' 202 | if "%MAVEN_BATCH_PAUSE%"=="on" pause 203 | 204 | if "%MAVEN_TERMINATE_CMD%"=="on" exit %ERROR_CODE% 205 | 206 | cmd /C exit /B %ERROR_CODE% 207 | -------------------------------------------------------------------------------- /pom.xml: -------------------------------------------------------------------------------- 1 | 2 | 25 | 26 | 4.0.0 27 | 28 | 29 | org.sonatype.oss 30 | oss-parent 31 | 9 32 | 33 | 34 | 35 | com.akathist.maven.plugins.launch4j 36 | launch4j-maven-plugin 37 | maven-plugin 38 | 2.6.1-SNAPSHOT 39 | 40 | Maven Launch4j Plugin 41 | This plugin creates Windows executables from Java jar files using the Launch4j utility. 42 | https://orphan.software/ 43 | 44 | 45 | 3.50 46 | 1.8 47 | 1.8 48 | 49 | 50 | 51 | 52 | GNU General Public License v3.0 53 | https://www.gnu.org/licenses/gpl-3.0.txt 54 | repo 55 | 56 | 57 | 58 | 59 | scm:git:git@github.com:orphan-oss/launch4j-maven-plugin.git 60 | git@github.com:orphan-oss/launch4j-maven-plugin.git 61 | scm:git:git@github.com:orphan-oss/launch4j-maven-plugin.git 62 | HEAD 63 | 64 | 65 | 66 | 67 | net.sf.launch4j 68 | launch4j 69 | ${launch4j.version} 70 | core 71 | 72 | 73 | com.ibm.icu 74 | icu4j 75 | 76 | 77 | abeille 78 | net.java.abeille 79 | 80 | 81 | com.thoughtworks.xstream 82 | xstream 83 | 84 | 85 | org.apache.ant 86 | ant 87 | 88 | 89 | 90 | 91 | org.apache.ant 92 | ant 93 | 1.10.15 94 | 95 | 96 | com.thoughtworks.xstream 97 | xstream 98 | 1.4.21 99 | 100 | 101 | org.apache.maven 102 | maven-plugin-api 103 | 3.9.9 104 | provided 105 | 106 | 107 | org.apache.maven 108 | maven-model 109 | 3.9.9 110 | provided 111 | 112 | 113 | org.apache.maven 114 | maven-artifact 115 | 3.9.9 116 | provided 117 | 118 | 119 | org.apache.maven 120 | maven-core 121 | 3.9.9 122 | provided 123 | 124 | 125 | org.apache.maven.plugin-tools 126 | maven-plugin-annotations 127 | 3.15.1 128 | provided 129 | 130 | 131 | org.apache.commons 132 | commons-lang3 133 | 3.17.0 134 | 135 | 136 | junit 137 | junit 138 | 4.13.2 139 | test 140 | 141 | 142 | pl.pragmatists 143 | JUnitParams 144 | 1.1.1 145 | test 146 | 147 | 148 | org.mockito 149 | mockito-core 150 | 4.11.0 151 | test 152 | 153 | 154 | org.apache.maven.plugin-testing 155 | maven-plugin-testing-harness 156 | 3.3.0 157 | test 158 | 159 | 160 | org.apache.maven 161 | maven-compat 162 | 3.9.9 163 | test 164 | 165 | 166 | 167 | 168 | 169 | 170 | 171 | org.apache.maven.plugins 172 | maven-compiler-plugin 173 | 3.14.0 174 | 175 | 176 | org.apache.maven.plugins 177 | maven-plugin-plugin 178 | 3.15.1 179 | 180 | 181 | true 182 | 183 | 184 | 185 | default-descriptor 186 | 187 | descriptor 188 | 189 | process-classes 190 | 191 | 192 | help-descriptor 193 | 194 | helpmojo 195 | 196 | process-classes 197 | 198 | 199 | 200 | 201 | 202 | 203 | 204 | 205 | org.apache.maven.plugins 206 | maven-plugin-plugin 207 | 3.15.1 208 | 209 | 210 | mojo-descriptor 211 | 212 | descriptor 213 | 214 | 215 | 216 | help-goal 217 | 218 | helpmojo 219 | 220 | 221 | 222 | 223 | 224 | org.apache.maven.plugins 225 | maven-site-plugin 226 | 3.21.0 227 | 228 | 229 | org.apache.maven.doxia 230 | doxia-core 231 | 2.0.0 232 | 233 | 234 | org.apache.maven.doxia 235 | doxia-module-markdown 236 | 2.0.0 237 | 238 | 239 | 240 | 241 | 242 | 243 | 244 | 245 | eclipse 246 | 247 | 248 | m2e.version 249 | 250 | 251 | 252 | 253 | 254 | 255 | 256 | org.eclipse.m2e 257 | lifecycle-mapping 258 | 1.0.0 259 | 260 | 261 | 262 | 263 | 264 | org.apache.maven.plugins 265 | maven-plugin-plugin 266 | [3.4,) 267 | 268 | helpmojo 269 | descriptor 270 | 271 | 272 | 273 | 274 | 275 | 276 | 277 | 278 | 279 | 280 | 281 | 282 | 283 | 284 | 285 | 286 | 287 | 288 | 289 | org.apache.maven.plugins 290 | maven-project-info-reports-plugin 291 | 3.9.0 292 | 293 | 294 | 295 | index 296 | summary 297 | licenses 298 | dependencies 299 | plugins 300 | 301 | 302 | 303 | 304 | 305 | org.apache.maven.plugins 306 | maven-plugin-plugin 307 | 3.15.1 308 | 309 | 310 | org.apache.maven.plugins 311 | maven-javadoc-plugin 312 | 3.11.2 313 | 314 | 315 | 316 | 317 | 318 | -------------------------------------------------------------------------------- /renovate.json: -------------------------------------------------------------------------------- 1 | { 2 | "$schema": "https://docs.renovatebot.com/renovate-schema.json", 3 | "extends": [ 4 | "config:recommended" 5 | ], 6 | "packageRules": [ 7 | { 8 | "matchUpdateTypes": ["major","minor", "patch"], 9 | "matchCurrentVersion": "!/^0/", 10 | "automerge": true 11 | } 12 | ] 13 | } 14 | -------------------------------------------------------------------------------- /src/main/java/com/akathist/maven/plugins/launch4j/ClassPath.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Maven Launch4j Plugin 3 | * Copyright (c) 2006 Paul Jungwirth 4 | * Copyright (c) 2011-2025 Lukasz Lenart 5 | * 6 | * This program is free software; you can redistribute it and/or modify 7 | * it under the terms of the GNU General Public License as published by 8 | * the Free Software Foundation; either version 3 of the License, or 9 | * (at your option) any later version. 10 | * 11 | * This program is distributed in the hope that it will be useful, 12 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | * GNU General Public License for more details. 15 | * 16 | * You should have received a copy of the GNU General Public License 17 | * along with this program; if not, write to the Free Software 18 | * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA 19 | */ 20 | package com.akathist.maven.plugins.launch4j; 21 | 22 | import org.apache.maven.artifact.Artifact; 23 | import org.apache.maven.plugins.annotations.Parameter; 24 | 25 | import java.util.ArrayList; 26 | import java.util.Arrays; 27 | import java.util.List; 28 | import java.util.Set; 29 | 30 | public class ClassPath { 31 | 32 | /** 33 | * The main class to run. This is not required if you are wrapping an executable jar. 34 | */ 35 | @Parameter 36 | String mainClass; 37 | 38 | /** 39 | * The launch4j executable sets up a classpath before running your jar, but it must know what the 40 | * classpath should be. If you set this property to true, the plugin will indicate a classpath 41 | * based on all the dependencies your program will need at runtime. You can augment this classpath 42 | * using the preCp and postCp properties. 43 | */ 44 | @Parameter(defaultValue = "true") 45 | boolean addDependencies = true; 46 | 47 | /** 48 | * If you want maven to build the classpath from dependencies, you can optionally set the jarLocation, 49 | * which is the location of the jars in your distro relative to the executable. So if your distro 50 | * has the exe at the top level and all the jars in a lib directory, you could set this to "lib." 51 | * This property does not affect preCp and postCp. 52 | */ 53 | @Parameter 54 | String jarLocation; 55 | 56 | /** 57 | * Part of the classpath that the executable should give to your application. 58 | * Paths are relative to the executable and should be in Windows format (separated by a semicolon). 59 | * You don't have to list all your dependencies here; the plugin will include them by default 60 | * after this list. 61 | */ 62 | @Parameter 63 | String preCp; 64 | 65 | /** 66 | * Part of the classpath that the executable should give to your application. 67 | * Paths are relative to the executable and should be in Windows format (separated by a semicolon). 68 | * You don't have to list all your dependencies here; the plugin will include them by default 69 | * before this list. 70 | */ 71 | @Parameter 72 | String postCp; 73 | 74 | private void addToCp(List cp, String cpStr) { 75 | cp.addAll(Arrays.asList(cpStr.split("\\s*;\\s*"))); 76 | } 77 | 78 | net.sf.launch4j.config.ClassPath toL4j(Set dependencies) { 79 | net.sf.launch4j.config.ClassPath ret = new net.sf.launch4j.config.ClassPath(); 80 | ret.setMainClass(mainClass); 81 | 82 | List cp = new ArrayList<>(); 83 | if (preCp != null) addToCp(cp, preCp); 84 | 85 | if (addDependencies) { 86 | if (jarLocation == null) jarLocation = ""; 87 | else if (!jarLocation.endsWith("/")) jarLocation += "/"; 88 | 89 | for (Artifact dependency : dependencies) { 90 | String depFilename; 91 | depFilename = dependency.getFile().getName(); 92 | // System.out.println("dependency = " + depFilename); 93 | cp.add(jarLocation + depFilename); 94 | } 95 | } 96 | 97 | if (postCp != null) addToCp(cp, postCp); 98 | ret.setPaths(cp); 99 | 100 | return ret; 101 | } 102 | 103 | @Override 104 | public String toString() { 105 | return "ClassPath{" + 106 | "mainClass='" + mainClass + '\'' + 107 | ", addDependencies=" + addDependencies + 108 | ", jarLocation='" + jarLocation + '\'' + 109 | ", preCp='" + preCp + '\'' + 110 | ", postCp='" + postCp + '\'' + 111 | '}'; 112 | } 113 | 114 | } 115 | -------------------------------------------------------------------------------- /src/main/java/com/akathist/maven/plugins/launch4j/Jre.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Maven Launch4j Plugin 3 | * Copyright (c) 2006 Paul Jungwirth 4 | * Copyright (c) 2011-2025 Lukasz Lenart 5 | * 6 | * This program is free software; you can redistribute it and/or modify 7 | * it under the terms of the GNU General Public License as published by 8 | * the Free Software Foundation; either version 3 of the License, or 9 | * (at your option) any later version. 10 | * 11 | * This program is distributed in the hope that it will be useful, 12 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | * GNU General Public License for more details. 15 | * 16 | * You should have received a copy of the GNU General Public License 17 | * along with this program; if not, write to the Free Software 18 | * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA 19 | */ 20 | package com.akathist.maven.plugins.launch4j; 21 | 22 | import java.util.List; 23 | 24 | import org.apache.maven.plugin.logging.Log; 25 | import org.apache.maven.plugins.annotations.Parameter; 26 | 27 | /** 28 | * Details about which jre the executable should call. 29 | */ 30 | public class Jre { 31 | 32 | /** 33 | * The property is used to specify absolute or relative JRE paths, it does not rely 34 | * on the current directory or . 35 | * Note: the path is not checked until the actual application execution. 36 | * The is now required and always used for searching before the registry, 37 | * to ensure compatibility with the latest runtimes, which by default 38 | * do not add registry keys during installation. 39 | */ 40 | @Parameter(required = true) 41 | String path; 42 | 43 | /** 44 | * Sets jre's bundledJre64Bit flag 45 | * 46 | * @deprecated Replaced with which works during path and registry search. 47 | * @since using Launch4j 3.50 48 | */ 49 | @Parameter(defaultValue = "false") 50 | @Deprecated 51 | String bundledJre64Bit; 52 | 53 | /** 54 | * Sets jre's bundledJreAsFallback flag 55 | * 56 | * @deprecated Removed, path search is always first and registry search second 57 | * in order to improve compatibility with modern runtimes 58 | * @since using Launch4j 3.50 59 | */ 60 | @Parameter(defaultValue = "false") 61 | @Deprecated 62 | String bundledJreAsFallback; 63 | 64 | /** 65 | * When set to "true", limits the runtimes to 64-Bit only, "false" will use 64-Bit or 32-Bit 66 | * depending on which is found. This option works with path and registry search. 67 | * @since version 2.2.0 68 | */ 69 | @Parameter(defaultValue = "false") 70 | boolean requires64Bit; 71 | 72 | /** 73 | * Use this property if you want the executable to search the system for a jre. 74 | * It names the minimum version acceptable, in x.x.x[_xx] format. 75 | *

76 | * If you specify this property without giving a path, then the executable will search for a jre 77 | * and, none is found, display the java download page. 78 | *

79 | * If you include a path also, the executable will try that path before searching for jre matching minVersion. 80 | *

81 | * In either case, you can also specify a maxVersion. 82 | */ 83 | String minVersion; 84 | 85 | /** 86 | * If you specify minVersion, you can also use maxVersion to further constrain the search for a jre. 87 | * This property should be in the format x.x.x[_xx]. 88 | */ 89 | String maxVersion; 90 | 91 | /** 92 | * Allows you to specify a preference for a public JRE or a private JDK runtime. 93 | *

94 | * Valid values are: 95 | * 96 | * 97 | * 98 | * 99 | * 100 | * 101 | * 102 | * 103 | * 104 | * 105 | * 106 | * 107 | * 108 | * 109 | * 110 | * 111 | * 112 | *
jreOnlyAlways use a public JRE
preferJrePrefer a public JRE, but use a JDK private runtime if it is newer than the public JRE
preferJdkPrefer a JDK private runtime, but use a public JRE if it is newer than the JDK
jdkOnlyAlways use a private JDK runtime (fails if there is no JDK installed)
113 | * 114 | * @deprecated Replaces with which works during path and registry search. 115 | * @since using Launch4j 3.50 116 | */ 117 | @Parameter(defaultValue = "preferJre") 118 | @Deprecated 119 | String jdkPreference; 120 | 121 | /** 122 | * When set to "true" only a JDK will be used for execution. An additional check will be performed 123 | * if javac is available during path and registry search. 124 | * @since version 2.2.0 125 | */ 126 | @Parameter(defaultValue = "false") 127 | boolean requiresJdk; 128 | 129 | /** 130 | * Sets java's initial heap size in MB, like the -Xms flag. 131 | */ 132 | int initialHeapSize; 133 | 134 | /** 135 | * Sets java's initial heap size in percent of free memory. 136 | */ 137 | int initialHeapPercent; 138 | 139 | /** 140 | * Sets java's maximum heap size in MB, like the -Xmx flag. 141 | */ 142 | int maxHeapSize; 143 | 144 | /** 145 | * Sets java's maximum heap size in percent of free memory. 146 | */ 147 | int maxHeapPercent; 148 | 149 | /** 150 | * Use this to pass arbitrary options to the java/javaw program. 151 | * For instance, you can say: 152 | *

153 |      * <opt>-Dlaunch4j.exedir="%EXEDIR%"</opt>
154 |      * <opt>-Dlaunch4j.exefile="%EXEFILE%"</opt>
155 |      * <opt>-Denv.path="%Path%"</opt>
156 |      * <opt>-Dsettings="%HomeDrive%%HomePath%\\settings.ini"</opt>
157 |      * 
158 | */ 159 | List opts; 160 | 161 | /** 162 | * Sets JVM version to use: 32 bits, 64 bits or 64/32 bits 163 | * Possible values: 32, 64, 64/32 - it will fallback to default value if different option was used 164 | * Default value is: 64/32 165 | * 166 | * @deprecated Replaced with which works during path and registry search. 167 | * @since using Launch4j 3.50 168 | */ 169 | @Parameter(defaultValue = "64/32") 170 | @Deprecated 171 | String runtimeBits; 172 | 173 | net.sf.launch4j.config.Jre toL4j() { 174 | net.sf.launch4j.config.Jre ret = new net.sf.launch4j.config.Jre(); 175 | 176 | ret.setPath(path); 177 | ret.setRequires64Bit(requires64Bit); 178 | ret.setMinVersion(minVersion); 179 | ret.setMaxVersion(maxVersion); 180 | ret.setRequiresJdk(requiresJdk); 181 | ret.setInitialHeapSize(initialHeapSize); 182 | ret.setInitialHeapPercent(initialHeapPercent); 183 | ret.setMaxHeapSize(maxHeapSize); 184 | ret.setMaxHeapPercent(maxHeapPercent); 185 | ret.setOptions(opts); 186 | 187 | return ret; 188 | } 189 | 190 | @Override 191 | public String toString() { 192 | return "Jre{" + 193 | "path='" + path + '\'' + 194 | ", requires64Bit=" + requires64Bit + 195 | ", minVersion='" + minVersion + '\'' + 196 | ", maxVersion='" + maxVersion + '\'' + 197 | ", requiresJdk=" + requiresJdk + 198 | ", initialHeapSize=" + initialHeapSize + 199 | ", initialHeapPercent=" + initialHeapPercent + 200 | ", maxHeapSize=" + maxHeapSize + 201 | ", maxHeapPercent=" + maxHeapPercent + 202 | ", opts=" + opts + 203 | '}'; 204 | } 205 | 206 | public void deprecationWarning(Log log) { 207 | if (this.bundledJreAsFallback != null) { 208 | log.warn(" has been removed! It has no effect!"); 209 | } 210 | if (this.bundledJre64Bit != null) { 211 | log.warn(" is deprecated, use instead!"); 212 | } 213 | if (this.runtimeBits != null) { 214 | log.warn(" is deprecated, use instead!"); 215 | } 216 | if (this.jdkPreference != null) { 217 | log.warn(" is deprecated, use instead!"); 218 | } 219 | } 220 | } 221 | -------------------------------------------------------------------------------- /src/main/java/com/akathist/maven/plugins/launch4j/MavenLog.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Maven Launch4j Plugin 3 | * Copyright (c) 2006 Paul Jungwirth 4 | * Copyright (c) 2011-2025 Lukasz Lenart 5 | * 6 | * This program is free software; you can redistribute it and/or modify 7 | * it under the terms of the GNU General Public License as published by 8 | * the Free Software Foundation; either version 3 of the License, or 9 | * (at your option) any later version. 10 | * 11 | * This program is distributed in the hope that it will be useful, 12 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | * GNU General Public License for more details. 15 | * 16 | * You should have received a copy of the GNU General Public License 17 | * along with this program; if not, write to the Free Software 18 | * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA 19 | */ 20 | package com.akathist.maven.plugins.launch4j; 21 | 22 | import org.apache.maven.plugin.logging.Log; 23 | 24 | public class MavenLog extends net.sf.launch4j.Log { 25 | 26 | Log _log; 27 | 28 | public MavenLog(Log log) { 29 | _log = log; 30 | } 31 | 32 | @Override 33 | public void clear() { 34 | _log.info(""); 35 | } 36 | 37 | @Override 38 | public void append(String line) { 39 | _log.info("launch4j: " + line); 40 | } 41 | 42 | } 43 | -------------------------------------------------------------------------------- /src/main/java/com/akathist/maven/plugins/launch4j/Messages.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Maven Launch4j Plugin 3 | * Copyright (c) 2006 Paul Jungwirth 4 | * Copyright (c) 2011-2025 Lukasz Lenart 5 | * 6 | * This program is free software; you can redistribute it and/or modify 7 | * it under the terms of the GNU General Public License as published by 8 | * the Free Software Foundation; either version 3 of the License, or 9 | * (at your option) any later version. 10 | * 11 | * This program is distributed in the hope that it will be useful, 12 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | * GNU General Public License for more details. 15 | * 16 | * You should have received a copy of the GNU General Public License 17 | * along with this program; if not, write to the Free Software 18 | * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA 19 | */ 20 | package com.akathist.maven.plugins.launch4j; 21 | 22 | import net.sf.launch4j.config.Msg; 23 | import org.apache.maven.plugins.annotations.Parameter; 24 | 25 | /** 26 | * Details about messages you can pass. 27 | */ 28 | public class Messages { 29 | 30 | @Parameter 31 | String startupErr; 32 | 33 | @Parameter 34 | @Deprecated 35 | String bundledJreErr; 36 | 37 | @Parameter 38 | String jreVersionErr; 39 | 40 | @Parameter 41 | String launcherErr; 42 | 43 | @Parameter 44 | String instanceAlreadyExistsMsg; 45 | 46 | @Parameter 47 | String jreNotFoundErr; 48 | 49 | Msg toL4j() { 50 | Msg ret = new Msg(); 51 | 52 | ret.setStartupErr(startupErr); 53 | ret.setJreVersionErr(jreVersionErr); 54 | ret.setLauncherErr(launcherErr); 55 | ret.setInstanceAlreadyExistsMsg(instanceAlreadyExistsMsg); 56 | 57 | /* since Launch4j 3.50 */ 58 | ret.setJreNotFoundErr(jreNotFoundErr); 59 | return ret; 60 | } 61 | 62 | @Override 63 | public String toString() { 64 | return "Messages{" + 65 | "startupErr='" + startupErr + '\'' + 66 | ", jreVersionErr='" + jreVersionErr + '\'' + 67 | ", launcherErr='" + launcherErr + '\'' + 68 | ", instanceAlreadyExistsMsg='" + instanceAlreadyExistsMsg + '\'' + 69 | ", jreNotFoundErr='" + jreNotFoundErr + '\'' + 70 | '}'; 71 | } 72 | } 73 | -------------------------------------------------------------------------------- /src/main/java/com/akathist/maven/plugins/launch4j/SingleInstance.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Maven Launch4j Plugin 3 | * Copyright (c) 2006 Paul Jungwirth 4 | * Copyright (c) 2011-2025 Lukasz Lenart 5 | * 6 | * This program is free software; you can redistribute it and/or modify 7 | * it under the terms of the GNU General Public License as published by 8 | * the Free Software Foundation; either version 3 of the License, or 9 | * (at your option) any later version. 10 | * 11 | * This program is distributed in the hope that it will be useful, 12 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | * GNU General Public License for more details. 15 | * 16 | * You should have received a copy of the GNU General Public License 17 | * along with this program; if not, write to the Free Software 18 | * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA 19 | */ 20 | package com.akathist.maven.plugins.launch4j; 21 | 22 | import org.apache.maven.plugins.annotations.Parameter; 23 | 24 | /** 25 | * Details about running your application as a single instance. 26 | */ 27 | public class SingleInstance { 28 | 29 | @Parameter 30 | String mutexName; 31 | 32 | @Parameter 33 | String windowTitle; 34 | 35 | net.sf.launch4j.config.SingleInstance toL4j() { 36 | net.sf.launch4j.config.SingleInstance ret = new net.sf.launch4j.config.SingleInstance(); 37 | 38 | ret.setMutexName(mutexName); 39 | ret.setWindowTitle(windowTitle); 40 | 41 | return ret; 42 | } 43 | 44 | } 45 | -------------------------------------------------------------------------------- /src/main/java/com/akathist/maven/plugins/launch4j/Splash.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Maven Launch4j Plugin 3 | * Copyright (c) 2006 Paul Jungwirth 4 | * Copyright (c) 2011-2025 Lukasz Lenart 5 | * 6 | * This program is free software; you can redistribute it and/or modify 7 | * it under the terms of the GNU General Public License as published by 8 | * the Free Software Foundation; either version 3 of the License, or 9 | * (at your option) any later version. 10 | * 11 | * This program is distributed in the hope that it will be useful, 12 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | * GNU General Public License for more details. 15 | * 16 | * You should have received a copy of the GNU General Public License 17 | * along with this program; if not, write to the Free Software 18 | * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA 19 | */ 20 | package com.akathist.maven.plugins.launch4j; 21 | 22 | import java.io.*; 23 | 24 | import org.apache.maven.plugins.annotations.Parameter; 25 | 26 | public class Splash { 27 | 28 | /** 29 | * The path (relative to the executable when distributed) to the splash page image. 30 | */ 31 | @Parameter 32 | File file; 33 | 34 | /** 35 | * If true, the splash screen will close automatically as soon as an error window or java window appears. 36 | * If false, the splash screen will not close until {@link #timeout} sections. Defaults to true. 37 | */ 38 | @Parameter(defaultValue = "true") 39 | boolean waitForWindow; 40 | 41 | /** 42 | * The number of seconds to keep the splash screen open before automatically closing it. 43 | * Defaults to 60. 44 | */ 45 | @Parameter(defaultValue = "60") 46 | int timeout; 47 | 48 | /** 49 | * If true, an error message will appear if the app hasn't started in {@link #timeout} seconds. 50 | * If false, the splash screen will close quietly. Defaults to true. 51 | */ 52 | @Parameter(defaultValue = "true") 53 | boolean timeoutErr; 54 | 55 | net.sf.launch4j.config.Splash toL4j() { 56 | net.sf.launch4j.config.Splash ret = new net.sf.launch4j.config.Splash(); 57 | 58 | ret.setFile(file); 59 | ret.setWaitForWindow(waitForWindow); 60 | ret.setTimeout(timeout); 61 | ret.setTimeoutErr(timeoutErr); 62 | 63 | return ret; 64 | } 65 | 66 | @Override 67 | public String toString() { 68 | return "Splash{" + 69 | "file=" + file + 70 | ", waitForWindow=" + waitForWindow + 71 | ", timeout=" + timeout + 72 | ", timeoutErr=" + timeoutErr + 73 | '}'; 74 | } 75 | } 76 | -------------------------------------------------------------------------------- /src/main/java/com/akathist/maven/plugins/launch4j/VersionInfo.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Maven Launch4j Plugin 3 | * Copyright (c) 2006 Paul Jungwirth 4 | * Copyright (c) 2011-2025 Lukasz Lenart 5 | * 6 | * This program is free software; you can redistribute it and/or modify 7 | * it under the terms of the GNU General Public License as published by 8 | * the Free Software Foundation; either version 3 of the License, or 9 | * (at your option) any later version. 10 | * 11 | * This program is distributed in the hope that it will be useful, 12 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | * GNU General Public License for more details. 15 | * 16 | * You should have received a copy of the GNU General Public License 17 | * along with this program; if not, write to the Free Software 18 | * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA 19 | */ 20 | package com.akathist.maven.plugins.launch4j; 21 | 22 | import com.akathist.maven.plugins.launch4j.generators.CopyrightGenerator; 23 | import com.akathist.maven.plugins.launch4j.generators.Launch4jFileVersionGenerator; 24 | import net.sf.launch4j.config.LanguageID; 25 | import org.apache.commons.lang3.StringUtils; 26 | import org.apache.maven.model.Organization; 27 | import org.apache.maven.plugin.logging.Log; 28 | import org.apache.maven.plugins.annotations.Parameter; 29 | import org.apache.maven.project.MavenProject; 30 | 31 | import java.io.File; 32 | import java.util.HashMap; 33 | import java.util.Map; 34 | 35 | /** 36 | * Information that appears in the Windows Explorer. 37 | */ 38 | public class VersionInfo { 39 | private static final Map LANGUAGE_TO_LANGUAGE_ID; 40 | 41 | static { 42 | LANGUAGE_TO_LANGUAGE_ID = new HashMap<>(); 43 | for (LanguageID languageID : LanguageID.values()) { 44 | LANGUAGE_TO_LANGUAGE_ID.put(languageID.name(), languageID); 45 | } 46 | } 47 | 48 | /** 49 | * Version number in x.x.x.x format. 50 | */ 51 | @Parameter 52 | String fileVersion; 53 | 54 | /** 55 | * Free-form version number, like "1.20.RC1." 56 | */ 57 | @Parameter 58 | String txtFileVersion; 59 | 60 | /** 61 | * File description shown to the user. 62 | */ 63 | @Parameter 64 | String fileDescription; 65 | 66 | /** 67 | * Legal copyright. 68 | */ 69 | @Parameter 70 | String copyright; 71 | 72 | /** 73 | * Version number in x.x.x.x format. 74 | */ 75 | @Parameter 76 | String productVersion; 77 | 78 | /** 79 | * Free-form version number, like "1.20.RC1." 80 | */ 81 | @Parameter 82 | String txtProductVersion; 83 | 84 | /** 85 | * The product name. 86 | */ 87 | @Parameter 88 | String productName; 89 | 90 | /** 91 | * The company name. 92 | */ 93 | @Parameter 94 | String companyName; 95 | 96 | /** 97 | * The internal name. For instance, you could use the filename without extension or the module name. 98 | */ 99 | @Parameter 100 | String internalName; 101 | 102 | /** 103 | * The original filename without path. Setting this lets you determine whether a user has renamed the file. 104 | */ 105 | @Parameter 106 | String originalFilename; 107 | 108 | /** 109 | * Language to be used during installation, default ENGLISH_US 110 | */ 111 | @Parameter 112 | String language = LanguageID.ENGLISH_US.name(); 113 | 114 | /** 115 | * Trademarks of author 116 | */ 117 | @Parameter 118 | String trademarks; 119 | 120 | private Log log; 121 | 122 | public VersionInfo() { 123 | } 124 | 125 | public VersionInfo(String fileVersion, String txtFileVersion, String fileDescription, 126 | String copyright, String productVersion, String txtProductVersion, 127 | String productName, String companyName, String internalName, 128 | String originalFilename, String language, String trademarks, 129 | Log log) { 130 | this.fileVersion = fileVersion; 131 | this.txtFileVersion = txtFileVersion; 132 | this.fileDescription = fileDescription; 133 | this.copyright = copyright; 134 | this.productVersion = productVersion; 135 | this.txtProductVersion = txtProductVersion; 136 | this.productName = productName; 137 | this.companyName = companyName; 138 | this.internalName = internalName; 139 | this.originalFilename = originalFilename; 140 | this.language = language; 141 | this.trademarks = trademarks; 142 | this.log = log; 143 | } 144 | 145 | public void setLog(Log log) { 146 | this.log = log; 147 | } 148 | 149 | net.sf.launch4j.config.VersionInfo toL4j() { 150 | net.sf.launch4j.config.VersionInfo ret = new net.sf.launch4j.config.VersionInfo(); 151 | 152 | ret.setFileVersion(fileVersion); 153 | ret.setTxtFileVersion(txtFileVersion); 154 | ret.setFileDescription(fileDescription); 155 | ret.setCopyright(copyright); 156 | ret.setProductVersion(productVersion); 157 | ret.setTxtProductVersion(txtProductVersion); 158 | ret.setProductName(productName); 159 | ret.setCompanyName(companyName); 160 | ret.setInternalName(internalName); 161 | ret.setOriginalFilename(originalFilename); 162 | setLanguage(ret); 163 | ret.setTrademarks(trademarks); 164 | 165 | return ret; 166 | } 167 | 168 | private void setLanguage(net.sf.launch4j.config.VersionInfo ret) { 169 | LanguageID languageID = LANGUAGE_TO_LANGUAGE_ID.get(language); 170 | if (languageID == null) { 171 | languageID = LanguageID.ENGLISH_US; 172 | } 173 | ret.setLanguage(languageID); 174 | } 175 | 176 | void tryFillOutByDefaults(MavenProject project, File outfile) { 177 | if (project == null) { 178 | throw new IllegalArgumentException("'project' is required, but it is null."); 179 | } 180 | if (outfile == null) { 181 | throw new IllegalArgumentException("'outfile' is required, but it is null."); 182 | } 183 | 184 | String version = getDefaultWhenSourceIsBlankAndLogWarn(project.getVersion(), "1.0.0", "project.version"); 185 | Organization organization = project.getOrganization(); 186 | String organizationName = "Default organization"; 187 | if(organization == null) { 188 | logWarningAboutDummyValue("project.organization.name", organizationName); 189 | } else { 190 | organizationName = getDefaultWhenSourceIsBlankAndLogWarn(organization.getName(), organizationName, "project.organization.name"); 191 | } 192 | 193 | tryFillOutByDefaultVersionInL4jFormat(version); 194 | tryFillOutCopyrightByDefaults( 195 | getDefaultWhenSourceIsBlankAndLogWarn(project.getInceptionYear(), "2020", "project.inceptionYear"), 196 | organizationName 197 | ); 198 | tryFillOutOrganizationRelatedDefaults(organizationName); 199 | tryFillOutSimpleValuesByDefaults( 200 | version, 201 | getDefaultWhenSourceIsBlankAndLogWarn(project.getName(), "Java Project", "project.name"), 202 | getDefaultWhenSourceIsBlankAndLogWarn(project.getArtifactId(), "java-project", "project.artifactId"), 203 | getDefaultWhenSourceIsBlankAndLogWarn(project.getDescription(), "A Java project.", "project.description") 204 | ); 205 | 206 | String outfileName = getDefaultWhenSourceIsBlankAndLogWarn(outfile.getName(), "app.exe", "outfile"); 207 | originalFilename = getDefaultWhenSourceIsBlank(originalFilename, outfileName); 208 | } 209 | 210 | private void tryFillOutByDefaultVersionInL4jFormat(String version) { 211 | String defaultFileVersion = Launch4jFileVersionGenerator.generate(version); 212 | 213 | fileVersion = getDefaultWhenSourceIsBlank(fileVersion, defaultFileVersion); 214 | productVersion = getDefaultWhenSourceIsBlank(productVersion, defaultFileVersion); 215 | } 216 | 217 | private void tryFillOutCopyrightByDefaults(String inceptionYear, String organizationName) { 218 | final String defaultCopyright = CopyrightGenerator.generate(inceptionYear, organizationName); 219 | copyright = getDefaultWhenSourceIsBlank(copyright, defaultCopyright); 220 | } 221 | 222 | private void tryFillOutOrganizationRelatedDefaults(String organizationName) { 223 | companyName = getDefaultWhenSourceIsBlank(companyName, organizationName); 224 | trademarks = getDefaultWhenSourceIsBlank(trademarks, organizationName); 225 | } 226 | 227 | private void tryFillOutSimpleValuesByDefaults(String version, 228 | String name, 229 | String artifactId, 230 | String description) { 231 | txtFileVersion = getDefaultWhenSourceIsBlank(txtFileVersion, version); 232 | txtProductVersion = getDefaultWhenSourceIsBlank(txtProductVersion, version); 233 | productName = getDefaultWhenSourceIsBlank(productName, name); 234 | internalName = getDefaultWhenSourceIsBlank(internalName, artifactId); 235 | fileDescription = getDefaultWhenSourceIsBlank(fileDescription, description); 236 | } 237 | 238 | private String getDefaultWhenSourceIsBlank(final String source, final String defaultValue) { 239 | if (StringUtils.isBlank(source)) { 240 | return defaultValue; 241 | } 242 | 243 | return source; 244 | } 245 | 246 | private String getDefaultWhenSourceIsBlankAndLogWarn(final String source, 247 | final String defaultValue, 248 | final String sourceParamName) { 249 | if (StringUtils.isBlank(source)) { 250 | logWarningAboutDummyValue(sourceParamName, defaultValue); 251 | 252 | return defaultValue; 253 | } 254 | 255 | return source; 256 | } 257 | 258 | private void logWarningAboutDummyValue(final String sourceParamName, final String dummyValue) { 259 | log.warn("Configuration param ${" + sourceParamName + "} is empty, so a dummy value \"" + dummyValue + "\" " + 260 | "might be used instead to fulfill some of VersionInfo params by defaults."); 261 | } 262 | 263 | @Override 264 | public String toString() { 265 | return "VersionInfo{" + 266 | "fileVersion='" + fileVersion + '\'' + 267 | ", txtFileVersion='" + txtFileVersion + '\'' + 268 | ", fileDescription='" + fileDescription + '\'' + 269 | ", copyright='" + copyright + '\'' + 270 | ", productVersion='" + productVersion + '\'' + 271 | ", txtProductVersion='" + txtProductVersion + '\'' + 272 | ", productName='" + productName + '\'' + 273 | ", companyName='" + companyName + '\'' + 274 | ", internalName='" + internalName + '\'' + 275 | ", originalFilename='" + originalFilename + '\'' + 276 | ", language='" + language + '\'' + 277 | ", trademarks='" + trademarks + '\'' + 278 | '}'; 279 | } 280 | } 281 | -------------------------------------------------------------------------------- /src/main/java/com/akathist/maven/plugins/launch4j/generators/CopyrightGenerator.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Licensed to the Apache Software Foundation (ASF) under one 3 | * or more contributor license agreements. See the NOTICE file 4 | * distributed with this work for additional information 5 | * regarding copyright ownership. The ASF licenses this file 6 | * to you under the Apache License, Version 2.0 (the 7 | * "License"); you may not use this file except in compliance 8 | * with the License. You may obtain a copy of the License at 9 | * 10 | * http://www.apache.org/licenses/LICENSE-2.0 11 | * 12 | * Unless required by applicable law or agreed to in writing, 13 | * software distributed under the License is distributed on an 14 | * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 15 | * KIND, either express or implied. See the License for the 16 | * specific language governing permissions and limitations 17 | * under the License. 18 | */ 19 | package com.akathist.maven.plugins.launch4j.generators; 20 | 21 | import org.apache.commons.lang3.StringUtils; 22 | 23 | import java.time.LocalDate; 24 | 25 | public class CopyrightGenerator { 26 | private CopyrightGenerator() { 27 | } 28 | 29 | /** 30 | * Parameters should be taken from MavenProject properties: 31 | * @param projectInceptionYear as ${project.inceptionYear} 32 | * @param projectOrganizationName as ${project.organization.name} 33 | * @return a string representing copyrights 34 | */ 35 | public static String generate(String projectInceptionYear, String projectOrganizationName) { 36 | String inceptionYear = generateInceptionYear(projectInceptionYear); 37 | int buildYear = LocalDate.now().getYear(); 38 | String organizationName = generateOrganizationName(projectOrganizationName); 39 | 40 | return String.format("Copyright © %s%d%s. All rights reserved.", inceptionYear, buildYear, organizationName); 41 | } 42 | 43 | private static String generateInceptionYear(String projectInceptionYear) { 44 | if(StringUtils.isNotBlank(projectInceptionYear)) { 45 | return projectInceptionYear + "-"; 46 | } 47 | 48 | return ""; 49 | } 50 | 51 | private static String generateOrganizationName(String projectOrganizationName) { 52 | if(StringUtils.isNotBlank(projectOrganizationName)) { 53 | return " " + projectOrganizationName; 54 | } 55 | 56 | return ""; 57 | } 58 | } 59 | -------------------------------------------------------------------------------- /src/main/java/com/akathist/maven/plugins/launch4j/generators/Launch4jFileVersionGenerator.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Licensed to the Apache Software Foundation (ASF) under one 3 | * or more contributor license agreements. See the NOTICE file 4 | * distributed with this work for additional information 5 | * regarding copyright ownership. The ASF licenses this file 6 | * to you under the Apache License, Version 2.0 (the 7 | * "License"); you may not use this file except in compliance 8 | * with the License. You may obtain a copy of the License at 9 | * 10 | * http://www.apache.org/licenses/LICENSE-2.0 11 | * 12 | * Unless required by applicable law or agreed to in writing, 13 | * software distributed under the License is distributed on an 14 | * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 15 | * KIND, either express or implied. See the License for the 16 | * specific language governing permissions and limitations 17 | * under the License. 18 | */ 19 | package com.akathist.maven.plugins.launch4j.generators; 20 | 21 | import java.util.Arrays; 22 | import java.util.List; 23 | import java.util.regex.Matcher; 24 | import java.util.regex.Pattern; 25 | 26 | public class Launch4jFileVersionGenerator { 27 | private static final int REQUIRED_NESTED_VERSION_LEVELS = 4; 28 | private static final String SIMPLE_PROJECT_VERSION_REGEX = "^((\\d(\\.)?)*\\d+)(-\\w+)?(?:-(?[\\w.-]+))?(?:\\+(?[\\w.-]+))?$"; 29 | private static final Pattern simpleProjectVersionPattern = Pattern.compile( 30 | SIMPLE_PROJECT_VERSION_REGEX, Pattern.CASE_INSENSITIVE | Pattern.UNICODE_CASE 31 | ); 32 | 33 | private Launch4jFileVersionGenerator() { 34 | } 35 | 36 | /** 37 | * Converts projectVersion into a format "x.x.x.x" ('x' as a number), which is required by Launch4j. 38 | *

39 | * For shorter versions like "x.x.x" it will append zeros (to the 4th level) at the end like "x.x.x.0". 40 | * Every text flag like "-SNAPSHOT" or "-alpha" will be cut off. 41 | * Too many nested numbers (more than 4 levels) will be cut off as well: "1.2.3.4.5.6" into "1.2.3.4". 42 | *

43 | * Param should be taken from MavenProject property: 44 | * @param projectVersion as ${project.version} 45 | * @return a string representing a file version of format x.x.x.x 46 | */ 47 | public static String generate(String projectVersion) { 48 | if(projectVersion == null) { 49 | return null; 50 | } 51 | if(!simpleProjectVersionPattern.matcher(projectVersion).matches()) { 52 | throw new IllegalArgumentException("'project.version' is in invalid format. Regex pattern: " + SIMPLE_PROJECT_VERSION_REGEX); 53 | } 54 | 55 | String versionLevels = removeTextFlags(projectVersion); 56 | String limitedVersionLevels = cutOffTooManyNestedLevels(versionLevels); 57 | 58 | return appendMissingNestedLevelsByZeros(limitedVersionLevels); 59 | } 60 | 61 | private static String removeTextFlags(String version) { 62 | Pattern pattern = Pattern.compile("[-+]"); 63 | Matcher matcher = pattern.matcher(version); 64 | if (matcher.find()) { 65 | return version.substring(0, matcher.start()); 66 | } else { 67 | return version; 68 | } 69 | } 70 | 71 | private static String cutOffTooManyNestedLevels(String versionLevels) { 72 | String[] levels = versionLevels.split("\\."); 73 | 74 | if(levels.length > REQUIRED_NESTED_VERSION_LEVELS) { 75 | List limitedLevels = Arrays.asList(levels) 76 | .subList(0, REQUIRED_NESTED_VERSION_LEVELS); 77 | return String.join(".", limitedLevels); 78 | } 79 | 80 | return versionLevels; 81 | } 82 | 83 | private static String appendMissingNestedLevelsByZeros(String versionLevels) { 84 | String[] levels = versionLevels.split("\\."); 85 | 86 | StringBuilder filledLevels = new StringBuilder(versionLevels); 87 | for (int i = levels.length; i < REQUIRED_NESTED_VERSION_LEVELS; i++) { 88 | filledLevels.append(".0"); 89 | } 90 | 91 | return filledLevels.toString(); 92 | } 93 | } 94 | -------------------------------------------------------------------------------- /src/main/java/com/akathist/maven/plugins/launch4j/tools/ResourceIO.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Licensed to the Apache Software Foundation (ASF) under one 3 | * or more contributor license agreements. See the NOTICE file 4 | * distributed with this work for additional information 5 | * regarding copyright ownership. The ASF licenses this file 6 | * to you under the Apache License, Version 2.0 (the 7 | * "License"); you may not use this file except in compliance 8 | * with the License. You may obtain a copy of the License at 9 | * 10 | * http://www.apache.org/licenses/LICENSE-2.0 11 | * 12 | * Unless required by applicable law or agreed to in writing, 13 | * software distributed under the License is distributed on an 14 | * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 15 | * KIND, either express or implied. See the License for the 16 | * specific language governing permissions and limitations 17 | * under the License. 18 | */ 19 | package com.akathist.maven.plugins.launch4j.tools; 20 | 21 | import java.io.BufferedInputStream; 22 | import java.io.BufferedOutputStream; 23 | import java.io.ByteArrayOutputStream; 24 | import java.io.File; 25 | import java.io.FileInputStream; 26 | import java.io.FileOutputStream; 27 | import java.io.IOException; 28 | import java.io.InputStream; 29 | import java.util.Arrays; 30 | 31 | final public class ResourceIO { 32 | 33 | private static final int DEFAULT_BUFFER_SIZE = 4 * 1024; 34 | 35 | private ResourceIO() { 36 | // avoids creating an instance of this class 37 | } 38 | 39 | private static byte[] readAllBytes(InputStream is) throws IOException { 40 | ByteArrayOutputStream baos = new ByteArrayOutputStream(); 41 | 42 | byte[] buf = new byte[DEFAULT_BUFFER_SIZE]; 43 | int bytesRead; 44 | while ((bytesRead = is.read(buf)) != -1) { 45 | baos.write(buf, 0, bytesRead); 46 | } 47 | 48 | return baos.toByteArray(); 49 | } 50 | 51 | public static byte[] readResourceAsBytes(String resName) throws IOException { 52 | ClassLoader cl = Thread.currentThread().getContextClassLoader(); 53 | try (InputStream is = cl.getResourceAsStream(resName)) { 54 | if (is == null) { 55 | throw new IOException("Resource not found: " + resName); 56 | } 57 | return readAllBytes(is); 58 | } 59 | } 60 | 61 | public static void writeBytesIfDiff(File outFile, byte[] outBytes) throws IOException { 62 | if (outFile.exists()) { 63 | byte[] existingBytes = readBytes(outFile); 64 | if (Arrays.equals(outBytes, existingBytes)) { 65 | return; 66 | } 67 | } 68 | writeBytes(outFile, outBytes); 69 | } 70 | 71 | public static byte[] readBytes(File inFile) throws IOException { 72 | try ( 73 | FileInputStream fis = new FileInputStream(inFile); 74 | BufferedInputStream bis = new BufferedInputStream(fis) 75 | ) { 76 | return readAllBytes(bis); 77 | } 78 | } 79 | 80 | public static void writeBytes(File outFile, byte[] outBytes) throws IOException { 81 | try ( 82 | FileOutputStream fos = new FileOutputStream(outFile, false); 83 | BufferedOutputStream bos = new BufferedOutputStream(fos) 84 | ) { 85 | bos.write(outBytes); 86 | bos.flush(); 87 | } 88 | } 89 | } 90 | -------------------------------------------------------------------------------- /src/main/legal/LICENSE.txt: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /src/main/legal/XStream.LICENSE.txt: -------------------------------------------------------------------------------- 1 | Copyright (c) 2003-2006, Joe Walnes 2 | Copyright (c) 2006-2015 XStream Committers 3 | All rights reserved. 4 | 5 | Redistribution and use in source and binary forms, with or without 6 | modification, are permitted provided that the following conditions are met: 7 | 8 | 1. Redistributions of source code must retain the above copyright notice, this list of 9 | conditions and the following disclaimer. 10 | 11 | 2. Redistributions in binary form must reproduce the above copyright notice, this list of 12 | conditions and the following disclaimer in the documentation and/or other materials provided 13 | with the distribution. 14 | 15 | 3. Neither the name of XStream nor the names of its contributors may be used to endorse 16 | or promote products derived from this software without specific prior written 17 | permission. 18 | 19 | THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY 20 | EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 21 | OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT 22 | SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, 23 | INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED 24 | TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR 25 | BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 26 | CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY 27 | WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH 28 | DAMAGE. 29 | -------------------------------------------------------------------------------- /src/main/legal/commons.LICENSE.txt: -------------------------------------------------------------------------------- 1 | 2 | Apache License 3 | Version 2.0, January 2004 4 | http://www.apache.org/licenses/ 5 | 6 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 7 | 8 | 1. Definitions. 9 | 10 | "License" shall mean the terms and conditions for use, reproduction, 11 | and distribution as defined by Sections 1 through 9 of this document. 12 | 13 | "Licensor" shall mean the copyright owner or entity authorized by 14 | the copyright owner that is granting the License. 15 | 16 | "Legal Entity" shall mean the union of the acting entity and all 17 | other entities that control, are controlled by, or are under common 18 | control with that entity. For the purposes of this definition, 19 | "control" means (i) the power, direct or indirect, to cause the 20 | direction or management of such entity, whether by contract or 21 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 22 | outstanding shares, or (iii) beneficial ownership of such entity. 23 | 24 | "You" (or "Your") shall mean an individual or Legal Entity 25 | exercising permissions granted by this License. 26 | 27 | "Source" form shall mean the preferred form for making modifications, 28 | including but not limited to software source code, documentation 29 | source, and configuration files. 30 | 31 | "Object" form shall mean any form resulting from mechanical 32 | transformation or translation of a Source form, including but 33 | not limited to compiled object code, generated documentation, 34 | and conversions to other media types. 35 | 36 | "Work" shall mean the work of authorship, whether in Source or 37 | Object form, made available under the License, as indicated by a 38 | copyright notice that is included in or attached to the work 39 | (an example is provided in the Appendix below). 40 | 41 | "Derivative Works" shall mean any work, whether in Source or Object 42 | form, that is based on (or derived from) the Work and for which the 43 | editorial revisions, annotations, elaborations, or other modifications 44 | represent, as a whole, an original work of authorship. For the purposes 45 | of this License, Derivative Works shall not include works that remain 46 | separable from, or merely link (or bind by name) to the interfaces of, 47 | the Work and Derivative Works thereof. 48 | 49 | "Contribution" shall mean any work of authorship, including 50 | the original version of the Work and any modifications or additions 51 | to that Work or Derivative Works thereof, that is intentionally 52 | submitted to Licensor for inclusion in the Work by the copyright owner 53 | or by an individual or Legal Entity authorized to submit on behalf of 54 | the copyright owner. For the purposes of this definition, "submitted" 55 | means any form of electronic, verbal, or written communication sent 56 | to the Licensor or its representatives, including but not limited to 57 | communication on electronic mailing lists, source code control systems, 58 | and issue tracking systems that are managed by, or on behalf of, the 59 | Licensor for the purpose of discussing and improving the Work, but 60 | excluding communication that is conspicuously marked or otherwise 61 | designated in writing by the copyright owner as "Not a Contribution." 62 | 63 | "Contributor" shall mean Licensor and any individual or Legal Entity 64 | on behalf of whom a Contribution has been received by Licensor and 65 | subsequently incorporated within the Work. 66 | 67 | 2. Grant of Copyright License. Subject to the terms and conditions of 68 | this License, each Contributor hereby grants to You a perpetual, 69 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 70 | copyright license to reproduce, prepare Derivative Works of, 71 | publicly display, publicly perform, sublicense, and distribute the 72 | Work and such Derivative Works in Source or Object form. 73 | 74 | 3. Grant of Patent License. Subject to the terms and conditions of 75 | this License, each Contributor hereby grants to You a perpetual, 76 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 77 | (except as stated in this section) patent license to make, have made, 78 | use, offer to sell, sell, import, and otherwise transfer the Work, 79 | where such license applies only to those patent claims licensable 80 | by such Contributor that are necessarily infringed by their 81 | Contribution(s) alone or by combination of their Contribution(s) 82 | with the Work to which such Contribution(s) was submitted. If You 83 | institute patent litigation against any entity (including a 84 | cross-claim or counterclaim in a lawsuit) alleging that the Work 85 | or a Contribution incorporated within the Work constitutes direct 86 | or contributory patent infringement, then any patent licenses 87 | granted to You under this License for that Work shall terminate 88 | as of the date such litigation is filed. 89 | 90 | 4. Redistribution. You may reproduce and distribute copies of the 91 | Work or Derivative Works thereof in any medium, with or without 92 | modifications, and in Source or Object form, provided that You 93 | meet the following conditions: 94 | 95 | (a) You must give any other recipients of the Work or 96 | Derivative Works a copy of this License; and 97 | 98 | (b) You must cause any modified files to carry prominent notices 99 | stating that You changed the files; and 100 | 101 | (c) You must retain, in the Source form of any Derivative Works 102 | that You distribute, all copyright, patent, trademark, and 103 | attribution notices from the Source form of the Work, 104 | excluding those notices that do not pertain to any part of 105 | the Derivative Works; and 106 | 107 | (d) If the Work includes a "NOTICE" text file as part of its 108 | distribution, then any Derivative Works that You distribute must 109 | include a readable copy of the attribution notices contained 110 | within such NOTICE file, excluding those notices that do not 111 | pertain to any part of the Derivative Works, in at least one 112 | of the following places: within a NOTICE text file distributed 113 | as part of the Derivative Works; within the Source form or 114 | documentation, if provided along with the Derivative Works; or, 115 | within a display generated by the Derivative Works, if and 116 | wherever such third-party notices normally appear. The contents 117 | of the NOTICE file are for informational purposes only and 118 | do not modify the License. You may add Your own attribution 119 | notices within Derivative Works that You distribute, alongside 120 | or as an addendum to the NOTICE text from the Work, provided 121 | that such additional attribution notices cannot be construed 122 | as modifying the License. 123 | 124 | You may add Your own copyright statement to Your modifications and 125 | may provide additional or different license terms and conditions 126 | for use, reproduction, or distribution of Your modifications, or 127 | for any such Derivative Works as a whole, provided Your use, 128 | reproduction, and distribution of the Work otherwise complies with 129 | the conditions stated in this License. 130 | 131 | 5. Submission of Contributions. Unless You explicitly state otherwise, 132 | any Contribution intentionally submitted for inclusion in the Work 133 | by You to the Licensor shall be under the terms and conditions of 134 | this License, without any additional terms or conditions. 135 | Notwithstanding the above, nothing herein shall supersede or modify 136 | the terms of any separate license agreement you may have executed 137 | with Licensor regarding such Contributions. 138 | 139 | 6. Trademarks. This License does not grant permission to use the trade 140 | names, trademarks, service marks, or product names of the Licensor, 141 | except as required for reasonable and customary use in describing the 142 | origin of the Work and reproducing the content of the NOTICE file. 143 | 144 | 7. Disclaimer of Warranty. Unless required by applicable law or 145 | agreed to in writing, Licensor provides the Work (and each 146 | Contributor provides its Contributions) on an "AS IS" BASIS, 147 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 148 | implied, including, without limitation, any warranties or conditions 149 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 150 | PARTICULAR PURPOSE. You are solely responsible for determining the 151 | appropriateness of using or redistributing the Work and assume any 152 | risks associated with Your exercise of permissions under this License. 153 | 154 | 8. Limitation of Liability. In no event and under no legal theory, 155 | whether in tort (including negligence), contract, or otherwise, 156 | unless required by applicable law (such as deliberate and grossly 157 | negligent acts) or agreed to in writing, shall any Contributor be 158 | liable to You for damages, including any direct, indirect, special, 159 | incidental, or consequential damages of any character arising as a 160 | result of this License or out of the use or inability to use the 161 | Work (including but not limited to damages for loss of goodwill, 162 | work stoppage, computer failure or malfunction, or any and all 163 | other commercial damages or losses), even if such Contributor 164 | has been advised of the possibility of such damages. 165 | 166 | 9. Accepting Warranty or Additional Liability. While redistributing 167 | the Work or Derivative Works thereof, You may choose to offer, 168 | and charge a fee for, acceptance of support, warranty, indemnity, 169 | or other liability obligations and/or rights consistent with this 170 | License. However, in accepting such obligations, You may act only 171 | on Your own behalf and on Your sole responsibility, not on behalf 172 | of any other Contributor, and only if You agree to indemnify, 173 | defend, and hold each Contributor harmless for any liability 174 | incurred by, or claims asserted against, such Contributor by reason 175 | of your accepting any such warranty or additional liability. 176 | 177 | END OF TERMS AND CONDITIONS 178 | 179 | APPENDIX: How to apply the Apache License to your work. 180 | 181 | To apply the Apache License to your work, attach the following 182 | boilerplate notice, with the fields enclosed by brackets "[]" 183 | replaced with your own identifying information. (Don't include 184 | the brackets!) The text should be enclosed in the appropriate 185 | comment syntax for the file format. We also recommend that a 186 | file or class name and description of purpose be included on the 187 | same "printed page" as the copyright notice for easier 188 | identification within third-party archives. 189 | 190 | Copyright [yyyy] [name of copyright owner] 191 | 192 | Licensed under the Apache License, Version 2.0 (the "License"); 193 | you may not use this file except in compliance with the License. 194 | You may obtain a copy of the License at 195 | 196 | http://www.apache.org/licenses/LICENSE-2.0 197 | 198 | Unless required by applicable law or agreed to in writing, software 199 | distributed under the License is distributed on an "AS IS" BASIS, 200 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 201 | See the License for the specific language governing permissions and 202 | limitations under the License. 203 | -------------------------------------------------------------------------------- /src/main/resources/META-INF/resources/manifest-require_admin_rights-v1.xml: -------------------------------------------------------------------------------- 1 | 2 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | -------------------------------------------------------------------------------- /src/main/resources/MOJO.md: -------------------------------------------------------------------------------- 1 | # Launch4j Maven plugin – launch4j:launch4j 2 | 3 | **Description**: 4 | 5 | Wraps a jar in a Windows executable. 6 | 7 | **Attributes**: 8 | 9 | * Requires a Maven project to be executed. 10 | * Requires dependency resolution of artifacts in scope: `runtime`. 11 | * The goal is thread-safe and supports parallel builds. 12 | * Binds by default to the [lifecycle phase](http://maven.apache.org/ref/current/maven-core/lifecycles.html): `package`. 13 | 14 | ### Parameter Details 15 | 16 | #### **\** 17 | 18 | Changes to the given directory, relative to the executable, before running your jar. If set to `.` the current directory will be where the executable is. If omitted, the directory will not be changed. 19 | 20 | * **Type**: `java.lang.String` 21 | * **Required**: `No` 22 | 23 | * * * 24 | 25 | #### **\** 26 | 27 | Details about the classpath your application should have. This is required if you are not wrapping a jar. 28 | 29 | * **Type**: `com.akathist.maven.plugins.launch4j.ClassPath` 30 | * **Required**: `No` 31 | 32 | * * * 33 | 34 | #### **\** 35 | 36 | Constant command line arguments to pass to your program's main method. Actual command line arguments entered by the user will appear after these. 37 | 38 | * **Type**: `java.lang.String` 39 | * **Required**: `No` 40 | 41 | * * * 42 | 43 | #### **\** 44 | 45 | If `saveConfig` is set to true, config will be written to this file 46 | 47 | * **Type**: `java.io.File` 48 | * **Required**: `No` 49 | * **Default**: `${project.build.directory}/launch4j-config.xml` 50 | 51 | * * * 52 | 53 | #### **\** 54 | 55 | Whether the executable should wrap the jar or not. 56 | 57 | * **Type**: `boolean` 58 | * **Required**: `No` 59 | * **Default**: `false` 60 | 61 | * * * 62 | 63 | #### **\** 64 | 65 | downloadUrl (?). 66 | 67 | * **Type**: `java.lang.String` 68 | * **Required**: `No` 69 | 70 | * * * 71 | 72 | #### **\** 73 | 74 | The title of the error popup if something goes wrong trying to run your program, like if java can't be found. If this is a console app and not a gui, then this value is used to prefix any error messages, as in ${errTitle}: ${errorMessage}. 75 | 76 | * **Type**: `java.lang.String` 77 | * **Required**: `No` 78 | * **Default**: `${project.name}` 79 | 80 | * * * 81 | 82 | #### **\** 83 | 84 | Whether you want a gui or console app. Valid values are "gui" and "console." If you say gui, then launch4j will run your app from javaw instead of java in order to avoid opening a DOS window. Choosing gui also enables other options like taskbar icon and a splash screen. 85 | 86 | * **Type**: `java.lang.String` 87 | * **Required**: `No` 88 | 89 | * * * 90 | 91 | #### **\** 92 | 93 | The icon to use in the taskbar. Must be in ico format. 94 | 95 | * **Type**: `java.io.File` 96 | * **Required**: `No` 97 | 98 | * * * 99 | 100 | #### **\** 101 | 102 | The name of the Launch4j native configuration file The path, if relative, is relative to the pom.xml. 103 | 104 | * **Type**: `java.io.File` 105 | * **Required**: `No` 106 | 107 | * * * 108 | 109 | #### **\** 110 | 111 | The jar to bundle inside the executable. The path, if relative, is relative to the pom.xml. If you don't want to wrap the jar, then this value should be the runtime path to the jar relative to the executable. You should also set dontWrapJar to true. You can only bundle a single jar. Therefore, you should either create a jar that contains your own code plus all your dependencies, or you should distribute your dependencies alongside the executable. 112 | 113 | * **Type**: `java.lang.String` 114 | * **Required**: `No` 115 | * **Default**: `${project.build.directory}/${project.build.finalName}.jar` 116 | 117 | * * * 118 | 119 | #### **\** 120 | 121 | Details about the supported jres. 122 | 123 | * **Type**: `com.akathist.maven.plugins.launch4j.Jre` 124 | * **Required**: `No` 125 | 126 | * * * 127 | 128 | #### **\** 129 | 130 | Win32 libraries to include. Used for custom headers only. 131 | 132 | * **Type**: `java.util.List` 133 | * **Required**: `No` 134 | 135 | * * * 136 | 137 | #### **\** 138 | 139 | Windows manifest file (a XML file) with the same name as .exe file (myapp.exe.manifest) 140 | 141 | * **Type**: `java.io.File` 142 | * **Required**: `No` 143 | 144 | * * * 145 | 146 | #### **\** 147 | 148 | Various messages you can display. 149 | 150 | * **Type**: `com.akathist.maven.plugins.launch4j.Messages` 151 | * **Required**: `No` 152 | 153 | * * * 154 | 155 | #### **\** 156 | 157 | Object files to include. Used for custom headers only. 158 | 159 | * **Type**: `java.util.List` 160 | * **Required**: `No` 161 | 162 | * * * 163 | 164 | #### **\** 165 | 166 | The name of the executable you want launch4j to produce. The path, if relative, is relative to the pom.xml. 167 | 168 | * **Type**: `java.io.File` 169 | * **Required**: `No` 170 | * **Default**: `${project.build.directory}/${project.artifactId}.exe` 171 | 172 | * * * 173 | 174 | #### **\** 175 | 176 | If set to true, a synchronized block will be used to protect resources 177 | 178 | * **Type**: `boolean` 179 | * **Required**: `No` 180 | * **Default**: `false` 181 | 182 | * * * 183 | 184 | #### **\** 185 | 186 | The dependencies of this plugin. Used to get the Launch4j artifact version. 187 | 188 | * **Type**: `java.util.List` 189 | * **Required**: `No` 190 | * **Default**: `${plugin.artifacts}` 191 | 192 | * * * 193 | 194 | #### **\** 195 | 196 | Priority class of windows process. Valid values are "normal" (default), "idle" and "high". 197 | 198 | * **Type**: `java.lang.String` 199 | * **Required**: `No` 200 | * **Default**: `normal` 201 | 202 | * * * 203 | 204 | #### **\** 205 | 206 | If true, when the application exits, any exit code other than 0 is considered a crash and the application will be started again. 207 | 208 | * **Type**: `boolean` 209 | * **Required**: `No` 210 | * **Default**: `false` 211 | 212 | * * * 213 | 214 | #### **\** 215 | 216 | If set to true it will save final config into a XML file 217 | 218 | * **Type**: `boolean` 219 | * **Required**: `No` 220 | * **Default**: `false` 221 | 222 | * * * 223 | 224 | #### **\** 225 | 226 | Details about whether to run as a single instance. 227 | 228 | * **Type**: `com.akathist.maven.plugins.launch4j.SingleInstance` 229 | * **Required**: `No` 230 | 231 | * * * 232 | 233 | #### **\** 234 | 235 | If set to true, execution of the plugin will be skipped 236 | 237 | * **Type**: `boolean` 238 | * **Required**: `No` 239 | * **Default**: `false` 240 | 241 | * * * 242 | 243 | #### **\** 244 | 245 | Details about the splash screen. 246 | 247 | * **Type**: `com.akathist.maven.plugins.launch4j.Splash` 248 | * **Required**: `No` 249 | 250 | * * * 251 | 252 | #### **\** 253 | 254 | If true, the executable waits for the java application to finish before returning its exit code. Defaults to false for gui applications. Has no effect for console applications, which always wait. 255 | 256 | * **Type**: `boolean` 257 | * **Required**: `No` 258 | * **Default**: `false` 259 | 260 | * * * 261 | 262 | #### **\** 263 | 264 | supportUrl (?). 265 | 266 | * **Type**: `java.lang.String` 267 | * **Required**: `No` 268 | 269 | * * * 270 | 271 | #### **\** 272 | 273 | Variables to set. 274 | 275 | * **Type**: `java.util.List` 276 | * **Required**: `No` 277 | 278 | * * * 279 | 280 | #### **\** 281 | 282 | Lots of information you can attach to the windows process. 283 | 284 | * **Type**: `com.akathist.maven.plugins.launch4j.VersionInfo` 285 | * **Required**: `No` 286 | 287 | The full list of all the `VersionInfo` parameters is available [here](./VERSIONINFO.md). 288 | 289 | * * * 290 | 291 | #### **\** 292 | 293 | If `disableVersionInfoDefaults` is set to true, it will prevent filling out the VersionInfo params with default values. 294 | 295 | * **Type**: `boolean` 296 | * **Required**: `No` 297 | * **Default**: `false` 298 | 299 | * * * -------------------------------------------------------------------------------- /src/main/resources/README.adoc: -------------------------------------------------------------------------------- 1 | = Maven Launch4j Plugin 2 | 3 | Copyright (C) 2006 Paul Jungwirth with additional changes by Lukasz Lenart 4 | version 1.7.4, 13 February 2015 5 | 6 | :toc: 7 | 8 | == Description 9 | 10 | http://launch4j.sourceforge.net/[Launch4j] by Grzegorz Kowal wraps a jar file 11 | in a Windows executable to ease deployment of Java desktop applications. You 12 | can either bundle a JRE or tell Launch4j to search the hard drive for an 13 | existing one. If none is found, then Launch4j will show the user a download 14 | page. Launch4j has many features. You can create either GUI or console 15 | applications. You can show a splash screen while the JRE loads, give your 16 | application a custom icon in the Windows task bar, set a more descriptive 17 | process name (other than "java"), and set a variety of other process attributes. 18 | 19 | You can run Launch4j on Windows, Linux, Solaris, or OS X. You specify the 20 | configuration through an XML file. Please see the Launch4j site for more 21 | information on this file. You can also set your configuration via the Launch4j 22 | GUI. 23 | 24 | The Maven plugin for Launch4j lets you generate the Launch4j executable as part 25 | of the Maven build process. It supports Maven 2.0.4 and Launch4j 3.x. 26 | Depending on your operating system, the plugin will download an additional artifact 27 | containing platform-specific binaries that Launch4j uses to create the 28 | executable. This artifact is treated like any other Maven dependency, so it is 29 | only downloaded the first time you need it. 30 | 31 | == Adding plugin to pom.xml 32 | 33 | Using the Maven plugin, you specify the Launch4j configuration in your POM. I 34 | hope to add support for external configuration files, but right now you have to 35 | use the POM. The format of this configuration is very similar to the standard 36 | Launch4j XML format. There are two main differences. First, any lists of 37 | like-named elements must appear in a wrapper element. For example, you can't 38 | say: 39 | 40 | [source,xml] 41 | ---- 42 | logo.bin 43 | this=that 44 | foo=bar 45 | blep=blurp 46 | ---- 47 | 48 | You must say: 49 | 50 | [source,xml] 51 | ---- 52 | logo.bin 53 | 54 | this=that 55 | foo=bar 56 | blep=blurp 57 | 58 | ---- 59 | 60 | Likewise for `` and `` elements. 61 | 62 | Second, the sub-elements of the `` element are a little different. 63 | This is so you can set the classpath based on your dependencies. `` 64 | still takes a `` element, but it does not take ``. Instead, it 65 | supports these children: 66 | 67 | * `` - If you set this to "true," the plugin will build your 68 | classpath based on all dependencies in the runtime and 69 | compile scopes. This is on by default. 70 | 71 | * `` - If you are using the addDependencies feature, you can 72 | use this option to add a prefix before each jar's name. 73 | This is useful if you are bundling your app with the 74 | executable alongside a lib directory that contains all 75 | your jars. If that's what you're doing, you would specify 76 | `lib/`. 77 | 78 | * `` - Use this to add classpath entries before the automatically- 79 | generated list. This element functions whether you have 80 | enabled `` or not. Entries in the list should 81 | be separated by semicolons, as in a Windows-style `CLASSPATH` 82 | variable. 83 | 84 | * `` - Use this to add classpath entries after the automatically- 85 | generated list. This element functions whether you have 86 | enabled `` or not. Entries in the list should 87 | be separated by semicolons, as in a Windows-style `CLASSPATH` 88 | variable. 89 | 90 | Other than these changes, the XML format is just like Launch4j's standard 91 | format. 92 | 93 | == Examples 94 | 95 | === Single-module project 96 | 97 | By default, the Launch4j plugin is bound to the package phase. Suppose you have 98 | a single-module project named encc. It is a console application, not a GUI. It 99 | is packaged as a jar, so the jarring runs automatically during the package 100 | phase before anything else. You want to use launch4j to create an executable 101 | and then use the assembly plugin to bundle everything up. You could bind both 102 | launch4j and assembly to the package phase with a POM like this: 103 | 104 | 105 | [source,xml] 106 | ---- 107 | 108 | . . . 109 | com.akathist.encc 110 | encc 111 | jar 112 | . . . 113 | 114 | 115 | 116 | com.akathist.maven.plugins.launch4j 117 | launch4j-maven-plugin 118 | 119 | 120 | l4j-clui 121 | package 122 | launch4j 123 | 124 | console 125 | target/encc.exe 126 | target/encc-1.0.jar 127 | encc 128 | 129 | com.akathist.encc.Clui 130 | false 131 | anything 132 | 133 | 134 | 1.5.0 135 | 136 | -Djava.endorsed.dirs=./endorsed 137 | 138 | 139 | 140 | 1.2.3.4 141 | txt file version? 142 | a description 143 | my copyright 144 | 4.3.2.1 145 | txt product version 146 | E-N-C-C 147 | ccne 148 | original.exe 149 | 150 | 151 | 152 | 153 | 154 | 155 | maven-assembly-plugin 156 | 157 | 158 | assembly 159 | package 160 | single 161 | 162 | 163 | assembly.xml 164 | 165 | 166 | 167 | 168 | 169 | 170 | 171 | . . . 172 | 173 | ---- 174 | 175 | Note that when you bind the assembly plugin to a phase, you must use 176 | `assembly:single`, not `assembly:assembly`, to prevent its forking a parallel 177 | lifecycle and running everything twice. 178 | 179 | === GUI and console mode 180 | 181 | Or suppose your application can run in either GUI or console mode, and you want 182 | to create separate executables for each. Then your POM would look like this: 183 | 184 | [source,xml] 185 | ---- 186 | 187 | . . . 188 | com.akathist.encc 189 | encc 190 | jar 191 | . . . 192 | 193 | 194 | 195 | com.akathist.maven.plugins.launch4j 196 | launch4j-maven-plugin 197 | 198 | 199 | l4j-clui 200 | package 201 | launch4j 202 | 203 | console 204 | target/encc.exe 205 | target/encc-1.0.jar 206 | encc 207 | 208 | com.akathist.encc.Clui 209 | false 210 | anything 211 | 212 | 213 | 1.5.0 214 | 215 | 216 | 1.2.3.4 217 | txt file version? 218 | a description 219 | my copyright 220 | 4.3.2.1 221 | txt product version 222 | E-N-C-C 223 | ccne 224 | original.exe 225 | 226 | 227 | 228 | 229 | l4j-gui 230 | package 231 | launch4j 232 | 233 | gui 234 | target/enccg.exe 235 | target/encc-1.0.jar 236 | enccg 237 | 238 | com.akathist.encc.Gui 239 | 240 | 241 | 1.5.0 242 | 243 | 244 | 1.2.3.4 245 | txt file version? 246 | a description 247 | my copyright 248 | 4.3.2.1 249 | txt product version 250 | E-N-C-C 251 | ccne 252 | original.exe 253 | 254 | 255 | 256 | 257 | 258 | 259 | maven-assembly-plugin 260 | 261 | 262 | assembly 263 | package 264 | single 265 | 266 | 267 | assembly.xml 268 | 269 | 270 | 271 | 272 | 273 | 274 | 275 | . . . 276 | 277 | ---- 278 | 279 | === Example `assembly.xml` 280 | 281 | Here is a simple assmbly defintion to build a zip file with executable artifact included. 282 | 283 | ---- 284 | 287 | cdc-upgrade 288 | 289 | zip 290 | 291 | false 292 | 293 | 294 | ${project.build.directory}/package 295 | / 296 | 297 | *.exe 298 | 299 | 300 | 301 | 302 | ---- 303 | 304 | If you have any questions, please register a ticket! 305 | 306 | Enjoy! 307 | -------------------------------------------------------------------------------- /src/main/resources/TODO: -------------------------------------------------------------------------------- 1 | + Instead of distributing all the binary files together, 2 | distrubte them separately and pull down the right one as needed, based on a system property. 3 | Look at maven-dependency-plugin for code on grabbing dependencies--and unpacking them. 4 | 5 | + give version ranges for our dependencies so we play nice in people's projects. 6 | 7 | + By default, generate the element automatically from the dependencies. 8 | 9 | - What is up with downloading xstream every time? 10 | 11 | + Add a license file of my own. 12 | 13 | + Add license comment blocks to all files. 14 | 15 | + Use mvn site to generate a site for this plugin. 16 | - javadoc should include private fields. 17 | - put something like the README in the index.html file. 18 | 19 | + Use maven to generate a source distro for this plugin. 20 | 21 | - Use maven release to release new versions. 22 | 23 | - Add to : 24 | 25 | 26 | 27 | 28 | 29 | ... 30 | 31 | 32 | + Use ftp in to make updating my online repository easy. 33 | But don't put this in the POM with username & password, because that gets posted publicly! 34 | + getting NPE from ftp-wagon. (this was because I was missing a matching in ~/.m2/settings.xml) 35 | 36 | - add a snapshot repository, too. 37 | 38 | - Don't run launch4j unless the inputs are newer than the output? 39 | 40 | + Improve logic on whether to unjar: 41 | + After unjarring, write the marker file. 42 | + If the marker is there and newer than the jar, don't unjar. 43 | + But if the jar is newer, unjar anyway. 44 | + After unjarring, either write the marker file or touch it. 45 | 46 | - dontWrapJar doesn't work? 47 | from an email: 48 | However (sorry!) I can't get to work. I have tried every combination of "target/" or "./", including using backslashes (in case of a platform specific-issue) but each results in: 49 | "Specify runtime path of the jar relative to executable" 50 | 51 | I would expect the following config should have worked. I have confirmed that it works from the root of the project using the commandline launch4j. 52 | 53 | target/app.exe 54 | app-1.0.jar 55 | 56 | - support bundling the JRE (or figure out what parameters already allow this) 57 | . 58 | 59 | -------------------------------------------------------------------------------- /src/main/resources/VERSIONINFO.md: -------------------------------------------------------------------------------- 1 | # VersionInfo parameters 2 | 3 | ### Description. 4 | 5 | This file describes the `VersionInfo` parameters. 6 | 7 | * **Type**: `com.akathist.maven.plugins.launch4j.VersionInfo` 8 | 9 | Every parameter (including their parent `VersionInfo`) have a default value defined. 10 | To fulfill them by default values you need to make sure that **\** inside plugin configuration is set to `false`. 11 | 12 | ### Parameter Details 13 | 14 | #### **\** 15 | 16 | Version number in `x.x.x.x` format. 17 | 18 | * **Type**: `java.lang.String` 19 | * **Required**: `Yes` 20 | * **Default**: `${project.version}` converted into a `x.x.x.x` format. 21 | 22 | Conversion into a `x.x.x.x` format have specific constraints: 23 | * `x` as a number 24 | * shorter project versions like `x.x.x` will have appended zeros (to the 4th level) like `x.x.x.0` 25 | * every text flag like "-SNAPSHOT" or "-alpha" will be cut off 26 | * too many nested levels (>4) will be cut off as well. Example input: `1.2.3.4.5.6`, output: `1.2.3.4`. 27 | 28 | * * * 29 | 30 | #### **\** 31 | 32 | Free-form version number, like "1.20.RC1." 33 | 34 | * **Type**: `java.lang.String` 35 | * **Required**: `Yes` 36 | * **Default**: `${project.version}` 37 | 38 | * * * 39 | 40 | #### **\** 41 | 42 | File description shown to the user. 43 | 44 | * **Type**: `java.lang.String` 45 | * **Required**: `Yes` 46 | * **Default**: `${project.description}` 47 | 48 | * * * 49 | 50 | #### **\** 51 | 52 | Legal copyright. 53 | 54 | * **Type**: `java.lang.String` 55 | * **Required**: `Yes` 56 | * **Default**: `Copyright © ${project.inceptionYear}-${currentYear} ${project.organization.name}. All rights reserved.`. 57 | 58 | Where: 59 | * `${project.inceptionYear}` is not mandatory. 60 | * `${currentYear}` is generated programmatically. 61 | * `${project.organization.name}` is not mandatory. 62 | 63 | * * * 64 | 65 | #### **\** 66 | 67 | Version number in `x.x.x.x` format. 68 | 69 | * **Type**: `java.lang.String` 70 | * **Required**: `Yes` 71 | * **Default**: `${project.version}` converted into a `x.x.x.x` format. The same conversion such the one described regarding `fileVersion` parameter above. 72 | 73 | * * * 74 | 75 | #### **\** 76 | 77 | Free-form version number, like "1.20.RC1." 78 | 79 | * **Type**: `java.lang.String` 80 | * **Required**: `Yes` 81 | * **Default**: `${project.version}` 82 | 83 | * * * 84 | 85 | #### **\** 86 | 87 | The product name. 88 | 89 | * **Type**: `java.lang.String` 90 | * **Required**: `Yes` 91 | * **Default**: `${project.name}` 92 | 93 | * * * 94 | 95 | #### **\** 96 | 97 | The company name. 98 | 99 | * **Type**: `java.lang.String` 100 | * **Required**: `Yes` 101 | * **Default**: `${project.organization.name}` 102 | 103 | * * * 104 | 105 | #### **\** 106 | 107 | The internal name. For instance, you could use the filename without extension or the module name. 108 | 109 | * **Type**: `java.lang.String` 110 | * **Required**: `Yes` 111 | * **Default**: `${project.artifactId}` 112 | 113 | * * * 114 | 115 | #### **\** 116 | 117 | The original filename without path. Setting this lets you determine whether a user has renamed the file. 118 | 119 | * **Type**: `java.lang.String` 120 | * **Required**: `Yes` 121 | * **Default**: last path segment of the `${outfile}` configuration 122 | 123 | * * * 124 | 125 | #### **\** 126 | 127 | Language to be used during installation. 128 | 129 | * **Type**: `java.lang.String` 130 | * **Required**: `Yes` 131 | * **Default**: `ENGLISH_US` 132 | 133 | * * * 134 | 135 | #### **\** 136 | 137 | Trademarks of author. 138 | 139 | * **Type**: `java.lang.String` 140 | * **Required**: `Yes` 141 | * **Default**: `${project.organization.name}` 142 | 143 | * * * -------------------------------------------------------------------------------- /src/site/site.xml: -------------------------------------------------------------------------------- 1 | 2 | 22 | 23 | 24 | 25 | 26 |

27 | 28 | 29 | -------------------------------------------------------------------------------- /src/test/java/com/akathist/maven/plugins/launch4j/Launch4jMojoTest.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Licensed to the Apache Software Foundation (ASF) under one 3 | * or more contributor license agreements. See the NOTICE file 4 | * distributed with this work for additional information 5 | * regarding copyright ownership. The ASF licenses this file 6 | * to you under the Apache License, Version 2.0 (the 7 | * "License"); you may not use this file except in compliance 8 | * with the License. You may obtain a copy of the License at 9 | * 10 | * http://www.apache.org/licenses/LICENSE-2.0 11 | * 12 | * Unless required by applicable law or agreed to in writing, 13 | * software distributed under the License is distributed on an 14 | * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 15 | * KIND, either express or implied. See the License for the 16 | * specific language governing permissions and limitations 17 | * under the License. 18 | */ 19 | package com.akathist.maven.plugins.launch4j; 20 | 21 | import org.apache.maven.plugin.testing.AbstractMojoTestCase; 22 | 23 | import java.io.File; 24 | 25 | public class Launch4jMojoTest extends AbstractMojoTestCase { 26 | public void testPrintOutFulfilledConfiguration() throws Exception { 27 | File testPom = new File(getBasedir(), "src/test/resources/unit/launch4j-config/launch4j-full-plugin-config.xml"); 28 | 29 | Launch4jMojo mojo = (Launch4jMojo) lookupMojo("launch4j", testPom); 30 | 31 | assertNotNull(mojo); 32 | 33 | assertEquals("Launch4jMojo{" + 34 | "headerType='gui', " + 35 | "infile=null, " + 36 | "outfile=${project.build.directory}" + File.separator + "app.exe, " + 37 | "jar='${project.build.directory}/${project.artifactId}-${project.version}.jar', " + 38 | "dontWrapJar=false, " + 39 | "errTitle='null', " + 40 | "downloadUrl='https://java.com/download', " + 41 | "supportUrl='null', " + 42 | "cmdLine='null', " + 43 | "chdir='null', " + 44 | "priority='null', " + 45 | "stayAlive=false, " + 46 | "restartOnCrash=false, " + 47 | "icon=null, " + 48 | "requireAdminRights=false, " + 49 | "objs=null, " + 50 | "libs=null, " + 51 | "vars=null, " + 52 | "jre=Jre{" + 53 | "path='%JAVA_HOME%;%PATH%', " + 54 | "requires64Bit=false, " + 55 | "minVersion='1.8', " + 56 | "maxVersion='null', " + 57 | "requiresJdk=true," + 58 | " initialHeapSize=0, " + 59 | "initialHeapPercent=0, " + 60 | "maxHeapSize=0, " + 61 | "maxHeapPercent=0, " + 62 | "opts=[-Dname=Lukasz]" + 63 | "}, " + 64 | "classPath=ClassPath{" + 65 | "mainClass='pl.org.lenart.launch4j.App', " + 66 | "addDependencies=true, " + 67 | "jarLocation='null', " + 68 | "preCp='anything', " + 69 | "postCp='null'" + 70 | "}, " + 71 | "singleInstance=null, " + 72 | "splash=null, " + 73 | "versionInfo=VersionInfo{" + 74 | "fileVersion='1.0.0.0', " + 75 | "txtFileVersion='${project.version}', " + 76 | "fileDescription='Launch4j Demo App', " + 77 | "copyright='Lukasz Lenart', " + 78 | "productVersion='1.0.0.0', " + 79 | "txtProductVersion='1.0.0.0', " + 80 | "productName='App', " + 81 | "companyName='Lukasz Lenart', " + 82 | "internalName='app', " + 83 | "originalFilename='app.exe', " + 84 | "language='ENGLISH_US', " + 85 | "trademarks='Luk ™'" + 86 | "}, " + 87 | "disableVersionInfoDefaults=true, " + 88 | "messages=Messages{" + 89 | "startupErr='null', " + 90 | "jreVersionErr='null', " + 91 | "launcherErr='null', " + 92 | "instanceAlreadyExistsMsg='null', " + 93 | "jreNotFoundErr='null'" + 94 | "}, " + 95 | "manifest=null, " + 96 | "saveConfig=false, " + 97 | "configOutfile=null, " + 98 | "parallelExecution=false, " + 99 | "skip=false" + 100 | "}", mojo.toString()); 101 | } 102 | } -------------------------------------------------------------------------------- /src/test/java/com/akathist/maven/plugins/launch4j/VersionInfoTest.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Licensed to the Apache Software Foundation (ASF) under one 3 | * or more contributor license agreements. See the NOTICE file 4 | * distributed with this work for additional information 5 | * regarding copyright ownership. The ASF licenses this file 6 | * to you under the Apache License, Version 2.0 (the 7 | * "License"); you may not use this file except in compliance 8 | * with the License. You may obtain a copy of the License at 9 | * 10 | * http://www.apache.org/licenses/LICENSE-2.0 11 | * 12 | * Unless required by applicable law or agreed to in writing, 13 | * software distributed under the License is distributed on an 14 | * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 15 | * KIND, either express or implied. See the License for the 16 | * specific language governing permissions and limitations 17 | * under the License. 18 | */ 19 | package com.akathist.maven.plugins.launch4j; 20 | 21 | import net.sf.launch4j.config.LanguageID; 22 | import org.apache.maven.model.Organization; 23 | import org.apache.maven.plugin.logging.Log; 24 | import org.apache.maven.project.MavenProject; 25 | import org.junit.Before; 26 | import org.junit.Test; 27 | import org.junit.runner.RunWith; 28 | import org.mockito.ArgumentCaptor; 29 | import org.mockito.Mock; 30 | import org.mockito.junit.MockitoJUnitRunner; 31 | 32 | import java.io.File; 33 | import java.time.LocalDate; 34 | import java.util.Arrays; 35 | import java.util.List; 36 | 37 | import static org.junit.Assert.assertEquals; 38 | import static org.junit.Assert.assertFalse; 39 | import static org.junit.Assert.assertNotEquals; 40 | import static org.junit.Assert.assertNotNull; 41 | import static org.junit.Assert.assertTrue; 42 | import static org.mockito.Mockito.doReturn; 43 | import static org.mockito.Mockito.times; 44 | import static org.mockito.Mockito.verify; 45 | 46 | @RunWith(MockitoJUnitRunner.class) 47 | public class VersionInfoTest { 48 | // VersionInfo test params 49 | private String fileVersion = "1.0.0.0"; 50 | private String txtFileVersion = "1.0.0.0"; 51 | private String fileDescription = "Launch4j Test Application"; 52 | private String copyright = "Copyright Orphan OSS"; 53 | private String productVersion = "1.0.0.0"; 54 | private String txtProductVersion = "1.0.0.0"; 55 | private String productName = "Test App"; 56 | private String companyName = "Orphan OSS Company"; 57 | private String internalName = "app"; 58 | private String originalFilename = "app.exe"; 59 | private String language = LanguageID.ENGLISH_US.name(); 60 | private String trademarks = "Test ™"; 61 | 62 | // Mocks 63 | @Mock 64 | Organization organization; 65 | @Mock 66 | MavenProject project; 67 | @Mock 68 | File outfile; 69 | @Mock 70 | Log log; 71 | 72 | // Subject 73 | private VersionInfo versionInfo; 74 | 75 | @Before 76 | public void buildVersionInfoFromTestParams() { 77 | versionInfo = new VersionInfo(fileVersion, txtFileVersion, fileDescription, 78 | copyright, productVersion, txtProductVersion, 79 | productName, companyName, internalName, 80 | originalFilename, language, trademarks, 81 | log); 82 | } 83 | 84 | @Test 85 | public void shouldConvertIntoL4jFormatProperly() { 86 | // when 87 | net.sf.launch4j.config.VersionInfo l4jVersionInfo = versionInfo.toL4j(); 88 | 89 | // then 90 | assertEquals(versionInfo.fileVersion, l4jVersionInfo.getFileVersion()); 91 | assertEquals(versionInfo.txtFileVersion, l4jVersionInfo.getTxtFileVersion()); 92 | assertEquals(versionInfo.fileDescription, l4jVersionInfo.getFileDescription()); 93 | assertEquals(versionInfo.copyright, l4jVersionInfo.getCopyright()); 94 | assertEquals(versionInfo.productVersion, l4jVersionInfo.getProductVersion()); 95 | assertEquals(versionInfo.txtProductVersion, l4jVersionInfo.getTxtProductVersion()); 96 | assertEquals(versionInfo.productName, l4jVersionInfo.getProductName()); 97 | assertEquals(versionInfo.companyName, l4jVersionInfo.getCompanyName()); 98 | assertEquals(versionInfo.internalName, l4jVersionInfo.getInternalName()); 99 | assertEquals(versionInfo.originalFilename, l4jVersionInfo.getOriginalFilename()); 100 | assertEquals(versionInfo.trademarks, l4jVersionInfo.getTrademarks()); 101 | assertEquals(versionInfo.language, l4jVersionInfo.getLanguage().name()); 102 | } 103 | 104 | @Test 105 | public void shouldConvertIntoL4jFormat_For_All_Languages() { 106 | for (LanguageID languageId : LanguageID.values()) { 107 | // given 108 | versionInfo.language = languageId.name(); 109 | 110 | // when 111 | net.sf.launch4j.config.VersionInfo l4jVersionInfo = versionInfo.toL4j(); 112 | 113 | // then 114 | assertEquals(languageId, l4jVersionInfo.getLanguage()); 115 | } 116 | } 117 | 118 | @Test(expected = IllegalArgumentException.class) 119 | public void shouldThrowException_WhenTryingToFillOutDefaults_WithEmptyProject() { 120 | // expect throws 121 | versionInfo.tryFillOutByDefaults(null, outfile); 122 | } 123 | 124 | @Test(expected = IllegalArgumentException.class) 125 | public void shouldThrowException_WhenTryingToFillOutDefaults_WithEmptyOutfile() { 126 | // expect throws 127 | versionInfo.tryFillOutByDefaults(project, null); 128 | } 129 | 130 | @Test 131 | public void should_Not_FillOut_ByDefaultVersion_InL4jFormat_When_VersionInfoPropsWere_Filled() { 132 | // given 133 | String projectVersion = "4.3.2.1"; 134 | doReturn(projectVersion).when(project).getVersion(); 135 | 136 | // when 137 | versionInfo.tryFillOutByDefaults(project, outfile); 138 | 139 | // then 140 | assertNotEquals(projectVersion, versionInfo.fileVersion); 141 | assertEquals(fileVersion, versionInfo.fileVersion); 142 | assertNotEquals(projectVersion, versionInfo.productVersion); 143 | assertEquals(productVersion, versionInfo.productVersion); 144 | } 145 | 146 | @Test 147 | public void shouldFillOut_ByDefaultVersion_InL4jFormat_When_VersionInfoPropsWere_Empty() { 148 | // given 149 | String projectVersion = "1.2.3.4"; 150 | doReturn(projectVersion).when(project).getVersion(); 151 | 152 | versionInfo.fileVersion = null; 153 | versionInfo.productVersion = null; 154 | 155 | // when 156 | versionInfo.tryFillOutByDefaults(project, outfile); 157 | 158 | // then 159 | assertEquals(projectVersion, versionInfo.fileVersion); 160 | assertNotEquals(fileVersion, versionInfo.fileVersion); 161 | assertEquals(projectVersion, versionInfo.productVersion); 162 | assertNotEquals(productVersion, versionInfo.productVersion); 163 | } 164 | 165 | @Test 166 | public void should_Not_FillOut_Copyright_ByDefault_When_ItWas_Filled() { 167 | // given 168 | String projectInceptionYear = "2017"; 169 | doReturn(projectInceptionYear).when(project).getInceptionYear(); 170 | 171 | String organizationName = "Another OSS"; 172 | doReturn(organizationName).when(organization).getName(); 173 | doReturn(organization).when(project).getOrganization(); 174 | 175 | // when 176 | versionInfo.tryFillOutByDefaults(project, outfile); 177 | 178 | // then 179 | assertNotNull(versionInfo.copyright); 180 | assertEquals(copyright, versionInfo.copyright); 181 | assertFalse(versionInfo.copyright.contains(projectInceptionYear)); 182 | assertFalse(versionInfo.copyright.contains(organizationName)); 183 | } 184 | 185 | @Test 186 | public void shouldFillOut_Copyright_ByDefault_When_ItWas_Empty() { 187 | // given 188 | String projectInceptionYear = "2019"; 189 | doReturn(projectInceptionYear).when(project).getInceptionYear(); 190 | 191 | String organizationName = "Some OSS"; 192 | doReturn(organizationName).when(organization).getName(); 193 | doReturn(organization).when(project).getOrganization(); 194 | 195 | versionInfo.copyright = null; 196 | 197 | // when 198 | versionInfo.tryFillOutByDefaults(project, outfile); 199 | 200 | // then 201 | assertNotNull(versionInfo.copyright); 202 | assertNotEquals(copyright, versionInfo.copyright); 203 | assertTrue(versionInfo.copyright.contains(projectInceptionYear)); 204 | assertTrue(versionInfo.copyright.contains(organizationName)); 205 | } 206 | 207 | @Test 208 | public void should_Not_FillOutByDefaults_From_OrganizationName_When_VersionInfoPropsWere_Filled() { 209 | // given 210 | String organizationName = "Example OSS"; 211 | doReturn(organizationName).when(organization).getName(); 212 | doReturn(organization).when(project).getOrganization(); 213 | 214 | // when 215 | versionInfo.tryFillOutByDefaults(project, outfile); 216 | 217 | // then 218 | assertNotEquals(organizationName, versionInfo.companyName); 219 | assertEquals(companyName, versionInfo.companyName); 220 | assertNotEquals(organizationName, versionInfo.trademarks); 221 | assertEquals(trademarks, versionInfo.trademarks); 222 | } 223 | 224 | @Test 225 | public void shouldFillOutByDefaults_From_OrganizationName_When_OrganizationWas_Filled() { 226 | // given 227 | String organizationName = "Other OSS"; 228 | doReturn(organizationName).when(organization).getName(); 229 | doReturn(organization).when(project).getOrganization(); 230 | 231 | versionInfo.companyName = null; 232 | versionInfo.trademarks = null; 233 | 234 | // when 235 | versionInfo.tryFillOutByDefaults(project, outfile); 236 | 237 | // then 238 | assertEquals(organizationName, versionInfo.companyName); 239 | assertEquals(organizationName, versionInfo.trademarks); 240 | } 241 | 242 | @Test 243 | public void should_Not_FillOutByDefaults_SimpleValues_From_MavenProject_When_VersionInfoPropsWere_Filled() { 244 | // given 245 | String projectVersion = "1.21.1"; 246 | doReturn(projectVersion).when(project).getVersion(); 247 | 248 | String projectName = "launch4j-test-app"; 249 | doReturn(projectName).when(project).getName(); 250 | 251 | String projectArtifactId = "launch4j-test"; 252 | doReturn(projectArtifactId).when(project).getArtifactId(); 253 | 254 | String projectDescription = "Launch4j Test App"; 255 | doReturn(projectDescription).when(project).getDescription(); 256 | 257 | // when 258 | versionInfo.tryFillOutByDefaults(project, outfile); 259 | 260 | // then 261 | assertNotEquals(projectVersion, versionInfo.txtFileVersion); 262 | assertEquals(txtFileVersion, versionInfo.txtFileVersion); 263 | assertNotEquals(projectVersion, versionInfo.txtProductVersion); 264 | assertEquals(txtProductVersion, versionInfo.txtProductVersion); 265 | assertNotEquals(projectName, versionInfo.productName); 266 | assertEquals(productName, versionInfo.productName); 267 | assertNotEquals(projectArtifactId, versionInfo.internalName); 268 | assertEquals(internalName, versionInfo.internalName); 269 | assertNotEquals(projectDescription, versionInfo.fileDescription); 270 | assertEquals(fileDescription, versionInfo.fileDescription); 271 | } 272 | 273 | @Test 274 | public void shouldFillOutByDefaults_SimpleValues_From_MavenProject_When_VersionInfoPropsWere_Empty() { 275 | // given 276 | String projectVersion = "1.21.1"; 277 | doReturn(projectVersion).when(project).getVersion(); 278 | versionInfo.txtFileVersion = null; 279 | versionInfo.txtProductVersion = null; 280 | 281 | String projectName = "launch4j-test-app"; 282 | doReturn(projectName).when(project).getName(); 283 | versionInfo.productName = null; 284 | 285 | String projectArtifactId = "launch4j-test"; 286 | doReturn(projectArtifactId).when(project).getArtifactId(); 287 | versionInfo.internalName = null; 288 | 289 | String projectDescription = "Launch4j Test App"; 290 | doReturn(projectDescription).when(project).getDescription(); 291 | versionInfo.fileDescription = null; 292 | 293 | // when 294 | versionInfo.tryFillOutByDefaults(project, outfile); 295 | 296 | // then 297 | assertEquals(projectVersion, versionInfo.txtFileVersion); 298 | assertEquals(projectVersion, versionInfo.txtProductVersion); 299 | assertEquals(projectName, versionInfo.productName); 300 | assertEquals(projectArtifactId, versionInfo.internalName); 301 | assertEquals(projectDescription, versionInfo.fileDescription); 302 | } 303 | 304 | @Test 305 | public void should_Not_FillOut_ByDefault_LastSegmentOfOutfilePath_When_OriginalFilenameWas_Filled() { 306 | // given 307 | String outfileName = "testApp.exe"; 308 | doReturn(outfileName).when(outfile).getName(); 309 | 310 | // when 311 | versionInfo.tryFillOutByDefaults(project, outfile); 312 | 313 | // then 314 | assertNotEquals(outfileName, versionInfo.originalFilename); 315 | assertEquals(originalFilename, versionInfo.originalFilename); 316 | } 317 | 318 | @Test 319 | public void shouldFillOut_ByDefault_LastSegmentOfOutfilePath_When_OriginalFilenameWas_Empty() { 320 | // given 321 | String outfileName = "testApp.exe"; 322 | doReturn(outfileName).when(outfile).getName(); 323 | versionInfo.originalFilename = null; 324 | 325 | // when 326 | versionInfo.tryFillOutByDefaults(project, outfile); 327 | 328 | // then 329 | assertEquals(outfileName, versionInfo.originalFilename); 330 | } 331 | 332 | @Test 333 | public void shouldLogWarningsAboutDummyValues() { 334 | // given 335 | ArgumentCaptor logMessageCaptor = ArgumentCaptor.forClass(String.class); 336 | List missingParamNames = Arrays.asList( 337 | "project.version", 338 | "project.name", 339 | "project.artifactId", 340 | "project.description", 341 | "project.inceptionYear", 342 | "project.organization.name", 343 | "outfile" 344 | ); 345 | 346 | // when 347 | versionInfo.tryFillOutByDefaults(project, outfile); 348 | 349 | // then 350 | verify(log, times(missingParamNames.size())).warn(logMessageCaptor.capture()); 351 | List logMessages = logMessageCaptor.getAllValues(); 352 | 353 | 354 | missingParamNames.forEach(missingParamName -> { 355 | assertTrue(logMessages.stream().anyMatch(message -> message.contains(missingParamName))); 356 | }); 357 | } 358 | 359 | @Test 360 | public void shouldFillOut_ByDummyValues_When_OriginalValues_Empty_And_ProjectParams_Empty() { 361 | // given 362 | final String buildYear = String.valueOf(LocalDate.now().getYear()); 363 | 364 | VersionInfo emptyValuesVersionInfo = new VersionInfo(); 365 | emptyValuesVersionInfo.setLog(log); 366 | 367 | // when 368 | emptyValuesVersionInfo.tryFillOutByDefaults(project, outfile); 369 | 370 | // then 371 | assertEquals("1.0.0.0", emptyValuesVersionInfo.fileVersion); 372 | assertEquals("1.0.0", emptyValuesVersionInfo.txtFileVersion); 373 | assertEquals("A Java project.", emptyValuesVersionInfo.fileDescription); 374 | assertEquals("Copyright © 2020-" + buildYear + " Default organization. All rights reserved.", emptyValuesVersionInfo.copyright); 375 | assertEquals("1.0.0.0", emptyValuesVersionInfo.productVersion); 376 | assertEquals("1.0.0", emptyValuesVersionInfo.txtProductVersion); 377 | assertEquals("Java Project", emptyValuesVersionInfo.productName); 378 | assertEquals("Default organization", emptyValuesVersionInfo.companyName); 379 | assertEquals("java-project", emptyValuesVersionInfo.internalName); 380 | assertEquals("Default organization", emptyValuesVersionInfo.trademarks); 381 | assertEquals("app.exe", emptyValuesVersionInfo.originalFilename); 382 | } 383 | 384 | @Test 385 | public void shouldGenerateString_WithTestParams() { 386 | // when 387 | String result = versionInfo.toString(); 388 | 389 | // then 390 | assertNotNull(result); 391 | assertTrue(containsParam(result, "fileVersion", fileVersion)); 392 | assertTrue(containsParam(result, "txtFileVersion", txtFileVersion)); 393 | assertTrue(containsParam(result, "fileDescription", fileDescription)); 394 | assertTrue(containsParam(result, "copyright", copyright)); 395 | assertTrue(containsParam(result, "productVersion", productVersion)); 396 | assertTrue(containsParam(result, "txtProductVersion", txtProductVersion)); 397 | assertTrue(containsParam(result, "productName", productName)); 398 | assertTrue(containsParam(result, "companyName", companyName)); 399 | assertTrue(containsParam(result, "internalName", internalName)); 400 | assertTrue(containsParam(result, "originalFilename", originalFilename)); 401 | assertTrue(containsParam(result, "language", language)); 402 | assertTrue(containsParam(result, "trademarks", trademarks)); 403 | } 404 | 405 | private boolean containsParam(String result, String paramName, String paramValue) { 406 | return result.contains(paramName + "='" + paramValue + "'"); 407 | } 408 | } 409 | -------------------------------------------------------------------------------- /src/test/java/com/akathist/maven/plugins/launch4j/generators/CopyrightGeneratorTest.java: -------------------------------------------------------------------------------- 1 | package com.akathist.maven.plugins.launch4j.generators; 2 | 3 | import org.junit.Before; 4 | import org.junit.Test; 5 | 6 | import java.time.LocalDate; 7 | 8 | import static org.junit.Assert.*; 9 | 10 | public class CopyrightGeneratorTest { 11 | private static final String COPYRIGHT_PREFIX = "Copyright © "; 12 | private static final String COPYRIGHT_POSTFIX = ". All rights reserved."; 13 | 14 | private String buildYear; 15 | 16 | @Before 17 | public void initializeBuildYear() { 18 | buildYear = String.valueOf( 19 | LocalDate.now().getYear() 20 | ); 21 | } 22 | 23 | @Test 24 | public void shouldContain_BuildYear() { 25 | // when 26 | final String copyright = CopyrightGenerator.generate(null, null); 27 | 28 | // then 29 | String expected = concatAndWrapWithCopyright(buildYear); 30 | assertEquals(expected, copyright); 31 | } 32 | 33 | @Test 34 | public void shouldContain_InceptionYear_And_BuildYear() { 35 | // given 36 | final String projectInceptionYear = "2019"; 37 | 38 | // when 39 | final String copyright = CopyrightGenerator.generate(projectInceptionYear, null); 40 | 41 | // then 42 | String expected = concatAndWrapWithCopyright( 43 | projectInceptionYear, "-", buildYear 44 | ); 45 | assertEquals(expected, copyright); 46 | } 47 | 48 | @Test 49 | public void shouldContain_BuildYear_And_OrganizationName() { 50 | // given 51 | final String organizationName = "SoftwareMill"; 52 | 53 | // when 54 | final String copyright = CopyrightGenerator.generate(null, organizationName); 55 | 56 | // then 57 | String expected = concatAndWrapWithCopyright( 58 | buildYear, " ", organizationName 59 | ); 60 | assertEquals(expected, copyright); 61 | } 62 | 63 | @Test 64 | public void shouldContain_InceptionYear_And_BuildYear_And_OrganizationName() { 65 | // given 66 | final String projectInceptionYear = "2020"; 67 | final String organizationName = "Orphan OSS"; 68 | 69 | // when 70 | final String copyright = CopyrightGenerator.generate(projectInceptionYear, organizationName); 71 | 72 | // then 73 | String expected = concatAndWrapWithCopyright( 74 | projectInceptionYear, "-", buildYear, " ", organizationName 75 | ); 76 | assertEquals(expected, copyright); 77 | } 78 | 79 | private String concatAndWrapWithCopyright(String... elements) { 80 | StringBuilder builder = new StringBuilder(COPYRIGHT_PREFIX); 81 | 82 | for (String element : elements) { 83 | builder.append(element); 84 | } 85 | 86 | builder.append(COPYRIGHT_POSTFIX); 87 | 88 | return builder.toString(); 89 | } 90 | } 91 | -------------------------------------------------------------------------------- /src/test/java/com/akathist/maven/plugins/launch4j/generators/Launch4jFileVersionGeneratorTest.java: -------------------------------------------------------------------------------- 1 | package com.akathist.maven.plugins.launch4j.generators; 2 | 3 | import junitparams.JUnitParamsRunner; 4 | import junitparams.Parameters; 5 | import org.junit.Test; 6 | import org.junit.runner.RunWith; 7 | 8 | import static org.junit.Assert.*; 9 | 10 | @RunWith(JUnitParamsRunner.class) 11 | public class Launch4jFileVersionGeneratorTest { 12 | @Test 13 | public void shouldReturnNull_WhenProjectVersionIsNull() { 14 | // given 15 | String projectVersion = null; 16 | 17 | // expect 18 | assertNull(Launch4jFileVersionGenerator.generate(projectVersion)); 19 | } 20 | 21 | @Test(expected = IllegalArgumentException.class) 22 | @Parameters({ 23 | "", 24 | " ", 25 | "null", 26 | "alpha-1.2.3", 27 | "1a.2.3", 28 | "1.X.3", 29 | "1.2.3_11", 30 | "1.2.3;4", 31 | "1.2.3.4SNAPSHOT", 32 | "1.2.3.4.SNAPSHOT" 33 | }) 34 | public void shouldThrowException_WhenProjectVersion_HaveWrongFormat(String projectVersion) { 35 | // expect throws 36 | Launch4jFileVersionGenerator.generate(projectVersion); 37 | } 38 | 39 | @Test 40 | @Parameters({ 41 | "0, 0.0.0.0", 42 | "1, 1.0.0.0", 43 | "2, 2.0.0.0", 44 | "3.14, 3.14.0.0", 45 | "4.0.1, 4.0.1.0", 46 | "55.44.33, 55.44.33.0" 47 | }) 48 | public void shouldFillMissingPlacesByZeros(String projectVersion, String expected) { 49 | // when 50 | final String launch4jFileVersion = Launch4jFileVersionGenerator.generate(projectVersion); 51 | 52 | // then 53 | assertEquals(expected, launch4jFileVersion); 54 | } 55 | 56 | @Test 57 | @Parameters({ 58 | "1-SNAPSHOT, 1.0.0.0", 59 | "1.2.1-alpha, 1.2.1.0", 60 | "1.2.3.4-beta, 1.2.3.4", 61 | "0.0.1-snapshot, 0.0.1.0", 62 | "1.2.3.4-alpha+001, 1.2.3.4", 63 | "1.2.3-alpha+001, 1.2.3.0", 64 | "1.2.3.4-alpha+001, 1.2.3.4", 65 | "1.2.3+20130313144700, 1.2.3.0", 66 | "1.2.3.4+20130313144700, 1.2.3.4", 67 | "1.2.3-beta+exp.sha.5114f85, 1.2.3.0", 68 | "1.2.3.4-beta+exp.sha.5114f85, 1.2.3.4", 69 | }) 70 | public void shouldCutOffTextFlags(String projectVersion, String expected) { 71 | // when 72 | final String launch4jFileVersion = Launch4jFileVersionGenerator.generate(projectVersion); 73 | 74 | // then 75 | assertEquals(expected, launch4jFileVersion); 76 | } 77 | 78 | @Test 79 | @Parameters({ 80 | "0.0.0.0.1, 0.0.0.0", 81 | "1.22.333.4444.55555.666666, 1.22.333.4444", 82 | "9.8.7.6.5-SNAPSHOT, 9.8.7.6", 83 | "3.0.1.12.44.62.1.0.0.0.1-alpha, 3.0.1.12", 84 | }) 85 | public void shouldCutOffTooManyNestedDigits(String projectVersion, String expected) { 86 | // when 87 | final String launch4jFileVersion = Launch4jFileVersionGenerator.generate(projectVersion); 88 | 89 | // then 90 | assertEquals(expected, launch4jFileVersion); 91 | } 92 | } -------------------------------------------------------------------------------- /src/test/resources/unit/launch4j-config/launch4j-full-plugin-config.xml: -------------------------------------------------------------------------------- 1 | 21 | 23 | 4.0.0 24 | 25 | com.akathist.maven.plugins.launch4j.unit 26 | launch4j-default 27 | 1.0-SNAPSHOT 28 | jar 29 | 30 | launch4j-full 31 | 32 | 33 | 34 | 35 | com.akathist.maven.plugins.launch4j 36 | launch4j-maven-plugin 37 | 38 | gui 39 | ${project.build.directory}/${project.artifactId}-${project.version}.jar 40 | ${project.build.directory}/app.exe 41 | https://java.com/download 42 | 43 | pl.org.lenart.launch4j.App 44 | anything 45 | 46 | 47 | %JAVA_HOME%;%PATH% 48 | 1.8 49 | true 50 | preferJre 51 | true 52 | true 53 | 32 54 | 55 | -Dname=Lukasz 56 | 57 | 58 | true 59 | 60 | Test bundledJreErr 61 | 62 | 63 | 1.0.0.0 64 | ${project.version} 65 | Launch4j Demo App 66 | Lukasz Lenart 67 | 1.0.0.0 68 | 1.0.0.0 69 | App 70 | Lukasz Lenart 71 | app 72 | app.exe 73 | Luk ™ 74 | 75 | 76 | 77 | 78 | 79 | 80 | --------------------------------------------------------------------------------