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
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
|
/*
** Zabbix
** Copyright (C) 2001-2021 Zabbix SIA
**
** This program is free software; you can redistribute it and/or modify
** it under the terms of the GNU General Public License as published by
** the Free Software Foundation; either version 2 of the License, or
** (at your option) any later version.
**
** This program is distributed in the hope that it will be useful,
** but WITHOUT ANY WARRANTY; without even the implied warranty of
** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
** GNU General Public License for more details.
**
** You should have received a copy of the GNU General Public License
** along with this program; if not, write to the Free Software
** Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
**/
#include "common.h"
#include "zbxregexp.h"
#include "log.h"
#ifdef USE_PCRE
#ifdef USE_PCRE2
#error "cannot use both pcre and pcre2 at the same time!"
#endif
#define ZBX_REGEXP_MULTILINE PCRE_MULTILINE
#ifdef PCRE_NO_AUTO_CAPTURE
#define ZBX_REGEXP_NO_AUTO_CAPTURE PCRE_NO_AUTO_CAPTURE
#endif
#define ZBX_REGEXP_CASELESS PCRE_CASELESS
#endif
#ifndef USE_PCRE
#ifndef USE_PCRE2
#error "must use pcre or pcre2!"
#endif
#define ZBX_REGEXP_MULTILINE PCRE2_MULTILINE
#ifdef PCRE2_NO_AUTO_CAPTURE
#define ZBX_REGEXP_NO_AUTO_CAPTURE PCRE2_NO_AUTO_CAPTURE
#endif
#define ZBX_REGEXP_CASELESS PCRE2_CASELESS
#define ZBX_REGEXP_ERR_MSG_SIZE 256
#endif
struct zbx_regexp
{
#ifdef USE_PCRE
pcre *pcre_regexp;
struct pcre_extra *extra;
#endif
#ifdef USE_PCRE2
pcre2_code *pcre2_regexp;
pcre2_match_context *match_ctx;
#endif
};
/* maps to ovector of pcre_exec() */
typedef struct
{
int rm_so;
int rm_eo;
}
zbx_regmatch_t;
#define ZBX_REGEXP_GROUPS_MAX 10 /* Max number of supported capture groups in regular expressions. */
/* Group \0 contains the matching part of string, groups \1 ...\9 */
/* contain captured groups (substrings). */
/******************************************************************************
* *
* Function: regexp_compile *
* *
* Purpose: compiles a regular expression *
* *
* Parameters: *
* pattern - [IN] regular expression as a text string. Empty *
* string ("") is allowed, it will match everything. *
* NULL is not allowed. *
* flags - [IN] regexp compilation parameters passed to pcre_compile. *
* ZBX_REGEXP_CASELESS, ZBX_REGEXP_NO_AUTO_CAPTURE, *
* ZBX_REGEXP_MULTILINE. *
* regexp - [OUT] output regexp. *
* err_msg - [OUT] error message if any. *
* Free with zbx_regexp_err_msg_free() *
* *
* Return value: SUCCEED or FAIL *
* *
******************************************************************************/
static int regexp_compile(const char *pattern, int flags, zbx_regexp_t **regexp, const char **err_msg)
{
#ifdef USE_PCRE
int error_offset = -1;
pcre *pcre_regexp;
struct pcre_extra *extra;
#endif
#ifdef USE_PCRE2
pcre2_code *pcre2_regexp;
pcre2_match_context *match_ctx;
int error = 0;
PCRE2_SIZE error_offset = 0;
char *err_msg_buff = NULL;
#endif
#ifdef ZBX_REGEXP_NO_AUTO_CAPTURE
/* If ZBX_REGEXP_NO_AUTO_CAPTURE bit is set in 'flags' but regular expression contains references to numbered */
/* capturing groups then reset ZBX_REGEXP_NO_AUTO_CAPTURE bit. */
/* Otherwise the regular expression might not compile. */
if (0 != (flags & ZBX_REGEXP_NO_AUTO_CAPTURE))
{
const char *pstart = pattern, *offset;
while (NULL != (offset = strchr(pstart, '\\')))
{
offset++;
if (('1' <= *offset && *offset <= '9') || 'g' == *offset)
{
flags ^= ZBX_REGEXP_NO_AUTO_CAPTURE;
break;
}
if (*offset == '\\')
offset++;
pstart = offset;
}
}
#endif
#ifdef USE_PCRE
if (NULL == (pcre_regexp = pcre_compile(pattern, flags, err_msg, &error_offset, NULL)))
return FAIL;
if (NULL != regexp)
{
if (NULL == (extra = pcre_study(pcre_regexp, 0, err_msg)) && NULL != *err_msg)
{
pcre_free(pcre_regexp);
return FAIL;
}
*regexp = (zbx_regexp_t *)zbx_malloc(NULL, sizeof(zbx_regexp_t));
(*regexp)->pcre_regexp = pcre_regexp;
(*regexp)->extra = extra;
}
else
pcre_free(pcre_regexp);
#endif
#ifdef USE_PCRE2
*err_msg = NULL;
if (NULL == (pcre2_regexp = pcre2_compile(pattern, PCRE2_ZERO_TERMINATED, PCRE2_UTF | flags, &error,
&error_offset, NULL)))
{
err_msg_buff = zbx_malloc(NULL, ZBX_REGEXP_ERR_MSG_SIZE);
pcre2_get_error_message(error, err_msg_buff, ZBX_REGEXP_ERR_MSG_SIZE);
*err_msg = (const char*)err_msg_buff;
return FAIL;
}
if (NULL != regexp)
{
match_ctx = pcre2_match_context_create(NULL);
if (NULL == match_ctx)
{
pcre2_code_free(pcre2_regexp);
return FAIL;
}
*regexp = (zbx_regexp_t *)zbx_malloc(NULL, sizeof(zbx_regexp_t));
(*regexp)->pcre2_regexp = pcre2_regexp;
(*regexp)->match_ctx = match_ctx;
}
else
pcre2_code_free(pcre2_regexp);
#endif
return SUCCEED;
}
/*******************************************************
* *
* Function: zbx_regexp_compile *
* *
* Purpose: public wrapper for regexp_compile *
* *
*******************************************************/
int zbx_regexp_compile(const char *pattern, zbx_regexp_t **regexp, const char **err_msg)
{
#ifdef ZBX_REGEXP_NO_AUTO_CAPTURE
return regexp_compile(pattern, ZBX_REGEXP_MULTILINE | ZBX_REGEXP_NO_AUTO_CAPTURE, regexp, err_msg);
#else
return regexp_compile(pattern, ZBX_REGEXP_MULTILINE, regexp, err_msg);
#endif
}
/*******************************************************
* *
* Function: zbx_regexp_compile_ext *
* *
* Purpose: public wrapper for regexp_compile *
* *
*******************************************************/
int zbx_regexp_compile_ext(const char *pattern, zbx_regexp_t **regexp, int flags, const char **err_msg)
{
return regexp_compile(pattern, flags, regexp, err_msg);
}
/****************************************************************************************************
* *
* Function: regexp_prepare *
* *
* Purpose: wrapper for zbx_regexp_compile. Caches and reuses the last used regexp. *
* *
****************************************************************************************************/
static int regexp_prepare(const char *pattern, int flags, zbx_regexp_t **regexp, const char **err_msg)
{
static ZBX_THREAD_LOCAL zbx_regexp_t *curr_regexp = NULL;
static ZBX_THREAD_LOCAL char *curr_pattern = NULL;
static ZBX_THREAD_LOCAL int curr_flags = 0;
int ret = SUCCEED;
if (NULL == curr_regexp || 0 != strcmp(curr_pattern, pattern) || curr_flags != flags)
{
if (NULL != curr_regexp)
{
zbx_regexp_free(curr_regexp);
zbx_free(curr_pattern);
}
curr_regexp = NULL;
curr_pattern = NULL;
curr_flags = 0;
if (SUCCEED == regexp_compile(pattern, flags, &curr_regexp, err_msg))
{
curr_pattern = zbx_strdup(curr_pattern, pattern);
curr_flags = flags;
}
else
ret = FAIL;
}
*regexp = curr_regexp;
return ret;
}
static unsigned long int compute_recursion_limit(void)
{
#if !defined(_WINDOWS) && !defined(__MINGW32__)
struct rlimit rlim;
/* calculate recursion limit, PCRE man page suggests to reckon on about 500 bytes per recursion */
/* but to be on the safe side - reckon on 800 bytes and do not set limit higher than 100000 */
if (0 == getrlimit(RLIMIT_STACK, &rlim))
return rlim.rlim_cur < 80000000 ? rlim.rlim_cur / 800 : 100000;
else
return 10000; /* if stack size cannot be retrieved then assume ~8 MB */
#else
return ZBX_REGEXP_RECURSION_LIMIT;
#endif
}
/***********************************************************************************
* *
* Function: regexp_exec *
* *
* Purpose: wrapper for pcre_exec(), searches for a given pattern, specified by *
* regexp, in the string *
* *
* Parameters: *
* string - [IN] string to be matched against 'regexp' *
* regexp - [IN] precompiled regular expression *
* flags - [IN] execution flags for matching *
* count - [IN] count of elements in matches array *
* matches - [OUT] matches (can be NULL if matching results are *
* not required) *
* *
* Return value: ZBX_REGEXP_MATCH - successful match *
* ZBX_REGEXP_NO_MATCH - no match *
* FAIL - error occurred *
* *
***********************************************************************************/
static int regexp_exec(const char *string, const zbx_regexp_t *regexp, int flags, int count,
zbx_regmatch_t *matches)
{
#ifdef USE_PCRE
#define MATCHES_BUFF_SIZE (ZBX_REGEXP_GROUPS_MAX * 3) /* see pcre_exec() in "man pcreapi" why 3 */
int result, r;
static ZBX_THREAD_LOCAL int matches_buff[MATCHES_BUFF_SIZE];
int *ovector = NULL;
int ovecsize = 3 * count; /* see pcre_exec() in "man pcreapi" why 3 */
struct pcre_extra extra, *pextra;
if (ZBX_REGEXP_GROUPS_MAX < count)
ovector = (int *)zbx_malloc(NULL, (size_t)ovecsize * sizeof(int));
else
ovector = matches_buff;
if (NULL == regexp->extra)
{
pextra = &extra;
pextra->flags = 0;
}
else
pextra = regexp->extra;
#if defined(PCRE_EXTRA_MATCH_LIMIT) && defined(PCRE_EXTRA_MATCH_LIMIT_RECURSION)
pextra->flags |= PCRE_EXTRA_MATCH_LIMIT | PCRE_EXTRA_MATCH_LIMIT_RECURSION;
pextra->match_limit = 1000000;
pextra->match_limit_recursion = compute_recursion_limit();
#endif
/* see "man pcreapi" about pcre_exec() return value and 'ovector' size and layout */
if (0 <= (r = pcre_exec(regexp->pcre_regexp, pextra, string, strlen(string), flags, 0, ovector, ovecsize)))
{
if (NULL != matches)
memcpy(matches, ovector, (size_t)((0 < r) ? MIN(r, count) : count) * sizeof(zbx_regmatch_t));
result = ZBX_REGEXP_MATCH;
}
else if (PCRE_ERROR_NOMATCH == r)
{
result = ZBX_REGEXP_NO_MATCH;
}
else
{
zabbix_log(LOG_LEVEL_WARNING, "%s() failed with error %d", __func__, r);
result = FAIL;
}
if (ZBX_REGEXP_GROUPS_MAX < count)
zbx_free(ovector);
return result;
#undef MATCHES_BUFF_SIZE
#endif
#ifdef USE_PCRE2
int result, r, i;
pcre2_match_data *match_data = NULL;
PCRE2_SIZE *ovector = NULL;
pcre2_set_match_limit(regexp->match_ctx, 1000000);
pcre2_set_recursion_limit(regexp->match_ctx, compute_recursion_limit());
match_data = pcre2_match_data_create(count, NULL);
if (NULL == match_data)
{
zabbix_log(LOG_LEVEL_ERR, "cannot create pcre2 match data of size %d", count);
result = FAIL;
}
else
{
if (0 <= (r = pcre2_match(regexp->pcre2_regexp, string, PCRE2_ZERO_TERMINATED, 0, flags, match_data,
regexp->match_ctx)))
{
if (NULL != matches)
{
ovector = pcre2_get_ovector_pointer(match_data);
/* have to copy this way because pcre2 ovector uses 8 byte integers, *
* but we want to keep it compatible with existing matches structure, *
* which uses 4 byte integers */
for (i = 0; i < ((0 < r) ? MIN(r, count) : count); i++)
{
matches[i].rm_so = (int)ovector[i*2];
matches[i].rm_eo = (int)ovector[i*2+1];
}
}
result = ZBX_REGEXP_MATCH;
}
else if (PCRE2_ERROR_NOMATCH == r)
{
result = ZBX_REGEXP_NO_MATCH;
}
else
{
zabbix_log(LOG_LEVEL_WARNING, "%s() failed with error %d", __func__, r);
result = FAIL;
}
pcre2_match_data_free(match_data);
}
return result;
#endif
}
/******************************************************************************
* *
* Function: zbx_regexp_free *
* *
* Purpose: wrapper for pcre_free *
* *
* Parameters: regexp - [IN] compiled regular expression *
* *
******************************************************************************/
void zbx_regexp_free(zbx_regexp_t *regexp)
{
#ifdef USE_PCRE
/* pcre_free_study() was added to the API for release 8.20 while extra was available before */
#ifdef PCRE_CONFIG_JIT
pcre_free_study(regexp->extra);
#else
pcre_free(regexp->extra);
#endif
pcre_free(regexp->pcre_regexp);
#endif
#ifdef USE_PCRE2
pcre2_code_free(regexp->pcre2_regexp);
pcre2_match_context_free(regexp->match_ctx);
#endif
zbx_free(regexp);
}
/******************************************************************************
* *
* Function: zbx_regexp_match_precompiled *
* *
* Purpose: checks if string matches a precompiled regular expression without *
* returning matching groups *
* *
* Parameters: string - [IN] string to be matched *
* regex - [IN] precompiled regular expression *
* *
* Return value: 0 - successful match *
* nonzero - no match *
* *
* Comments: use this function for better performance if many strings need to *
* be matched against the same regular expression *
* *
******************************************************************************/
int zbx_regexp_match_precompiled(const char *string, const zbx_regexp_t *regexp)
{
return (ZBX_REGEXP_MATCH == regexp_exec(string, regexp, 0, 0, NULL)) ? 0 : -1;
}
/****************************************************************************************************
* *
* Function: zbx_regexp *
* *
* Purpose: compiles and executes a regexp *
* *
* Parameters: *
* string - [IN] string to be matched against 'regexp' *
* pattern - [IN] regular expression pattern *
* flags - [IN] execution flags for matching *
* len - [OUT] length of matched string, *
* 0 in case of no match or *
* FAIL if an error occurred. *
* *
* Return value: pointer to the matched substring or null *
* *
****************************************************************************************************/
static char *zbx_regexp(const char *string, const char *pattern, int flags, int *len)
{
char *c = NULL;
zbx_regmatch_t match;
zbx_regexp_t *regexp = NULL;
const char* error = NULL;
if (NULL != len)
*len = FAIL;
if (SUCCEED != regexp_prepare(pattern, flags, ®exp, &error))
return NULL;
if (NULL != string)
{
int r;
if (ZBX_REGEXP_MATCH == (r = regexp_exec(string, regexp, 0, 1, &match)))
{
c = (char *)string + match.rm_so;
if (NULL != len)
*len = match.rm_eo - match.rm_so;
}
else if (ZBX_REGEXP_NO_MATCH == r && NULL != len)
*len = 0;
}
return c;
}
char *zbx_regexp_match(const char *string, const char *pattern, int *len)
{
return zbx_regexp(string, pattern, ZBX_REGEXP_MULTILINE, len);
}
/******************************************************************************
* *
* Function: strncpy_alloc *
* *
* Purpose: zbx_strncpy_alloc with maximum allocated memory limit. *
* *
* Parameters: str - [IN/OUT] destination buffer pointer *
* alloc_len - [IN/OUT] already allocated memory *
* offset - [IN/OUT] offset for writing *
* src - [IN] copied string *
* n - [IN] maximum number of bytes to copy *
* limit - [IN] maximum number of bytes to be allocated *
* *
******************************************************************************/
static void strncpy_alloc(char **str, size_t *alloc_len, size_t *offset, const char *src, size_t n, size_t limit)
{
if (0 != limit && *offset + n > limit)
n = (limit > *offset) ? (limit - *offset) : 0;
zbx_strncpy_alloc(str, alloc_len, offset, src, n);
}
/*********************************************************************************
* *
* Function: regexp_sub_replace *
* *
* Purpose: Constructs a string from the specified template and regexp match. *
* *
* Parameters: text - [IN] the input string. *
* output_template - [IN] the output string template. The output *
* string is constructed from template by *
* replacing \<n> sequences with the captured *
* regexp group. *
* If the output template is NULL or contains *
* empty string then a copy of the whole *
* input string is returned. *
* match - [IN] the captured group data *
* nmatch - [IN] the number of items in captured group data *
* limit - [IN] size limit for memory allocation *
* 0 means no limit *
* *
* Return value: Allocated string containing output value *
* *
*********************************************************************************/
static char *regexp_sub_replace(const char *text, const char *output_template, zbx_regmatch_t *match, int nmatch,
size_t limit)
{
char *ptr = NULL;
const char *pstart = output_template, *pgroup;
size_t size = 0, offset = 0;
int group_index;
if (NULL == output_template || '\0' == *output_template)
return zbx_strdup(NULL, text);
while (NULL != (pgroup = strchr(pstart, '\\')))
{
switch (*(++pgroup))
{
case '\\':
strncpy_alloc(&ptr, &size, &offset, pstart, pgroup - pstart, limit);
pstart = pgroup + 1;
continue;
case '0':
case '1':
case '2':
case '3':
case '4':
case '5':
case '6':
case '7':
case '8':
case '9':
strncpy_alloc(&ptr, &size, &offset, pstart, pgroup - pstart - 1, limit);
group_index = *pgroup - '0';
if (group_index < nmatch && -1 != match[group_index].rm_so)
{
strncpy_alloc(&ptr, &size, &offset, text + match[group_index].rm_so,
match[group_index].rm_eo - match[group_index].rm_so, limit);
}
pstart = pgroup + 1;
continue;
case '@':
/* artificial construct to replace the first captured group or fail */
/* if the regular expression pattern contains no groups */
if (-1 == match[1].rm_so)
{
zbx_free(ptr);
goto out;
}
strncpy_alloc(&ptr, &size, &offset, text + match[1].rm_so,
match[1].rm_eo - match[1].rm_so, limit);
pstart = pgroup + 1;
continue;
default:
strncpy_alloc(&ptr, &size, &offset, pstart, pgroup - pstart, limit);
pstart = pgroup;
}
if (0 != limit && offset >= limit)
break;
}
if ('\0' != *pstart)
strncpy_alloc(&ptr, &size, &offset, pstart, strlen(pstart), limit);
out:
if (NULL != ptr)
{
if (0 != limit && offset >= limit)
{
size = offset;
offset--;
/* ensure that the string is not cut in the middle of UTF-8 sequence */
if (0x80 <= (0xc0 & ptr[offset]))
{
while (0x80 == (0xc0 & ptr[offset]) && 0 < offset)
offset--;
if (zbx_utf8_char_len(&ptr[offset]) != size - offset)
ptr[offset] = '\0';
}
}
/* Some regexp and output template combinations can produce invalid UTF-8 sequences. */
/* For example, regexp "(.)(.)" and output template "\1 \2" produce a valid UTF-8 sequence */
/* for single-byte UTF-8 characters and invalid sequence for multi-byte characters. */
/* Using (*UTF) modifier (e.g. "(*UTF)(.)(.)") solves the problem for multi-byte characters */
/* but it is up to user to add the modifier. To prevent producing invalid UTF-8 sequences do */
/* output sanitization. */
zbx_replace_invalid_utf8(ptr);
}
return ptr;
}
/*********************************************************************************
* *
* Function: regexp_sub *
* *
* Purpose: Test if a string matches the specified regular expression. If yes *
* then create a return value by substituting '\<n>' sequences in *
* output template with the captured groups. *
* *
* Parameters: string - [IN] the string to parse *
* pattern - [IN] the regular expression *
* output_template - [IN] the output string template. The output *
* string is constructed from template by *
* replacing \<n> sequences with the captured *
* regexp group. *
* If output template is NULL or contains *
* empty string then the whole input string *
* is used as output value. *
* flags - [IN] the pcre_compile() function flags. *
* See pcre_compile() manual. *
* out - [OUT] the output value if the input string *
* matches the specified regular expression *
* or NULL otherwise *
* *
* Return value: SUCCEED - the regular expression match was done *
* FAIL - failed to compile regexp *
* *
*********************************************************************************/
static int regexp_sub(const char *string, const char *pattern, const char *output_template, int flags, char **out)
{
const char *error = NULL;
zbx_regexp_t *regexp = NULL;
zbx_regmatch_t match[ZBX_REGEXP_GROUPS_MAX];
unsigned int i;
if (NULL == string)
{
zbx_free(*out);
return SUCCEED;
}
#ifdef ZBX_REGEXP_NO_AUTO_CAPTURE
/* no subpatterns without an output template */
if (NULL == output_template || '\0' == *output_template)
flags |= ZBX_REGEXP_NO_AUTO_CAPTURE;
#endif
if (FAIL == regexp_prepare(pattern, flags, ®exp, &error))
return FAIL;
zbx_free(*out);
/* -1 is special pcre value for unused patterns */
for (i = 0; i < ARRSIZE(match); i++)
match[i].rm_so = match[i].rm_eo = -1;
if (ZBX_REGEXP_MATCH == regexp_exec(string, regexp, 0, ZBX_REGEXP_GROUPS_MAX, match))
*out = regexp_sub_replace(string, output_template, match, ZBX_REGEXP_GROUPS_MAX, 0);
return SUCCEED;
#undef MATCH_SIZE
}
/*********************************************************************************
* *
* Function: zbx_mregexp_sub_precompiled *
* *
* Purpose: Test if a string matches precompiled regular expression. If yes *
* then create a return value by substituting '\<n>' sequences in *
* output template with the captured groups. *
* *
* Parameters: string - [IN] the string to parse *
* regexp - [IN] the precompiled regular expression *
* output_template - [IN] the output string template. The output *
* string is constructed from template by *
* replacing \<n> sequences with the captured *
* regexp group. *
* If output template is NULL or contains *
* empty string then the whole input string *
* is used as output value. *
* limit - [IN] size limit for memory allocation *
* 0 means no limit *
* out - [OUT] the output value if the input string *
* matches the specified regular expression *
* or NULL otherwise *
* *
* Return value: SUCCEED - the regular expression match was done *
* FAIL - failed to match *
* *
* Comments: Multiline match is performed *
* *
*********************************************************************************/
int zbx_mregexp_sub_precompiled(const char *string, const zbx_regexp_t *regexp, const char *output_template,
size_t limit, char **out)
{
zbx_regmatch_t match[ZBX_REGEXP_GROUPS_MAX];
unsigned int i;
zbx_free(*out);
/* -1 is special pcre value for unused patterns */
for (i = 0; i < ARRSIZE(match); i++)
match[i].rm_so = match[i].rm_eo = -1;
if (ZBX_REGEXP_MATCH == regexp_exec(string, regexp, 0, ZBX_REGEXP_GROUPS_MAX, match) &&
NULL != (*out = regexp_sub_replace(string, output_template, match, ZBX_REGEXP_GROUPS_MAX,
limit)))
{
return SUCCEED;
}
return FAIL;
}
/*********************************************************************************
* *
* Function: zbx_regexp_sub *
* *
* Purpose: Test if a string matches the specified regular expression. If yes *
* then create a return value by substituting '\<n>' sequences in *
* output template with the captured groups. *
* *
* Parameters: string - [IN] the string to parse *
* pattern - [IN] the regular expression *
* output_template - [IN] the output string template. The output *
* string is constructed from template by *
* replacing \<n> sequences with the captured *
* regexp group. *
* out - [OUT] the output value if the input string *
* matches the specified regular expression *
* or NULL otherwise *
* *
* Return value: SUCCEED - the regular expression match was done *
* FAIL - failed to compile regexp *
* *
* Comments: This function performs case sensitive match *
* *
*********************************************************************************/
int zbx_regexp_sub(const char *string, const char *pattern, const char *output_template, char **out)
{
return regexp_sub(string, pattern, output_template, ZBX_REGEXP_MULTILINE, out);
}
/*********************************************************************************
* *
* Function: zbx_mregexp_sub *
* *
* Purpose: This function is similar to zbx_regexp_sub() with exception that *
* multiline matches are accepted. *
* *
*********************************************************************************/
int zbx_mregexp_sub(const char *string, const char *pattern, const char *output_template, char **out)
{
return regexp_sub(string, pattern, output_template, 0, out);
}
/*********************************************************************************
* *
* Function: zbx_iregexp_sub *
* *
* Purpose: This function is similar to zbx_regexp_sub() with exception that *
* case insensitive matches are accepted. *
* *
*********************************************************************************/
int zbx_iregexp_sub(const char *string, const char *pattern, const char *output_template, char **out)
{
return regexp_sub(string, pattern, output_template, ZBX_REGEXP_CASELESS, out);
}
/******************************************************************************
* *
* Function: zbx_regexp_clean_expressions *
* *
* Purpose: frees expression data retrieved by DCget_expressions function or *
* prepared with add_regexp_ex() function calls *
* *
* Parameters: expressions - [IN] a vector of expression data pointers *
* *
******************************************************************************/
void zbx_regexp_clean_expressions(zbx_vector_ptr_t *expressions)
{
int i;
for (i = 0; i < expressions->values_num; i++)
{
zbx_expression_t *regexp = expressions->values[i];
zbx_free(regexp->name);
zbx_free(regexp->expression);
zbx_free(regexp);
}
zbx_vector_ptr_clear(expressions);
}
void add_regexp_ex(zbx_vector_ptr_t *regexps, const char *name, const char *expression, int expression_type,
char exp_delimiter, int case_sensitive)
{
zbx_expression_t *regexp;
regexp = zbx_malloc(NULL, sizeof(zbx_expression_t));
regexp->name = zbx_strdup(NULL, name);
regexp->expression = zbx_strdup(NULL, expression);
regexp->expression_type = expression_type;
regexp->exp_delimiter = exp_delimiter;
regexp->case_sensitive = case_sensitive;
zbx_vector_ptr_append(regexps, regexp);
}
/**********************************************************************************
* *
* Function: regexp_match_ex_regsub *
* *
* Purpose: Test if the string matches regular expression with the specified *
* case sensitivity option and allocates output variable to store the *
* result if necessary. *
* *
* Parameters: string - [IN] the string to check *
* pattern - [IN] the regular expression *
* case_sensitive - [IN] ZBX_IGNORE_CASE - case insensitive match. *
* ZBX_CASE_SENSITIVE - case sensitive match. *
* output_template - [IN] the output string template. The output *
* string is constructed from the template by *
* replacing \<n> sequences with the captured *
* regexp group. *
* If output_template is NULL the whole *
* matched string is returned. *
* output - [OUT] a reference to the variable where allocated *
* memory containing the resulting value *
* (substitution) is stored. *
* Specify NULL to skip output value creation. *
* *
* Return value: ZBX_REGEXP_MATCH - the string matches the specified regular *
* expression *
* ZBX_REGEXP_NO_MATCH - the string does not match the regular *
* expression *
* FAIL - the string is NULL or the specified *
* regular expression is invalid *
* *
**********************************************************************************/
static int regexp_match_ex_regsub(const char *string, const char *pattern, int case_sensitive,
const char *output_template, char **output)
{
int regexp_flags = ZBX_REGEXP_MULTILINE, ret = FAIL;
if (ZBX_IGNORE_CASE == case_sensitive)
regexp_flags |= ZBX_REGEXP_CASELESS;
if (NULL == output)
{
if (NULL == zbx_regexp(string, pattern, regexp_flags, &ret))
{
if (FAIL != ret)
ret = ZBX_REGEXP_NO_MATCH;
}
else
ret = ZBX_REGEXP_MATCH;
}
else
{
if (SUCCEED == regexp_sub(string, pattern, output_template, regexp_flags, output))
{
ret = (NULL != *output ? ZBX_REGEXP_MATCH : ZBX_REGEXP_NO_MATCH);
}
else
ret = FAIL;
}
return ret;
}
/**********************************************************************************
* *
* Function: regexp_match_ex_substring *
* *
* Purpose: Test if the string contains substring with the specified case *
* sensitivity option. *
* *
* Parameters: string - [IN] the string to check *
* pattern - [IN] the substring to search *
* case_sensitive - [IN] ZBX_IGNORE_CASE - case insensitive search *
* ZBX_CASE_SENSITIVE - case sensitive search *
* *
* Return value: ZBX_REGEXP_MATCH - string contains the specified substring *
* ZBX_REGEXP_NO_MATCH - string does not contain the substring *
* *
**********************************************************************************/
static int regexp_match_ex_substring(const char *string, const char *pattern, int case_sensitive)
{
char *ptr = NULL;
switch (case_sensitive)
{
case ZBX_CASE_SENSITIVE:
ptr = strstr(string, pattern);
break;
case ZBX_IGNORE_CASE:
ptr = zbx_strcasestr(string, pattern);
break;
}
return (NULL != ptr ? ZBX_REGEXP_MATCH : ZBX_REGEXP_NO_MATCH);
}
/**********************************************************************************
* *
* Function: regexp_match_ex_substring_list *
* *
* Purpose: Test if the string contains a substring from list with the specified *
* delimiter and case sensitivity option. *
* *
* Parameters: string - [IN] the string to check *
* pattern - [IN] the substring list *
* case_sensitive - [IN] ZBX_IGNORE_CASE - case insensitive search *
* ZBX_CASE_SENSITIVE - case sensitive search *
* delimiter - [IN] the delimiter separating items in the *
* substring list *
* *
* Return value: ZBX_REGEXP_MATCH - string contains a substring from the list *
* ZBX_REGEXP_NO_MATCH - string does not contain any substrings *
* from the list *
* *
**********************************************************************************/
static int regexp_match_ex_substring_list(const char *string, char *pattern, int case_sensitive, char delimiter)
{
int ret = ZBX_REGEXP_NO_MATCH;
char *s, *c;
for (s = pattern; '\0' != *s && ZBX_REGEXP_MATCH != ret;)
{
if (NULL != (c = strchr(s, delimiter)))
*c = '\0';
ret = regexp_match_ex_substring(string, s, case_sensitive);
if (NULL != c)
{
*c = delimiter;
s = ++c;
}
else
break;
}
return ret;
}
/**********************************************************************************
* *
* Function: regexp_sub_ex *
* *
* Purpose: Test if the string matches regular expression with the specified *
* case sensitivity option and allocates output variable to store the *
* result if necessary. *
* *
* Parameters: regexps - [IN] the global regular expression array *
* string - [IN] the string to check *
* pattern - [IN] the regular expression or global regular *
* expression name (@<global regexp name>). *
* case_sensitive - [IN] ZBX_IGNORE_CASE - case insensitive match *
* ZBX_CASE_SENSITIVE - case sensitive match *
* output_template - [IN] the output string template. For regular *
* expressions (type Result is TRUE) output *
* string is constructed from the template by *
* replacing '\<n>' sequences with the *
* captured regexp group. *
* If output_template is NULL then the whole *
* matched string is returned. *
* output - [OUT] a reference to the variable where allocated *
* memory containing the resulting value *
* (substitution) is stored. *
* Specify NULL to skip output value creation. *
* *
* Return value: ZBX_REGEXP_MATCH - the string matches the specified regular *
* expression *
* ZBX_REGEXP_NO_MATCH - the string does not match the specified *
* regular expression *
* FAIL - invalid regular expression *
* *
* Comments: For regular expressions and global regular expressions with 'Result *
* is TRUE' type the 'output_template' substitution result is stored *
* into 'output' variable. For other global regular expression types *
* the whole string is stored into 'output' variable. *
* *
**********************************************************************************/
int regexp_sub_ex(const zbx_vector_ptr_t *regexps, const char *string, const char *pattern,
int case_sensitive, const char *output_template, char **output)
{
int i, ret = FAIL;
char *output_accu; /* accumulator for 'output' when looping over global regexp subexpressions */
if (NULL == pattern || '\0' == *pattern)
{
/* always match when no pattern is specified */
ret = ZBX_REGEXP_MATCH;
goto out;
}
if ('@' != *pattern) /* not a global regexp */
{
ret = regexp_match_ex_regsub(string, pattern, case_sensitive, output_template, output);
goto out;
}
pattern++;
output_accu = NULL;
for (i = 0; i < regexps->values_num; i++) /* loop over global regexp subexpressions */
{
const zbx_expression_t *regexp = regexps->values[i];
if (0 != strcmp(regexp->name, pattern))
continue;
switch (regexp->expression_type)
{
case EXPRESSION_TYPE_TRUE:
if (NULL != output)
{
char *output_tmp = NULL;
if (ZBX_REGEXP_MATCH == (ret = regexp_match_ex_regsub(string,
regexp->expression, regexp->case_sensitive, output_template,
&output_tmp)))
{
zbx_free(output_accu);
output_accu = output_tmp;
}
}
else
{
ret = regexp_match_ex_regsub(string, regexp->expression, regexp->case_sensitive,
NULL, NULL);
}
break;
case EXPRESSION_TYPE_FALSE:
ret = regexp_match_ex_regsub(string, regexp->expression, regexp->case_sensitive,
NULL, NULL);
if (FAIL != ret) /* invert output value */
ret = (ZBX_REGEXP_MATCH == ret ? ZBX_REGEXP_NO_MATCH : ZBX_REGEXP_MATCH);
break;
case EXPRESSION_TYPE_INCLUDED:
ret = regexp_match_ex_substring(string, regexp->expression, regexp->case_sensitive);
break;
case EXPRESSION_TYPE_NOT_INCLUDED:
ret = regexp_match_ex_substring(string, regexp->expression, regexp->case_sensitive);
/* invert output value */
ret = (ZBX_REGEXP_MATCH == ret ? ZBX_REGEXP_NO_MATCH : ZBX_REGEXP_MATCH);
break;
case EXPRESSION_TYPE_ANY_INCLUDED:
ret = regexp_match_ex_substring_list(string, regexp->expression, regexp->case_sensitive,
regexp->exp_delimiter);
break;
default:
THIS_SHOULD_NEVER_HAPPEN;
ret = FAIL;
}
if (FAIL == ret || ZBX_REGEXP_NO_MATCH == ret)
{
zbx_free(output_accu);
break;
}
}
if (ZBX_REGEXP_MATCH == ret && NULL != output_accu)
{
*output = output_accu;
return ZBX_REGEXP_MATCH;
}
out:
if (ZBX_REGEXP_MATCH == ret && NULL != output && NULL == *output)
{
/* Handle output value allocation for global regular expression types */
/* that cannot perform output_template substitution (practically */
/* all global regular expression types except EXPRESSION_TYPE_TRUE). */
size_t offset = 0, size = 0;
zbx_strcpy_alloc(output, &size, &offset, string);
}
return ret;
}
int regexp_match_ex(const zbx_vector_ptr_t *regexps, const char *string, const char *pattern, int case_sensitive)
{
return regexp_sub_ex(regexps, string, pattern, case_sensitive, NULL, NULL);
}
int zbx_global_regexp_exists(const char *name, const zbx_vector_ptr_t *regexps)
{
int i;
for (i = 0; i < regexps->values_num; i++)
{
const zbx_expression_t *regexp = (const zbx_expression_t *)regexps->values[i];
if (0 == strcmp(regexp->name, name))
return SUCCEED;
}
return FAIL;
}
/**********************************************************************************
* *
* Function: zbx_regexp_escape_stringsize *
* *
* Purpose: calculate a string size after symbols escaping *
* *
* Parameters: string - [IN] the string to check *
* *
* Return value: new size of the string *
* *
**********************************************************************************/
static size_t zbx_regexp_escape_stringsize(const char *string)
{
size_t len = 0;
const char *sptr;
if (NULL == string)
return 0;
for (sptr = string; '\0' != *sptr; sptr++)
{
switch (*sptr)
{
case '.':
case '\\':
case '+':
case '*':
case '?':
case '[':
case '^':
case ']':
case '$':
case '(':
case ')':
case '{':
case '}':
case '=':
case '!':
case '>':
case '<':
case '|':
case ':':
case '-':
case '#':
len += 2;
break;
default:
len++;
}
}
return len;
}
/**********************************************************************************
* *
* Function: zbx_regexp_escape_string *
* *
* Purpose: replace . \ + * ? [ ^ ] $ ( ) { } = ! < > | : - symbols in string *
* with combination of \ and escaped symbol *
* *
* Parameters: p - [IN/OUT] buffer for new string after update *
* string - [IN] the string to update *
* *
**********************************************************************************/
static void zbx_regexp_escape_string(char *p, const char *string)
{
const char *sptr;
for (sptr = string; '\0' != *sptr; sptr++)
{
switch (*sptr)
{
case '.':
case '\\':
case '+':
case '*':
case '?':
case '[':
case '^':
case ']':
case '$':
case '(':
case ')':
case '{':
case '}':
case '=':
case '!':
case '>':
case '<':
case '|':
case ':':
case '-':
case '#':
*p++ = '\\';
*p++ = *sptr;
break;
default:
*p++ = *sptr;
}
}
return;
}
/**********************************************************************************
* *
* Function: zbx_regexp_escape *
* *
* Purpose: escaping of symbols for using in regexp expression *
* *
* Parameters: string - [IN/OUT] the string to update *
* *
**********************************************************************************/
void zbx_regexp_escape(char **string)
{
size_t size;
char *buffer;
if (0 == (size = zbx_regexp_escape_stringsize(*string)))
return;
buffer = zbx_malloc(NULL, size + 1);
buffer[size] = '\0';
zbx_regexp_escape_string(buffer, *string);
zbx_free(*string);
*string = buffer;
}
/**********************************************************************************
* *
* Function: zbx_wildcard_minimize *
* *
* Purpose: remove repeated wildcard characters from the expression *
* *
* Parameters: str - [IN/OUT] the string to update *
* *
**********************************************************************************/
void zbx_wildcard_minimize(char *str)
{
char *p1, *p2;
int w = 0;
for(p1 = p2 = str; '\0' != *p2; p2++)
{
if ('*' == *p2)
{
if (0 != w)
continue;
w = 1;
}
else
w = 0;
*p1 = *p2;
p1++;
}
*p1 = '\0';
}
/******************************************************************************
* *
* Function: zbx_wildcard_match *
* *
* Purpose: Matches string value to specified wildcard. *
* Asterisk (*) characters match to any characters of any length. *
* *
* Parameters: value - [IN] string to match *
* wildcard - [IN] wildcard string expression *
* *
* Return value: 1 - value match the wildcard *
* 0 - otherwise *
* *
* Author: Andrejs Tumilovics *
* *
******************************************************************************/
int zbx_wildcard_match(const char *value, const char *wildcard)
{
const char *s_pivot = value, *w_pivot = wildcard;
while('\0' != *value && '*' != *wildcard)
{
if (*value++ != *wildcard++)
return 0;
}
while('\0' != *value)
{
if ('*' == *wildcard)
{
wildcard++;
if ('\0' == *wildcard)
return 1;
w_pivot = wildcard;
s_pivot = value + 1;
}
else if (*value == *wildcard)
{
value++;
wildcard++;
}
else
{
wildcard = w_pivot;
value = s_pivot++;
}
}
while('*' == *wildcard)
wildcard++;
return '\0' == *wildcard;
}
void zbx_regexp_err_msg_free(const char *err_msg)
{
#ifdef USE_PCRE
ZBX_UNUSED(err_msg);
#endif
#ifdef USE_PCRE2
char *ptr;
if (NULL != err_msg)
{
ptr = (char*)err_msg;
zbx_free(ptr);
}
#endif
}
|