summaryrefslogtreecommitdiffstats
path: root/src/plugins/fts/fts-parser.h
blob: 0eb716ef7f054c9350a0b46634ed9d2dba15e65c (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
#ifndef FTS_PARSER_H
#define FTS_PARSER_H

struct message_block;
struct mail_user;

struct fts_parser_context {
	/* Can't be NULL */
	struct mail_user *user;
	/* Can't be NULL */
	const char *content_type;
	const char *content_disposition;
};

struct fts_parser_vfuncs {
	struct fts_parser *(*try_init)(struct fts_parser_context *parser_context);
	void (*more)(struct fts_parser *parser, struct message_block *block);
	int (*deinit)(struct fts_parser *parser, const char **retriable_err_msg_r);
	void (*unload)(void);
};

struct fts_parser {
	struct fts_parser_vfuncs v;
	buffer_t *utf8_output;
	bool may_need_retry;
	char *retriable_error_msg;
};

extern struct fts_parser_vfuncs fts_parser_html;
extern struct fts_parser_vfuncs fts_parser_script;
extern struct fts_parser_vfuncs fts_parser_tika;

bool fts_parser_init(struct fts_parser_context *parser_context,
		     struct fts_parser **parser_r);
struct fts_parser *fts_parser_text_init(void);

/* The parser is initially called with message body blocks. Once message is
   finished, it's still called with incoming size=0 while the parser increases
   it to non-zero. */
void fts_parser_more(struct fts_parser *parser, struct message_block *block);
/* Returns 1 if ok, 0 if the parsing should be retried, -1 if error.
   If 0 is returned, the retriable_err_msg_r is set, which should be logged
   as error if no retrying is performed. */
int fts_parser_deinit(struct fts_parser **parser, const char **retriable_err_msg_r);

void fts_parsers_unload(void);

#endif