Mark component descriptions for translation.
[gnupg.git] / common / http.h
index c92bbf1..7a11b84 100644 (file)
@@ -1,7 +1,7 @@
 /* http.h  -  HTTP protocol handler
- * Copyright (C) 1999, 2000, 2001, 2003,
- *               2006 Free Software Foundation, Inc.
- *     
+ * Copyright (C) 1999, 2000, 2001, 2003, 2006,
+ *               2010 Free Software Foundation, Inc.
+ *
  * This file is part of GnuPG.
  *
  * GnuPG is free software; you can redistribute it and/or modify
  * along with this program; if not, see <http://www.gnu.org/licenses/>.
  */
 #ifndef GNUPG_COMMON_HTTP_H
-#define GNUPG_COMMON_HTTP_H 
+#define GNUPG_COMMON_HTTP_H
 
 #include <gpg-error.h>
-#ifdef HTTP_USE_ESTREAM
-#include "estream.h"
-#endif
+#include "../common/estream.h"
 
-struct uri_tuple_s {
+struct uri_tuple_s
+{
   struct uri_tuple_s *next;
   const char *name;    /* A pointer into name. */
   char  *value;         /* A pointer to value (a Nul is always appended). */
@@ -35,12 +34,14 @@ struct uri_tuple_s {
 };
 typedef struct uri_tuple_s *uri_tuple_t;
 
-struct parsed_uri_s 
+struct parsed_uri_s
 {
   /* All these pointers point into BUFFER; most stuff is not escaped. */
-  char *scheme;                /* Pointer to the scheme string (lowercase). */
-  int use_tls;          /* Whether TLS should be used. */
-  char *auth;           /* username/password for basic auth */
+  char *scheme;                /* Pointer to the scheme string (always lowercase). */
+  unsigned int is_http:1; /* This is a HTTP style URI.   */
+  unsigned int use_tls:1; /* Whether TLS should be used. */
+  unsigned int opaque:1;/* Unknown scheme; PATH has the rest.  */
+  char *auth;           /* username/password for basic auth.  */
   char *host;          /* Host (converted to lowercase). */
   unsigned short port;  /* Port (always set if the host is set). */
   char *path;          /* Path. */
@@ -50,22 +51,22 @@ struct parsed_uri_s
 };
 typedef struct parsed_uri_s *parsed_uri_t;
 
-typedef enum 
+typedef enum
   {
     HTTP_REQ_GET  = 1,
     HTTP_REQ_HEAD = 2,
-    HTTP_REQ_POST = 3
-  } 
+    HTTP_REQ_POST = 3,
+    HTTP_REQ_OPAQUE = 4  /* Internal use.  */
+  }
 http_req_t;
 
 /* We put the flag values into an enum, so that gdb can display them. */
 enum
-  { 
+  {
     HTTP_FLAG_TRY_PROXY = 1,
-    HTTP_FLAG_NO_SHUTDOWN = 2,
-    HTTP_FLAG_TRY_SRV = 4,
+    HTTP_FLAG_SHUTDOWN = 2,
     HTTP_FLAG_LOG_RESP = 8,
-    HTTP_FLAG_NEED_HEADER = 16
+    HTTP_FLAG_IGNORE_CL = 32
   };
 
 struct http_context_s;
@@ -73,41 +74,59 @@ typedef struct http_context_s *http_t;
 
 void http_register_tls_callback (gpg_error_t (*cb) (http_t, void *, int));
 
-gpg_error_t http_parse_uri (parsed_uri_t *ret_uri, const char *uri);
+gpg_error_t _http_parse_uri (parsed_uri_t *ret_uri, const char *uri,
+                             int no_scheme_check, gpg_err_source_t errsource);
+#define http_parse_uri(a,b,c)                                    \
+  _http_parse_uri ((a), (b), (c), GPG_ERR_SOURCE_DEFAULT)
 
 void http_release_parsed_uri (parsed_uri_t uri);
 
-gpg_error_t http_open (http_t *r_hd, http_req_t reqtype,
-                       const char *url,
-                       const char *auth,
-                       unsigned int flags,
-                       const char *proxy,
-                       void *tls_context);
+gpg_error_t _http_raw_connect (http_t *r_hd,
+                               const char *server, unsigned short port,
+                               unsigned int flags, const char *srvtag,
+                               gpg_err_source_t errsource);
+#define http_raw_connect(a,b,c,d,e) \
+  _http_raw_connect ((a),(b),(c),(d),(e), GPG_ERR_SOURCE_DEFAULT)
+
+gpg_error_t _http_open (http_t *r_hd, http_req_t reqtype,
+                        const char *url,
+                        const char *auth,
+                        unsigned int flags,
+                        const char *proxy,
+                        void *tls_context,
+                        const char *srvtag,
+                        strlist_t headers,
+                        gpg_err_source_t errsource);
+#define http_open(a,b,c,d,e,f,g,h,i) \
+  _http_open ((a),(b),(c),(d),(e),(f),(g),(h),(i), GPG_ERR_SOURCE_DEFAULT)
 
 void http_start_data (http_t hd);
 
-gpg_error_t http_wait_response (http_t hd);
+gpg_error_t _http_wait_response (http_t hd, gpg_err_source_t errsource);
+#define http_wait_response(a) \
+  _http_wait_response ((a), GPG_ERR_SOURCE_DEFAULT)
 
 void http_close (http_t hd, int keep_read_stream);
 
-gpg_error_t http_open_document (http_t *r_hd,
-                                const char *document,
-                                const char *auth,
-                                unsigned int flags,
-                                const char *proxy,
-                                void *tls_context);
+gpg_error_t _http_open_document (http_t *r_hd,
+                                 const char *document,
+                                 const char *auth,
+                                 unsigned int flags,
+                                 const char *proxy,
+                                 void *tls_context,
+                                 const char *srvtag,
+                                 strlist_t headers,
+                                 gpg_err_source_t errsource);
+#define http_open_document(a,b,c,d,e,f,g,h) \
+  _http_open_document ((a),(b),(c),(d),(e),(f),(g),(h), GPG_ERR_SOURCE_DEFAULT)
 
-#ifdef HTTP_USE_ESTREAM
 estream_t http_get_read_ptr (http_t hd);
 estream_t http_get_write_ptr (http_t hd);
-#else /*!HTTP_USE_ESTREAM*/
-FILE *http_get_read_ptr (http_t hd);
-FILE *http_get_write_ptr (http_t hd);
-#endif /*!HTTP_USE_ESTREAM*/
 unsigned int http_get_status_code (http_t hd);
 const char *http_get_header (http_t hd, const char *name);
 
 char *http_escape_string (const char *string, const char *specials);
+char *http_escape_data (const void *data, size_t datalen, const char *specials);
 
 
 #endif /*GNUPG_COMMON_HTTP_H*/