MERGE command
[rxpd] / src / rxpd.h
1 /*
2     rxpd.h - regex policy daemon
3
4   Copyright (C)
5     2007,               Christian Thaeter <ct@pipapo.org>
6
7   This program is free software; you can redistribute it and/or
8   modify it under the terms of the GNU General Public License as
9   published by the Free Software Foundation; either version 2 of the
10   License, or (at your option) any later version.
11
12   This program is distributed in the hope that it will be useful,
13   but WITHOUT ANY WARRANTY; without even the implied warranty of
14   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15   GNU General Public License for more details.
16
17   You should have received a copy of the GNU General Public License
18   along with this program; if not, write to the Free Software
19   Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
20 */
21 #ifndef RXPD_H
22 #define RXPD_H
23
24 #include "llist.h"
25 #include "psplay.h"
26
27 #include <errno.h>
28 #include <string.h>
29 #include <stdlib.h>
30 #include <stdarg.h>
31 #include <unistd.h>
32 #include <regex.h>
33 #include <syslog.h>
34 #include <sys/stat.h>
35 #include <sys/time.h>
36 #include <sys/types.h>
37 #include <sys/socket.h>
38 #include <netinet/in.h>
39 #include <arpa/inet.h>
40 #include <event.h>
41 #include <pth.h>
42 #include <time.h>
43 #include <netdb.h>
44
45 #define RXPD_COMMANDS                                           \
46   RXPD_CMD(CHECK,       "data against regular expressions")     \
47   RXPD_CMD(APPEND,      "new rules to a list")                  \
48   RXPD_CMD(PREPEND,     "new rules in front of a list")         \
49   RXPD_CMD(REMOVE,      "rules from a list")                    \
50   RXPD_CMD(REPLACE,     "a rule in a list with new rules")      \
51   RXPD_CMD(DELETE,      "a list from memory")                   \
52   RXPD_CMD(LOAD,        "a list from disk")                     \
53   RXPD_CMD(SAVE,        "a list to disk")                       \
54   RXPD_CMD(FETCH,       "a list from a remote server")          \
55   RXPD_CMD(UPDATE,      "atimes from other lists")              \
56   RXPD_CMD(MERGE,       "new rules from from other lists")      \
57   RXPD_CMD(EXPIRE,      "aged rules from a list")               \
58   RXPD_CMD(DUMP,        "rules in a list")                      \
59   RXPD_CMD(LIST,        "all existing lists")                   \
60   RXPD_CMD(VERSION,     "of this rxpd is "PACKAGE_VERSION)      \
61   RXPD_CMD(HELP,        "is what you see right now")            \
62   RXPD_CMD(SHUTDOWN,    "the daemon")
63
64 #define RXPD_CMD(cmd, _) RXPD_CMD_##cmd,
65 enum rxpd_cmd_e {RXPD_COMMANDS};
66 #undef RXPD_CMD
67
68 /*
69  * characters which are absolutely not allowed in rule filenames
70  * for finer control use policies, note that this are arbitary
71  * decisions also reserving some chars for later extension
72  */
73 #define RXPD_FILE_ILG_CHARS "@&?<>|/: \t\n\r*?\\"
74
75 /*
76  * Call a cooperative pth_yield every this much expensive interations
77  * not implemented yet
78  * A higher number favors throughput, lower number improves latency
79  */
80 #define RXPD_YIELD_EVERY 500
81
82 struct rxpd_base;
83 struct rxpd_file;
84 struct rxpd_rule;
85 struct rxpd_socket;
86 struct rxpd_buffer;
87 struct rxpd_connection;
88
89 struct rxpd_base
90 {
91   char* basedir;
92
93   int verbosity;
94   int regflags;
95   int daemonize;
96
97   struct rxpd_file* policy;
98
99   // TODO
100   //FILE* -l log      log hits to logfile
101
102   psplayroot files;
103   llist sockets;
104 };
105
106 struct rxpd_base*
107 rxpd_init (void);
108
109 void
110 rxpd_destroy (void);
111
112 void
113 rxpd_log (struct rxpd_base*, int level, const char* fmt, ...);
114
115 void
116 rxpd_fail (struct rxpd_base*, const char* fmt, ...);
117
118 void
119 rxpd_die (const char* fmt, ...);
120
121 void*
122 rxpd_malloc (size_t size);
123
124 char*
125 rxpd_strdup (const char* str);
126
127 struct rxpd_base*
128 rxpd_set_basedir (struct rxpd_base*, const char* basedir);
129
130 //
131 struct rxpd_rule
132 {
133   llist node;
134   char* string;
135   time_t atime;
136   regex_t rx;
137 };
138
139 struct rxpd_rule*
140 rxpd_rule_new (const char* buf);
141
142 struct rxpd_rule*
143 rxpd_rule_copy (const struct rxpd_rule* src);
144
145 void
146 rxpd_rule_delete (struct rxpd_rule* self);
147
148
149
150 //
151 struct rxpd_file
152 {
153   psplay node;          // key points to basename part of filename
154   const char* filename; // full filename
155   //TODO later     struct stat last_stat;
156   struct rxpd_base* base;
157   pth_rwlock_t lock;
158   llist rules;
159 };
160
161 struct rxpd_file*
162 rxpd_file_new (struct rxpd_base* base, const char* filename);
163
164 void
165 rxpd_file_delete (struct rxpd_file* file);
166
167 struct rxpd_file*
168 rxpd_file_rules_delete (struct rxpd_file* self);
169
170 int
171 rxpd_file_load (struct rxpd_file* self);
172
173 int
174 rxpd_file_save (struct rxpd_file* self);
175
176 struct rxpd_file*
177 rxpd_file_dump (struct rxpd_file* self, struct rxpd_buffer* out);
178
179 int
180 rxpd_file_cmp (const void* A, const void* B);
181
182
183 //
184
185 struct rxpd_socket
186 {
187   llist node;
188   int fd;
189   struct event ev;
190   struct rxpd_base* base;
191   pth_t accepter;
192   int (*rxpd_socket_addr)(struct rxpd_connection* conn, char* dst, const char* pfx, size_t size);
193 };
194
195
196 struct rxpd_socket*
197 rxpd_socket_new_tcp4 (struct rxpd_base* base, const char* addr, unsigned short port);
198
199 int
200 rxpd_socket_tcp4addr (struct rxpd_connection* conn, char* dst, const char* pfx, size_t size);
201
202 //TODO
203 //struct rxpd_socket*
204 //rxpd_socket_new_unix (struct rxpd_base* base, const char* name);
205
206 void
207 rxpd_socket_delete (struct rxpd_socket* self);
208
209 void *
210 rxpd_socket_accept (void* ptr);
211
212 struct rxpd_socket*
213 rxpd_socket_spawn (struct rxpd_socket* self);
214
215 struct rxpd_socket*
216 rxpd_socket_join (struct rxpd_socket* self);
217
218 struct rxpd_socket*
219 rxpd_socket_cancel (struct rxpd_socket* self);
220
221 //
222
223 enum rxpd_buffer_state_e
224   {
225     RXPD_OK,            // operational
226     RXPD_EOF,           // connection closed
227     RXPD_ERROR          // some other error
228   };
229
230 struct rxpd_buffer
231 {
232   int fd;
233   enum rxpd_buffer_state_e state;
234   char* eol;
235   char* eob;
236   char buffer[4096];
237 };
238
239 struct rxpd_buffer*
240 rxpd_buffer_init (struct rxpd_buffer* self, int fd);
241
242 char*
243 rxpd_buffer_readline (struct rxpd_buffer* self);
244
245 int
246 rxpd_buffer_printf (struct rxpd_buffer* self, const char* fmt, ...);
247
248 inline static enum rxpd_buffer_state_e
249 rxpd_buffer_state (struct rxpd_buffer* self)
250 {
251   return self->state;
252 }
253
254
255 //
256 struct rxpd_connection
257 {
258   int fd;
259   pth_t connecter;
260   struct rxpd_file* file;
261   struct rxpd_socket* socket;
262   char* tmp_str;
263   llist tmp_list;
264
265   struct rxpd_buffer in;
266   struct rxpd_buffer out;
267 };
268
269
270 struct rxpd_connection*
271 rxpd_connection_new (struct rxpd_socket* socket, int fd);
272
273 void
274 rxpd_connection_delete (struct rxpd_connection* self);
275
276 struct rxpd_connection*
277 rxpd_connection_spawn (struct rxpd_connection* self);
278
279 int
280 rxpd_connection_readline (struct rxpd_connection* self);
281
282 int
283 rxpd_connection_check_policy (struct rxpd_connection* self, char* line);
284
285 void*
286 rxpd_connection_parse_cmd (void* ptr);
287
288 /* generate prototypes for each defined command */
289 #define RXPD_CMD(cmd, _) void rxpd_connection_cmd_##cmd (struct rxpd_connection* self);
290 RXPD_COMMANDS
291 #undef RXPD_CMD
292
293
294 #endif