Merge branch 'master' into phpng
[m6w6/ext-http] / php_http_env_response.c
index d13cde104a7acb9f8230613ff3704173fdfcb15f..557bb1088b07849d6ac56855d62fb1db77dc05ed 100644 (file)
@@ -60,12 +60,12 @@ static void set_option(zval *options, const char *name_str, size_t name_len, int
                }
        }
 }
-static zval *get_option(zval *options, const char *name_str, size_t name_len)
+static zval *get_option(zval *options, const char *name_str, size_t name_len, zval *tmp)
 {
        zval *val = NULL;
 
        if (Z_TYPE_P(options) == IS_OBJECT) {
-               val = zend_read_property(Z_OBJCE_P(options), options, name_str, name_len, 0);
+               val = zend_read_property(Z_OBJCE_P(options), options, name_str, name_len, 0, tmp);
        } else if (Z_TYPE_P(options) == IS_ARRAY) {
                val = zend_symtable_str_find(Z_ARRVAL_P(options), name_str, name_len);
        } else {
@@ -78,10 +78,10 @@ static zval *get_option(zval *options, const char *name_str, size_t name_len)
 }
 static php_http_message_body_t *get_body(zval *options)
 {
-       zval *zbody;
+       zval zbody_tmp, *zbody;
        php_http_message_body_t *body = NULL;
 
-       if ((zbody = get_option(options, ZEND_STRL("body")))) {
+       if ((zbody = get_option(options, ZEND_STRL("body"), &zbody_tmp))) {
                if ((Z_TYPE_P(zbody) == IS_OBJECT) && instanceof_function(Z_OBJCE_P(zbody), php_http_message_body_class_entry)) {
                        php_http_message_body_object_t *body_obj = PHP_HTTP_OBJ(NULL, zbody);
 
@@ -94,10 +94,10 @@ static php_http_message_body_t *get_body(zval *options)
 }
 static php_http_message_t *get_request(zval *options)
 {
-       zval *zrequest;
+       zval zrequest_tmp, *zrequest;
        php_http_message_t *request = NULL;
 
-       if ((zrequest = get_option(options, ZEND_STRL("request")))) {
+       if ((zrequest = get_option(options, ZEND_STRL("request"), &zrequest_tmp))) {
                if (Z_TYPE_P(zrequest) == IS_OBJECT && instanceof_function(Z_OBJCE_P(zrequest), php_http_message_class_entry)) {
                        php_http_message_object_t *request_obj = PHP_HTTP_OBJ(NULL, zrequest);
 
@@ -108,36 +108,32 @@ static php_http_message_t *get_request(zval *options)
 
        return request;
 }
-static void set_cookie(zval *options, zval *zcookie_new TSRMLS_DC)
+static void set_cookie(zval *options, zval *zcookie_new)
 {
-       zval *zcookies_set;
+       zval tmp, zcookies_set_tmp, *zcookies_set;
        php_http_arrkey_t key;
        php_http_cookie_object_t *obj = PHP_HTTP_OBJ(NULL, zcookie_new);
 
-       zcookies_set = get_option(options, ZEND_STRL("cookies"));
-       if (!zcookies_set || Z_TYPE_P(zcookies_set) != IS_ARRAY) {
-               if (zcookies_set) {
-                       zval_ptr_dtor(zcookies_set);
-               }
-               array_init_size(zcookies_set, zend_hash_num_elements(&obj->list->cookies));
-       } else {
-               Z_ADDREF_P(zcookies_set);
-               SEPARATE_ZVAL(zcookies_set);
+       array_init(&tmp);
+       zcookies_set = get_option(options, ZEND_STRL("cookies"), &zcookies_set_tmp);
+       if (zcookies_set && Z_TYPE_P(zcookies_set) == IS_ARRAY) {
+               array_copy(Z_ARRVAL_P(zcookies_set), Z_ARRVAL(tmp));
+               zval_ptr_dtor(zcookies_set);
        }
 
        ZEND_HASH_FOREACH_KEY(&obj->list->cookies, key.h, key.key)
        {
                Z_ADDREF_P(zcookie_new);
                if (key.key) {
-                       add_assoc_zval_ex(zcookies_set, key.key->val, key.key->len, zcookie_new);
+                       add_assoc_zval_ex(&tmp, key.key->val, key.key->len, zcookie_new);
                } else {
-                       add_index_zval(zcookies_set, key.h, zcookie_new);
+                       add_index_zval(&tmp, key.h, zcookie_new);
                }
        }
        ZEND_HASH_FOREACH_END();
 
-       set_option(options, ZEND_STRL("cookies"), IS_ARRAY, zcookies_set, 0);
-       zval_ptr_dtor(zcookies_set);
+       set_option(options, ZEND_STRL("cookies"), IS_ARRAY, &tmp, 0);
+       zval_ptr_dtor(&tmp);
 }
 
 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)
@@ -145,14 +141,14 @@ php_http_cache_status_t php_http_env_is_response_cached_by_etag(zval *options, c
        php_http_cache_status_t ret = PHP_HTTP_CACHE_NO;
        char *header = NULL, *etag = NULL;
        php_http_message_body_t *body;
-       zval *zetag;
+       zval zetag_tmp, *zetag;
 
 
        if (!(body = get_body(options))) {
                return ret;
        }
 
-       if ((zetag = get_option(options, ZEND_STRL("etag")))) {
+       if ((zetag = get_option(options, ZEND_STRL("etag"), &zetag_tmp)) && Z_TYPE_P(zetag) != IS_NULL) {
                zend_string *zs = zval_get_string(zetag);
                etag = estrndup(zs->val, zs->len);
                zend_string_release(zs);
@@ -179,13 +175,13 @@ php_http_cache_status_t php_http_env_is_response_cached_by_last_modified(zval *o
        char *header;
        time_t ums, lm = 0;
        php_http_message_body_t *body;
-       zval *zlm;
+       zval zlm_tmp, *zlm;
 
        if (!(body = get_body(options))) {
                return ret;
        }
 
-       if ((zlm = get_option(options, ZEND_STRL("lastModified")))) {
+       if ((zlm = get_option(options, ZEND_STRL("lastModified"), &zlm_tmp))) {
                lm = zval_get_long(zlm);
                zval_ptr_dtor(zlm);
        }
@@ -211,7 +207,9 @@ php_http_cache_status_t php_http_env_is_response_cached_by_last_modified(zval *o
 
 static zend_bool php_http_env_response_is_cacheable(php_http_env_response_t *r, php_http_message_t *request)
 {
-       if (r->ops->get_status(r) >= 400) {
+       long status = r->ops->get_status(r);
+
+       if (status && status / 100 != 2) {
                return 0;
        }
 
@@ -335,13 +333,13 @@ void php_http_env_response_free(php_http_env_response_t **r)
 static ZEND_RESULT_CODE php_http_env_response_send_head(php_http_env_response_t *r, php_http_message_t *request)
 {
        ZEND_RESULT_CODE ret = SUCCESS;
-       zval *zoption, *options = &r->options;
+       zval zoption_tmp, *zoption, *options = &r->options;
 
        if (r->done) {
                return ret;
        }
 
-       if ((zoption = get_option(options, ZEND_STRL("headers")))) {
+       if ((zoption = get_option(options, ZEND_STRL("headers"), &zoption_tmp))) {
                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);
                }
@@ -352,7 +350,7 @@ static ZEND_RESULT_CODE php_http_env_response_send_head(php_http_env_response_t
                return ret;
        }
 
-       if ((zoption = get_option(options, ZEND_STRL("responseCode")))) {
+       if ((zoption = get_option(options, ZEND_STRL("responseCode"), &zoption_tmp))) {
                zend_long rc = zval_get_long(zoption);
 
                zval_ptr_dtor(zoption);
@@ -365,7 +363,7 @@ static ZEND_RESULT_CODE php_http_env_response_send_head(php_http_env_response_t
                return ret;
        }
 
-       if ((zoption = get_option(options, ZEND_STRL("httpVersion")))) {
+       if ((zoption = get_option(options, ZEND_STRL("httpVersion"), &zoption_tmp))) {
                php_http_version_t v;
                zend_string *zs = zval_get_string(zoption);
 
@@ -381,7 +379,7 @@ static ZEND_RESULT_CODE php_http_env_response_send_head(php_http_env_response_t
                return ret;
        }
 
-       if ((zoption = get_option(options, ZEND_STRL("cookies")))) {
+       if ((zoption = get_option(options, ZEND_STRL("cookies"), &zoption_tmp))) {
                if (Z_TYPE_P(zoption) == IS_ARRAY) {
                        zval *zcookie;
 
@@ -409,7 +407,7 @@ static ZEND_RESULT_CODE php_http_env_response_send_head(php_http_env_response_t
                return ret;
        }
 
-       if ((zoption = get_option(options, ZEND_STRL("contentType")))) {
+       if ((zoption = get_option(options, ZEND_STRL("contentType"), &zoption_tmp))) {
                zend_string *zs = zval_get_string(zoption);
 
                zval_ptr_dtor(zoption);
@@ -447,7 +445,7 @@ static ZEND_RESULT_CODE php_http_env_response_send_head(php_http_env_response_t
                        }
                }
        } else {
-               if ((zoption = get_option(options, ZEND_STRL("cacheControl")))) {
+               if ((zoption = get_option(options, ZEND_STRL("cacheControl"), &zoption_tmp))) {
                        zend_string *zs = zval_get_string(zoption);
 
                        zval_ptr_dtor(zoption);
@@ -461,24 +459,20 @@ static ZEND_RESULT_CODE php_http_env_response_send_head(php_http_env_response_t
                        return ret;
                }
 
-               if ((zoption = get_option(options, ZEND_STRL("contentDisposition")))) {
-                       php_http_buffer_t buf;
+               if ((zoption = get_option(options, ZEND_STRL("contentDisposition"), &zoption_tmp))) {
 
-                       if (Z_TYPE_P(zoption) != IS_ARRAY) {
-                               zval *tmp = zoption;
-                               SEPARATE_ZVAL(tmp);
-                               convert_to_array(tmp);
-                               zoption = tmp;
-                       }
+                       if (Z_TYPE_P(zoption) == IS_ARRAY) {
+                               php_http_buffer_t buf;
 
-                       php_http_buffer_init(&buf);
-                       if (php_http_params_to_string(&buf, Z_ARRVAL_P(zoption), ZEND_STRL(","), ZEND_STRL(";"), ZEND_STRL("="), PHP_HTTP_PARAMS_DEFAULT)) {
-                               if (buf.used) {
-                                       ret = r->ops->set_header(r, "Content-Disposition: %.*s", buf.used, buf.data);
+                               php_http_buffer_init(&buf);
+                               if (php_http_params_to_string(&buf, Z_ARRVAL_P(zoption), ZEND_STRL(","), ZEND_STRL(";"), ZEND_STRL("="), PHP_HTTP_PARAMS_DEFAULT)) {
+                                       if (buf.used) {
+                                               ret = r->ops->set_header(r, "Content-Disposition: %.*s", buf.used, buf.data);
+                                       }
                                }
-                       }
 
-                       php_http_buffer_dtor(&buf);
+                               php_http_buffer_dtor(&buf);
+                       }
                        zval_ptr_dtor(zoption);
                }
 
@@ -486,7 +480,7 @@ static ZEND_RESULT_CODE php_http_env_response_send_head(php_http_env_response_t
                        return ret;
                }
 
-               if ((zoption = get_option(options, ZEND_STRL("contentEncoding")))) {
+               if ((zoption = get_option(options, ZEND_STRL("contentEncoding"), &zoption_tmp))) {
                        zend_long ce = zval_get_long(zoption);
                        zval zsupported;
                        HashTable *result = NULL;
@@ -561,7 +555,7 @@ static ZEND_RESULT_CODE php_http_env_response_send_head(php_http_env_response_t
                                        break;
                        }
 
-                       if ((zoption = get_option(options, ZEND_STRL("etag")))) {
+                       if ((zoption = get_option(options, ZEND_STRL("etag"), &zoption_tmp))) {
                                zend_string *zs = zval_get_string(zoption);
 
                                zval_ptr_dtor(zoption);
@@ -572,7 +566,7 @@ static ZEND_RESULT_CODE php_http_env_response_send_head(php_http_env_response_t
                                }
                                zend_string_release(zs);
                        }
-                       if ((zoption = get_option(options, ZEND_STRL("lastModified") TSRMLS_CC))) {
+                       if ((zoption = get_option(options, ZEND_STRL("lastModified"), &zoption_tmp))) {
                                zend_long lm = zval_get_long(zoption);
 
                                zval_ptr_dtor(zoption);
@@ -593,7 +587,7 @@ static ZEND_RESULT_CODE php_http_env_response_send_head(php_http_env_response_t
 static ZEND_RESULT_CODE php_http_env_response_send_body(php_http_env_response_t *r)
 {
        ZEND_RESULT_CODE ret = SUCCESS;
-       zval *zoption;
+       zval zoption_tmp, *zoption;
        php_http_message_body_t *body;
 
        if (r->done) {
@@ -601,11 +595,11 @@ static ZEND_RESULT_CODE php_http_env_response_send_body(php_http_env_response_t
        }
 
        if ((body = get_body(&r->options))) {
-               if ((zoption = get_option(&r->options, ZEND_STRL("throttleDelay")))) {
+               if ((zoption = get_option(&r->options, ZEND_STRL("throttleDelay"), &zoption_tmp))) {
                        r->throttle.delay = zval_get_double(zoption);
                        zval_ptr_dtor(zoption);
                }
-               if ((zoption = get_option(&r->options, ZEND_STRL("throttleChunk") TSRMLS_CC))) {
+               if ((zoption = get_option(&r->options, ZEND_STRL("throttleChunk"), &zoption_tmp))) {
                        r->throttle.chunk = zval_get_long(zoption);
                        zval_ptr_dtor(zoption);
                }
@@ -842,14 +836,18 @@ typedef struct php_http_env_response_stream_ctx {
        long status_code;
 
        php_stream *stream;
+       php_stream_filter *chunked_filter;
+       php_http_message_t *request;
 
        unsigned started:1;
        unsigned finished:1;
+       unsigned chunked:1;
 } php_http_env_response_stream_ctx_t;
 
 static ZEND_RESULT_CODE php_http_env_response_stream_init(php_http_env_response_t *r, void *init_arg)
 {
        php_http_env_response_stream_ctx_t *ctx;
+       size_t buffer_size = 0x1000;
 
        ctx = ecalloc(1, sizeof(*ctx));
 
@@ -857,7 +855,15 @@ static ZEND_RESULT_CODE php_http_env_response_stream_init(php_http_env_response_
        ++GC_REFCOUNT(ctx->stream->res);
        ZEND_INIT_SYMTABLE(&ctx->header);
        php_http_version_init(&ctx->version, 1, 1);
+       php_stream_set_option(ctx->stream, PHP_STREAM_OPTION_WRITE_BUFFER, PHP_STREAM_BUFFER_FULL, &buffer_size);
        ctx->status_code = 200;
+       ctx->chunked = 1;
+       ctx->request = get_request(&r->options);
+
+       /* 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;
 
@@ -867,24 +873,33 @@ static void php_http_env_response_stream_dtor(php_http_env_response_t *r)
 {
        php_http_env_response_stream_ctx_t *ctx = r->ctx;
 
+       if (ctx->chunked_filter) {
+               ctx->chunked_filter = php_stream_filter_remove(ctx->chunked_filter, 1);
+       }
        zend_hash_destroy(&ctx->header);
        zend_list_delete(ctx->stream->res);
        efree(ctx);
        r->ctx = NULL;
 }
-static void php_http_env_response_stream_header(php_http_env_response_stream_ctx_t *ctx, HashTable *header)
+static void php_http_env_response_stream_header(php_http_env_response_stream_ctx_t *ctx, HashTable *header, php_http_buffer_t *buf)
 {
        zval *val;
 
        ZEND_HASH_FOREACH_VAL(header, val)
        {
                if (Z_TYPE_P(val) == IS_ARRAY) {
-                       php_http_env_response_stream_header(ctx, Z_ARRVAL_P(val));
+                       php_http_env_response_stream_header(ctx, Z_ARRVAL_P(val), buf);
                } else {
                        zend_string *zs = zval_get_string(val);
 
-                       php_stream_write(ctx->stream, zs->val, zs->len);
-                       php_stream_write_string(ctx->stream, PHP_HTTP_CRLF);
+                       if (ctx->chunked) {
+                               /* disable chunked transfer encoding if we've got an explicit content-length */
+                               if (!strncasecmp(zs->val, "Content-Length:", lenof("Content-Length:"))) {
+                                       ctx->chunked = 0;
+                               }
+                       }
+                       php_http_buffer_append(buf, zs->val, zs->len);
+                       php_http_buffer_appends(buf, PHP_HTTP_CRLF);
                        zend_string_release(zs);
                }
        }
@@ -892,15 +907,45 @@ static void php_http_env_response_stream_header(php_http_env_response_stream_ctx
 }
 static ZEND_RESULT_CODE php_http_env_response_stream_start(php_http_env_response_stream_ctx_t *ctx)
 {
+       php_http_buffer_t header_buf;
+
        if (ctx->started || ctx->finished) {
                return FAILURE;
        }
 
-       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));
-       php_http_env_response_stream_header(ctx, &ctx->header);
-       php_stream_write_string(ctx->stream, PHP_HTTP_CRLF);
-       ctx->started = 1;
-       return SUCCESS;
+       php_http_buffer_init(&header_buf);
+       php_http_buffer_appendf(&header_buf, "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, &header_buf);
+
+       /* enable chunked transfer encoding */
+       if (ctx->chunked) {
+               php_http_buffer_appends(&header_buf, "Transfer-Encoding: chunked" PHP_HTTP_CRLF);
+       }
+
+       php_http_buffer_appends(&header_buf, PHP_HTTP_CRLF);
+
+       if (header_buf.used == php_stream_write(ctx->stream, header_buf.data, header_buf.used)) {
+               ctx->started = 1;
+       }
+       php_http_buffer_dtor(&header_buf);
+       php_stream_flush(ctx->stream);
+
+       if (ctx->chunked) {
+               ctx->chunked_filter = php_stream_filter_create("http.chunked_encode", NULL, 0);
+               php_stream_filter_append(&ctx->stream->writefilters, ctx->chunked_filter);
+       }
+
+       return ctx->started ? SUCCESS : FAILURE;
 }
 static long php_http_env_response_stream_get_status(php_http_env_response_t *r)
 {
@@ -938,6 +983,8 @@ static ZEND_RESULT_CODE php_http_env_response_stream_set_header_ex(php_http_env_
        char *header_end, *header_str = NULL;
        size_t header_len = 0;
        zval zheader, *zheader_ptr;
+       zend_string *header_key;
+       ZEND_RESULT_CODE rv;
 
        if (stream_ctx->started || stream_ctx->finished) {
                return FAILURE;
@@ -950,22 +997,21 @@ static ZEND_RESULT_CODE php_http_env_response_stream_set_header_ex(php_http_env_
                return FAILURE;
        }
 
-       *header_end = '\0';
+       header_key = zend_string_init(header_str, header_end - header_str, 0);
 
-       if (!replace && (zheader_ptr = zend_hash_str_find(&stream_ctx->header, header_str, header_end - header_str))) {
+       if (!replace && (zheader_ptr = zend_hash_find(&stream_ctx->header, header_key))) {
                convert_to_array(zheader_ptr);
-               *header_end = ':';
-               return add_next_index_str(zheader_ptr, php_http_cs2zs(header_str, header_len));
+               rv = add_next_index_str(zheader_ptr, php_http_cs2zs(header_str, header_len));
        } else {
                ZVAL_STR(&zheader, php_http_cs2zs(header_str, header_len));
 
-               if (SUCCESS != zend_hash_str_update(&stream_ctx->header, header_str, header_end - header_str, &zheader)) {
-                       return FAILURE;
-               }
-
-               *header_end = ':';
-               return SUCCESS;
+               rv = zend_hash_update(&stream_ctx->header, header_key, &zheader)
+                       ? SUCCESS : FAILURE;
        }
+
+       zend_string_release(header_key);
+
+       return rv;
 }
 static ZEND_RESULT_CODE php_http_env_response_stream_set_header(php_http_env_response_t *r, const char *fmt, ...)
 {
@@ -1036,18 +1082,24 @@ static ZEND_RESULT_CODE php_http_env_response_stream_flush(php_http_env_response
 }
 static ZEND_RESULT_CODE php_http_env_response_stream_finish(php_http_env_response_t *r)
 {
-       php_http_env_response_stream_ctx_t *stream_ctx = r->ctx;
+       php_http_env_response_stream_ctx_t *ctx = r->ctx;
 
-       if (stream_ctx->finished) {
+       if (ctx->finished) {
                return FAILURE;
        }
-       if (!stream_ctx->started) {
-               if (SUCCESS != php_http_env_response_stream_start(stream_ctx)) {
+       if (!ctx->started) {
+               if (SUCCESS != php_http_env_response_stream_start(ctx)) {
                        return FAILURE;
                }
        }
 
-       stream_ctx->finished = 1;
+       php_stream_flush(ctx->stream);
+       if (ctx->chunked && ctx->chunked_filter) {
+               php_stream_filter_flush(ctx->chunked_filter, 1);
+               ctx->chunked_filter = php_stream_filter_remove(ctx->chunked_filter, 1 TSRMLS_CC);
+       }
+
+       ctx->finished = 1;
 
        return SUCCESS;
 }
@@ -1107,7 +1159,12 @@ static PHP_METHOD(HttpEnvResponse, __invoke)
                PHP_HTTP_ENV_RESPONSE_OBJECT_INIT(obj);
 
                php_http_message_object_init_body_object(obj);
-               php_http_message_body_append(obj->message->body, ob_str, ob_len);
+
+               if (ob_flags & PHP_OUTPUT_HANDLER_CLEAN) {
+                       php_stream_truncate_set_size(php_http_message_body_stream(obj->message->body), 0);
+               } else {
+                       php_http_message_body_append(obj->message->body, ob_str, ob_len);
+               }
                RETURN_TRUE;
        }
 }
@@ -1280,14 +1337,15 @@ static PHP_METHOD(HttpEnvResponse, setCookie)
        case IS_ARRAY:
                list = php_http_cookie_list_from_struct(NULL, zcookie_new);
                zcookie_new = &tmp;
-               ZVAL_OBJ(zcookie_new, &php_http_cookie_object_new_ex(php_http_cookie_class_entry, list)->zo);
+               ZVAL_OBJECT(zcookie_new, &php_http_cookie_object_new_ex(php_http_cookie_class_entry, list)->zo, 1);
                break;
 
        default:
                zs = zval_get_string(zcookie_new);
                list = php_http_cookie_list_parse(NULL, zs->val, zs->len, 0, NULL);
+               zend_string_release(zs);
                zcookie_new = &tmp;
-               ZVAL_OBJ(zcookie_new, &php_http_cookie_object_new_ex(php_http_cookie_class_entry, list)->zo);
+               ZVAL_OBJECT(zcookie_new, &php_http_cookie_object_new_ex(php_http_cookie_class_entry, list)->zo, 1);
        }
        zend_restore_error_handling(&zeh);