View Javadoc
1   package org.apache.maven.cli;
2   
3   /*
4    * Licensed to the Apache Software Foundation (ASF) under one
5    * or more contributor license agreements.  See the NOTICE file
6    * distributed with this work for additional information
7    * regarding copyright ownership.  The ASF licenses this file
8    * to you under the Apache License, Version 2.0 (the
9    * "License"); you may not use this file except in compliance
10   * with the License.  You may obtain a copy of the License at
11   *
12   *  http://www.apache.org/licenses/LICENSE-2.0
13   *
14   * Unless required by applicable law or agreed to in writing,
15   * software distributed under the License is distributed on an
16   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17   * KIND, either express or implied.  See the License for the
18   * specific language governing permissions and limitations
19   * under the License.
20   */
21  
22  import java.io.PrintStream;
23  import java.io.PrintWriter;
24  import java.util.ArrayList;
25  import java.util.List;
26  
27  import org.apache.commons.cli.CommandLine;
28  import org.apache.commons.cli.CommandLineParser;
29  import org.apache.commons.cli.GnuParser;
30  import org.apache.commons.cli.HelpFormatter;
31  import org.apache.commons.cli.OptionBuilder;
32  import org.apache.commons.cli.Options;
33  import org.apache.commons.cli.ParseException;
34  
35  /**
36   * @author Jason van Zyl
37   */
38  public class CLIManager
39  {
40      public static final char ALTERNATE_POM_FILE = 'f';
41  
42      public static final char BATCH_MODE = 'B';
43  
44      public static final char SET_SYSTEM_PROPERTY = 'D';
45  
46      public static final char OFFLINE = 'o';
47  
48      public static final char QUIET = 'q';
49  
50      public static final char DEBUG = 'X';
51  
52      public static final char ERRORS = 'e';
53  
54      public static final char HELP = 'h';
55  
56      public static final char VERSION = 'v';
57  
58      public static final char SHOW_VERSION = 'V';
59  
60      public static final char NON_RECURSIVE = 'N';
61  
62      public static final char UPDATE_SNAPSHOTS = 'U';
63  
64      public static final char ACTIVATE_PROFILES = 'P';
65  
66      public static final String SUPRESS_SNAPSHOT_UPDATES = "nsu";
67  
68      public static final char CHECKSUM_FAILURE_POLICY = 'C';
69  
70      public static final char CHECKSUM_WARNING_POLICY = 'c';
71  
72      public static final char ALTERNATE_USER_SETTINGS = 's';
73  
74      public static final String ALTERNATE_GLOBAL_SETTINGS = "gs";
75  
76      public static final char ALTERNATE_USER_TOOLCHAINS = 't';
77  
78      public static final String FAIL_FAST = "ff";
79  
80      public static final String FAIL_AT_END = "fae";
81  
82      public static final String FAIL_NEVER = "fn";
83  
84      public static final String RESUME_FROM = "rf";
85  
86      public static final String PROJECT_LIST = "pl";
87  
88      public static final String ALSO_MAKE = "am";
89  
90      public static final String ALSO_MAKE_DEPENDENTS = "amd";
91  
92      public static final String LOG_FILE = "l";
93  
94      public static final String ENCRYPT_MASTER_PASSWORD = "emp";
95  
96      public static final String ENCRYPT_PASSWORD = "ep";
97  
98      public static final String THREADS = "T";
99  
100     public static final String LEGACY_LOCAL_REPOSITORY = "llr";
101 
102     public static final String BUILDER = "b";
103 
104     protected Options options;
105 
106     @SuppressWarnings( { "static-access", "checkstyle:linelength" } )
107     public CLIManager()
108     {
109         options = new Options();
110         options.addOption( OptionBuilder.withLongOpt( "help" ).withDescription( "Display help information" ).create( HELP ) );
111         options.addOption( OptionBuilder.withLongOpt( "file" ).hasArg().withDescription( "Force the use of an alternate POM file (or directory with pom.xml)." ).create( ALTERNATE_POM_FILE ) );
112         options.addOption( OptionBuilder.withLongOpt( "define" ).hasArg().withDescription( "Define a system property" ).create( SET_SYSTEM_PROPERTY ) );
113         options.addOption( OptionBuilder.withLongOpt( "offline" ).withDescription( "Work offline" ).create( OFFLINE ) );
114         options.addOption( OptionBuilder.withLongOpt( "version" ).withDescription( "Display version information" ).create( VERSION ) );
115         options.addOption( OptionBuilder.withLongOpt( "quiet" ).withDescription( "Quiet output - only show errors" ).create( QUIET ) );
116         options.addOption( OptionBuilder.withLongOpt( "debug" ).withDescription( "Produce execution debug output" ).create( DEBUG ) );
117         options.addOption( OptionBuilder.withLongOpt( "errors" ).withDescription( "Produce execution error messages" ).create( ERRORS ) );
118         options.addOption( OptionBuilder.withLongOpt( "non-recursive" ).withDescription( "Do not recurse into sub-projects" ).create( NON_RECURSIVE ) );
119         options.addOption( OptionBuilder.withLongOpt( "update-snapshots" ).withDescription( "Forces a check for missing releases and updated snapshots on remote repositories" ).create( UPDATE_SNAPSHOTS ) );
120         options.addOption( OptionBuilder.withLongOpt( "activate-profiles" ).withDescription( "Comma-delimited list of profiles to activate" ).hasArg().create( ACTIVATE_PROFILES ) );
121         options.addOption( OptionBuilder.withLongOpt( "batch-mode" ).withDescription( "Run in non-interactive (batch) mode" ).create( BATCH_MODE ) );
122         options.addOption( OptionBuilder.withLongOpt( "no-snapshot-updates" ).withDescription( "Suppress SNAPSHOT updates" ).create( SUPRESS_SNAPSHOT_UPDATES ) );
123         options.addOption( OptionBuilder.withLongOpt( "strict-checksums" ).withDescription( "Fail the build if checksums don't match" ).create( CHECKSUM_FAILURE_POLICY ) );
124         options.addOption( OptionBuilder.withLongOpt( "lax-checksums" ).withDescription( "Warn if checksums don't match" ).create( CHECKSUM_WARNING_POLICY ) );
125         options.addOption( OptionBuilder.withLongOpt( "settings" ).withDescription( "Alternate path for the user settings file" ).hasArg().create( ALTERNATE_USER_SETTINGS ) );
126         options.addOption( OptionBuilder.withLongOpt( "global-settings" ).withDescription( "Alternate path for the global settings file" ).hasArg().create( ALTERNATE_GLOBAL_SETTINGS ) );
127         options.addOption( OptionBuilder.withLongOpt( "toolchains" ).withDescription( "Alternate path for the user toolchains file" ).hasArg().create( ALTERNATE_USER_TOOLCHAINS ) );
128         options.addOption( OptionBuilder.withLongOpt( "fail-fast" ).withDescription( "Stop at first failure in reactorized builds" ).create( FAIL_FAST ) );
129         options.addOption( OptionBuilder.withLongOpt( "fail-at-end" ).withDescription( "Only fail the build afterwards; allow all non-impacted builds to continue" ).create( FAIL_AT_END ) );
130         options.addOption( OptionBuilder.withLongOpt( "fail-never" ).withDescription( "NEVER fail the build, regardless of project result" ).create( FAIL_NEVER ) );
131         options.addOption( OptionBuilder.withLongOpt( "resume-from" ).hasArg().withDescription( "Resume reactor from specified project" ).create( RESUME_FROM ) );
132         options.addOption( OptionBuilder.withLongOpt( "projects" ).withDescription( "Comma-delimited list of specified reactor projects to build instead of all projects. A project can be specified by [groupId]:artifactId or by its relative path." ).hasArg().create( PROJECT_LIST ) );
133         options.addOption( OptionBuilder.withLongOpt( "also-make" ).withDescription( "If project list is specified, also build projects required by the list" ).create( ALSO_MAKE ) );
134         options.addOption( OptionBuilder.withLongOpt( "also-make-dependents" ).withDescription( "If project list is specified, also build projects that depend on projects on the list" ).create( ALSO_MAKE_DEPENDENTS ) );
135         options.addOption( OptionBuilder.withLongOpt( "log-file" ).hasArg().withDescription( "Log file to where all build output will go." ).create( LOG_FILE ) );
136         options.addOption( OptionBuilder.withLongOpt( "show-version" ).withDescription( "Display version information WITHOUT stopping build" ).create( SHOW_VERSION ) );
137         options.addOption( OptionBuilder.withLongOpt( "encrypt-master-password" ).hasOptionalArg().withDescription( "Encrypt master security password" ).create( ENCRYPT_MASTER_PASSWORD ) );
138         options.addOption( OptionBuilder.withLongOpt( "encrypt-password" ).hasOptionalArg().withDescription( "Encrypt server password" ).create( ENCRYPT_PASSWORD ) );
139         options.addOption( OptionBuilder.withLongOpt( "threads" ).hasArg().withDescription( "Thread count, for instance 2.0C where C is core multiplied" ).create( THREADS ) );
140         options.addOption( OptionBuilder.withLongOpt( "legacy-local-repository" ).withDescription( "Use Maven 2 Legacy Local Repository behaviour, ie no use of _remote.repositories. Can also be activated by using -Dmaven.legacyLocalRepo=true" ).create( LEGACY_LOCAL_REPOSITORY ) );
141         options.addOption( OptionBuilder.withLongOpt( "builder" ).hasArg().withDescription( "The id of the build strategy to use." ).create( BUILDER ) );
142 
143         // Adding this back in for compatibility with the verifier that hard codes this option.
144         options.addOption( OptionBuilder.withLongOpt( "no-plugin-registry" ).withDescription( "Ineffective, only kept for backward compatibility" ).create( "npr" ) );
145         options.addOption( OptionBuilder.withLongOpt( "check-plugin-updates" ).withDescription( "Ineffective, only kept for backward compatibility" ).create( "cpu" ) );
146         options.addOption( OptionBuilder.withLongOpt( "update-plugins" ).withDescription( "Ineffective, only kept for backward compatibility" ).create( "up" ) );
147         options.addOption( OptionBuilder.withLongOpt( "no-plugin-updates" ).withDescription( "Ineffective, only kept for backward compatibility" ).create( "npu" ) );
148     }
149 
150     public CommandLine parse( String[] args )
151         throws ParseException
152     {
153         // We need to eat any quotes surrounding arguments...
154         String[] cleanArgs = cleanArgs( args );
155 
156         CommandLineParser parser = new GnuParser();
157 
158         return parser.parse( options, cleanArgs );
159     }
160 
161     private String[] cleanArgs( String[] args )
162     {
163         List<String> cleaned = new ArrayList<String>();
164 
165         StringBuilder currentArg = null;
166 
167         for ( String arg : args )
168         {
169             boolean addedToBuffer = false;
170 
171             if ( arg.startsWith( "\"" ) )
172             {
173                 // if we're in the process of building up another arg, push it and start over.
174                 // this is for the case: "-Dfoo=bar "-Dfoo2=bar two" (note the first unterminated quote)
175                 if ( currentArg != null )
176                 {
177                     cleaned.add( currentArg.toString() );
178                 }
179 
180                 // start building an argument here.
181                 currentArg = new StringBuilder( arg.substring( 1 ) );
182                 addedToBuffer = true;
183             }
184 
185             // this has to be a separate "if" statement, to capture the case of: "-Dfoo=bar"
186             if ( arg.endsWith( "\"" ) )
187             {
188                 String cleanArgPart = arg.substring( 0, arg.length() - 1 );
189 
190                 // if we're building an argument, keep doing so.
191                 if ( currentArg != null )
192                 {
193                     // if this is the case of "-Dfoo=bar", then we need to adjust the buffer.
194                     if ( addedToBuffer )
195                     {
196                         currentArg.setLength( currentArg.length() - 1 );
197                     }
198                     // otherwise, we trim the trailing " and append to the buffer.
199                     else
200                     {
201                         // TODO: introducing a space here...not sure what else to do but collapse whitespace
202                         currentArg.append( ' ' ).append( cleanArgPart );
203                     }
204 
205                     cleaned.add( currentArg.toString() );
206                 }
207                 else
208                 {
209                     cleaned.add( cleanArgPart );
210                 }
211 
212                 currentArg = null;
213 
214                 continue;
215             }
216 
217             // if we haven't added this arg to the buffer, and we ARE building an argument
218             // buffer, then append it with a preceding space...again, not sure what else to
219             // do other than collapse whitespace.
220             // NOTE: The case of a trailing quote is handled by nullifying the arg buffer.
221             if ( !addedToBuffer )
222             {
223                 if ( currentArg != null )
224                 {
225                     currentArg.append( ' ' ).append( arg );
226                 }
227                 else
228                 {
229                     cleaned.add( arg );
230                 }
231             }
232         }
233 
234         if ( currentArg != null )
235         {
236             cleaned.add( currentArg.toString() );
237         }
238 
239         int cleanedSz = cleaned.size();
240 
241         String[] cleanArgs;
242 
243         if ( cleanedSz == 0 )
244         {
245             cleanArgs = args;
246         }
247         else
248         {
249             cleanArgs = cleaned.toArray( new String[cleanedSz] );
250         }
251 
252         return cleanArgs;
253     }
254 
255     public void displayHelp( PrintStream stdout )
256     {
257         stdout.println();
258 
259         PrintWriter pw = new PrintWriter( stdout );
260 
261         HelpFormatter formatter = new HelpFormatter();
262 
263         formatter.printHelp( pw, HelpFormatter.DEFAULT_WIDTH, "mvn [options] [<goal(s)>] [<phase(s)>]", "\nOptions:",
264                              options, HelpFormatter.DEFAULT_LEFT_PAD, HelpFormatter.DEFAULT_DESC_PAD, "\n", false );
265 
266         pw.flush();
267     }
268 }