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
|
/**
* @file protocol.h
* Rspamd protocol definition
*/
#ifndef RSPAMD_PROTOCOL_H
#define RSPAMD_PROTOCOL_H
#include "config.h"
#include "filter.h"
#define RSPAMD_FILTER_ERROR 1
#define RSPAMD_NETWORK_ERROR 2
#define RSPAMD_PROTOCOL_ERROR 3
#define RSPAMD_LENGTH_ERROR 4
#define RSPAMD_STATFILE_ERROR 5
#define RSPAMC_PROTO_1_0 "1.0"
#define RSPAMC_PROTO_1_1 "1.1"
#define RSPAMC_PROTO_1_2 "1.2"
#define RSPAMC_PROTO_1_3 "1.3"
/*
* Reply messages
*/
#define RSPAMD_REPLY_BANNER "RSPAMD"
#define SPAMD_REPLY_BANNER "SPAMD"
#define SPAMD_OK "EX_OK"
/* XXX: try to convert rspamd errors to spamd errors */
#define SPAMD_ERROR "EX_ERROR"
struct worker_task;
struct metric;
enum rspamd_protocol {
SPAMC_PROTO,
RSPAMC_PROTO,
};
enum rspamd_command {
CMD_CHECK,
CMD_SYMBOLS,
CMD_REPORT,
CMD_REPORT_IFSPAM,
CMD_SKIP,
CMD_PING,
CMD_PROCESS,
CMD_LEARN,
CMD_OTHER,
};
typedef gint (*protocol_reply_func)(struct worker_task *task);
struct custom_command {
const gchar *name;
protocol_reply_func func;
};
/**
* Read one line of user's input for specified task
* @param task task object
* @param line line of user's input
* @return 0 if line was successfully parsed and -1 if we have protocol error
*/
gboolean read_rspamd_input_line (struct worker_task *task, f_str_t *line);
/**
* Write reply for specified task command
* @param task task object
* @return 0 if we wrote reply and -1 if there was some error
*/
gboolean write_reply (struct worker_task *task) G_GNUC_WARN_UNUSED_RESULT;
/**
* Register custom fucntion to extend protocol
* @param name symbolic name of custom function
* @param func callback function for writing reply
*/
void register_protocol_command (const gchar *name, protocol_reply_func func);
#endif
|
