libecoli/ecoli_node_re_lex.c

   1 /* SPDX-License-Identifier: BSD-3-Clause
   2  * Copyright 2016, Olivier MATZ <zer0@droids-corp.org>
   3  */
   4
   5 #include <stdio.h>
   6 #include <stdlib.h>
   7 #include <stdbool.h>
   8 #include <string.h>
   9 #include <regex.h>
  10 #include <errno.h>
  11
  12 #include <ecoli_malloc.h>
  13 #include <ecoli_log.h>
  14 #include <ecoli_test.h>
  15 #include <ecoli_strvec.h>
  16 #include <ecoli_keyval.h>
  17 #include <ecoli_node.h>
  18 #include <ecoli_complete.h>
  19 #include <ecoli_parse.h>
  20 #include <ecoli_config.h>
  21 #include <ecoli_node_many.h>
  22 #include <ecoli_node_or.h>
  23 #include <ecoli_node_str.h>
  24 #include <ecoli_node_int.h>
  25 #include <ecoli_node_re_lex.h>
  26
  27 EC_LOG_TYPE_REGISTER(node_re_lex);
  28
  29 struct regexp_pattern {
  30         char *pattern;
  31         char *attr_name;
  32         regex_t r;
  33         bool keep;
  34 };
  35
  36 struct ec_node_re_lex {
  37         struct ec_node gen;
  38         struct ec_node *child;
  39         struct regexp_pattern *table;
  40         size_t len;
  41 };
  42
  43 static struct ec_strvec *
  44 tokenize(struct regexp_pattern *table, size_t table_len, const char *str)
  45 {
  46         struct ec_strvec *strvec = NULL;
  47         struct ec_keyval *attrs = NULL;
  48         char *dup = NULL;
  49         char c;
  50         size_t len, off = 0;
  51         size_t i;
  52         int ret;
  53         regmatch_t pos;
  54
  55         dup = ec_strdup(str);
  56         if (dup == NULL)
  57                 goto fail;
  58
  59         strvec = ec_strvec();
  60         if (strvec == NULL)
  61                 goto fail;
  62
  63         len = strlen(dup);
  64         while (off < len) {
  65                 for (i = 0; i < table_len; i++) {
  66                         ret = regexec(&table[i].r, &dup[off], 1, &pos, 0);
  67                         if (ret != 0)
  68                                 continue;
  69                         if (pos.rm_so != 0 || pos.rm_eo == 0) {
  70                                 ret = -1;
  71                                 continue;
  72                         }
  73
  74                         if (table[i].keep == 0)
  75                                 break;
  76
  77                         c = dup[pos.rm_eo + off];
  78                         dup[pos.rm_eo + off] = '\0';
  79                         EC_LOG(EC_LOG_DEBUG, "re_lex match <%s>\n", &dup[off]);
  80                         if (ec_strvec_add(strvec, &dup[off]) < 0)
  81                                 goto fail;
  82
  83                         if (table[i].attr_name != NULL) {
  84                                 attrs = ec_keyval();
  85                                 if (attrs == NULL)
  86                                         goto fail;
  87                                 if (ec_keyval_set(attrs, table[i].attr_name,
  88                                                 NULL, NULL) < 0)
  89                                         goto fail;
  90                                 if (ec_strvec_set_attrs(strvec,
  91                                                 ec_strvec_len(strvec) - 1,
  92                                                 attrs) < 0) {
  93                                         attrs = NULL;
  94                                         goto fail;
  95                                 }
  96                                 attrs = NULL;
  97                         }
  98
  99                         dup[pos.rm_eo + off] = c;
 100                         break;
 101                 }
 102
 103                 if (ret != 0)
 104                         goto fail;
 105
 106                 off += pos.rm_eo;
 107         }
 108
 109         ec_free(dup);
 110         return strvec;
 111
 112 fail:
 113         ec_free(dup);
 114         ec_strvec_free(strvec);
 115         return NULL;
 116 }
 117
 118 static int
 119 ec_node_re_lex_parse(const struct ec_node *gen_node,
 120                 struct ec_parse *state,
 121                 const struct ec_strvec *strvec)
 122 {
 123         struct ec_node_re_lex *node = (struct ec_node_re_lex *)gen_node;
 124         struct ec_strvec *new_vec = NULL;
 125         struct ec_parse *child_parse;
 126         const char *str;
 127         int ret;
 128
 129         if (node->child == NULL) {
 130                 errno = EINVAL;
 131                 goto fail;
 132         }
 133
 134         if (ec_strvec_len(strvec) == 0) {
 135                 new_vec = ec_strvec();
 136         } else {
 137                 str = ec_strvec_val(strvec, 0);
 138                 new_vec = tokenize(node->table, node->len, str);
 139         }
 140         if (new_vec == NULL)
 141                 goto fail;
 142
 143         ret = ec_node_parse_child(node->child, state, new_vec);
 144         if (ret < 0)
 145                 goto fail;
 146
 147         if ((unsigned)ret == ec_strvec_len(new_vec)) {
 148                 ret = 1;
 149         } else if (ret != EC_PARSE_NOMATCH) {
 150                 child_parse = ec_parse_get_last_child(state);
 151                 ec_parse_unlink_child(state, child_parse);
 152                 ec_parse_free(child_parse);
 153                 ret = EC_PARSE_NOMATCH;
 154         }
 155
 156         ec_strvec_free(new_vec);
 157         new_vec = NULL;
 158
 159         return ret;
 160
 161  fail:
 162         ec_strvec_free(new_vec);
 163         return -1;
 164 }
 165
 166 static void ec_node_re_lex_free_priv(struct ec_node *gen_node)
 167 {
 168         struct ec_node_re_lex *node = (struct ec_node_re_lex *)gen_node;
 169         unsigned int i;
 170
 171         ec_node_free(node->child);
 172         for (i = 0; i < node->len; i++) {
 173                 ec_free(node->table[i].pattern);
 174                 ec_free(node->table[i].attr_name);
 175                 regfree(&node->table[i].r);
 176         }
 177
 178         ec_free(node->table);
 179 }
 180
 181 static size_t
 182 ec_node_re_lex_get_children_count(const struct ec_node *gen_node)
 183 {
 184         struct ec_node_re_lex *node = (struct ec_node_re_lex *)gen_node;
 185
 186         if (node->child)
 187                 return 1;
 188         return 0;
 189 }
 190
 191 static int
 192 ec_node_re_lex_get_child(const struct ec_node *gen_node, size_t i,
 193                         struct ec_node **child, unsigned int *refs)
 194 {
 195         struct ec_node_re_lex *node = (struct ec_node_re_lex *)gen_node;
 196
 197         if (i >= 1)
 198                 return -1;
 199
 200         *child = node->child;
 201         *refs = 2;
 202         return 0;
 203 }
 204
 205 static const struct ec_config_schema ec_node_re_lex_dict[] = {
 206         {
 207                 .key = "pattern",
 208                 .desc = "The pattern to match.",
 209                 .type = EC_CONFIG_TYPE_STRING,
 210         },
 211         {
 212                 .key = "keep",
 213                 .desc = "Whether to keep or drop the string matching "
 214                 "the regular expression.",
 215                 .type = EC_CONFIG_TYPE_BOOL,
 216         },
 217         {
 218                 .key = "attr",
 219                 .desc = "The optional attribute name to attach.",
 220                 .type = EC_CONFIG_TYPE_STRING,
 221         },
 222         {
 223                 .type = EC_CONFIG_TYPE_NONE,
 224         },
 225 };
 226
 227 static const struct ec_config_schema ec_node_re_lex_elt[] = {
 228         {
 229                 .desc = "A pattern element.",
 230                 .type = EC_CONFIG_TYPE_DICT,
 231                 .subschema = ec_node_re_lex_dict,
 232         },
 233         {
 234                 .type = EC_CONFIG_TYPE_NONE,
 235         },
 236 };
 237
 238 static const struct ec_config_schema ec_node_re_lex_schema[] = {
 239         {
 240                 .key = "patterns",
 241                 .desc = "The list of patterns elements.",
 242                 .type = EC_CONFIG_TYPE_LIST,
 243                 .subschema = ec_node_re_lex_elt,
 244         },
 245         {
 246                 .key = "child",
 247                 .desc = "The child node.",
 248                 .type = EC_CONFIG_TYPE_NODE,
 249         },
 250         {
 251                 .type = EC_CONFIG_TYPE_NONE,
 252         },
 253 };
 254
 255 static int ec_node_re_lex_set_config(struct ec_node *gen_node,
 256                                 const struct ec_config *config)
 257 {
 258         struct ec_node_re_lex *node = (struct ec_node_re_lex *)gen_node;
 259         struct regexp_pattern *table = NULL;
 260         const struct ec_config *patterns, *child, *elt, *pattern, *keep, *attr;
 261         char *pattern_str = NULL, *attr_name = NULL;
 262         ssize_t i, n = 0;
 263         int ret;
 264
 265         child = ec_config_dict_get(config, "child");
 266         if (child == NULL)
 267                 goto fail;
 268         if (ec_config_get_type(child) != EC_CONFIG_TYPE_NODE) {
 269                 errno = EINVAL;
 270                 goto fail;
 271         }
 272
 273         patterns = ec_config_dict_get(config, "patterns");
 274         if (patterns != NULL) {
 275                 n = ec_config_count(patterns);
 276                 if (n < 0)
 277                         goto fail;
 278
 279                 table = ec_calloc(n, sizeof(*table));
 280                 if (table == NULL)
 281                         goto fail;
 282
 283                 n = 0;
 284                 TAILQ_FOREACH(elt, &patterns->list, next) {
 285                         if (ec_config_get_type(elt) != EC_CONFIG_TYPE_DICT) {
 286                                 errno = EINVAL;
 287                                 goto fail;
 288                         }
 289                         pattern = ec_config_dict_get(elt, "pattern");
 290                         if (pattern == NULL) {
 291                                 errno = EINVAL;
 292                                 goto fail;
 293                         }
 294                         if (ec_config_get_type(pattern) != EC_CONFIG_TYPE_STRING) {
 295                                 errno = EINVAL;
 296                                 goto fail;
 297                         }
 298                         keep = ec_config_dict_get(elt, "keep");
 299                         if (keep == NULL) {
 300                                 errno = EINVAL;
 301                                 goto fail;
 302                         }
 303                         if (ec_config_get_type(keep) != EC_CONFIG_TYPE_BOOL) {
 304                                 errno = EINVAL;
 305                                 goto fail;
 306                         }
 307                         attr = ec_config_dict_get(elt, "attr");
 308                         if (attr != NULL && ec_config_get_type(attr) !=
 309                                         EC_CONFIG_TYPE_STRING) {
 310                                 errno = EINVAL;
 311                                 goto fail;
 312                         }
 313                         pattern_str = ec_strdup(pattern->string);
 314                         if (pattern_str == NULL)
 315                                 goto fail;
 316                         if (attr != NULL && attr->string != NULL) {
 317                                 attr_name = ec_strdup(attr->string);
 318                                 if (attr_name == NULL)
 319                                         goto fail;
 320                         }
 321
 322                         ret = regcomp(&table[n].r, pattern_str, REG_EXTENDED);
 323                         if (ret != 0) {
 324                                 EC_LOG(EC_LOG_ERR,
 325                                         "Regular expression <%s> compilation failed: %d\n",
 326                                         pattern_str, ret);
 327                                 if (ret == REG_ESPACE)
 328                                         errno = ENOMEM;
 329                                 else
 330                                         errno = EINVAL;
 331                                 goto fail;
 332                         }
 333                         table[n].pattern = pattern_str;
 334                         table[n].keep = keep->boolean;
 335                         table[n].attr_name = attr_name;
 336                         pattern_str = NULL;
 337                         attr_name = NULL;
 338
 339                         n++;
 340                 }
 341         }
 342
 343         if (node->child != NULL)
 344                 ec_node_free(node->child);
 345         node->child = ec_node_clone(child->node);
 346         for (i = 0; i < (ssize_t)node->len; i++) {
 347                 ec_free(node->table[i].pattern);
 348                 regfree(&node->table[i].r);
 349         }
 350         ec_free(node->table);
 351         node->table = table;
 352         node->len = n;
 353
 354         return 0;
 355
 356 fail:
 357         if (table != NULL) {
 358                 for (i = 0; i < n; i++) {
 359                         if (table[i].pattern != NULL) {
 360                                 ec_free(table[i].pattern);
 361                                 regfree(&table[i].r);
 362                         }
 363                 }
 364         }
 365         ec_free(table);
 366         ec_free(pattern_str);
 367         return -1;
 368 }
 369
 370 static struct ec_node_type ec_node_re_lex_type = {
 371         .name = "re_lex",
 372         .schema = ec_node_re_lex_schema,
 373         .set_config = ec_node_re_lex_set_config,
 374         .parse = ec_node_re_lex_parse,
 375         .complete = ec_node_complete_unknown,
 376         .size = sizeof(struct ec_node_re_lex),
 377         .free_priv = ec_node_re_lex_free_priv,
 378         .get_children_count = ec_node_re_lex_get_children_count,
 379         .get_child = ec_node_re_lex_get_child,
 380 };
 381
 382 EC_NODE_TYPE_REGISTER(ec_node_re_lex_type);
 383
 384 int ec_node_re_lex_add(struct ec_node *gen_node, const char *pattern, int keep,
 385         const char *attr_name)
 386 {
 387         const struct ec_config *cur_config = NULL;
 388         struct ec_config *config = NULL, *patterns = NULL, *elt = NULL;
 389         int ret;
 390
 391         if (ec_node_check_type(gen_node, &ec_node_re_lex_type) < 0)
 392                 goto fail;
 393
 394         elt = ec_config_dict();
 395         if (elt == NULL)
 396                 goto fail;
 397         if (ec_config_dict_set(elt, "pattern", ec_config_string(pattern)) < 0)
 398                 goto fail;
 399         if (ec_config_dict_set(elt, "keep", ec_config_bool(keep)) < 0)
 400                 goto fail;
 401         if (attr_name != NULL) {
 402                 if (ec_config_dict_set(elt, "attr",
 403                                         ec_config_string(attr_name)) < 0)
 404                         goto fail;
 405         }
 406
 407         cur_config = ec_node_get_config(gen_node);
 408         if (cur_config == NULL)
 409                 config = ec_config_dict();
 410         else
 411                 config = ec_config_dup(cur_config);
 412         if (config == NULL)
 413                 goto fail;
 414
 415         patterns = ec_config_dict_get(config, "patterns");
 416         if (patterns == NULL) {
 417                 patterns = ec_config_list();
 418                 if (patterns == NULL)
 419                         goto fail;
 420
 421                 if (ec_config_dict_set(config, "patterns", patterns) < 0)
 422                         goto fail; /* patterns list is freed on error */
 423         }
 424
 425         if (ec_config_list_add(patterns, elt) < 0) {
 426                 elt = NULL;
 427                 goto fail;
 428         }
 429         elt = NULL;
 430
 431         ret = ec_node_set_config(gen_node, config);
 432         config = NULL; /* freed */
 433         if (ret < 0)
 434                 goto fail;
 435
 436         return 0;
 437
 438 fail:
 439         ec_config_free(config);
 440         ec_config_free(elt);
 441         return -1;
 442 }
 443
 444 static int
 445 ec_node_re_lex_set_child(struct ec_node *gen_node, struct ec_node *child)
 446 {
 447         const struct ec_config *cur_config = NULL;
 448         struct ec_config *config = NULL;
 449         int ret;
 450
 451         if (ec_node_check_type(gen_node, &ec_node_re_lex_type) < 0)
 452                 goto fail;
 453
 454         cur_config = ec_node_get_config(gen_node);
 455         if (cur_config == NULL)
 456                 config = ec_config_dict();
 457         else
 458                 config = ec_config_dup(cur_config);
 459         if (config == NULL)
 460                 goto fail;
 461
 462         if (ec_config_dict_set(config, "child", ec_config_node(child)) < 0) {
 463                 child = NULL; /* freed */
 464                 goto fail;
 465         }
 466         child = NULL; /* freed */
 467
 468         ret = ec_node_set_config(gen_node, config);
 469         config = NULL; /* freed */
 470         if (ret < 0)
 471                 goto fail;
 472
 473         return 0;
 474
 475 fail:
 476         ec_config_free(config);
 477         ec_node_free(child);
 478         return -1;
 479 }
 480
 481 struct ec_node *ec_node_re_lex(const char *id, struct ec_node *child)
 482 {
 483         struct ec_node *gen_node = NULL;
 484
 485         if (child == NULL)
 486                 return NULL;
 487
 488         gen_node = ec_node_from_type(&ec_node_re_lex_type, id);
 489         if (gen_node == NULL)
 490                 goto fail;
 491
 492         if (ec_node_re_lex_set_child(gen_node, child) < 0) {
 493                 child = NULL; /* freed */
 494                 goto fail;
 495         }
 496
 497         return gen_node;
 498
 499 fail:
 500         ec_node_free(gen_node);
 501         ec_node_free(child);
 502         return NULL;
 503 }
 504
 505 /* LCOV_EXCL_START */
 506 static int ec_node_re_lex_testcase(void)
 507 {
 508         struct ec_node *node;
 509         int ret, testres = 0;
 510
 511         node = ec_node_re_lex(EC_NO_ID,
 512                 ec_node_many(EC_NO_ID,
 513                         EC_NODE_OR(EC_NO_ID,
 514                                 ec_node_str(EC_NO_ID, "foo"),
 515                                 ec_node_str(EC_NO_ID, "bar"),
 516                                 ec_node_int(EC_NO_ID, 0, 1000, 0)
 517                         ), 0, 0
 518                 )
 519         );
 520         if (node == NULL) {
 521                 EC_LOG(EC_LOG_ERR, "cannot create node\n");
 522                 return -1;
 523         }
 524
 525         ret = ec_node_re_lex_add(node, "[a-zA-Z]+", 1, NULL);
 526         testres |= EC_TEST_CHECK(ret == 0, "cannot add regexp");
 527         ret = ec_node_re_lex_add(node, "[0-9]+", 1, NULL);
 528         testres |= EC_TEST_CHECK(ret == 0, "cannot add regexp");
 529         ret = ec_node_re_lex_add(node, "=", 1, NULL);
 530         testres |= EC_TEST_CHECK(ret == 0, "cannot add regexp");
 531         ret = ec_node_re_lex_add(node, "-", 1, NULL);
 532         testres |= EC_TEST_CHECK(ret == 0, "cannot add regexp");
 533         ret = ec_node_re_lex_add(node, "\\+", 1, NULL);
 534         testres |= EC_TEST_CHECK(ret == 0, "cannot add regexp");
 535         ret = ec_node_re_lex_add(node, "[       ]+", 0, NULL);
 536         testres |= EC_TEST_CHECK(ret == 0, "cannot add regexp");
 537         if (ret != 0) {
 538                 EC_LOG(EC_LOG_ERR, "cannot add regexp to node\n");
 539                 ec_node_free(node);
 540                 return -1;
 541         }
 542
 543         testres |= EC_TEST_CHECK_PARSE(node, 1, "  foo bar  324 bar234");
 544         testres |= EC_TEST_CHECK_PARSE(node, 1, "foo bar324");
 545         testres |= EC_TEST_CHECK_PARSE(node, 1, "");
 546         testres |= EC_TEST_CHECK_PARSE(node, -1, "foobar");
 547
 548         /* no completion */
 549         testres |= EC_TEST_CHECK_COMPLETE(node,
 550                 "", EC_NODE_ENDLIST,
 551                 EC_NODE_ENDLIST);
 552
 553         ec_node_free(node);
 554
 555         return testres;
 556 }
 557 /* LCOV_EXCL_STOP */
 558
 559 static struct ec_test ec_node_re_lex_test = {
 560         .name = "node_re_lex",
 561         .test = ec_node_re_lex_testcase,
 562 };
 563
 564 EC_TEST_REGISTER(ec_node_re_lex_test);