blob: 01e45c4df3633ca5f052c39c3fa0ecb1d241ee13 [file] [log] [blame]
Radek Krejci5819f7c2019-05-31 14:53:29 +02001/**
2 * @file main.c
3 * @author Radek Krejci <rkrejci@cesnet.cz>
4 * @brief libyang's YANG Regular Expression tool
5 *
6 * Copyright (c) 2017 CESNET, z.s.p.o.
7 *
8 * This source code is licensed under BSD 3-Clause License (the "License").
9 * You may not use this file except in compliance with the License.
10 * You may obtain a copy of the License at
11 *
12 * https://opensource.org/licenses/BSD-3-Clause
13 */
14
Radek Krejci535ea9f2020-05-29 16:01:05 +020015#define _GNU_SOURCE
Radek Krejci5819f7c2019-05-31 14:53:29 +020016
17#include <errno.h>
18#include <fcntl.h>
19#include <stdio.h>
20#include <stdlib.h>
21#include <sys/stat.h>
22#include <sys/types.h>
23#include <string.h>
24#include <getopt.h>
25#include <unistd.h>
26
Radek Krejci535ea9f2020-05-29 16:01:05 +020027#include "libyang.h"
28
29#include "tools/config.h"
Michal Vasko5aa44c02020-06-29 11:47:02 +020030#include "compat.h"
Radek Krejci5819f7c2019-05-31 14:53:29 +020031
32void
33help(void)
34{
35 fprintf(stdout, "YANG Regular Expressions processor.\n");
36 fprintf(stdout, "Usage:\n");
37 fprintf(stdout, " yangre [-hv]\n");
38 fprintf(stdout, " yangre [-V] -p <regexp1> [-i] [-p <regexp2> [-i] ...] <string>\n");
39 fprintf(stdout, " yangre [-V] -f <file>\n");
40 fprintf(stdout, "Returns 0 if string matches the pattern(s), 1 if not and -1 on error.\n\n");
41 fprintf(stdout, "Options:\n"
42 " -h, --help Show this help message and exit.\n"
43 " -v, --version Show version number and exit.\n"
44 " -V, --verbose Print the processing information.\n"
45 " -i, --invert-match Invert-match modifier for the closest preceding\n"
46 " pattern.\n"
47 " -p, --pattern=\"REGEXP\" Regular expression including the quoting,\n"
48 " which is applied the same way as in a YANG module.\n"
49 " -f, --file=\"FILE\" List of patterns and the <string> (separated by an\n"
50 " empty line) are taken from <file>. Invert-match is\n"
51 " indicated by the single space character at the \n"
52 " beginning of the pattern line. YANG quotation around\n"
53 " patterns is still expected, but that avoids issues with\n"
54 " reading quotation by shell. Avoid newline at the end\n"
55 " of the string line to represent empty <string>.");
56 fprintf(stdout, "Examples:\n"
57 " pattern \"[0-9a-fA-F]*\"; -> yangre -p '\"[0-9a-fA-F]*\"' '1F'\n"
58 " pattern '[a-zA-Z0-9\\-_.]*'; -> yangre -p \"'[a-zA-Z0-9\\-_.]*'\" 'a-b'\n"
59 " pattern [xX][mM][lL].*; -> yangre -p '[xX][mM][lL].*' 'xml-encoding'\n\n");
60 fprintf(stdout, "Note that to pass YANG quoting through your shell, you are supposed to use\n"
61 "the other quotation around. For not-quoted patterns, use single quotes.\n\n");
62}
63
64void
65version(void)
66{
67 fprintf(stdout, "yangre %s\n", PROJECT_VERSION);
68}
69
70void
71pattern_error(LY_LOG_LEVEL level, const char *msg, const char *path)
72{
73 (void) path; /* unused */
74
75 if (level == LY_LLERR && strcmp(msg, "Module \"yangre\" parsing failed.")) {
76 fprintf(stderr, "yangre error: %s\n", msg);
77 }
78}
79
80static const char *module_start = "module yangre {"
81 "yang-version 1.1;"
82 "namespace urn:cesnet:libyang:yangre;"
83 "prefix re;"
84 "leaf pattern {"
85 " type string {";
86static const char *module_invertmatch = " { modifier invert-match; }";
87static const char *module_match = ";";
88static const char *module_end = "}}}";
89
90static int
91add_pattern(char ***patterns, int **inverts, int *counter, char *pattern)
92{
93 void *reallocated1, *reallocated2;
94
95 (*counter)++;
96 reallocated1 = realloc(*patterns, *counter * sizeof **patterns);
97 reallocated2 = realloc(*inverts, *counter * sizeof **inverts);
98 if (!reallocated1 || !reallocated2) {
99 fprintf(stderr, "yangre error: memory allocation error.\n");
100 free(reallocated1);
101 free(reallocated2);
102 return EXIT_FAILURE;
103 }
104 (*patterns) = reallocated1;
105 (*patterns)[*counter - 1] = strdup(pattern);
106 (*inverts) = reallocated2;
107 (*inverts)[*counter - 1] = 0;
108
109 return EXIT_SUCCESS;
110}
111
112int
113main(int argc, char* argv[])
114{
115 LY_ERR match;
116 int i, opt_index = 0, ret = -1, verbose = 0, blankline = 0;
117 struct option options[] = {
118 {"help", no_argument, NULL, 'h'},
119 {"file", required_argument, NULL, 'f'},
120 {"invert-match", no_argument, NULL, 'i'},
121 {"pattern", required_argument, NULL, 'p'},
122 {"version", no_argument, NULL, 'v'},
123 {"verbose", no_argument, NULL, 'V'},
124 {NULL, 0, NULL, 0}
125 };
126 char **patterns = NULL, *str = NULL, *modstr = NULL, *s;
127 int *invert_match = NULL;
128 int patterns_count = 0;
129 struct ly_ctx *ctx = NULL;
130 const struct lys_module *mod;
131 FILE *infile = NULL;
132 size_t len = 0;
133 ssize_t l;
134 struct lysc_type *type;
Radek Krejci99afd3a2019-06-03 09:30:57 +0200135 struct ly_err_item *err = NULL;
Radek Krejci5819f7c2019-05-31 14:53:29 +0200136
137 opterr = 0;
138 while ((i = getopt_long(argc, argv, "hf:ivVp:", options, &opt_index)) != -1) {
139 switch (i) {
140 case 'h':
141 help();
142 ret = -2; /* continue to allow printing version and help at once */
143 break;
144 case 'f':
145 if (infile) {
146 help();
147 fprintf(stderr, "yangre error: multiple input files are not supported.\n");
148 goto cleanup;
149 } else if (patterns_count) {
150 help();
151 fprintf(stderr, "yangre error: command line patterns cannot be mixed with file input.\n");
152 goto cleanup;
153 }
154 infile = fopen(optarg, "r");
155 if (!infile) {
156 fprintf(stderr, "yangre error: unable to open input file %s (%s).\n", optarg, strerror(errno));
157 goto cleanup;
158 }
159
160 while((l = getline(&str, &len, infile)) != -1) {
161 if (!blankline && str[0] == '\n') {
162 /* blank line */
163 blankline = 1;
164 continue;
165 }
166 if (str[0] != '\n' && str[l - 1] == '\n') {
167 /* remove ending newline */
168 str[l - 1] = '\0';
169 }
170 if (blankline) {
171 /* done - str is now the string to check */
172 blankline = 0;
173 break;
174 /* else read the patterns */
175 } else if (add_pattern(&patterns, &invert_match, &patterns_count,
176 str[0] == ' ' ? &str[1] : str)) {
177 goto cleanup;
178 }
179 if (str[0] == ' ') {
180 /* set invert-match */
181 invert_match[patterns_count - 1] = 1;
182 }
183 }
184 if (blankline) {
185 /* corner case, no input after blankline meaning the pattern to check is empty */
186 if (str != NULL) {
187 free(str);
188 }
189 str = malloc(sizeof(char));
190 str[0] = '\0';
191 }
192 break;
193 case 'i':
194 if (!patterns_count || invert_match[patterns_count - 1]) {
195 help();
196 fprintf(stderr, "yangre error: invert-match option must follow some pattern.\n");
197 goto cleanup;
198 }
199 invert_match[patterns_count - 1] = 1;
200 break;
201 case 'p':
202 if (infile) {
203 help();
204 fprintf(stderr, "yangre error: command line patterns cannot be mixed with file input.\n");
205 goto cleanup;
206 }
207 if (add_pattern(&patterns, &invert_match, &patterns_count, optarg)) {
208 goto cleanup;
209 }
210 break;
211 case 'v':
212 version();
213 ret = -2; /* continue to allow printing version and help at once */
214 break;
215 case 'V':
216 verbose = 1;
217 break;
218 default:
219 help();
220 if (optopt) {
221 fprintf(stderr, "yangre error: invalid option: -%c\n", optopt);
222 } else {
223 fprintf(stderr, "yangre error: invalid option: %s\n", argv[optind - 1]);
224 }
225 goto cleanup;
226 }
227 }
228
229 if (ret == -2) {
230 goto cleanup;
231 }
232
233 if (!str) {
234 /* check options compatibility */
235 if (optind >= argc) {
236 help();
237 fprintf(stderr, "yangre error: missing <string> parameter to process.\n");
238 goto cleanup;
239 } else if (!patterns_count) {
240 help();
241 fprintf(stderr, "yangre error: missing pattern parameter to use.\n");
242 goto cleanup;
243 }
244 str = argv[optind];
245 }
246
247 for (modstr = (char*)module_start, i = 0; i < patterns_count; i++) {
248 if (asprintf(&s, "%s pattern %s%s", modstr, patterns[i], invert_match[i] ? module_invertmatch : module_match) == -1) {
249 fprintf(stderr, "yangre error: memory allocation failed.\n");
250 goto cleanup;
251 }
252 if (modstr != module_start) {
253 free(modstr);
254 }
255 modstr = s;
256 }
257 if (asprintf(&s, "%s%s", modstr, module_end) == -1) {
258 fprintf(stderr, "yangre error: memory allocation failed.\n");
259 goto cleanup;
260 }
261 if (modstr != module_start) {
262 free(modstr);
263 }
264 modstr = s;
265
266 if (ly_ctx_new(NULL, 0, &ctx)) {
267 goto cleanup;
268 }
269
270 ly_set_log_clb(pattern_error, 0);
Michal Vasko3a41dff2020-07-15 14:30:28 +0200271 if (lys_parse_mem(ctx, modstr, LYS_IN_YANG, &mod) || !mod->compiled || !mod->compiled->data) {
Radek Krejci5819f7c2019-05-31 14:53:29 +0200272 goto cleanup;
273 }
274
275 type = ((struct lysc_node_leaf*)mod->compiled->data)->type;
Radek Krejci73dead22019-07-11 16:46:16 +0200276 match = type->plugin->store(ctx, type, str, strlen(str), 0, NULL, NULL, LYD_XML, NULL, NULL, NULL, NULL, &err);
Radek Krejci5819f7c2019-05-31 14:53:29 +0200277 if (verbose) {
278 for (i = 0; i < patterns_count; i++) {
279 fprintf(stdout, "pattern %d: %s\n", i + 1, patterns[i]);
280 fprintf(stdout, "matching %d: %s\n", i + 1, invert_match[i] ? "inverted" : "regular");
281 }
282 fprintf(stdout, "string : %s\n", str);
283 if (match == LY_SUCCESS) {
284 fprintf(stdout, "result : matching\n");
285 } else if (match == LY_EVALID) {
286 fprintf(stdout, "result : not matching\n");
287 } else {
288 fprintf(stdout, "result : error (%s)\n", err->msg);
289 }
290 }
291 if (match == LY_SUCCESS) {
292 ret = 0;
293 } else if (match == LY_EVALID) {
294 ret = 1;
295 } else {
296 ret = -1;
297 }
298
299cleanup:
300 ly_ctx_destroy(ctx, NULL);
301 for (i = 0; i < patterns_count; i++) {
302 free(patterns[i]);
303 }
304 free(patterns);
305 free(invert_match);
306 free(modstr);
307 if (infile) {
308 fclose(infile);
309 free(str);
310 }
311 ly_err_free(err);
312
313 return ret;
314}