aboutsummaryrefslogtreecommitdiffstats
path: root/src/classifiers/classifiers.h
blob: 8e59fc5555dc1c240993d09b9a9291c2b65643cc (plain)
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
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
#ifndef CLASSIFIERS_H
#define CLASSIFIERS_H

#include "config.h"
#include "mem_pool.h"
#include "statfile.h"
#include "tokenizers/tokenizers.h"
#include <lua.h>

/* Consider this value as 0 */
#define ALPHA 0.0001

struct rspamd_classifier_config;
struct rspamd_task;

struct classifier_ctx {
	rspamd_mempool_t *pool;
	GHashTable *results;
	gboolean debug;
	struct rspamd_classifier_config *cfg;
};

struct classify_weight {
	const char *name;
	long double weight;
};

/* Common classifier structure */
struct classifier {
	char *name;
	struct classifier_ctx * (*init_func)(rspamd_mempool_t *pool,
		struct rspamd_classifier_config *cf);
	gboolean (*classify_func)(struct classifier_ctx * ctx,
		statfile_pool_t *pool, GTree *input, struct rspamd_task *task,
		lua_State *L);
	gboolean (*learn_func)(struct classifier_ctx * ctx, statfile_pool_t *pool,
		const char *symbol, GTree *input, gboolean in_class,
		double *sum, double multiplier, GError **err);
	gboolean (*learn_spam_func)(struct classifier_ctx * ctx,
		statfile_pool_t *pool,
		GTree *input, struct rspamd_task *task, gboolean is_spam, lua_State *L,
		GError **err);
	GList * (*weights_func)(struct classifier_ctx * ctx, statfile_pool_t *pool,
		GTree *input, struct rspamd_task *task);
};

/* Get classifier structure by name or return NULL if this name is not found */
struct classifier * get_classifier (const char *name);

/* Winnow algorithm */
struct classifier_ctx * winnow_init (rspamd_mempool_t *pool,
	struct rspamd_classifier_config *cf);
gboolean winnow_classify (struct classifier_ctx * ctx,
	statfile_pool_t *pool,
	GTree *input,
	struct rspamd_task *task,
	lua_State *L);
gboolean winnow_learn (struct classifier_ctx * ctx,
	statfile_pool_t *pool,
	const char *symbol,
	GTree *input,
	gboolean in_class,
	double *sum,
	double multiplier,
	GError **err);
gboolean winnow_learn_spam (struct classifier_ctx * ctx,
	statfile_pool_t *pool,
	GTree *input,
	struct rspamd_task *task,
	gboolean is_spam,
	lua_State *L,
	GError **err);
GList * winnow_weights (struct classifier_ctx * ctx,
	statfile_pool_t *pool,
	GTree *input,
	struct rspamd_task *task);

/* Bayes algorithm */
struct classifier_ctx * bayes_init (rspamd_mempool_t *pool,
	struct rspamd_classifier_config *cf);
gboolean bayes_classify (struct classifier_ctx * ctx,
	statfile_pool_t *pool,
	GTree *input,
	struct rspamd_task *task,
	lua_State *L);
gboolean bayes_learn (struct classifier_ctx * ctx,
	statfile_pool_t *pool,
	const char *symbol,
	GTree *input,
	gboolean in_class,
	double *sum,
	double multiplier,
	GError **err);
gboolean bayes_learn_spam (struct classifier_ctx * ctx,
	statfile_pool_t *pool,
	GTree *input,
	struct rspamd_task *task,
	gboolean is_spam,
	lua_State *L,
	GError **err);
GList * bayes_weights (struct classifier_ctx * ctx,
	statfile_pool_t *pool,
	GTree *input,
	struct rspamd_task *task);
/* Array of all defined classifiers */
extern struct classifier classifiers[];

#endif
/*
 * vi:ts=4
 */