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
|
/* Copyright (c) 2002-2013 Pigeonhole authors, see the included COPYING file
*/
/* Match-type ':matches'
*/
#include "lib.h"
#include "str.h"
#include "sieve-match-types.h"
#include "sieve-comparators.h"
#include "sieve-match.h"
#include <string.h>
#include <stdio.h>
/*
* Forward declarations
*/
static int mcht_matches_match_key
(struct sieve_match_context *mctx, const char *val, size_t val_size,
const char *key, size_t key_size);
/*
* Match-type object
*/
const struct sieve_match_type_def matches_match_type = {
SIEVE_OBJECT("matches", &match_type_operand, SIEVE_MATCH_TYPE_MATCHES),
NULL,
sieve_match_substring_validate_context,
NULL, NULL, NULL,
mcht_matches_match_key,
NULL
};
/*
* Match-type implementation
*/
/* Quick 'n dirty debug */
//#define MATCH_DEBUG
#ifdef MATCH_DEBUG
#define debug_printf(...) printf ("match debug: " __VA_ARGS__)
#else
#define debug_printf(...)
#endif
/* FIXME: Naive implementation, substitute this with dovecot src/lib/str-find.c
*/
static inline bool _string_find(const struct sieve_comparator *cmp,
const char **valp, const char *vend, const char **keyp, const char *kend)
{
while ( (*valp < vend) && (*keyp < kend) ) {
if ( !cmp->def->char_match(cmp, valp, vend, keyp, kend) )
(*valp)++;
}
return (*keyp == kend);
}
static char _scan_key_section
(string_t *section, const char **wcardp, const char *key_end)
{
/* Find next wildcard and resolve escape sequences */
str_truncate(section, 0);
while ( *wcardp < key_end && **wcardp != '*' && **wcardp != '?') {
if ( **wcardp == '\\' ) {
(*wcardp)++;
}
str_append_c(section, **wcardp);
(*wcardp)++;
}
/* Record wildcard character or \0 */
if ( *wcardp < key_end ) {
return **wcardp;
}
i_assert( *wcardp == key_end );
return '\0';
}
static int mcht_matches_match_key
(struct sieve_match_context *mctx, const char *val, size_t val_size,
const char *key, size_t key_size)
{
const struct sieve_comparator *cmp = mctx->comparator;
struct sieve_match_values *mvalues;
string_t *mvalue = NULL, *mchars = NULL;
string_t *section, *subsection;
const char *vend, *kend, *vp, *kp, *wp, *pvp;
bool backtrack = FALSE; /* TRUE: match of '?'-connected sections failed */
char wcard = '\0'; /* Current wildcard */
char next_wcard = '\0'; /* Next widlcard */
unsigned int key_offset = 0;
if ( cmp->def == NULL || cmp->def->char_match == NULL )
return FALSE;
/* Key sections */
section = t_str_new(32); /* Section (after beginning or *) */
subsection = t_str_new(32); /* Sub-section (after ?) */
/* Mark end of value and key */
vend = (const char *) val + val_size;
kend = (const char *) key + key_size;
/* Initialize pointers */
vp = val; /* Value pointer */
kp = key; /* Key pointer */
wp = key; /* Wildcard (key) pointer */
/* Start match values list if requested */
if ( (mvalues = sieve_match_values_start(mctx->runenv)) != NULL ) {
/* Skip ${0} for now; added when match succeeds */
sieve_match_values_add(mvalues, NULL);
mvalue = t_str_new(32); /* Match value (*) */
mchars = t_str_new(32); /* Match characters (.?..?.??) */
}
/* Match the pattern:
* <pattern> = <section>*<section>*<section>...
* <section> = <sub-section>?<sub-section>?<sub-section>...
*
* Escape sequences \? and \* need special attention.
*/
debug_printf("=== Start ===\n");
debug_printf(" key: %s\n", t_strdup_until(key, kend));
debug_printf(" value: %s\n", t_strdup_until(val, vend));
/* Loop until either key or value ends */
while (kp < kend && vp < vend ) {
const char *needle, *nend;
if ( !backtrack ) {
/* Search the next '*' wildcard in the key string */
wcard = next_wcard;
/* Find the needle to look for in the string */
key_offset = 0;
for (;;) {
next_wcard = _scan_key_section(section, &wp, kend);
if ( wcard == '\0' || str_len(section) > 0 )
break;
if ( next_wcard == '*' ) {
break;
}
if ( wp < kend )
wp++;
else
break;
key_offset++;
}
debug_printf("found wildcard '%c' at pos [%d]\n",
next_wcard, (int) (wp-key));
if ( mvalues != NULL )
str_truncate(mvalue, 0);
} else {
/* Backtracked; '*' wildcard is retained */
debug_printf("backtracked");
backtrack = FALSE;
}
/* Determine what we are looking for */
needle = str_c(section);
nend = PTR_OFFSET(needle, str_len(section));
debug_printf(" section needle: '%s'\n", t_strdup_until(needle, nend));
debug_printf(" section key: '%s'\n", t_strdup_until(kp, kend));
debug_printf(" section remnant: '%s'\n", t_strdup_until(wp, kend));
debug_printf(" value remnant: '%s'\n", t_strdup_until(vp, vend));
debug_printf(" key offset: %d\n", key_offset);
pvp = vp;
if ( next_wcard == '\0' ) {
/* No more wildcards; find the needle substring at the end of string */
const char *qp, *qend;
debug_printf("next_wcard = NUL; must find needle at end\n");
/* Check if the value is still large enough */
if ( vend - str_len(section) < vp ) {
debug_printf(" wont match: value is too short\n");
break;
}
/* Move value pointer to where the needle should be */
vp = PTR_OFFSET(vend, -str_len(section));
/* Record match values */
qend = vp;
qp = vp - key_offset;
if ( mvalues != NULL )
str_append_n(mvalue, pvp, qp-pvp);
/* Compare needle to end of value string */
if ( !cmp->def->char_match(cmp, &vp, vend, &needle, nend) ) {
debug_printf(" match at end failed\n");
break;
}
/* Add match values */
if ( mvalues != NULL ) {
/* Append '*' match value */
sieve_match_values_add(mvalues, mvalue);
/* Append any initial '?' match values */
for ( ; qp < qend; qp++ )
sieve_match_values_add_char(mvalues, *qp);
}
/* Finish match */
kp = kend;
vp = vend;
debug_printf(" matched end of value\n");
break;
} else {
/* Next wildcard found; match needle before next wildcard */
const char *prv = NULL; /* Stored value pointer for backtrack */
const char *prk = NULL; /* Stored key pointer for backtrack */
const char *prw = NULL; /* Stored wildcard pointer for backtrack */
const char *chars;
/* Reset '?' match values */
if ( mvalues != NULL )
str_truncate(mchars, 0);
if ( wcard == '\0' ) {
/* No current wildcard; match needs to happen right at the beginning */
debug_printf("wcard = NUL; needle should be found at the beginning.\n");
debug_printf(" begin needle: '%s'\n", t_strdup_until(needle, nend));
debug_printf(" begin value: '%s'\n", t_strdup_until(vp, vend));
if ( !cmp->def->char_match(cmp, &vp, vend, &needle, nend) ) {
debug_printf(" failed to find needle at beginning\n");
break;
}
} else {
/* Current wildcard present; match needle between current and next wildcard */
debug_printf("wcard != NUL; must find needle at an offset (>= %d).\n",
key_offset);
/* Match may happen at any offset (>= key offset): find substring */
vp += key_offset;
if ( (vp >= vend) || !_string_find(cmp, &vp, vend, &needle, nend) ) {
debug_printf(" failed to find needle at an offset\n");
break;
}
prv = vp - str_len(section);
prk = kp;
prw = wp;
/* Append match values */
if ( mvalues != NULL ) {
const char *qend = vp - str_len(section);
const char *qp = qend - key_offset;
/* Append '*' match value */
str_append_n(mvalue, pvp, qp-pvp);
/* Append any initial '?' match values (those that caused the key
* offset.
*/
for ( ; qp < qend; qp++ )
str_append_c(mchars, *qp);
}
}
/* Update wildcard and key pointers for next wildcard scan */
if ( wp < kend ) wp++;
kp = wp;
/* Scan successive '?' wildcards */
while ( next_wcard == '?' ) {
debug_printf("next_wcard = '?'; need to match arbitrary character\n");
/* Add match value */
if ( mvalues != NULL )
str_append_c(mchars, *vp);
vp++;
/* Scan for next '?' wildcard */
next_wcard = _scan_key_section(subsection, &wp, kend);
debug_printf("found next wildcard '%c' at pos [%d] (fixed match)\n",
next_wcard, (int) (wp-key));
/* Determine what we are looking for */
needle = str_c(subsection);
nend = PTR_OFFSET(needle, str_len(subsection));
debug_printf(" sub key: '%s'\n", t_strdup_until(needle, nend));
debug_printf(" value remnant: '%s'\n", vp <= vend ? t_strdup_until(vp, vend) : "");
/* Try matching the needle at fixed position */
if ( (needle == nend && next_wcard == '\0' && vp < vend ) ||
!cmp->def->char_match(cmp, &vp, vend, &needle, nend) ) {
/* Match failed: now we have a problem. We need to backtrack to the previous
* '*' wildcard occurence and start scanning for the next possible match.
*/
debug_printf(" failed fixed match\n");
/* Start backtrack */
if ( prv != NULL && prv + 1 < vend ) {
/* Restore pointers */
vp = prv;
kp = prk;
wp = prw;
/* Skip forward one value character to scan the next possible match */
if ( mvalues != NULL )
str_append_c(mvalue, *vp);
vp++;
/* Set wildcard state appropriately */
wcard = '*';
next_wcard = '?';
/* Backtrack */
backtrack = TRUE;
debug_printf(" BACKTRACK\n");
}
/* Break '?' wildcard scanning loop */
break;
}
/* Update wildcard and key pointers for next wildcard scan */
if ( wp < kend ) wp++;
kp = wp;
}
if ( !backtrack ) {
unsigned int i;
if ( next_wcard == '?' ) {
debug_printf("failed to match '?'\n");
break;
}
if ( mvalues != NULL ) {
if ( prv != NULL )
sieve_match_values_add(mvalues, mvalue);
chars = (const char *) str_data(mchars);
for ( i = 0; i < str_len(mchars); i++ ) {
sieve_match_values_add_char(mvalues, chars[i]);
}
}
if ( next_wcard != '*' ) {
debug_printf("failed to match at end of string\n");
break;
}
}
}
/* Check whether string ends in a wildcard
* (avoid scanning the rest of the string)
*/
if ( kp == kend && next_wcard == '*' ) {
/* Add the rest of the string as match value */
if ( mvalues != NULL ) {
str_truncate(mvalue, 0);
str_append_n(mvalue, vp, vend-vp);
sieve_match_values_add(mvalues, mvalue);
}
/* Finish match */
kp = kend;
vp = vend;
debug_printf("key ends with '*'\n");
break;
}
debug_printf("== Loop ==\n");
}
/* Eat away a trailing series of *s */
if ( vp == vend ) {
while ( kp < kend && *kp == '*' ) kp++;
}
/* By definition, the match is only successful if both value and key pattern
* are exhausted.
*/
debug_printf("=== Finish ===\n");
debug_printf(" result: %s\n", (kp == kend && vp == vend) ? "true" : "false");
if (kp == kend && vp == vend) {
/* Activate new match values after successful match */
if ( mvalues != NULL ) {
/* Set ${0} */
string_t *matched = str_new_const(pool_datastack_create(), val, val_size);
sieve_match_values_set(mvalues, 0, matched);
/* Commit new match values */
sieve_match_values_commit(mctx->runenv, &mvalues);
}
return TRUE;
}
/* No match; drop collected match values */
sieve_match_values_abort(&mvalues);
return FALSE;
}
|