release 2.4.0
[m6w6/ext-http] / php_http_env.h
index e78f7e3a80c5893e5548449703ce045e275d743e..3fc80aba1e489bbb821a33b9e331eeea96ba2a20 100644 (file)
@@ -6,17 +6,14 @@
     | modification, are permitted provided that the conditions mentioned |
     | in the accompanying LICENSE file are met.                          |
     +--------------------------------------------------------------------+
-    | Copyright (c) 2004-2010, Michael Wallner <mike@php.net>            |
+    | Copyright (c) 2004-2014, Michael Wallner <mike@php.net>            |
     +--------------------------------------------------------------------+
 */
 
-/* $Id$ */
-
 #ifndef PHP_HTTP_ENV_H
 #define PHP_HTTP_ENV_H
 
 #include "php_http_message_body.h"
-#include "php_http_encoding.h"
 #include "php_http_version.h"
 
 struct php_http_env_globals {
@@ -24,33 +21,28 @@ struct php_http_env_globals {
        char *etag_mode;
 
        struct {
-               char *content_type;
-               php_http_message_body_t *body;
-               char *etag;
-               time_t last_modified;
-               double throttle_delay;
-               size_t throttle_chunk;
-               php_http_encoding_stream_t *deflate;
-       } response;
-
-       struct {
-               time_t time;
                HashTable *headers;
                php_http_message_body_t *body;
        } request;
 };
 
+typedef enum php_http_content_encoding {
+       PHP_HTTP_CONTENT_ENCODING_NONE,
+       PHP_HTTP_CONTENT_ENCODING_GZIP
+} php_http_content_encoding_t;
+
 typedef enum php_http_range_status {
        PHP_HTTP_RANGE_NO,
        PHP_HTTP_RANGE_OK,
        PHP_HTTP_RANGE_ERR
 } php_http_range_status_t;
 
-PHP_HTTP_API php_http_range_status_t php_http_env_get_request_ranges(HashTable *ranges, size_t entity_length TSRMLS_DC);
+PHP_HTTP_API php_http_range_status_t php_http_env_get_request_ranges(HashTable *ranges, size_t entity_length, php_http_message_t *request TSRMLS_DC);
 PHP_HTTP_API void php_http_env_get_request_headers(HashTable *headers TSRMLS_DC);
-PHP_HTTP_API char *php_http_env_get_request_header(const char *name_str, size_t name_len TSRMLS_DC);
-PHP_HTTP_API int php_http_env_got_request_header(const char *name_str, size_t name_len TSRMLS_DC);
+PHP_HTTP_API char *php_http_env_get_request_header(const char *name_str, size_t name_len, size_t *len, php_http_message_t *request TSRMLS_DC);
+PHP_HTTP_API int php_http_env_got_request_header(const char *name_str, size_t name_len, php_http_message_t *request TSRMLS_DC);
 PHP_HTTP_API php_http_message_body_t *php_http_env_get_request_body(TSRMLS_D);
+PHP_HTTP_API const char *php_http_env_get_request_method(php_http_message_t *request TSRMLS_DC);
 
 typedef enum php_http_content_disposition {
        PHP_HTTP_CONTENT_DISPOSITION_NONE,
@@ -66,67 +58,21 @@ typedef enum php_http_cache_status {
 
 PHP_HTTP_API long php_http_env_get_response_code(TSRMLS_D);
 PHP_HTTP_API const char *php_http_env_get_response_status_for_code(unsigned code);
-PHP_HTTP_API STATUS php_http_env_get_response_headers(HashTable *headers_ht TSRMLS_DC);
+PHP_HTTP_API ZEND_RESULT_CODE php_http_env_get_response_headers(HashTable *headers_ht TSRMLS_DC);
 PHP_HTTP_API char *php_http_env_get_response_header(const char *name_str, size_t name_len TSRMLS_DC);
-PHP_HTTP_API STATUS php_http_env_set_response_code(long http_code TSRMLS_DC);
-PHP_HTTP_API STATUS php_http_env_set_response_protocol_version(php_http_version_t *v TSRMLS_DC);
-PHP_HTTP_API STATUS php_http_env_set_response_header(long http_code, const char *header_str, size_t header_len, zend_bool replace TSRMLS_DC);
-PHP_HTTP_API STATUS php_http_env_set_response_header_value(long http_code, const char *name_str, size_t name_len, zval *value, zend_bool replace TSRMLS_DC);
-PHP_HTTP_API STATUS php_http_env_set_response_header_format(long http_code, zend_bool replace TSRMLS_DC, const char *fmt, ...);
+PHP_HTTP_API ZEND_RESULT_CODE php_http_env_set_response_code(long http_code TSRMLS_DC);
+PHP_HTTP_API ZEND_RESULT_CODE php_http_env_set_response_protocol_version(php_http_version_t *v TSRMLS_DC);
+PHP_HTTP_API ZEND_RESULT_CODE php_http_env_set_response_header(long http_code, const char *header_str, size_t header_len, zend_bool replace TSRMLS_DC);
+PHP_HTTP_API ZEND_RESULT_CODE php_http_env_set_response_header_value(long http_code, const char *name_str, size_t name_len, zval *value, zend_bool replace TSRMLS_DC);
+PHP_HTTP_API ZEND_RESULT_CODE php_http_env_set_response_header_format(long http_code, zend_bool replace TSRMLS_DC, const char *fmt, ...);
+PHP_HTTP_API ZEND_RESULT_CODE php_http_env_set_response_header_va(long http_code, zend_bool replace, const char *fmt, va_list argv TSRMLS_DC);
 
 PHP_HTTP_API zval *php_http_env_get_server_var(const char *key_str, size_t key_len, zend_bool check TSRMLS_DC);
 #define php_http_env_got_server_var(v) (NULL != php_http_env_get_server_var((v), strlen(v), 1 TSRMLS_CC))
+PHP_HTTP_API zval *php_http_env_get_superglobal(const char *key, size_t key_len TSRMLS_DC);
 
-PHP_HTTP_API STATUS php_http_env_set_response_last_modified(zval *container, time_t lm, char **sent_header TSRMLS_DC);
-PHP_HTTP_API STATUS php_http_env_set_response_etag(zval *container, const char *etag_str, size_t etag_len, char **sent_header TSRMLS_DC);
-PHP_HTTP_API STATUS php_http_env_set_response_content_type(zval *container, const char *ct_str, size_t ct_len, char **sent_header TSRMLS_DC);
-PHP_HTTP_API STATUS php_http_env_set_response_content_disposition(zval *container, php_http_content_disposition_t d, const char *f_str, size_t f_len, char **sent_header TSRMLS_DC);
-PHP_HTTP_API STATUS php_http_env_set_response_cache_control(zval *container, const char *cc_str, size_t cc_len, char **sent_header TSRMLS_DC);
-PHP_HTTP_API void php_http_env_set_response_throttle_rate(zval *container, size_t chunk_size, double delay TSRMLS_DC);
-PHP_HTTP_API void php_http_env_set_response_body(zval *container, php_http_message_body_t *body);
-PHP_HTTP_API STATUS php_http_env_send_response(zval *container TSRMLS_DC);
-PHP_HTTP_API php_http_cache_status_t php_http_env_is_response_cached_by_etag(zval *container, const char *header_str, size_t header_len TSRMLS_DC);
-PHP_HTTP_API php_http_cache_status_t php_http_env_is_response_cached_by_last_modified(zval *container, const char *header_str, size_t header_len TSRMLS_DC);
-
-extern zend_class_entry *php_http_env_class_entry;
-extern zend_function_entry php_http_env_method_entry[];
-
-PHP_METHOD(HttpEnv, getRequestHeader);
-PHP_METHOD(HttpEnv, getRequestBody);
-PHP_METHOD(HttpEnv, getResponseStatusForCode);
-PHP_METHOD(HttpEnv, getResponseHeader);
-PHP_METHOD(HttpEnv, getResponseCode);
-PHP_METHOD(HttpEnv, setResponseHeader);
-PHP_METHOD(HttpEnv, setResponseCode);
-PHP_METHOD(HttpEnv, negotiateLanguage);
-PHP_METHOD(HttpEnv, negotiateCharset);
-PHP_METHOD(HttpEnv, negotiateContentType);
-PHP_METHOD(HttpEnv, negotiate);
-PHP_METHOD(HttpEnv, persistentHandlesStat);
-PHP_METHOD(HttpEnv, persistentHandlesClean);
-PHP_METHOD(HttpEnv, persistentHandlesIdent);
-
-extern zend_class_entry *php_http_env_request_class_entry;
-extern zend_function_entry php_http_env_request_method_entry[];
-
-PHP_METHOD(HttpEnvRequest, __construct);
-
-extern zend_class_entry *php_http_env_response_class_entry;
-extern zend_function_entry php_http_env_response_method_entry[];
-
-PHP_METHOD(HttpEnvResponse, __construct);
-PHP_METHOD(HttpEnvResponse, setContentType);
-PHP_METHOD(HttpEnvResponse, setContentDisposition);
-PHP_METHOD(HttpEnvResponse, setCacheControl);
-PHP_METHOD(HttpEnvResponse, setLastModified);
-PHP_METHOD(HttpEnvResponse, isCachedByLastModified);
-PHP_METHOD(HttpEnvResponse, setEtag);
-PHP_METHOD(HttpEnvResponse, isCachedByEtag);
-PHP_METHOD(HttpEnvResponse, setThrottleRate);
-PHP_METHOD(HttpEnvResponse, send);
-
+PHP_HTTP_API zend_class_entry *php_http_env_class_entry;
 PHP_MINIT_FUNCTION(http_env);
-PHP_RINIT_FUNCTION(http_env);
 PHP_RSHUTDOWN_FUNCTION(http_env);
 
 #endif