ad7d649a80e375d411081bc4984d084a7ebece35
[apps/pfixtools.git] / job.h
1 /******************************************************************************/
2 /*          postlicyd: a postfix policy daemon with a lot of features         */
3 /*          ~~~~~~~~~                                                         */
4 /*  ________________________________________________________________________  */
5 /*                                                                            */
6 /*  Redistribution and use in source and binary forms, with or without        */
7 /*  modification, are permitted provided that the following conditions        */
8 /*  are met:                                                                  */
9 /*                                                                            */
10 /*  1. Redistributions of source code must retain the above copyright         */
11 /*     notice, this list of conditions and the following disclaimer.          */
12 /*  2. Redistributions in binary form must reproduce the above copyright      */
13 /*     notice, this list of conditions and the following disclaimer in the    */
14 /*     documentation and/or other materials provided with the distribution.   */
15 /*  3. The names of its contributors may not be used to endorse or promote    */
16 /*     products derived from this software without specific prior written     */
17 /*     permission.                                                            */
18 /*                                                                            */
19 /*  THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND   */
20 /*  ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE     */
21 /*  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR        */
22 /*  PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS    */
23 /*  BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR    */
24 /*  CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF      */
25 /*  SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS  */
26 /*  INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN   */
27 /*  CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)   */
28 /*  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF    */
29 /*  THE POSSIBILITY OF SUCH DAMAGE.                                           */
30 /******************************************************************************/
31
32 /*
33  * Copyright © 2007 Pierre Habouzit
34  */
35
36 #ifndef POSTLICYD_JOB_H
37 #define POSTLICYD_JOB_H
38
39 #include "buffer.h"
40
41 enum job_state {
42     JOB_FREE   = 0x00,
43     JOB_READ   = 0x01,
44     JOB_WRITE  = 0x02,
45     JOB_RDWR   = 0x03,
46     JOB_CONN   = 0x04,
47     JOB_LISTEN = 0x08,
48     JOB_IDLE   = 0x10,
49 };
50
51 enum smtp_state {
52     STATE_CONNECT,
53     STATE_HELO, /* or EHLO */
54     STATE_MAIL,
55     STATE_RCPT,
56     STATE_DATE,
57     STATE_EOM,
58     STATE_VRFY,
59     STATE_ETRN,
60 };
61
62 typedef struct job_t   job_t;
63 typedef struct jpriv_t jpriv_t;
64 typedef struct task_t  task_t;
65 typedef struct query_t query_t;
66
67 struct task_t {
68     task_t *(*create)(void);
69     void (*release)(task_t **);
70
71     void (*run)(job_t *, query_t *);
72     void (*done)(job_t *);
73     void (*cancel)(job_t *);
74     void (*process)(job_t *);
75 };
76
77 struct job_t {
78     unsigned state : 6;
79     unsigned done  : 1;
80     unsigned error : 1;
81
82     int fd;
83
84     task_t *task;
85     jpriv_t *jdata;
86 };
87
88 struct query_t {
89     unsigned state : 4;
90     unsigned esmtp : 1;
91
92     const char *helo_name;
93     const char *queue_id;
94     const char *sender;
95     const char *recipient;
96     const char *recipient_count;
97     const char *client_address;
98     const char *client_name;
99     const char *rclient_name;
100     const char *instance;
101
102     /* postfix 2.2+ */
103     const char *sasl_method;
104     const char *sasl_username;
105     const char *sasl_sender;
106     const char *size;
107     const char *ccert_subject;
108     const char *ccert_issuer;
109     const char *ccsert_fingerprint;
110
111     /* postfix 2.3+ */
112     const char *encryption_protocol;
113     const char *encryption_cipher;
114     const char *encryption_keysize;
115     const char *etrn_domain;
116
117     buffer_t data;
118
119     job_t *postfix;
120     job_t *current;
121 };
122
123 static inline query_t *query_init(query_t *rq) {
124     p_clear(rq, 1);
125     buffer_init(&rq->data);
126     return rq;
127 }
128 static inline void query_wipe(query_t *rq) {
129     buffer_wipe(&rq->data);
130 }
131 DO_NEW(query_t, query);
132 DO_DELETE(query_t, query);
133
134 #endif