dma: add TODO
[dragonfly.git] / libexec / dma / spool.c
1 /*
2  * Copyright (c) 2008 The DragonFly Project.  All rights reserved.
3  *
4  * This code is derived from software contributed to The DragonFly Project
5  * by Simon 'corecode' Schubert <corecode@fs.ei.tum.de>.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  *
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice, this list of conditions and the following disclaimer.
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in
15  *    the documentation and/or other materials provided with the
16  *    distribution.
17  * 3. Neither the name of The DragonFly Project nor the names of its
18  *    contributors may be used to endorse or promote products derived
19  *    from this software without specific, prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
24  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
25  * COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
26  * INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
27  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
28  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
29  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
30  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
31  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32  * SUCH DAMAGE.
33  */
34
35 #include <sys/stat.h>
36
37 #include <ctype.h>
38 #include <dirent.h>
39 #include <err.h>
40 #include <errno.h>
41 #include <fcntl.h>
42 #include <inttypes.h>
43 #include <unistd.h>
44 #include <syslog.h>
45
46 #include "dma.h"
47
48 /*
49  * Spool file format:
50  *
51  * 'Q'id files (queue):
52  *   Organized like an RFC822 header, field: value.  Ignores unknown fields.
53  *   ID: id
54  *   Sender: envelope-from
55  *   Recipient: envelope-to
56  *
57  * 'M'id files (data):
58  *   mail data
59  *
60  * Each queue file needs to have a corresponding data file.
61  * One data file might be shared by linking it several times.
62  *
63  * Queue ids are unique, formed from the inode of the data file
64  * and a unique identifier.
65  */
66
67 int
68 newspoolf(struct queue *queue)
69 {
70         char fn[PATH_MAX+1];
71         struct stat st;
72         struct stritem *t;
73         int fd;
74
75         if (snprintf(fn, sizeof(fn), "%s/%s", config->spooldir, "tmp_XXXXXXXXXX") <= 0)
76                 return (-1);
77
78         fd = mkstemp(fn);
79         if (fd < 0)
80                 return (-1);
81         if (flock(fd, LOCK_EX) == -1)
82                 goto fail;
83         queue->tmpf = strdup(fn);
84         if (queue->tmpf == NULL)
85                 goto fail;
86
87         /*
88          * Assign queue id
89          */
90         if (fstat(fd, &st) != 0)
91                 goto fail;
92         if (asprintf(&queue->id, "%"PRIxMAX, st.st_ino) < 0)
93                 goto fail;
94
95         queue->mailf = fdopen(fd, "r+");
96         if (queue->mailf == NULL)
97                 goto fail;
98
99         t = malloc(sizeof(*t));
100         if (t != NULL) {
101                 t->str = queue->tmpf;
102                 SLIST_INSERT_HEAD(&tmpfs, t, next);
103         }
104         return (0);
105
106 fail:
107         if (queue->mailf != NULL)
108                 fclose(queue->mailf);
109         close(fd);
110         unlink(fn);
111         return (-1);
112 }
113
114 static int
115 writequeuef(struct qitem *it)
116 {
117         int error;
118         int queuefd;
119
120         queuefd = open_locked(it->queuefn, O_CREAT|O_EXCL|O_RDWR, 0600);
121         if (queuefd == -1)
122                 return (-1);
123         it->queuef = fdopen(queuefd, "w+");
124         if (it->queuef == NULL)
125                 return (-1);
126
127         error = fprintf(it->queuef,
128                         "ID: %s\n"
129                         "Sender: %s\n"
130                         "Recipient: %s\n",
131                          it->queueid,
132                          it->sender,
133                          it->addr);
134
135         if (error <= 0)
136                 return (-1);
137
138         if (fflush(it->queuef) != 0 || fsync(fileno(it->queuef)) != 0)
139                 return (-1);
140
141         return (0);
142 }
143
144 static struct qitem *
145 readqueuef(struct queue *queue, char *queuefn)
146 {
147         char line[1000];
148         struct queue itmqueue;
149         FILE *queuef = NULL;
150         char *s;
151         char *queueid = NULL, *sender = NULL, *addr = NULL;
152         struct qitem *it = NULL;
153
154         bzero(&itmqueue, sizeof(itmqueue));
155         LIST_INIT(&itmqueue.queue);
156
157         queuef = fopen(queuefn, "r");
158         if (queuef == NULL)
159                 goto out;
160
161         while (!feof(queuef)) {
162                 if (fgets(line, sizeof(line), queuef) == NULL || line[0] == 0)
163                         break;
164                 line[strlen(line) - 1] = 0;     /* chop newline */
165
166                 s = strchr(line, ':');
167                 if (s == NULL)
168                         goto malformed;
169                 *s = 0;
170
171                 s++;
172                 while (isspace(*s))
173                         s++;
174
175                 s = strdup(s);
176                 if (s == NULL || s[0] == 0)
177                         goto malformed;
178
179                 if (strcmp(line, "ID") == 0) {
180                         queueid = s;
181                 } else if (strcmp(line, "Sender") == 0) {
182                         sender = s;
183                 } else if (strcmp(line, "Recipient") == 0) {
184                         addr = s;
185                 } else {
186                         syslog(LOG_DEBUG, "ignoring unknown queue info `%s' in `%s'",
187                                line, queuefn);
188                         free(s);
189                 }
190         }
191
192         if (queueid == NULL || sender == NULL || addr == NULL) {
193 malformed:
194                 errno = EINVAL;
195                 syslog(LOG_ERR, "malformed queue file `%s'", queuefn);
196                 goto out;
197         }
198
199         if (add_recp(&itmqueue, addr, 0) != 0)
200                 goto out;
201
202         it = LIST_FIRST(&itmqueue.queue);
203         it->sender = sender; sender = NULL;
204         it->queueid = queueid; queueid = NULL;
205         it->queuefn = queuefn; queuefn = NULL;
206         LIST_INSERT_HEAD(&queue->queue, it, next);
207
208 out:
209         if (sender != NULL)
210                 free(sender);
211         if (queueid != NULL)
212                 free(queueid);
213         if (addr != NULL)
214                 free(addr);
215         if (queuef != NULL)
216                 fclose(queuef);
217
218         return (it);
219 }
220
221 int
222 linkspool(struct queue *queue)
223 {
224         struct stat st;
225         struct qitem *it;
226
227         if (fflush(queue->mailf) != 0 || fsync(fileno(queue->mailf)) != 0)
228                 goto delfiles;
229
230         syslog(LOG_INFO, "new mail from user=%s uid=%d envelope_from=<%s>",
231                username, getuid(), queue->sender);
232
233         LIST_FOREACH(it, &queue->queue, next) {
234                 if (asprintf(&it->queueid, "%s.%"PRIxPTR, queue->id, (uintptr_t)it) <= 0)
235                         goto delfiles;
236                 if (asprintf(&it->queuefn, "%s/Q%s", config->spooldir, it->queueid) <= 0)
237                         goto delfiles;
238                 if (asprintf(&it->mailfn, "%s/M%s", config->spooldir, it->queueid) <= 0)
239                         goto delfiles;
240
241                 /* Neither file may not exist yet */
242                 if (stat(it->queuefn, &st) == 0 || stat(it->mailfn, &st) == 0)
243                         goto delfiles;
244
245                 if (writequeuef(it) != 0)
246                         goto delfiles;
247
248                 if (link(queue->tmpf, it->mailfn) != 0)
249                         goto delfiles;
250         }
251
252         LIST_FOREACH(it, &queue->queue, next) {
253                 syslog(LOG_INFO, "mail to=<%s> queued as %s",
254                        it->addr, it->queueid);
255         }
256
257         unlink(queue->tmpf);
258         return (0);
259
260 delfiles:
261         LIST_FOREACH(it, &queue->queue, next) {
262                 unlink(it->mailfn);
263                 unlink(it->queuefn);
264         }
265         return (-1);
266 }
267
268 int
269 load_queue(struct queue *queue)
270 {
271         struct stat sb;
272         struct qitem *it;
273         DIR *spooldir;
274         struct dirent *de;
275         char *queuefn;
276         char *mailfn;
277
278         bzero(queue, sizeof(queue));
279         LIST_INIT(&queue->queue);
280
281         spooldir = opendir(config->spooldir);
282         if (spooldir == NULL)
283                 err(1, "reading queue");
284
285         while ((de = readdir(spooldir)) != NULL) {
286                 queuefn = NULL;
287                 mailfn = NULL;
288
289                 /* ignore temp files */
290                 if (strncmp(de->d_name, "tmp_", 4) == 0 || de->d_type != DT_REG)
291                         continue;
292                 if (de->d_name[0] != 'Q')
293                         continue;
294                 if (asprintf(&queuefn, "%s/Q%s", config->spooldir, de->d_name + 1) < 0)
295                         goto fail;
296                 if (asprintf(&mailfn, "%s/M%s", config->spooldir, de->d_name + 1) < 0)
297                         goto fail;
298
299                 if (stat(mailfn, &sb) != 0)
300                         goto skip_item;
301
302                 it = readqueuef(queue, queuefn);
303                 if (it == NULL)
304                         goto skip_item;
305
306                 it->mailfn = mailfn;
307                 continue;
308
309 skip_item:
310                 syslog(LOG_INFO, "could not pick up queue file: `%s'/`%s': %m", queuefn, mailfn);
311                 if (queuefn != NULL)
312                         free(queuefn);
313                 if (mailfn != NULL)
314                         free(queuefn);
315         }
316         closedir(spooldir);
317         return (0);
318
319 fail:
320         return (-1);
321 }
322
323 void
324 delqueue(struct qitem *it)
325 {
326         unlink(it->mailfn);
327         unlink(it->queuefn);
328         if (it->queuef != NULL)
329                 fclose(it->queuef);
330         if (it->mailf != NULL)
331                 fclose(it->mailf);
332         free(it);
333 }
334
335 int
336 aquirespool(struct qitem *it)
337 {
338         int queuefd;
339
340         if (it->queuef == NULL) {
341                 queuefd = open_locked(it->queuefn, O_RDWR|O_NONBLOCK);
342                 if (queuefd < 0)
343                         goto fail;
344                 it->queuef = fdopen(queuefd, "r+");
345                 if (it->queuef == NULL)
346                         goto fail;
347         }
348
349         if (it->mailf == NULL) {
350                 it->mailf = fopen(it->mailfn, "r");
351                 if (it->mailf == NULL)
352                         goto fail;
353         }
354
355         return (0);
356
357 fail:
358         syslog(LOG_INFO, "could not aquire queue file: %m");
359         return (-1);
360 }
361
362 void
363 dropspool(struct queue *queue, struct qitem *keep)
364 {
365         struct qitem *it;
366
367         LIST_FOREACH(it, &queue->queue, next) {
368                 if (it == keep)
369                         continue;
370
371                 if (it->queuef != NULL)
372                         fclose(it->queuef);
373                 if (it->mailf != NULL)
374                         fclose(it->mailf);
375         }
376 }