Take advantage of newer gpg-error features.
[gnupg.git] / common / http.h
1 /* http.h  -  HTTP protocol handler
2  * Copyright (C) 1999, 2000, 2001, 2003,
3  *               2006 Free Software Foundation, Inc.
4  *     
5  * This file is part of GnuPG.
6  *
7  * GnuPG is free software; you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation; either version 2 of the License, or
10  * (at your option) any later version.
11  *
12  * GnuPG is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program; if not, write to the Free Software
19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
20  * USA.
21  */
22 #ifndef GNUPG_COMMON_HTTP_H
23 #define GNUPG_COMMON_HTTP_H 
24
25 #include <gpg-error.h>
26 #ifdef HTTP_USE_ESTREAM
27 #include "estream.h"
28 #endif
29
30 struct uri_tuple_s {
31   struct uri_tuple_s *next;
32   const char *name;     /* A pointer into name. */
33   char  *value;         /* A pointer to value (a Nul is always appended). */
34   size_t valuelen;      /* The real length of the value; we need it
35                            because the value may contain embedded Nuls. */
36   int no_value;         /* True if no value has been given in the URL. */
37 };
38 typedef struct uri_tuple_s *uri_tuple_t;
39
40 struct parsed_uri_s 
41 {
42   /* All these pointers point into BUFFER; most stuff is not escaped. */
43   char *scheme;         /* Pointer to the scheme string (lowercase). */
44   int use_tls;          /* Whether TLS should be used. */
45   char *auth;           /* username/password for basic auth */
46   char *host;           /* Host (converted to lowercase). */
47   unsigned short port;  /* Port (always set if the host is set). */
48   char *path;           /* Path. */
49   uri_tuple_t params;   /* ";xxxxx" */
50   uri_tuple_t query;    /* "?xxx=yyy" */
51   char buffer[1];       /* Buffer which holds a (modified) copy of the URI. */
52 };
53 typedef struct parsed_uri_s *parsed_uri_t;
54
55 typedef enum 
56   {
57     HTTP_REQ_GET  = 1,
58     HTTP_REQ_HEAD = 2,
59     HTTP_REQ_POST = 3
60   } 
61 http_req_t;
62
63 /* We put the flag values into an enum, so that gdb can display them. */
64 enum
65   { 
66     HTTP_FLAG_TRY_PROXY = 1,
67     HTTP_FLAG_NO_SHUTDOWN = 2,
68     HTTP_FLAG_TRY_SRV = 4,
69     HTTP_FLAG_LOG_RESP = 8,
70     HTTP_FLAG_NEED_HEADER = 16
71   };
72
73 struct http_context_s;
74 typedef struct http_context_s *http_t;
75
76 void http_register_tls_callback (gpg_error_t (*cb) (http_t, void *, int));
77
78 gpg_error_t http_parse_uri (parsed_uri_t *ret_uri, const char *uri);
79
80 void http_release_parsed_uri (parsed_uri_t uri);
81
82 gpg_error_t http_open (http_t *r_hd, http_req_t reqtype,
83                        const char *url,
84                        const char *auth,
85                        unsigned int flags,
86                        const char *proxy,
87                        void *tls_context);
88
89 void http_start_data (http_t hd);
90
91 gpg_error_t http_wait_response (http_t hd);
92
93 void http_close (http_t hd, int keep_read_stream);
94
95 gpg_error_t http_open_document (http_t *r_hd,
96                                 const char *document,
97                                 const char *auth,
98                                 unsigned int flags,
99                                 const char *proxy,
100                                 void *tls_context);
101
102 #ifdef HTTP_USE_ESTREAM
103 estream_t http_get_read_ptr (http_t hd);
104 estream_t http_get_write_ptr (http_t hd);
105 #else /*!HTTP_USE_ESTREAM*/
106 FILE *http_get_read_ptr (http_t hd);
107 FILE *http_get_write_ptr (http_t hd);
108 #endif /*!HTTP_USE_ESTREAM*/
109 unsigned int http_get_status_code (http_t hd);
110 const char *http_get_header (http_t hd, const char *name);
111
112 char *http_escape_string (const char *string, const char *specials);
113
114
115 #endif /*GNUPG_COMMON_HTTP_H*/