]> git.ipfire.org Git - thirdparty/cups.git/blobdiff - cups/http-private.h
<rdar://problem/13655599> Seed: Print queue JOBS disappear after computer Wakes up...
[thirdparty/cups.git] / cups / http-private.h
index 3cfeff7f6371173a0c55cccecdfddf018baf39ba..016dfe2ba756de6b74895eb8716aca2053e78bb4 100644 (file)
@@ -1,9 +1,9 @@
 /*
- * "$Id: http-private.h 7850 2008-08-20 00:07:25Z mike $"
+ * "$Id$"
  *
  *   Private HTTP definitions for CUPS.
  *
- *   Copyright 2007-2012 by Apple Inc.
+ *   Copyright 2007-2013 by Apple Inc.
  *   Copyright 1997-2007 by Easy Software Products, all rights reserved.
  *
  *   These coded instructions, statements, and computer programs are the
@@ -23,6 +23,7 @@
  */
 
 #  include "config.h"
+#  include <cups/language.h>
 #  include <stddef.h>
 #  include <stdlib.h>
 
 #  ifdef WIN32
 #    include <io.h>
 #    include <winsock2.h>
+#    define CUPS_SOCAST (const char *)
 #  else
 #    include <unistd.h>
 #    include <fcntl.h>
 #    include <sys/socket.h>
 #    define closesocket(f) close(f)
+#    define CUPS_SOCAST
 #  endif /* WIN32 */
 
 #  ifdef HAVE_GSSAPI
 #    ifdef HAVE_GSS_GSSAPI_H
 #      include <GSS/gssapi.h>
-#      ifdef HAVE_GSSAPI_GENERIC_H
-#        include <GSS/gssapi_generic.h>
-#      endif /* HAVE_GSSAPI_GENERIC_H */
-#      ifdef HAVE_GSSAPI_KRB5_H
-#        include <GSS/gssapi_krb5.h>
-#      endif /* HAVE_GSSAPI_KRB5_H */
 #    elif defined(HAVE_GSSAPI_GSSAPI_H)
 #      include <gssapi/gssapi.h>
-#      ifdef HAVE_GSSAPI_GENERIC_H
-#        include <gssapi/gssapi_generic.h>
-#      endif /* HAVE_GSSAPI_GENERIC_H */
-#      ifdef HAVE_GSSAPI_KRB5_H
-#        include <gssapi/gssapi_krb5.h>
-#      endif /* HAVE_GSSAPI_KRB5_H */
 #    elif defined(HAVE_GSSAPI_H)
 #      include <gssapi.h>
 #    endif /* HAVE_GSS_GSSAPI_H */
 #    ifndef HAVE_GSS_C_NT_HOSTBASED_SERVICE
 #      define GSS_C_NT_HOSTBASED_SERVICE gss_nt_service_name
 #    endif /* !HAVE_GSS_C_NT_HOSTBASED_SERVICE */
-#    ifdef HAVE_KRB5_H
-#      include <krb5.h>
-#    endif /* HAVE_KRB5_H */
 #  endif /* HAVE_GSSAPI */
 
 #  ifdef HAVE_AUTHORIZATION_H
 #    include <Security/Authorization.h>
 #  endif /* HAVE_AUTHORIZATION_H */
 
-#  if defined(__sgi) || (defined(__APPLE__) && !defined(_SOCKLEN_T))
+#  if defined(__APPLE__) && !defined(_SOCKLEN_T)
 /*
- * IRIX and MacOS X 10.2.x do not define socklen_t, and in fact use an int instead of
+ * MacOS X 10.2.x does not define socklen_t, and in fact uses an int instead of
  * unsigned type for length values...
  */
 
 typedef int socklen_t;
-#  endif /* __sgi || (__APPLE__ && !_SOCKLEN_T) */
+#  endif /* __APPLE__ && !_SOCKLEN_T */
 
 #  include <cups/http.h>
 #  include "md5-private.h"
@@ -136,6 +124,10 @@ typedef int socklen_t;
 #    endif /* HAVE_GETIFADDRS */
 #  endif /* !WIN32 */
 
+#  ifdef HAVE_LIBZ
+#    include <zlib.h>
+#  endif /* HAVE_LIBZ */
+
 
 /*
  * C++ magic...
@@ -236,7 +228,22 @@ typedef void *http_tls_t;
 typedef void *http_tls_credentials_t;
 #  endif /* HAVE_LIBSSL */
 
-struct _http_s                         /**** HTTP connection structure. ****/
+typedef enum _http_coding_e            /**** HTTP content coding enumeration ****/
+{
+  _HTTP_CODING_IDENTITY,               /* No content coding */
+  _HTTP_CODING_GZIP,                   /* LZ77+gzip decompression */
+  _HTTP_CODING_DEFLATE,                        /* LZ77+zlib compression */
+  _HTTP_CODING_GUNZIP,                 /* LZ77+gzip decompression */
+  _HTTP_CODING_INFLATE                 /* LZ77+zlib decompression */
+} _http_coding_t;
+
+typedef enum _http_mode_e              /**** HTTP mode enumeration ****/
+{
+  _HTTP_MODE_CLIENT,                   /* Client connected to server */
+  _HTTP_MODE_SERVER                    /* Server connected (accepted) from client */
+} _http_mode_t;
+
+struct _http_s                         /**** HTTP connection structure ****/
 {
   int                  fd;             /* File descriptor for this socket */
   int                  blocking;       /* To block or not to block */
@@ -249,8 +256,8 @@ struct _http_s                              /**** HTTP connection structure. ****/
   struct sockaddr_in   _hostaddr;      /* Address of connected host (deprecated) */
   char                 hostname[HTTP_MAX_HOST],
                                        /* Name of connected host */
-                       fields[HTTP_FIELD_MAX][HTTP_MAX_VALUE];
-                                       /* Field values */
+                       fields[HTTP_FIELD_ACCEPT_ENCODING][HTTP_MAX_VALUE];
+                                       /* Field values up to Accept-Encoding */
   char                 *data;          /* Pointer to data buffer */
   http_encoding_t      data_encoding;  /* Chunked or not */
   int                  _data_remaining;/* Number of bytes left (deprecated) */
@@ -264,16 +271,19 @@ struct _http_s                            /**** HTTP connection structure. ****/
   int                  nonce_count;    /* Nonce count */
   http_tls_t           tls;            /* TLS state information */
   http_encryption_t    encryption;     /* Encryption requirements */
+
   /**** New in CUPS 1.1.19 ****/
   fd_set               *input_set;     /* select() set for httpWait() (deprecated) */
   http_status_t                expect;         /* Expect: header */
   char                 *cookie;        /* Cookie value(s) */
+
   /**** New in CUPS 1.1.20 ****/
   char                 _authstring[HTTP_MAX_VALUE],
-                                       /* Current Authentication value (deprecated) */
+                                       /* Current Authorization value (deprecated) */
                        userpass[HTTP_MAX_VALUE];
                                        /* Username:password string */
   int                  digest_tries;   /* Number of tries for digest auth */
+
   /**** New in CUPS 1.2 ****/
   off_t                        data_remaining; /* Number of bytes left */
   http_addr_t          *hostaddr;      /* Current host address and port */
@@ -281,10 +291,11 @@ struct _http_s                            /**** HTTP connection structure. ****/
   char                 wbuffer[HTTP_MAX_BUFFER];
                                        /* Buffer for outgoing data */
   int                  wused;          /* Write buffer bytes used */
+
   /**** New in CUPS 1.3 ****/
   char                 *field_authorization;
                                        /* Authorization field */
-  char                 *authstring;    /* Current authorization field */
+  char                 *authstring;    /* Current Authorization field */
 #  ifdef HAVE_GSSAPI
   gss_OID              gssmech;        /* Authentication mechanism */
   gss_ctx_id_t         gssctx;         /* Authentication context */
@@ -293,6 +304,7 @@ struct _http_s                              /**** HTTP connection structure. ****/
 #  ifdef HAVE_AUTHORIZATION_H
   AuthorizationRef     auth_ref;       /* Authorization ref */
 #  endif /* HAVE_AUTHORIZATION_H */
+
   /**** New in CUPS 1.5 ****/
   http_tls_credentials_t tls_credentials;
                                        /* TLS credentials */
@@ -303,6 +315,23 @@ struct _http_s                             /**** HTTP connection structure. ****/
 #  ifdef HAVE_GSSAPI
   char                 gsshost[256];   /* Hostname for Kerberos */
 #  endif /* HAVE_GSSAPI */
+
+  /**** New in CUPS 1.7 ****/
+  int                  tls_upgrade;    /* Non-zero if we are doing an upgrade */
+  _http_mode_t         mode;           /* _HTTP_MODE_CLIENT or _HTTP_MODE_SERVER */
+  char                 *accept_encoding,
+                                       /* Accept-Encoding field */
+                       *allow,         /* Allow field */
+                       *server,        /* Server field */
+                       *default_accept_encoding,
+                       *default_server,
+                       *default_user_agent;
+                                       /* Default field values */
+#  ifdef HAVE_LIBZ
+  _http_coding_t       coding;         /* _HTTP_CODING_xxx */
+  z_stream             stream;         /* (De)compression stream */
+  Bytef                        *dbuffer;       /* Decompression buffer */
+#  endif /* HAVE_LIBZ */
 };
 
 
@@ -368,15 +397,18 @@ extern void       _cups_freeifaddrs(struct ifaddrs *addrs);
  */
 
 #define                        _httpAddrFamily(addrp) (addrp)->addr.sa_family
-extern int             _httpAddrPort(http_addr_t *addr);
+extern int             _httpAddrPort(http_addr_t *addr)
+                                     _CUPS_INTERNAL_MSG("Use httpAddrPort instead.");
 extern void            _httpAddrSetPort(http_addr_t *addr, int port);
 extern char            *_httpAssembleUUID(const char *server, int port,
                                           const char *name, int number,
-                                          char *buffer, size_t bufsize);
+                                          char *buffer, size_t bufsize)
+                                          _CUPS_INTERNAL_MSG("Use httpAssembleUUID instead.");
 extern http_t          *_httpCreate(const char *host, int port,
                                     http_addrlist_t *addrlist,
                                     http_encryption_t encryption,
-                                    int family);
+                                    int family)
+                                    _CUPS_INTERNAL_MSG("Use httpConnect2 or httpAccept instead.");
 extern http_tls_credentials_t
                        _httpCreateCredentials(cups_array_t *credentials);
 extern char            *_httpDecodeURI(char *dst, const char *src,
@@ -385,11 +417,13 @@ extern void               _httpDisconnect(http_t *http);
 extern char            *_httpEncodeURI(char *dst, const char *src,
                                        size_t dstsize);
 extern void            _httpFreeCredentials(http_tls_credentials_t credentials);
-extern ssize_t         _httpPeek(http_t *http, char *buffer, size_t length);
+extern ssize_t         _httpPeek(http_t *http, char *buffer, size_t length)
+                                 _CUPS_INTERNAL_MSG("Use httpPeek instead.");
 extern const char      *_httpResolveURI(const char *uri, char *resolved_uri,
                                         size_t resolved_size, int options,
                                         int (*cb)(void *context),
                                         void *context);
+extern const char      *_httpStatus(cups_lang_t *lang, http_status_t status);
 extern int             _httpUpdate(http_t *http, http_status_t *status);
 extern int             _httpWait(http_t *http, int msec, int usessl);
 
@@ -405,5 +439,5 @@ extern int          _httpWait(http_t *http, int msec, int usessl);
 #endif /* !_CUPS_HTTP_PRIVATE_H_ */
 
 /*
- * End of "$Id: http-private.h 7850 2008-08-20 00:07:25Z mike $".
+ * End of "$Id$".
  */