summaryrefslogtreecommitdiffstats
path: root/nanohttp/nanohttp-client.h
blob: a1813541dc3bcfc3039963d9e718f64d7304433f (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
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
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
/******************************************************************
 *  $Id: nanohttp-client.h,v 1.40 2007/11/03 22:40:10 m0gg Exp $
 *
 * CSOAP Project:  A http client/server library in C
 * Copyright (C) 2003  Ferhat Ayaz
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Library General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library 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
 * Library General Public License for more details.
 *
 * You should have received a copy of the GNU Library General Public
 * License along with this library; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA  02111-1307, USA.
 * 
 * Email: ferhatayaz@yahoo.com
 ******************************************************************/
#ifndef __nanohttp_client_h
#define __nanohttp_client_h

/* XXX: Clean up nanohttp to make this unnecessary */
#ifndef __NHTTP_INTERNAL
#include <nanohttp/nanohttp-error.h>
#include <nanohttp/nanohttp-common.h>
#include <nanohttp/nanohttp-stream.h>
#include <nanohttp/nanohttp-request.h>
#include <nanohttp/nanohttp-response.h>
#endif

/** @page nanohttp_client_page Howto write an HTTP client
 *
 * @section client_sec Table of contents
 *
 * - @ref nanohttp_client_init_sec
 * - @ref nanohttp_client_conn_init_sec
 *   - @ref nanohttp_client_ssl_sec
 * - @ref nanohttp_client_header_sec
 *   - @ref nanohttp_client_header_uniq_sec
 *   - @ref nanohttp_client_header_mult_sec
 *   - @ref nanohttp_client_authorization_sec
 * - @ref nanohttp_client_invoke_sec
 *   - @ref nanohttp_client_get_sec
 *   - @ref nanohttp_client_post_sec
 *   - @ref nanohttp_client_mime_sec
 * - @ref nanohttp_client_result_sec
 * - @ref nanohttp_client_conn_cleanup_sec
 * - @ref nanohttp_client_cleanup_sec
 *
 * @section nanohttp_client_init_sec Client initialization
 *
 * @code
 * int main(int argc, char **argv)
 * {
 *   herror_t status;
 *   size_t len;
 *   httpc_conn_t conn;
 *
 *   if (argc < 2)
 *   {
 *     fprintf(stderr, "usage: %s <url> [nanoHTTP params]\n", argv[0]);
 *     exit(1);
 *   }
 *
 *   if ((status = httpc_init(argc, argv)) != H_OK)
 *   {
 *     fprintf(stderr, "Cannot init nanoHTTP client (%s)\n", herror_message(status));
 *     herror_release(status);
 *     exit(1);
 *   }
 * @endcode
 *
 * @section nanohttp_client_conn_init_sec Connection initialization
 *
 * @code
 *   if (!(conn = httpc_new()))
 *   {
 *     fprintf(stderr, "Cannot create nanoHTTP client connection\n");
 *     httpc_destroy();
 *     exit(1);
 *   }
 * @endcode
 *
 * @section nanohttp_client_ssl_sec SSL related functions
 *
 * T.B.D.
 *
 * @ref nanohttp_ssl_page
 *
 * @section nanohttp_client_header_sec Setting HTTP headers (optional)
 *
 * @subsection nanohttp_client_header_uniq_sec Setting an header with uniq key
 *
 * @code
 *   httpc_set_header(conn, "my-key", "my-value");
 * @endcode
 *
 * @subsection nanohttp_client_header_mult_sec Setting headers with the same key
 *
 * @code
 *   httpc_add_header(conn, "Cookie", "name1:value1");
 *   httpc_add_header(conn, "Cookie", "name2:value2");
 * @endcode
 *
 * Please see @ref http_general_header_fields and @ref http_request_header_fields
 * for more information.
 *
 * @subsection nanohttp_client_authorization_sec HTTP authorization
 *
 * @code
 *   httpc_set_basic_authorization(conn, "username", "password");
 * @endcode
 *
 * @code
 *   httpc_set_basic_proxy_authorization(conn, "username", "password");
 * @endcode
 *
 * @section nanohttp_client_invoke_sec Request the network resource
 *
 * @subsection nanohttp_client_get_sec HTTP GET method
 *
 * @code
 *   if ((status = httpc_get(conn, &result, argv[1])) != H_OK)
 *   {
 *     fprintf(stderr, "nanoHTTP client connection failed (%s)\n", herror_message(status));
 *     herror_release(status);
 *     httpc_destroy();
 *     exit(1);
 *   }
 * @endcode
 *
 * @subsection nanohttp_client_post_sec HTTP POST method
 *
 * @code
 *   if ((status = httpc_post_begin(conn, argv[1])) != H_OK)
 *   {
 *     fprintf(stderr, "nanoHTTP client connection failed (%s)\n", herror_message(status));
 *     herror_release(status);
 *     httpc_destroy();
 *     exit(1);
 *   }
 *
 *   if ((status = http_output_stream_write(conn->out, buffer, len)) != H_OK)
 *   {
 *     fprintf(stderr, "nanoHTTP client sending POST data failed (%s)\n", herror_message(status));
 *     herror_release(status);
 *     httpc_destroy();
 *     exit(1);
 *   }
 *
 *   if ((status = httpc_post_end(conn, &result)) != H_OK)
 *   {
 *     fprintf(stderr, "nanoHTTP client POST failed (%s)\n", herror_message(status));
 *     herror_release(status);
 *     httpc_destroy();
 *     exit(1);
 *   }
 * @endcode
 *
 * @section nanohttp_client_mime_sec MIME attachments
 *
 * T.B.D.
 *
 * @ref nanohttp_mime_page
 *
 * @section nanohttp_client_result_sec Fetch and print out the result
 *
 * @code
 *   while (http_input_stream_is_ready(res->in))
 *   {
 *     len = http_input_stream_read(res->in, buffer, MAX_BUFFER_SIZE);
 *     fwrite(buffer, len, 1, stdout);
 *   }
 * @endcode
 *
 * @section nanohttp_client_conn_cleanup_sec Connection cleanup
 *
 * @code
 *   hresponse_free(res);
 * @endcode
 *
 * @section nanohttp_client_cleanup_sec Client cleanup
 *
 * @code
 *   httpc_free(conn);
 *
 *   exit(0);
 * }
 * @endcode
 *
 */

/** @file nanohttp-client.h nanoHTTP client interface
 *
 * @defgroup NANOHTTP_CLIENT Client
 * @ingroup NANOHTTP
 *
 */
/**@{*/

typedef struct httpc_conn
{
  struct hsocket_t *sock;
  hpair_t *header;
  struct hurl_t *url;
  http_version_t version;

  int errcode;
  char errmsg[150];
  struct http_output_stream_t *out;
  int id;                       /* uniq id */
} httpc_conn_t;

#ifdef __cplusplus
extern "C" {
#endif

/**
 *
 * Initializes the nanoHTTP client module.
 *
 * @param argc		Argument count.
 * @param argv		Argument vector.
 *
 * @return H_OK on succes or a herror_t struct on failure.
 *
 * @see httpc_destroy
 * @see herror_t
 *
 */
extern herror_t httpc_init(int argc, char **argv);

/**
 *
 * Destroys the nanoHTTP client module.
 *
 * @see httpc_init
 *
 */
extern void httpc_destroy(void);

/**
 *
 * Creates a new HTTP client connection object. You need to create at least one
 * HTTP client connection to communicate via HTTP.
 *
 * @return A pointer to a httpc_conn_t structure on success, NULL on error.
 *
 * @see httpc_conn_t
 *
 */
extern httpc_conn_t *httpc_new(void);

/**
 *
 * Release a connection
 * (use httpc_close_free() instead)
 *
 * @see httpc_close_free
 *
 */
extern void httpc_free(httpc_conn_t * conn);

/**
 *
 * Close and release a connection
 *
 * @see httpc_close
 * @see httpc_free
 *
 */
extern void httpc_close_free(httpc_conn_t * conn);

/**
 *
 * Sets header element (key,value) pair.
 *
 * @return 0 on success or failure (yeah!), 1 if a (key,value) pair was replaced.
 *
 * @see httpc_add_header
 * @see httpc_add_headers
 * @see http_general_header_fields
 * @see http_request_header_fields
 *
 */
extern int httpc_set_header(httpc_conn_t * conn, const char *key, const char *value);

/**
 *
 * Adds a header element (key, value) pair.
 *
 * @return 0 on success, -1 on failure.
 *
 * @see httpc_set_header
 * @see httpc_add_headers
 * @see http_general_header_fields
 * @see http_request_header_fields
 *
 */
extern int httpc_add_header(httpc_conn_t *conn, const char *key, const char *value);

/**
 *
 * Adds a list of (key, value) pairs.
 *
 * @see httpc_set_header
 * @see httpc_add_header
 * @see http_general_header_fields
 * @see http_request_header_fields
 *
 */
extern void httpc_add_headers(httpc_conn_t *conn, const hpair_t *values);

/**
 *
 * Sets a HEADER_AUTHORIZATION header.
 *
 * @param conn		The HTTP connection.
 * @param user		The username.
 * @param password	The password.
 *
 * @see httpc_set_header
 * @see HEADER_AUTHORIZATION
 *
 */
extern int httpc_set_basic_authorization(httpc_conn_t *conn, const char *user, const char *password);

/**
 *
 * Sets a HEADER_PROXY_AUTHORIZATION header.
 *
 * @param conn		The HTTP connection.
 * @param user		The username.
 * @param password	The password.
 *
 * @see httpc_set_header
 * @see HEADER_PROXY_AUTHORIZATION
 *
 */
extern int httpc_set_basic_proxy_authorization(httpc_conn_t *conn, const char *user, const char *password);

/**
 *
 * Invoke a "GET" method request and receive the response
 *
 * @return H_OK on success
 *
 * @see HTTP_REQUEST_GET
 *
 */
extern herror_t httpc_get(httpc_conn_t * conn, hresponse_t ** out, const char *urlstr);

/**
 *
 * Start a "POST" method request
 *
 * @return H_OK on success or error flag
 *
 * @see HTTP_REQUEST_POST
 * @see httpc_post_end
 *
 */
extern herror_t httpc_post_begin(httpc_conn_t * conn, const char *url);

/**
 *
 * End a "POST" method and receive the response.
 * You MUST call httpc_post_end() before!
 *
 * @return H_OK on success
 *
 * @see httpc_post_begin
 * @see HTTP_REQUEST_POST
 *
 */
extern herror_t httpc_post_end(httpc_conn_t * conn, hresponse_t ** out);

/**
 *
 * @todo move to nanohttp-mime.c merge with httpc_mime_* functions
 *
 */

/**
 *
 * Begin MIME multipart/related POST request
 *
 * @return H_OK on success or error flag
 *
 * @see nanohttp_mime_page
 *
 */
extern herror_t httpc_mime_begin(httpc_conn_t * conn, const char *url,
                          const char *related_start,
                          const char *related_start_info,
                          const char *related_type);

/**
 *
 * Send boundary and part header and continue with next part
 *
 * @return H_OK on success
 *
 * @see nanohttp_mime_page
 *
 */
extern herror_t httpc_mime_next(httpc_conn_t * conn,
                         const char *content_id,
                         const char *content_type,
                         const char *transfer_encoding);

/**
 *
 * Finish MIME request and get the response
 *
 * @return H_OK on success
 *
 * @see nanohttp_mime_page
 *
 */
extern herror_t httpc_mime_end(httpc_conn_t * conn, hresponse_t ** out);

/**
 *
 * Send boundary and part header and continue with next part
 *
 * @return H_OK on success
 *
 * @see nanohttp_mime_page
 *
 */
extern herror_t httpc_mime_send_file(httpc_conn_t * conn,
                              const char *content_id,
                              const char *content_type,
                              const char *transfer_encoding,
                              const char *filename);

#ifdef __cplusplus
}
#endif

/**@}*/

#endif