* http.h: Pass the http proxy from outside rather than pulling it from the
[gnupg.git] / include / http.h
1 /* http.h  -  HTTP protocol handler
2  * Copyright (C) 1999, 2000, 2001, 2003 Free Software Foundation, Inc.
3  *
4  * This file is part of GnuPG.
5  *
6  * GnuPG is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 2 of the License, or
9  * (at your option) any later version.
10  *
11  * GnuPG is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software
18  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA
19  */
20
21 #ifndef G10_HTTP_H
22 #define G10_HTTP_H 1
23
24 #include "iobuf.h"
25
26 struct uri_tuple {
27     struct uri_tuple *next;
28     const char *name;   /* a pointer into name */
29     char  *value;       /* a pointer to value (a Nul is always appended) */
30     size_t valuelen;    /* and the real length of the value */
31                         /* because the value may contain embedded Nuls */
32 };
33 typedef struct uri_tuple *URI_TUPLE;
34
35 struct parsed_uri {
36     /* all these pointers point into buffer; most stuff is not escaped */
37     char *scheme;       /* pointer to the scheme string (lowercase) */
38     char *host;         /* host (converted to lowercase) */
39     ushort port;        /* port (always set if the host is set) */
40     char *path;         /* the path */
41     URI_TUPLE params;   /* ";xxxxx" */
42     URI_TUPLE query;    /* "?xxx=yyy" */
43     char buffer[1];     /* buffer which holds a (modified) copy of the URI */
44 };
45 typedef struct parsed_uri *PARSED_URI;
46
47 typedef enum {
48     HTTP_REQ_GET  = 1,
49     HTTP_REQ_HEAD = 2,
50     HTTP_REQ_POST = 3
51 } HTTP_REQ_TYPE;
52
53 /* put flag values into an enum, so that gdb can display them */
54 enum
55   { 
56     HTTP_FLAG_NO_SHUTDOWN = 1,
57     HTTP_FLAG_TRY_SRV = 2
58   };
59
60 struct http_context {
61     int initialized;
62     unsigned int status_code;
63     int sock;
64     int in_data;
65     IOBUF fp_read;
66     IOBUF fp_write;
67     int is_http_0_9;
68     PARSED_URI uri;
69     HTTP_REQ_TYPE req_type;
70     byte *buffer;          /* line buffer */
71     unsigned buffer_size;
72     unsigned int flags;
73 };
74 typedef struct http_context *HTTP_HD;
75
76 int http_open( HTTP_HD hd, HTTP_REQ_TYPE reqtype, const char *url,
77                unsigned int flags, const char *proxy );
78 void http_start_data( HTTP_HD hd );
79 int  http_wait_response( HTTP_HD hd, unsigned int *ret_status );
80 void http_close( HTTP_HD hd );
81 int http_open_document( HTTP_HD hd, const char *document,
82                         unsigned int flags, const char *proxy );
83
84 #endif /*G10_HTTP_H*/