ensure options are applied before the headers are set
[m6w6/ext-http] / php_http_env_response.c
index cc9d30c1b6103b16d9055ac0b1c52835b828e5ce..a4431b60af08c9be636272ea6110220aaae6ae78 100644 (file)
@@ -6,7 +6,7 @@
     | modification, are permitted provided that the conditions mentioned |
     | in the accompanying LICENSE file are met.                          |
     +--------------------------------------------------------------------+
-    | Copyright (c) 2004-2013, Michael Wallner <mike@php.net>            |
+    | Copyright (c) 2004-2014, Michael Wallner <mike@php.net>            |
     +--------------------------------------------------------------------+
 */
 
@@ -26,6 +26,7 @@ static void set_option(zval *options, const char *name_str, size_t name_len, int
                                case IS_STRING:
                                        zend_update_property_stringl(Z_OBJCE_P(options), options, name_str, name_len, value_ptr, value_len TSRMLS_CC);
                                        break;
+                               case IS_ARRAY:
                                case IS_OBJECT:
                                        zend_update_property(Z_OBJCE_P(options), options, name_str, name_len, value_ptr TSRMLS_CC);
                                        break;
@@ -47,6 +48,7 @@ static void set_option(zval *options, const char *name_str, size_t name_len, int
                                        char *value = estrndup(value_ptr, value_len);
                                        add_assoc_stringl_ex(options, name_str, name_len + 1, value, value_len, 0);
                                        break;
+                               case IS_ARRAY:
                                case IS_OBJECT:
                                        Z_ADDREF_P(value_ptr);
                                        add_assoc_zval_ex(options, name_str, name_len + 1, value_ptr);
@@ -108,6 +110,36 @@ static php_http_message_t *get_request(zval *options TSRMLS_DC)
 
        return request;
 }
+static void set_cookie(zval *options, zval *zcookie_new TSRMLS_DC)
+{
+       HashPosition pos;
+       zval *zcookies_set;
+       php_http_array_hashkey_t key = php_http_array_hashkey_init(0);
+       php_http_cookie_object_t *obj = zend_object_store_get_object(zcookie_new TSRMLS_CC);
+
+       zcookies_set = get_option(options, ZEND_STRL("cookies") TSRMLS_CC);
+       if (!zcookies_set || Z_TYPE_P(zcookies_set) != IS_ARRAY) {
+               if (zcookies_set) {
+                       zval_ptr_dtor(&zcookies_set);
+               }
+               MAKE_STD_ZVAL(zcookies_set);
+               array_init_size(zcookies_set, zend_hash_num_elements(&obj->list->cookies));
+       } else {
+               SEPARATE_ZVAL(&zcookies_set);
+       }
+
+       FOREACH_HASH_KEY(pos, &obj->list->cookies, key) {
+               Z_ADDREF_P(zcookie_new);
+               if (key.type == HASH_KEY_IS_STRING) {
+                       add_assoc_zval_ex(zcookies_set, key.str, key.len, zcookie_new);
+               } else {
+                       add_index_zval(zcookies_set, key.num, zcookie_new);
+               }
+       }
+
+       set_option(options, ZEND_STRL("cookies"), IS_ARRAY, zcookies_set, 0 TSRMLS_CC);
+       zval_ptr_dtor(&zcookies_set);
+}
 
 php_http_cache_status_t php_http_env_is_response_cached_by_etag(zval *options, const char *header_str, size_t header_len, php_http_message_t *request TSRMLS_DC)
 {
@@ -147,7 +179,7 @@ php_http_cache_status_t php_http_env_is_response_cached_by_etag(zval *options, c
                efree(etag);
        }
 
-       STR_FREE(header);
+       PTR_FREE(header);
        return ret;
 }
 
@@ -190,7 +222,7 @@ php_http_cache_status_t php_http_env_is_response_cached_by_last_modified(zval *o
                }
        }
 
-       STR_FREE(header);
+       PTR_FREE(header);
        return ret;
 }
 
@@ -217,7 +249,9 @@ static size_t output(void *context, char *buf, size_t len TSRMLS_DC)
 {
        php_http_env_response_t *r = context;
 
-       r->ops->write(r, buf, len);
+       if (SUCCESS != r->ops->write(r, buf, len)) {
+               return (size_t) -1;
+       }
 
        /*      we really only need to flush when throttling is enabled,
                because we push the data as fast as possible anyway if not */
@@ -231,7 +265,7 @@ static size_t output(void *context, char *buf, size_t len TSRMLS_DC)
 #define php_http_env_response_send_done(r) php_http_env_response_send_data((r), NULL, 0)
 static STATUS php_http_env_response_send_data(php_http_env_response_t *r, const char *buf, size_t len)
 {
-       size_t chunk = r->throttle.chunk ? r->throttle.chunk : PHP_HTTP_SENDBUF_SIZE;
+       size_t chunks_sent, chunk = r->throttle.chunk ? r->throttle.chunk : PHP_HTTP_SENDBUF_SIZE;
        TSRMLS_FETCH_FROM_CTX(r->ts);
 
        if (r->content.encoder) {
@@ -248,15 +282,16 @@ static STATUS php_http_env_response_send_data(php_http_env_response_t *r, const
                        }
                }
 
-               if (enc_str) {
-                       php_http_buffer_chunked_output(&r->buffer, enc_str, enc_len, buf ? chunk : 0, output, r TSRMLS_CC);
-                       STR_FREE(enc_str);
+               if (!enc_str) {
+                       return SUCCESS;
                }
+               chunks_sent = php_http_buffer_chunked_output(&r->buffer, enc_str, enc_len, buf ? chunk : 0, output, r TSRMLS_CC);
+               PTR_FREE(enc_str);
        } else {
-               php_http_buffer_chunked_output(&r->buffer, buf, len, buf ? chunk : 0, output, r TSRMLS_CC);
+               chunks_sent = php_http_buffer_chunked_output(&r->buffer, buf, len, buf ? chunk : 0, output, r TSRMLS_CC);
        }
 
-       return SUCCESS;
+       return chunks_sent != (size_t) -1 ? SUCCESS : FAILURE;
 }
 
 php_http_env_response_t *php_http_env_response_init(php_http_env_response_t *r, zval *options, php_http_env_response_ops_t *ops, void *init_arg TSRMLS_DC)
@@ -300,8 +335,8 @@ void php_http_env_response_dtor(php_http_env_response_t *r)
        }
        php_http_buffer_free(&r->buffer);
        zval_ptr_dtor(&r->options);
-       STR_FREE(r->content.type);
-       STR_FREE(r->content.encoding);
+       PTR_FREE(r->content.type);
+       PTR_FREE(r->content.encoding);
        if (r->content.encoder) {
                php_http_encoding_stream_free(&r->content.encoder);
        }
@@ -326,6 +361,17 @@ static STATUS php_http_env_response_send_head(php_http_env_response_t *r, php_ht
                return ret;
        }
 
+       if ((zoption = get_option(options, ZEND_STRL("headers") TSRMLS_CC))) {
+               if (Z_TYPE_P(zoption) == IS_ARRAY) {
+                       php_http_header_to_callback(Z_ARRVAL_P(zoption), 0, (php_http_pass_format_callback_t) r->ops->set_header, r TSRMLS_CC);
+               }
+               zval_ptr_dtor(&zoption);
+       }
+
+       if (ret != SUCCESS) {
+               return ret;
+       }
+
        if ((zoption = get_option(options, ZEND_STRL("responseCode") TSRMLS_CC))) {
                zval *zoption_copy = php_http_ztyp(IS_LONG, zoption);
 
@@ -356,9 +402,25 @@ static STATUS php_http_env_response_send_head(php_http_env_response_t *r, php_ht
                return ret;
        }
 
-       if ((zoption = get_option(options, ZEND_STRL("headers") TSRMLS_CC))) {
+       if ((zoption = get_option(options, ZEND_STRL("cookies") TSRMLS_CC))) {
                if (Z_TYPE_P(zoption) == IS_ARRAY) {
-                       php_http_header_to_callback(Z_ARRVAL_P(zoption), 0, (php_http_pass_format_callback_t) r->ops->set_header, r TSRMLS_CC);
+                       HashPosition pos;
+                       zval **zcookie;
+
+                       FOREACH_VAL(pos, zoption, zcookie) {
+                               if (Z_TYPE_PP(zcookie) == IS_OBJECT && instanceof_function(Z_OBJCE_PP(zcookie), php_http_cookie_class_entry TSRMLS_CC)) {
+                                       php_http_cookie_object_t *obj = zend_object_store_get_object(*zcookie TSRMLS_CC);
+                                       char *str;
+                                       size_t len;
+
+                                       php_http_cookie_list_to_string(obj->list, &str, &len);
+                                       if (SUCCESS != (ret = r->ops->add_header(r, "Set-Cookie: %s", str))) {
+                                               efree(str);
+                                               break;
+                                       }
+                                       efree(str);
+                               }
+                       }
                }
                zval_ptr_dtor(&zoption);
        }
@@ -821,9 +883,11 @@ typedef struct php_http_env_response_stream_ctx {
        long status_code;
 
        php_stream *stream;
+       php_http_message_t *request;
 
        unsigned started:1;
        unsigned finished:1;
+       unsigned chunked:1;
 } php_http_env_response_stream_ctx_t;
 
 static STATUS php_http_env_response_stream_init(php_http_env_response_t *r, void *init_arg)
@@ -841,6 +905,13 @@ static STATUS php_http_env_response_stream_init(php_http_env_response_t *r, void
        zend_hash_init(&ctx->header, 0, NULL, ZVAL_PTR_DTOR, 0);
        php_http_version_init(&ctx->version, 1, 1 TSRMLS_CC);
        ctx->status_code = 200;
+       ctx->chunked = 1;
+       ctx->request = get_request(r->options TSRMLS_CC);
+
+       /* there are some limitations regarding TE:chunked, see https://tools.ietf.org/html/rfc7230#section-3.3.1 */
+       if (ctx->request && ctx->request->http.version.major == 1 && ctx->request->http.version.minor == 0) {
+               ctx->version.minor = 0;
+       }
 
        r->ctx = ctx;
 
@@ -861,12 +932,21 @@ static void php_http_env_response_stream_header(php_http_env_response_stream_ctx
        HashPosition pos;
        zval **val;
 
-       FOREACH_HASH_VAL(pos, &ctx->header, val) {
+       FOREACH_HASH_VAL(pos, header, val) {
                if (Z_TYPE_PP(val) == IS_ARRAY) {
                        php_http_env_response_stream_header(ctx, Z_ARRVAL_PP(val) TSRMLS_CC);
                } else {
-                       php_stream_write(ctx->stream, Z_STRVAL_PP(val), Z_STRLEN_PP(val));
+                       zval *tmp = php_http_ztyp(IS_STRING, *val);
+
+                       if (ctx->chunked) {
+                               /* disable chunked transfer encoding if we've got an explicit content-length */
+                               if (!strncasecmp(Z_STRVAL_P(tmp), "Content-Length:", lenof("Content-Length:"))) {
+                                       ctx->chunked = 0;
+                               }
+                       }
+                       php_stream_write(ctx->stream, Z_STRVAL_P(tmp), Z_STRLEN_P(tmp));
                        php_stream_write_string(ctx->stream, PHP_HTTP_CRLF);
+                       zval_ptr_dtor(&tmp);
                }
        }
 }
@@ -877,9 +957,26 @@ static STATUS php_http_env_response_stream_start(php_http_env_response_stream_ct
        }
 
        php_stream_printf(ctx->stream TSRMLS_CC, "HTTP/%u.%u %ld %s" PHP_HTTP_CRLF, ctx->version.major, ctx->version.minor, ctx->status_code, php_http_env_get_response_status_for_code(ctx->status_code));
+
+       /* there are some limitations regarding TE:chunked, see https://tools.ietf.org/html/rfc7230#section-3.3.1 */
+       if (ctx->version.major == 1 && ctx->version.minor == 0) {
+               ctx->chunked = 0;
+       } else if (ctx->status_code == 204 || ctx->status_code/100 == 1) {
+               ctx->chunked = 0;
+       } else if (ctx->request && ctx->status_code/100 == 2 && !strcasecmp(ctx->request->http.info.request.method, "CONNECT")) {
+               ctx->chunked = 0;
+       }
+
        php_http_env_response_stream_header(ctx, &ctx->header TSRMLS_CC);
+
+       /* enable chunked transfer encoding */
+       if (ctx->chunked) {
+               php_stream_write_string(ctx->stream, "Transfer-Encoding: chunked" PHP_HTTP_CRLF);
+       }
        php_stream_write_string(ctx->stream, PHP_HTTP_CRLF);
+
        ctx->started = 1;
+
        return SUCCESS;
 }
 static long php_http_env_response_stream_get_status(php_http_env_response_t *r)
@@ -996,7 +1093,17 @@ static STATUS php_http_env_response_stream_write(php_http_env_response_t *r, con
                }
        }
 
-       php_stream_write(stream_ctx->stream, data_str, data_len);
+       if (stream_ctx->chunked && 0 == php_stream_printf(stream_ctx->stream TSRMLS_CC, "%lx" PHP_HTTP_CRLF, (unsigned long) data_len)) {
+               return FAILURE;
+       }
+
+       if (data_len != php_stream_write(stream_ctx->stream, data_str, data_len)) {
+               return FAILURE;
+       }
+
+       if (stream_ctx->chunked && 2 != php_stream_write_string(stream_ctx->stream, PHP_HTTP_CRLF)) {
+               return FAILURE;
+       }
 
        return SUCCESS;
 }
@@ -1030,6 +1137,10 @@ static STATUS php_http_env_response_stream_finish(php_http_env_response_t *r)
                }
        }
 
+       if (stream_ctx->chunked && 5 != php_stream_write_string(stream_ctx->stream, "0" PHP_HTTP_CRLF PHP_HTTP_CRLF)) {
+               return FAILURE;
+       }
+
        stream_ctx->finished = 1;
 
        return SUCCESS;
@@ -1091,7 +1202,11 @@ static PHP_METHOD(HttpEnvResponse, __invoke)
 
                php_http_message_object_init_body_object(obj);
                php_http_message_body_append(obj->message->body, ob_str, ob_len);
+#if PHP_VERSION_ID >= 50400
                RETURN_TRUE;
+#else
+               RETURN_EMPTY_STRING();
+#endif
        }
 }
 
@@ -1240,6 +1355,46 @@ static PHP_METHOD(HttpEnvResponse, setThrottleRate)
        RETVAL_ZVAL(getThis(), 1, 0);
 }
 
+ZEND_BEGIN_ARG_INFO_EX(ai_HttpEnvResponse_setCookie, 0, 0, 1)
+       ZEND_ARG_INFO(0, cookie)
+ZEND_END_ARG_INFO();
+static PHP_METHOD(HttpEnvResponse, setCookie)
+{
+       zval *zcookie_new;
+       zend_error_handling zeh;
+       php_http_cookie_list_t *list = NULL;
+
+       php_http_expect(SUCCESS == zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "z", &zcookie_new), invalid_arg, return);
+
+       zend_replace_error_handling(EH_THROW, php_http_exception_unexpected_val_class_entry, &zeh TSRMLS_CC);
+       switch (Z_TYPE_P(zcookie_new)) {
+       case IS_OBJECT:
+               if (instanceof_function(Z_OBJCE_P(zcookie_new), php_http_cookie_class_entry TSRMLS_CC)) {
+                       Z_ADDREF_P(zcookie_new);
+                       break;
+               }
+               /* no break */
+       case IS_ARRAY:
+               list = php_http_cookie_list_from_struct(NULL, zcookie_new TSRMLS_CC);
+               MAKE_STD_ZVAL(zcookie_new);
+               ZVAL_OBJVAL(zcookie_new, php_http_cookie_object_new_ex(php_http_cookie_class_entry, list, NULL TSRMLS_CC), 0);
+               break;
+
+       default:
+               zcookie_new = php_http_ztyp(IS_STRING, zcookie_new);
+               list = php_http_cookie_list_parse(NULL, Z_STRVAL_P(zcookie_new), Z_STRLEN_P(zcookie_new), 0, NULL TSRMLS_CC);
+               zval_ptr_dtor(&zcookie_new);
+               MAKE_STD_ZVAL(zcookie_new);
+               ZVAL_OBJVAL(zcookie_new, php_http_cookie_object_new_ex(php_http_cookie_class_entry, list, NULL TSRMLS_CC), 0);
+       }
+       zend_restore_error_handling(&zeh TSRMLS_CC);
+
+       set_cookie(getThis(), zcookie_new TSRMLS_CC);
+       zval_ptr_dtor(&zcookie_new);
+
+       RETVAL_ZVAL(getThis(), 1, 0);
+}
+
 ZEND_BEGIN_ARG_INFO_EX(ai_HttpEnvResponse_send, 0, 0, 0)
        ZEND_ARG_INFO(0, stream)
 ZEND_END_ARG_INFO();
@@ -1256,6 +1411,7 @@ static PHP_METHOD(HttpEnvResponse, send)
 #else
                php_end_ob_buffers(1 TSRMLS_CC);
 #endif
+
                if (zstream) {
                        php_http_env_response_t *r;
 
@@ -1284,6 +1440,7 @@ static zend_function_entry php_http_env_response_methods[] = {
        PHP_ME(HttpEnvResponse, __construct,             ai_HttpEnvResponse___construct,             ZEND_ACC_PUBLIC|ZEND_ACC_CTOR)
        PHP_ME(HttpEnvResponse, __invoke,                ai_HttpEnvResponse___invoke,                ZEND_ACC_PUBLIC)
        PHP_ME(HttpEnvResponse, setEnvRequest,           ai_HttpEnvResponse_setEnvRequest,           ZEND_ACC_PUBLIC)
+       PHP_ME(HttpEnvResponse, setCookie,               ai_HttpEnvResponse_setCookie,               ZEND_ACC_PUBLIC)
        PHP_ME(HttpEnvResponse, setContentType,          ai_HttpEnvResponse_setContentType,          ZEND_ACC_PUBLIC)
        PHP_ME(HttpEnvResponse, setContentDisposition,   ai_HttpEnvResponse_setContentDisposition,   ZEND_ACC_PUBLIC)
        PHP_ME(HttpEnvResponse, setContentEncoding,      ai_HttpEnvResponse_setContentEncoding,      ZEND_ACC_PUBLIC)
@@ -1314,6 +1471,7 @@ PHP_MINIT_FUNCTION(http_env_response)
        zend_declare_class_constant_long(php_http_env_response_class_entry, ZEND_STRL("CACHE_MISS"), PHP_HTTP_CACHE_MISS TSRMLS_CC);
 
        zend_declare_property_null(php_http_env_response_class_entry, ZEND_STRL("request"), ZEND_ACC_PROTECTED TSRMLS_CC);
+       zend_declare_property_null(php_http_env_response_class_entry, ZEND_STRL("cookies"), ZEND_ACC_PROTECTED TSRMLS_CC);
        zend_declare_property_null(php_http_env_response_class_entry, ZEND_STRL("contentType"), ZEND_ACC_PROTECTED TSRMLS_CC);
        zend_declare_property_null(php_http_env_response_class_entry, ZEND_STRL("contentDisposition"), ZEND_ACC_PROTECTED TSRMLS_CC);
        zend_declare_property_null(php_http_env_response_class_entry, ZEND_STRL("contentEncoding"), ZEND_ACC_PROTECTED TSRMLS_CC);