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
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
|
/*
* Copyright (C) 2008-2011 Martin Willi
* Hochschule fuer Technik Rapperswil
* Copyright (C) 2011 revosec AG
*
* This program is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License as published by the
* Free Software Foundation; either version 2 of the License, or (at your
* option) any later version. See <http://www.fsf.org/copyleft/gpl.txt>.
*
* This program is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
* or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* for more details.
*/
/**
* @defgroup fetcheri fetcher
* @{ @ingroup fetcher
*/
#ifndef FETCHER_H_
#define FETCHER_H_
typedef struct fetcher_t fetcher_t;
typedef enum fetcher_option_t fetcher_option_t;
#include <stdarg.h>
#include <utils/chunk.h>
/**
* Constructor function which creates fetcher instances.
*
* @return fetcher instance
*/
typedef fetcher_t* (*fetcher_constructor_t)();
/**
* Callback function used with FETCH_CALLBACK.
*
* @param userdata userdata passed to fetcher_t.fetch()
* @param chunk chunk with next chunk of data
* @return TRUE to continue with transfer, FALSE to abort
*/
typedef bool (*fetcher_callback_t)(void *userdata, chunk_t chunk);
#include <library.h>
/**
* Fetching options to use for fetcher_t.fetch() call.
*/
enum fetcher_option_t {
/**
* Data to include in fetch request, e.g. on a HTTP post.
* Additional argument is a chunk_t
*/
FETCH_REQUEST_DATA,
/**
* Mime-Type of data included in FETCH_REQUEST_DATA.
* Additional argument is a char*.
*/
FETCH_REQUEST_TYPE,
/**
* HTTP header to be sent with with the fetch request.
* Additional argument is a char*.
*/
FETCH_REQUEST_HEADER,
/**
* Use HTTP Version 1.0 instead of 1.1.
* No additional argument is needed.
*/
FETCH_HTTP_VERSION_1_0,
/**
* Timeout to use for fetch, in seconds.
* Additional argument is u_int
*/
FETCH_TIMEOUT,
/**
* Sets a pointer to a variable that receives the request's response code.
* Additional argument is a u_int*.
*/
FETCH_RESPONSE_CODE,
/**
* Callback to invoke with each chunk of data.
* Additional argument fetch_callback_t.
* If this option is not given, the fetcher_default_callback is used,
* which accumulates the data into an allocated chunk.
*/
FETCH_CALLBACK,
/**
* Source IP address to bind for a fetch.
* Additional argument is a host_t*, which may be NULL.
*/
FETCH_SOURCEIP,
/**
* end of fetching options
*/
FETCH_END,
};
/**
* Fetcher interface, an implementation fetches data from an URL.
*/
struct fetcher_t {
/**
* Fetch data from URI into chunk.
*
* The fetcher returns NOT_SUPPORTED to indicate that it is uncappable
* to handle such URLs. Other return values indicate a failure, and
* fetching of that URL gets cancelled.
* If no FETCH_CALLBACK function is set as option, userdata must be
* a chunk_t*. This chunk gets allocated, accumulated data using the
* fetcher_default_callback() function.
*
* @param uri URI to fetch from
* @param userdata userdata to pass to callback function.
* @return
* - SUCCESS if fetch was successful
* - NOT_SUPPORTED if fetcher does not support such URLs
* - FAILED, NOT_FOUND, PARSE_ERROR on failure
*/
status_t (*fetch)(fetcher_t *this, char *uri, void *userdata);
/**
* Set a fetcher option, as defined in fetcher_option_t.
*
* Arguments passed to options must stay in memory until fetch() returns.
*
* @param option option to set
* @param ... variable argument(s) to option
* @return TRUE if option supported, FALSE otherwise
*/
bool (*set_option)(fetcher_t *this, fetcher_option_t option, ...);
/**
* Destroy the fetcher instance.
*/
void (*destroy)(fetcher_t *this);
};
/**
* Default fetcher callback function, accumulates data to a chunk.
*
* @param userdata chunk for allocated data, empty on first invocation
* @param chunk current chunk of data
* @return FALSE if chunk too large to allocate
*/
bool fetcher_default_callback(void *userdata, chunk_t chunk);
#endif /** FETCHER_H_ @}*/
|
