Codebase list fdm / 3bab4dd
Deliver remove-from-cache. Nicholas Marriott 16 years ago
13 changed file(s) with 159 addition(s) and 17 deletion(s). Raw diff Collapse all Expand all
+2
-1
CHANGES less more
00 02 October 2007
11
2 * "remove-from-cache" action.
23 * Rename to-cache to add-to-cache (to-cache remains as a compatibility alias).
3 This is to match the planned delete-from-cache and perhaps other similar.
4 This is to match the planned remove-from-cache and perhaps other similar.
45 * The account/all warnings are now gone.
56
67 01 October 2007
+1
-1
GNUmakefile less more
3333 deliver-add-header.c deliver-drop.c deliver-keep.c deliver-maildir.c \
3434 deliver-mbox.c deliver-pipe.c deliver-remove-header.c deliver-rewrite.c \
3535 deliver-smtp.c deliver-stdout.c deliver-tag.c deliver-add-to-cache.c \
36 deliver-write.c \
36 deliver-remove-from-cache.c deliver-write.c \
3737 fetch-imap.c fetch-imappipe.c fetch-maildir.c fetch-nntp.c fetch-pop3.c \
3838 fetch-pop3pipe.c fetch-stdin.c fetch-mbox.c pop3-common.c imap-common.c \
3939 mail-state.c mail-time.c mail.c file.c \
+5
-1
MANUAL.in less more
12481248
12491249 match all action add-to-cache "~/my-cache" key "%[message_id]"
12501250
1251 Or the existence of a key in the cache may be tested for using the 'in-cache'
1251 Or removed with the 'remove-from-cache' action:
1252
1253 match all action remove-from-cache "~/my-cache" key "%[message_id]"
1254
1255 And the existence of a key in the cache may be tested for using the 'in-cache'
12521256 condition:
12531257
12541258 match in-cache "~/my-cache" key "%[message_id]" action "foundincache"
+1
-1
Makefile less more
2121 deliver-add-header.c deliver-drop.c deliver-keep.c deliver-maildir.c \
2222 deliver-mbox.c deliver-pipe.c deliver-remove-header.c deliver-rewrite.c \
2323 deliver-smtp.c deliver-stdout.c deliver-tag.c deliver-add-to-cache.c \
24 deliver-write.c \
24 deliver-remove-from-cache.c deliver-write.c \
2525 fetch-imap.c fetch-imappipe.c fetch-maildir.c fetch-nntp.c fetch-pop3.c \
2626 fetch-pop3pipe.c fetch-stdin.c fetch-mbox.c pop3-common.c imap-common.c \
2727 mail-state.c mail-time.c mail.c file.c \
+0
-1
TODO less more
3434 copying them... bad idea
3535 - no-create to stop creation of nonexistent mboxes/maildirs
3636 - create missing dirs when delivering
37 - delete-from-cache action
3837 - cache commands:
3938 fdm cache-add $cachename $key
4039 fdm cache-delete $cachename $key
+11
-0
db-tdb.c less more
6666 }
6767
6868 int
69 db_remove(TDB_CONTEXT *db, char *k)
70 {
71 TDB_DATA key;
72
73 key.dptr = k;
74 key.dsize = strlen(k);
75
76 return (tdb_delete(db, key));
77 }
78
79 int
6980 db_contains(TDB_CONTEXT *db, char *k)
7081 {
7182 TDB_DATA key;
+83
-0
deliver-remove-from-cache.c less more
0 /* $Id$ */
1
2 /*
3 * Copyright (c) 2007 Nicholas Marriott <nicm@users.sourceforge.net>
4 *
5 * Permission to use, copy, modify, and distribute this software for any
6 * purpose with or without fee is hereby granted, provided that the above
7 * copyright notice and this permission notice appear in all copies.
8 *
9 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13 * WHATSOEVER RESULTING FROM LOSS OF MIND, USE, DATA OR PROFITS, WHETHER
14 * IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
15 * OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
16 */
17
18 #include <sys/types.h>
19
20 #include <string.h>
21
22 #include "fdm.h"
23 #include "deliver.h"
24
25 int deliver_remove_from_cache_deliver(
26 struct deliver_ctx *, struct actitem *);
27 void deliver_remove_from_cache_desc(struct actitem *, char *, size_t);
28
29 struct deliver deliver_remove_from_cache = {
30 "remove-from-cache",
31 DELIVER_INCHILD,
32 deliver_remove_from_cache_deliver,
33 deliver_remove_from_cache_desc
34 };
35
36 int
37 deliver_remove_from_cache_deliver(struct deliver_ctx *dctx, struct actitem *ti)
38 {
39 struct account *a = dctx->account;
40 struct mail *m = dctx->mail;
41 struct deliver_remove_from_cache_data *data = ti->data;
42 char *key;
43 struct cache *cache;
44
45 key = replacestr(&data->key, m->tags, m, &m->rml);
46 if (key == NULL || *key == '\0') {
47 log_warnx("%s: empty key", a->name);
48 goto error;
49 }
50 log_debug2("%s: removing from cache %s: %s", a->name, data->path, key);
51
52 TAILQ_FOREACH(cache, &conf.caches, entry) {
53 if (strcmp(data->path, cache->path) == 0) {
54 if (open_cache(a, cache) != 0)
55 goto error;
56 if (db_contains(cache->db, key) &&
57 db_remove(cache->db, key) != 0) {
58 log_warnx(
59 "%s: error removing from cache %s: %s",
60 a->name, cache->path, key);
61 goto error;
62 }
63 xfree(key);
64 return (DELIVER_SUCCESS);
65 }
66 }
67 log_warnx("%s: cache %s not declared", a->name, data->path);
68
69 error:
70 if (key != NULL)
71 xfree(key);
72 return (DELIVER_FAILURE);
73 }
74
75 void
76 deliver_remove_from_cache_desc(struct actitem *ti, char *buf, size_t len)
77 {
78 struct deliver_remove_from_cache_data *data = ti->data;
79
80 xsnprintf(buf, len,
81 "remove-from-cache \"%s\" key \"%s\"", data->path, data->key.str);
82 }
+10
-1
deliver.h less more
123123 struct replstrs *actions;
124124 };
125125
126 /* Deliver rewrite data. */
126 /* Deliver add-to-cache data. */
127127 struct deliver_add_to_cache_data {
128 char *path;
129 struct replstr key;
130 };
131
132 /* Deliver remove-from-cache data. */
133 struct deliver_remove_from_cache_data {
128134 char *path;
129135 struct replstr key;
130136 };
168174 /* deliver-add-to-cache.c */
169175 extern struct deliver deliver_add_to_cache;
170176
177 /* deliver-remove-from-cache.c */
178 extern struct deliver deliver_remove_from_cache;
179
171180 #endif
+13
-3
fdm.conf.5 less more
654654 Caches must be declared before they are used. Items are added to caches using
655655 the
656656 .Ic add-to-cache
657 action
658 and they are searched using the
657 action, removed using the
658 .Ic remove-from-cache
659 action, and searched for using the
659660 .Ic in-cache
660661 condition; see below for information on these.
661662 .Sh ACTIONS
796797 This action adds the string
797798 .Ar key
798799 to the cache specified by
799 .Ar path .
800 .Ar path .
801 If
802 .Ar key
803 already exists in the cache, it is replaced.
804 .It Ic remove-from-cache Ar path Ic key Ar key
805 Remove the string
806 .Ar key
807 from the cache
808 .Ar path ,
809 if a matching key is present.
800810 .It Ic action Ar name
801811 This invokes another named action.
802812 A maximum of five actions may be called in a sequence.
+1
-0
fdm.h less more
871871 TDB_CONTEXT *db_open(char *);
872872 void db_close(TDB_CONTEXT *);
873873 int db_add(TDB_CONTEXT *, char *);
874 int db_remove(TDB_CONTEXT *, char *);
874875 int db_contains(TDB_CONTEXT *, char *);
875876 int db_size(TDB_CONTEXT *);
876877 int db_expire(TDB_CONTEXT *, uint64_t);
+2
-2
lex.c less more
8585 { "day", TOKDAYS },
8686 { "days", TOKDAYS },
8787 { "default-user", TOKDEFUSER },
88 { "delete-from-cache", TOKADDFROMCACHE },
8988 { "delete-oversized", TOKDELTOOBIG },
9089 { "disabled", TOKDISABLED },
9190 { "domain", TOKDOMAIN },
158157 { "purge-after", TOKPURGEAFTER },
159158 { "queue-high", TOKQUEUEHIGH },
160159 { "queue-low", TOKQUEUELOW },
160 { "remove-from-cache", TOKREMOVEFROMCACHE },
161161 { "remove-header", TOKREMOVEHEADER },
162162 { "remove-headers", TOKREMOVEHEADERS },
163163 { "returns", TOKRETURNS },
176176 { "tagged", TOKTAGGED },
177177 { "timeout", TOKTIMEOUT },
178178 { "to", TOKTO },
179 { "to-cache", TOKTOCACHE },
179 { "to-cache", TOKADDTOCACHE },
180180 { "total-size", TOKTOTALSIZE },
181181 { "unmatched", TOKUNMATCHED },
182182 { "unmatched-mail", TOKIMPLACT },
+6
-2
parse-fn.c less more
351351 xfree(data->key.str);
352352 if (data->value.str != NULL)
353353 xfree(data->value.str);
354 } else if (ti->deliver == &deliver_to_cache) {
355 struct deliver_to_cache_data *data = ti->data;
354 } else if (ti->deliver == &deliver_add_to_cache) {
355 struct deliver_add_to_cache_data *data = ti->data;
356 xfree(data->key.str);
357 xfree(data->path);
358 } else if (ti->deliver == &deliver_remove_from_cache) {
359 struct deliver_remove_from_cache_data *data = ti->data;
356360 xfree(data->key.str);
357361 xfree(data->path);
358362 } else if (ti->deliver == &deliver_smtp) {
+24
-4
parse.y less more
134134 %token TOKGROUP TOKGROUPS TOKPURGEAFTER TOKCOMPRESS TOKNORECEIVED TOKFILEUMASK
135135 %token TOKFILEGROUP TOKVALUE TOKTIMEOUT TOKREMOVEHEADER TOKREMOVEHEADERS
136136 %token TOKSTDOUT TOKNOVERIFY TOKADDHEADER TOKQUEUEHIGH TOKQUEUELOW TOKNOAPOP
137 %token TOKVERIFYCERTS TOKEXPIRE TOKADDTOCACHE TOKINCACHE TOKKEY TOKNEWONLY
138 %token TOKOLDONLY TOKCACHE TOKFLOCK TOKFCNTL TOKDOTLOCK TOKSTRIPCHARACTERS
137 %token TOKVERIFYCERTS TOKEXPIRE TOKADDTOCACHE TOKREMOVEFROMCACHE TOKINCACHE
138 %token TOKKEY TOKNEWONLY TOKOLDONLY TOKCACHE TOKFLOCK TOKFCNTL TOKDOTLOCK
139 %token TOKSTRIPCHARACTERS
139140
140141 %union
141142 {
13021303 | TOKADDTOCACHE replpathv TOKKEY strv
13031304 /** [$2: replpathv (char *)] [$4: strv (char *)] */
13041305 {
1305 struct deliver_to_cache_data *data;
1306 struct deliver_add_to_cache_data *data;
13061307
13071308 if (*$2 == '\0')
13081309 yyerror("invalid path");
13101311 yyerror("invalid key");
13111312
13121313 $$ = xcalloc(1, sizeof *$$);
1313 $$->deliver = &deliver_to_cache;
1314 $$->deliver = &deliver_add_to_cache;
1315
1316 data = xcalloc(1, sizeof *data);
1317 $$->data = data;
1318
1319 data->key.str = $4;
1320 data->path = $2;
1321 }
1322 | TOKREMOVEFROMCACHE replpathv TOKKEY strv
1323 /** [$2: replpathv (char *)] [$4: strv (char *)] */
1324 {
1325 struct deliver_remove_from_cache_data *data;
1326
1327 if (*$2 == '\0')
1328 yyerror("invalid path");
1329 if (*$4 == '\0')
1330 yyerror("invalid key");
1331
1332 $$ = xcalloc(1, sizeof *$$);
1333 $$->deliver = &deliver_remove_from_cache;
13141334
13151335 data = xcalloc(1, sizeof *data);
13161336 $$->data = data;