Make log_clock easier to read.
[gnupg.git] / common / http.h
index 4e70f42..75d64d1 100644 (file)
@@ -1,33 +1,40 @@
 /* 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
- * 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.
+ * This file is free software; you can redistribute it and/or modify
+ * it under the terms of either
+ *
+ *   - the GNU Lesser General Public License as published by the Free
+ *     Software Foundation; either version 3 of the License, or (at
+ *     your option) any later version.
+ *
+ * or
+ *
+ *   - 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.
  *
- * GnuPG is distributed in the hope that it will be useful,
+ * or both in parallel, as here.
+ *
+ * This file 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.
  *
  * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
- * USA.
+ * 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). */
@@ -37,12 +44,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. */
@@ -52,70 +61,69 @@ 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_IGNORE_CL = 32
   };
 
-struct http_context_s 
-{
-  int initialized;
-  unsigned int status_code;
-  int sock;
-  int in_data;
-#ifdef HTTP_USE_ESTREAM
-  estream_t fp_read;
-  estream_t fp_write;
-  void *write_cookie;
-#else /*!HTTP_USE_ESTREAM*/
-  FILE *fp_read;
-  FILE *fp_write;
-#endif /*!HTTP_USE_ESTREAM*/
-  void *tls_context;
-  int is_http_0_9;
-  parsed_uri_t uri;
-  http_req_t req_type;
-  char *buffer;          /* Line buffer. */
-  size_t buffer_size;
-  unsigned int flags;
-};
+struct http_context_s;
 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);
 
 void http_release_parsed_uri (parsed_uri_t uri);
 
-gpg_error_t http_open (http_t hd, http_req_t reqtype,
+gpg_error_t http_raw_connect (http_t *r_hd,
+                              const char *server, unsigned short port,
+                              unsigned int flags, const char *srvtag);
+
+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);
+                       void *tls_context,
+                       const char *srvtag,
+                       strlist_t headers);
 
 void http_start_data (http_t hd);
 
-gpg_error_t http_wait_response (http_t hd, unsigned int *ret_status);
+gpg_error_t http_wait_response (http_t hd);
 
 void http_close (http_t hd, int keep_read_stream);
 
-gpg_error_t http_open_document (http_t hd,
+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);
+                                void *tls_context,
+                                const char *srvtag,
+                                strlist_t headers);
+
+estream_t http_get_read_ptr (http_t hd);
+estream_t http_get_write_ptr (http_t hd);
+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*/