summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/source/support/arara/src/main/java/com/github/arara/utils/CommandLineAnalyzer.java
blob: 8cf0d2e91226fa965acf1e48651059d44b97d0e8 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
/**
 * \cond LICENSE
 * Arara -- the cool TeX automation tool
 * Copyright (c) 2012, Paulo Roberto Massa Cereda
 * All rights reserved.
 *
 * Redistribution and  use in source  and binary forms, with  or without
 * modification, are  permitted provided  that the  following conditions
 * are met:
 *
 * 1. Redistributions  of source  code must  retain the  above copyright
 * notice, this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form  must reproduce the above copyright
 * notice, this list  of conditions and the following  disclaimer in the
 * documentation and/or other materials provided with the distribution.
 *
 * 3. Neither  the name  of the  project's author nor  the names  of its
 * contributors may be used to  endorse or promote products derived from
 * this software without specific prior written permission.
 *
 * THIS SOFTWARE IS  PROVIDED BY THE COPYRIGHT  HOLDERS AND CONTRIBUTORS
 * "AS IS"  AND ANY  EXPRESS OR IMPLIED  WARRANTIES, INCLUDING,  BUT NOT
 * LIMITED  TO, THE  IMPLIED WARRANTIES  OF MERCHANTABILITY  AND FITNESS
 * FOR  A PARTICULAR  PURPOSE  ARE  DISCLAIMED. IN  NO  EVENT SHALL  THE
 * COPYRIGHT HOLDER OR CONTRIBUTORS BE  LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY,  OR CONSEQUENTIAL DAMAGES (INCLUDING,
 * BUT  NOT LIMITED  TO, PROCUREMENT  OF SUBSTITUTE  GOODS OR  SERVICES;
 * LOSS  OF USE,  DATA, OR  PROFITS; OR  BUSINESS INTERRUPTION)  HOWEVER
 * CAUSED AND  ON ANY THEORY  OF LIABILITY, WHETHER IN  CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY
 * WAY  OUT  OF  THE USE  OF  THIS  SOFTWARE,  EVEN  IF ADVISED  OF  THE
 * POSSIBILITY OF SUCH DAMAGE.
 * \endcond
 * 
 * CommandLineAnalyzer: This class implements a command line parser to provide
 * better control of flags and files to process.
 */
// package definition
package com.github.arara.utils;

// needed import
import java.io.File;
import org.apache.commons.cli.*;

/**
 * Implements a command line parser to provide better control of flags and files
 * to process.
 *
 * @author Paulo Roberto Massa Cereda
 * @version 3.0a
 * @since 1.0
 */
public class CommandLineAnalyzer {

    // the file to process
    private String theFile;
    // the command line arguments
    private String[] theArgs;
    // the command line options
    private Options commandLineOptions;
    // the verbose option
    private boolean showVerboseOutput;
    // the execution timeout,
    // in milliseconds
    private long executionTimeout;
    // the configuration
    private ConfigurationLoader configuration;
    // the localization class
    final static AraraLocalization localization = AraraLocalization.getInstance();

    /**
     * Constructor.
     *
     * @param theArgs The command line arguments.
     * @param configuration The current configuration.
     */
    public CommandLineAnalyzer(String[] theArgs, ConfigurationLoader configuration) {

        // set the array
        this.theArgs = theArgs;

        // set the configuration
        this.configuration = configuration;

        // create new options
        commandLineOptions = new Options();

        // set the default value to the output
        showVerboseOutput = false;

    }

    /**
     * Parses the command line arguments and provides feedback to the main
     * class.
     *
     * @return A boolean value if there is a file to be processed by Arara.
     */
    public boolean parse() {

        // create the version option
        Option optVersion = new Option("V", "version", false, localization.getMessage("Help_Version"));

        // create the help option
        Option optHelp = new Option("h", "help", false, localization.getMessage("Help_Help"));

        // create the log option
        Option optLog = new Option("l", "log", false, localization.getMessage("Help_Log"));

        // create the verbose option
        Option optVerbose = new Option("v", "verbose", false, localization.getMessage("Help_Verbose"));

        // create the timeout option
        Option optTimeout = new Option("t", "timeout", true, localization.getMessage("Help_Timeout"));

        // create the language option
        Option optLanguage = new Option("L", "language", true, localization.getMessage("Help_Language"));

        // add version
        commandLineOptions.addOption(optVersion);

        // add help
        commandLineOptions.addOption(optHelp);

        // add log
        commandLineOptions.addOption(optLog);

        // add verbose
        commandLineOptions.addOption(optVerbose);

        // add timeout
        commandLineOptions.addOption(optTimeout);

        // add language
        commandLineOptions.addOption(optLanguage);

        // create a new basic parser
        CommandLineParser parser = new BasicParser();

        // lets try to parse everthing
        try {

            // parse the arguments
            CommandLine line = parser.parse(commandLineOptions, theArgs);

            // if -L or --language found
            if (line.hasOption("language")) {
                
                // create a new language controler
                LanguageController language = new LanguageController();
                
                // if the attempt to set the language according to the command
                // line has failed
                if (!language.setLanguage(line.getOptionValue("language"))) {

                    // print the list of available languages
                    language.printLanguageHelp();
                    
                    // print the usage
                    printUsage();
                    
                    // and simply return
                    return false;
                }
                else {
                    
                    // new language, refresh the options
                    optVersion.setDescription(localization.getMessage("Help_Version"));
                    optHelp.setDescription(localization.getMessage("Help_Help"));
                    optLog.setDescription(localization.getMessage("Help_Log"));
                    optVerbose.setDescription(localization.getMessage("Help_Verbose"));
                    optTimeout.setDescription(localization.getMessage("Help_Timeout"));
                    optLanguage.setDescription(localization.getMessage("Help_Language"));
                }
            }

            // if -h or --help found
            if (line.hasOption("help")) {

                // print version
                printVersion();

                // and usage
                printUsage();

                // return
                return false;

            } else {

                // if -v or --version found
                if (line.hasOption("version")) {

                    // print version
                    printVersion();

                    printSpecialThanks();

                    // and return
                    return false;

                } else {

                    // get the list of files
                    String[] files = line.getArgs();

                    // we only expect one file
                    if (files.length != 1) {

                        // print version
                        printVersion();

                        // usage
                        printUsage();

                        // and return
                        return false;

                    } else {

                        // if -t or --timeout found
                        if (line.hasOption("timeout")) {

                            // try to convert the argument to a number
                            try {

                                // parse the long value
                                executionTimeout = Long.parseLong(line.getOptionValue("timeout"));

                                // if it's not a valid number
                                if (executionTimeout <= 0) {

                                    // print version
                                    printVersion();

                                    // usage
                                    printUsage();

                                    // and return
                                    return false;

                                }
                            } catch (NumberFormatException numberFormatException) {

                                // we have a bad conversion

                                // print version
                                printVersion();

                                // usage
                                printUsage();

                                // and return
                                return false;
                            }
                        } else {

                            // fallback to the default value, that is,
                            // timeout is disabled
                            executionTimeout = 0;
                        }

                        // active logging
                        AraraLogging.enableLogging(line.hasOption("log"));

                        // set verbose flag
                        showVerboseOutput = line.hasOption("verbose");

                        // everything is fine, set
                        // the file
                        theFile = files[0];

                        // check if file exists
                        if (!checkFile(theFile, configuration.getValidExtensions())) {

                            // file not found, return false
                            return false;

                        }
                        
                        // and return
                        return true;
                    }
                }
            }

        } catch (ParseException parseException) {

            // something happened, in the last case print version
            printVersion();

            // and usage
            printUsage();

            // and simply return
            return false;

        }
    }

    /**
     * Prints the usage message.
     */
    private void printUsage() {

        // new formatter
        HelpFormatter formatter = new HelpFormatter();

        // add the text and print
        formatter.printHelp("arara [file [--log] [--verbose] [--timeout N] [--language L] | --help | --version]", commandLineOptions);
    }

    /**
     * Prints the application version.
     */
    private void printVersion() {

        // print the version
        System.out.println("arara ".concat(AraraConstants.VERSION).concat(" - ").concat(localization.getMessage("Header_Slogan")));
        System.out.println("Copyright (c) ".concat(AraraConstants.COPYRIGHTYEAR).concat(", Paulo Roberto Massa Cereda"));
        System.out.println(localization.getMessage("Header_AllRightsReserved").concat("\n"));
    }

    /**
     * Getter for file obtained from the command line.
     *
     * @return The file.
     */
    public String getFile() {

        // return it
        return theFile;
    }

    /**
     * Checks if file is valid.
     *
     * @param filename The file name.
     * @param extensions A priority list of allowed extensions.
     * @return A boolean value to determine if the file is valid.
     */
    private boolean checkFile(String filename, String[] extensions) {

        // flag to indicate the file was found
        boolean foundFile = false;

        // iterate through all the extensions
        for (String currentExtension : extensions) {

            // check if the file has the current extension
            if (filename.toLowerCase().endsWith(currentExtension)) {

                // set flag
                foundFile = true;

                // set configuration
                configuration.setChosenFilePattern(currentExtension);

                // break iteration
                break;
            }
        }

        // create a new file status
        File fileStatus = null;

        // check if a reference was found
        if (foundFile) {

            // create new instance
            fileStatus = new File(filename);

            // check if exists
            if (fileStatus.exists()) {

                // add file
                theFile = filename;

                // found it!
                return true;
            } else {

                // print message about it
                System.out.println(localization.getMessage("Error_FileDoesNotExist", filename));

                // not found
                return false;
            }

        } else {

            // there's no extension, we will add them and see if something
            // is found
            for (String currentExtension : extensions) {

                // new file with extension
                fileStatus = new File(filename + currentExtension);

                // let's check it
                if (fileStatus.exists()) {

                    // add file
                    theFile = filename + currentExtension;

                    // add reference
                    configuration.setChosenFilePattern(currentExtension);

                    // found it!
                    return true;

                }

            }

            // print message about it
            System.out.println(AraraUtils.wrap(localization.getMessage("Error_FileDoesNotExistWithExtensionsList", filename, getExtensionsList(extensions))));

            // file not found
            return false;

        }

    }

    /**
     * Returns a string with the extensions list.
     *
     * @param extensions The extensions list.
     * @return A string with the extensions list.
     */
    private String getExtensionsList(String[] extensions) {

        // if it's an empty vector
        if (extensions.length == 0) {

            // return an empty string
            return "";

        } else {

            // get first element
            String result = "[".concat(extensions[0]);

            // iterate through the other values
            for (int i = 1; i < extensions.length; i++) {

                // add the current extension
                result = result.concat(", ").concat(extensions[i]);
            }

            // close the list
            result = result.concat("]");

            // return it
            return result;
        }
    }

    /**
     * Checks if the output must be verbose.
     *
     * @return A boolean value.
     */
    public boolean isVerbose() {

        // return it
        return showVerboseOutput;
    }

    /**
     * Getter for the execution timeout.
     *
     * @return The execution timeout.
     */
    public long getExecutionTimeout() {

        // return it
        return executionTimeout;
    }

    /**
     * Prints the special thanks message.
     */
    private void printSpecialThanks() {
        System.out.println(AraraUtils.wrap(localization.getMessage("Msg_SpecialThanks")));
    }
}