summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/source/support/arara/src/main/java/com/github/cereda/arara/utils/DirectiveUtils.java
blob: d4d2a88ac7e9b743b5baeeeb8d6120834be9b5dc (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
/**
 * Arara, the cool TeX automation tool
 * Copyright (c) 2012 -- 2018, 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.
 */
package com.github.cereda.arara.utils;

import com.github.cereda.arara.controller.ConfigurationController;
import com.github.cereda.arara.controller.LanguageController;
import com.github.cereda.arara.model.AraraException;
import com.github.cereda.arara.model.Conditional;
import com.github.cereda.arara.model.Directive;
import com.github.cereda.arara.model.Messages;
import com.github.cereda.arara.model.Pair;
import java.io.File;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.yaml.snakeyaml.DumperOptions;
import org.yaml.snakeyaml.Yaml;
import org.yaml.snakeyaml.constructor.Constructor;
import org.yaml.snakeyaml.error.MarkedYAMLException;
import org.yaml.snakeyaml.representer.Representer;

/**
 * Implements directive utilitary methods.
 * @author Paulo Roberto Massa Cereda
 * @version 4.0
 * @since 4.0
 */
public class DirectiveUtils {

    // the application messages obtained from the
    // language controller
    private static final LanguageController messages =
            LanguageController.getInstance();
    
    // get the logger context from a factory
    private static final Logger logger =
            LoggerFactory.getLogger(DirectiveUtils.class);

    /**
     * Extracts a list of directives from a list of strings.
     * @param lines List of strings.
     * @return A list of directives.
     * @throws AraraException Something wrong happened, to be caught in the
     * higher levels.
     */    
    public static List<Directive> extractDirectives(List<String> lines)
            throws AraraException {

        boolean header = (Boolean) ConfigurationController.
                getInstance().get("execution.header");
        String regex = (String) ConfigurationController.
                getInstance().get("execution.file.pattern");
        Pattern linecheck = Pattern.compile(regex);
        regex = regex.concat((String) ConfigurationController.
                getInstance().get("application.pattern"));
        Pattern pattern = Pattern.compile(regex);
        List<Pair<Integer, String>> pairs =
                new ArrayList<Pair<Integer, String>>();
        Matcher matcher;
        for (int i = 0; i < lines.size(); i++) {
            matcher = pattern.matcher(lines.get(i));
            if (matcher.find()) {
                String line = lines.get(i).substring(
                        matcher.end(),
                        lines.get(i).length()
                );
                Pair<Integer, String> pair =
                        new Pair<Integer, String>(i + 1, line);
                pairs.add(pair);

                logger.info(
                        messages.getMessage(
                                Messages.LOG_INFO_POTENTIAL_PATTERN_FOUND,
                                (i + 1),
                                line.trim()
                        )
                );
            }
            else {
                if (header) {
                    if (!checkLinePattern(linecheck, lines.get(i))) {
                        break;
                    }
                }
            }
        }

        if (pairs.isEmpty()) {
            throw new AraraException(
                    messages.getMessage(
                            Messages.ERROR_VALIDATE_NO_DIRECTIVES_FOUND
                    )
            );
        }

        List<DirectiveAssembler> assemblers
                = new ArrayList<DirectiveAssembler>();
        DirectiveAssembler assembler = new DirectiveAssembler();
        regex = (String) ConfigurationController.getInstance().
                get("directives.linebreak.pattern");
        pattern = Pattern.compile(regex);
        for (Pair<Integer, String> pair : pairs) {
            matcher = pattern.matcher(pair.getSecondElement());
            if (matcher.find()) {
                if (!assembler.isAppendAllowed()) {
                    throw new AraraException(
                            messages.getMessage(
                                    Messages.ERROR_VALIDATE_ORPHAN_LINEBREAK,
                                    pair.getFirstElement()
                            )
                    );
                } else {
                    assembler.addLineNumber(pair.getFirstElement());
                    assembler.appendLine(matcher.group(1));
                }
            } else {
                if (assembler.isAppendAllowed()) {
                    assemblers.add(assembler);
                }
                assembler = new DirectiveAssembler();
                assembler.addLineNumber(pair.getFirstElement());
                assembler.appendLine(pair.getSecondElement());
            }
        }
        if (assembler.isAppendAllowed()) {
            assemblers.add(assembler);
        }

        List<Directive> directives = new ArrayList<Directive>();
        for (DirectiveAssembler current : assemblers) {
            directives.add(generateDirective(current));
        }
        return directives;

    }

    /**
     * Generates a directive from a directive assembler.
     * @param assembler The directive assembler.
     * @return The corresponding directive.
     * @throws AraraException Something wrong happened, to be caught in the
     * higher levels.
     */
    public static Directive generateDirective(DirectiveAssembler assembler)
            throws AraraException {
        String regex = (String) ConfigurationController.getInstance().
                get("directives.pattern");
        Pattern pattern = Pattern.compile(regex);
        Matcher matcher = pattern.matcher(assembler.getText());
        if (matcher.find()) {
            Directive directive = new Directive();
            directive.setIdentifier(matcher.group(1));
            directive.setParameters(
                    getParameters(matcher.group(3), assembler.getLineNumbers())
            );
            Conditional conditional = new Conditional();
            conditional.setType(getType(matcher.group(5)));
            conditional.setCondition(getCondition(matcher.group(6)));
            directive.setConditional(conditional);
            directive.setLineNumbers(assembler.getLineNumbers());

            logger.info(
                    messages.getMessage(
                            Messages.LOG_INFO_POTENTIAL_DIRECTIVE_FOUND,
                            directive
                    )
            );

            return directive;
        } else {
            throw new AraraException(
                    messages.getMessage(
                            Messages.ERROR_VALIDATE_INVALID_DIRECTIVE_FORMAT,
                            CommonUtils.getCollectionElements(
                                    assembler.getLineNumbers(),
                                    "(",
                                    ")",
                                    ", "
                            )
                    )
            );
        }
    }

    /**
     * Gets the conditional type based on the input string.
     * @param text The input string.
     * @return The conditional type.
     */
    private static Conditional.ConditionalType getType(String text) {
        if (text == null) {
            return Conditional.ConditionalType.NONE;
        } else {
            if (text.equals("if")) {
                return Conditional.ConditionalType.IF;
            } else {
                if (text.equals("while")) {
                    return Conditional.ConditionalType.WHILE;
                } else {
                    if (text.equals("until")) {
                        return Conditional.ConditionalType.UNTIL;
                    } else {
                        return Conditional.ConditionalType.UNLESS;
                    }
                }
            }
        }
    }

    /**
     * Gets the condition from the input string.
     * @param text The input string.
     * @return A string representing the condition.
     */
    private static String getCondition(String text) {
        return text == null ? "" : text;
    }

    /**
     * Gets the parameters from the input string.
     * @param text The input string.
     * @param numbers The list of line numbers.
     * @return A map containing the directive parameters.
     * @throws AraraException Something wrong happened, to be caught in the
     * higher levels.
     */
    private static Map<String, Object> getParameters(String text,
            List<Integer> numbers) throws AraraException {

        if (text == null) {
            return new HashMap<String, Object>();
        }

        Yaml yaml = new Yaml(
                new Constructor(),
                new Representer(),
                new DumperOptions(),
                new DirectiveResolver()
        );
        try {
            @SuppressWarnings("unchecked")
            HashMap<String, Object> map = yaml.loadAs(text, HashMap.class);
            return map;
        } catch (MarkedYAMLException exception) {
            throw new AraraException(
                    messages.getMessage(
                            Messages.ERROR_VALIDATE_YAML_EXCEPTION,
                            CommonUtils.getCollectionElements(
                                    numbers,
                                    "(",
                                    ")",
                                    ", "
                            )
                    ),
                    exception
            );
        }
    }

    /**
     * Validates the list of directives, returning a new list.
     * @param directives The list of directives.
     * @return A new list of directives.
     * @throws AraraException Something wrong happened, to be caught in the
     * higher levels.
     */
    public static List<Directive> validate(List<Directive> directives)
            throws AraraException {

        ArrayList<Directive> result = new ArrayList<Directive>();
        for (Directive directive : directives) {
            Map<String, Object> parameters = directive.getParameters();

            if (parameters.containsKey("file")) {
                throw new AraraException(
                        messages.getMessage(
                                Messages.ERROR_VALIDATE_FILE_IS_RESERVED,
                                CommonUtils.getCollectionElements(
                                        directive.getLineNumbers(),
                                        "(",
                                        ")",
                                        ", "
                                )
                        )
                );
            }

            if (parameters.containsKey("reference")) {
                throw new AraraException(
                        messages.getMessage(
                                Messages.ERROR_VALIDATE_REFERENCE_IS_RESERVED,
                                CommonUtils.getCollectionElements(
                                        directive.getLineNumbers(),
                                        "(",
                                        ")",
                                        ", "
                                )
                        )
                );
            }

            if (parameters.containsKey("files")) {

                Object holder = parameters.get("files");
                if (holder instanceof List) {
                    @SuppressWarnings("unchecked")
                    List<Object> files = (List<Object>) holder;
                    parameters.remove("files");
                    if (files.isEmpty()) {
                        throw new AraraException(
                                messages.getMessage(
                                        Messages.ERROR_VALIDATE_EMPTY_FILES_LIST,
                                        CommonUtils.getCollectionElements(
                                                directive.getLineNumbers(),
                                                "(",
                                                ")",
                                                ", "
                                        )
                                )
                        );
                    }
                    for (Object file : files) {
                        Map<String, Object> map = new HashMap<String, Object>();
                        for (String key : parameters.keySet()) {
                            map.put(key, parameters.get(key));
                        }
                        File representation = CommonUtils.
                                getCanonicalFile(String.valueOf(file));

                        map.put("reference", representation);
                        map.put("file", representation.getName());

                        Directive addition = new Directive();
                        Conditional conditional = new Conditional();
                        conditional.setCondition(directive.getConditional().
                                getCondition()
                        );
                        conditional.setType(directive.getConditional().
                                getType()
                        );
                        addition.setIdentifier(directive.getIdentifier());
                        addition.setConditional(conditional);
                        addition.setParameters(map);
                        addition.setLineNumbers(directive.getLineNumbers());
                        result.add(addition);
                    }
                } else {
                    throw new AraraException(
                            messages.getMessage(
                                    Messages.ERROR_VALIDATE_FILES_IS_NOT_A_LIST,
                                    CommonUtils.getCollectionElements(
                                            directive.getLineNumbers(),
                                            "(",
                                            ")",
                                            ", "
                                    )
                            )
                    );
                }
            } else {
                File representation = (File) ConfigurationController.
                        getInstance().get("execution.reference");
                parameters.put("file", representation.getName());
                parameters.put("reference", representation);
                directive.setParameters(parameters);
                result.add(directive);
            }
        }

        logger.info(
                messages.getMessage(
                        Messages.LOG_INFO_VALIDATED_DIRECTIVES
                )
        );
        logger.info(DisplayUtils.displayOutputSeparator(
                messages.getMessage(
                        Messages.LOG_INFO_DIRECTIVES_BLOCK
                )
        ));
        for (Directive directive : result) {
            logger.info(directive.toString());
        }

        logger.info(DisplayUtils.displaySeparator());

        return result;
    }
    
    /**
     * Checks if the provided line contains the corresponding pattern, based on
     * the file type, or an empty line.
     * @param pattern Pattern to be matched, based on the file type.
     * @param line Provided line.
     * @return Logical value indicating if the provided line contains the
     * corresponding pattern, based on the file type, or an empty line.
     */
    private static boolean checkLinePattern(Pattern pattern, String line) {
        return CommonUtils.checkEmptyString(line.trim()) ||
                pattern.matcher(line).find();
    }

}