remodel file adding to accept paths, streams and plain data as upload files
[m6w6/ext-http] / php_http_message_body.c
index f80cb460e9124d2638d4285cdc3b57990507b37c..a33e330a2fa6d421fd06e2e2d74fba1a65735f91 100644 (file)
@@ -6,17 +6,13 @@
     | 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-2011, Michael Wallner <mike@php.net>            |
     +--------------------------------------------------------------------+
 */
 
-/* $Id: http_message_body.c 292841 2009-12-31 08:48:57Z mike $ */
+#include "php_http_api.h"
 
-#include "php_http.h"
-
-#include <libgen.h>
 #include <ext/standard/php_lcg.h>
-#include <ext/standard/php_string.h>
 
 #define BOUNDARY_OPEN(body) \
        do {\
@@ -79,6 +75,7 @@ PHP_HTTP_API php_http_message_body_t *php_http_message_body_copy(php_http_messag
 
 PHP_HTTP_API void php_http_message_body_dtor(php_http_message_body_t *body)
 {
+       TSRMLS_FETCH_FROM_CTX(body->ts);
        /* NO FIXME: shows leakinfo in DEBUG mode */
        zend_list_delete(body->stream_id);
        STR_FREE(body->boundary);
@@ -115,19 +112,19 @@ PHP_HTTP_API const char *php_http_message_body_boundary(php_http_message_body_t
 PHP_HTTP_API char *php_http_message_body_etag(php_http_message_body_t *body)
 {
        TSRMLS_FETCH_FROM_CTX(body->ts);
-       php_stream_statbuf *ssb = php_http_message_body_stat(body);
+       const php_stream_statbuf *ssb = php_http_message_body_stat(body);
 
        /* real file or temp buffer ? */
-       if (body->ssb.sb.st_mtime) {
+       if (ssb && ssb->sb.st_mtime) {
                char *etag;
 
                spprintf(&etag, 0, "%lx-%lx-%lx", ssb->sb.st_ino, ssb->sb.st_mtime, ssb->sb.st_size);
                return etag;
        } else {
-               void *ctx = php_http_etag_init(TSRMLS_C);
+               php_http_etag_t *etag = php_http_etag_init(PHP_HTTP_G->env.etag_mode TSRMLS_CC);
 
-               php_http_message_body_to_callback(body, php_http_etag_update, ctx, 0, 0);
-               return php_http_etag_finish(ctx TSRMLS_CC);
+               php_http_message_body_to_callback(body, (php_http_pass_callback_t) php_http_etag_update, etag, 0, 0);
+               return php_http_etag_finish(etag);
        }
 }
 
@@ -213,7 +210,6 @@ PHP_HTTP_API size_t php_http_message_body_appendf(php_http_message_body_t *body,
 PHP_HTTP_API STATUS php_http_message_body_add(php_http_message_body_t *body, HashTable *fields, HashTable *files)
 {
        zval tmp;
-       TSRMLS_FETCH_FROM_CTX(body->ts);
 
        if (fields) {
                INIT_PZVAL_ARRAY(&tmp, fields);
@@ -234,7 +230,10 @@ PHP_HTTP_API STATUS php_http_message_body_add(php_http_message_body_t *body, Has
 
 PHP_HTTP_API STATUS php_http_message_body_add_field(php_http_message_body_t *body, const char *name, const char *value_str, size_t value_len)
 {
-       char *safe_name = php_addslashes(estrdup(name), strlen(name), NULL, 1 TSRMLS_CC);
+       char *safe_name;
+       TSRMLS_FETCH_FROM_CTX(body->ts);
+
+       safe_name = php_addslashes(estrdup(name), strlen(name), NULL, 1 TSRMLS_CC);
 
        BOUNDARY_OPEN(body);
        php_http_message_body_appendf(
@@ -249,44 +248,56 @@ PHP_HTTP_API STATUS php_http_message_body_add_field(php_http_message_body_t *bod
        return SUCCESS;
 }
 
-PHP_HTTP_API STATUS php_http_message_body_add_file(php_http_message_body_t *body, const char *name, const char *path, const char *ctype)
+PHP_HTTP_API STATUS php_http_message_body_add_file(php_http_message_body_t *body, const char *name, const char *ctype, const char *path, php_stream *in)
 {
-       php_stream *in;
-       char *path_dup = estrdup(path);
+       php_stream_statbuf ssb = {{0}};
+       php_stream_filter *tef = NULL;
+       char *safe_name, *path_dup = estrdup(path);
        TSRMLS_FETCH_FROM_CTX(body->ts);
 
-       if ((in = php_stream_open_wrapper(path_dup, "r", REPORT_ERRORS|USE_PATH|STREAM_MUST_SEEK, NULL))) {
-               php_stream_statbuf ssb = {{0}};
-
-               if (SUCCESS == php_stream_stat(in, &ssb) && S_ISREG(ssb.sb.st_mode)) {
-                       char *safe_name = php_addslashes(estrdup(name), strlen(name), NULL, 1 TSRMLS_CC);
-
-                       BOUNDARY_OPEN(body);
-                       php_http_message_body_appendf(
-                               body,
-                               "Content-Disposition: attachment; name=\"%s\"; filename=\"%s\"" PHP_HTTP_CRLF
-                               "Content-Type: %s" PHP_HTTP_CRLF
-                               "Content-Length: %zu" PHP_HTTP_CRLF
-                               "" PHP_HTTP_CRLF,
-                               safe_name, basename(path_dup), ctype, ssb.sb.st_size);
-                       php_stream_copy_to_stream_ex(in, php_http_message_body_stream(body), PHP_STREAM_COPY_ALL, NULL);
-                       BOUNDARY_CLOSE(body);
-
-                       efree(safe_name);
-                       efree(path_dup);
-                       php_stream_close(in);
-                       return SUCCESS;
-               } else {
-                       efree(path_dup);
-                       php_stream_close(in);
-                       php_http_error(HE_WARNING, PHP_HTTP_E_MESSAGE_BODY, "Not a valid regular file: %s", path);
-                       return FAILURE;
-               }
+       safe_name = php_addslashes(estrdup(name), strlen(name), NULL, 1 TSRMLS_CC);
+
+       BOUNDARY_OPEN(body);
+       php_http_message_body_appendf(
+               body,
+               "Content-Disposition: attachment; name=\"%s\"; filename=\"%s\"" PHP_HTTP_CRLF
+               "Content-Type: %s" PHP_HTTP_CRLF,
+               safe_name, basename(path_dup), ctype
+       );
+
+       if (SUCCESS == php_stream_stat(in, &ssb)) {
+               php_http_message_body_appendf(
+                       body,
+                       "Content-Length: %zu" PHP_HTTP_CRLF
+                       "" PHP_HTTP_CRLF,
+                       ssb.sb.st_size
+               );
        } else {
-               efree(path_dup);
-               return FAILURE;
+               php_http_message_body_append(
+                       body,
+                       ZEND_STRL(
+                               "Transfer-Encoding: chunked" PHP_HTTP_CRLF
+                               "" PHP_HTTP_CRLF
+                       )
+               );
+
+               if ((tef = php_http_filter_factory.create_filter("http.chunked_encode", NULL, 0 TSRMLS_CC))) {
+                       php_stream_filter_append(&in->readfilters, tef);
+               }
+       }
+
+       php_stream_copy_to_stream_ex(in, php_http_message_body_stream(body), PHP_STREAM_COPY_ALL, NULL);
+       BOUNDARY_CLOSE(body);
+
+       if (tef) {
+               php_stream_filter_remove(tef, 1 TSRMLS_CC);
+               php_stream_filter_free(tef TSRMLS_CC);
        }
 
+       efree(safe_name);
+       efree(path_dup);
+
+       return SUCCESS;
 }
 
 static inline char *format_key(uint type, char *str, ulong num, const char *prefix) {
@@ -301,7 +312,7 @@ static inline char *format_key(uint type, char *str, ulong num, const char *pref
        } else if (type == HASH_KEY_IS_STRING) {
                new_key = estrdup(str);
        } else {
-               spprintf(&new_key, 0, "%lu", num);
+               estrdup("");
        }
 
        return new_key;
@@ -311,21 +322,24 @@ static STATUS add_recursive_fields(php_http_message_body_t *body, const char *na
 {
        if (Z_TYPE_P(value) == IS_ARRAY || Z_TYPE_P(value) == IS_OBJECT) {
                zval **val;
+               HashTable *ht;
                HashPosition pos;
                php_http_array_hashkey_t key = php_http_array_hashkey_init(0);
+               TSRMLS_FETCH_FROM_CTX(body->ts);
 
-               if (!HASH_OF(value)->nApplyCount) {
-                       ++HASH_OF(value)->nApplyCount;
+               ht = HASH_OF(value);
+               if (!ht->nApplyCount) {
+                       ++ht->nApplyCount;
                        FOREACH_KEYVAL(pos, value, key, val) {
                                char *str = format_key(key.type, key.str, key.num, name);
                                if (SUCCESS != add_recursive_fields(body, str, *val)) {
                                        efree(str);
-                                       HASH_OF(value)->nApplyCount--;
+                                       ht->nApplyCount--;
                                        return FAILURE;
                                }
                                efree(str);
                        }
-                       --HASH_OF(value)->nApplyCount;
+                       --ht->nApplyCount;
                }
        } else {
                zval *cpy = php_http_ztyp(IS_STRING, value);
@@ -338,50 +352,76 @@ static STATUS add_recursive_fields(php_http_message_body_t *body, const char *na
 
 static STATUS add_recursive_files(php_http_message_body_t *body, const char *name, zval *value)
 {
-       if (Z_TYPE_P(value) == IS_ARRAY || Z_TYPE_P(value) == IS_OBJECT) {
-               zval **zfile, **zname, **ztype;
+       zval **zdata = NULL, **zfile, **zname, **ztype;
+       HashTable *ht;
+       TSRMLS_FETCH_FROM_CTX(body->ts);
 
-               if ((SUCCESS == zend_hash_find(HASH_OF(value), ZEND_STRS("name"), (void *) &zname))
-               &&      (SUCCESS == zend_hash_find(HASH_OF(value), ZEND_STRS("file"), (void *) &zfile))
-               &&      (SUCCESS == zend_hash_find(HASH_OF(value), ZEND_STRS("type"), (void *) &ztype))
-               ) {
-                       zval *zfc = php_http_ztyp(IS_STRING, *zfile), *znc = php_http_ztyp(IS_STRING, *zname), *ztc = php_http_ztyp(IS_STRING, *ztype);
-                       char *str = format_key(HASH_KEY_IS_STRING, Z_STRVAL_P(znc), 0, name);
-                       STATUS ret = php_http_message_body_add_file(body, str, Z_STRVAL_P(zfc), Z_STRVAL_P(ztc));
+       if (Z_TYPE_P(value) != IS_ARRAY && Z_TYPE_P(value) != IS_OBJECT) {
+               php_http_error(HE_WARNING, PHP_HTTP_E_MESSAGE_BODY, "Expected array or object (name, type, file) for message body file to add");
+               return FAILURE;
+       }
 
-                       efree(str);
-                       zval_ptr_dtor(&znc);
-                       zval_ptr_dtor(&zfc);
-                       zval_ptr_dtor(&ztc);
+       ht = HASH_OF(value);
 
-                       if (ret != SUCCESS) {
-                               return ret;
-                       }
-               } else {
-                       zval **val;
-                       HashPosition pos;
-                       php_http_array_hashkey_t key = php_http_array_hashkey_init(0);
-
-                       if (!HASH_OF(value)->nApplyCount) {
-                               ++HASH_OF(value)->nApplyCount;
-                               FOREACH_KEYVAL(pos, value, key, val) {
-                                       char *str = format_key(key.type, key.str, key.num, name);
-                                       if (SUCCESS != add_recursive_files(body, str, *val)) {
-                                               efree(str);
-                                               --HASH_OF(value)->nApplyCount;
-                                               return FAILURE;
-                                       }
+       if ((SUCCESS != zend_hash_find(ht, ZEND_STRS("name"), (void *) &zname))
+       ||      (SUCCESS != zend_hash_find(ht, ZEND_STRS("type"), (void *) &ztype))
+       ||      (SUCCESS != zend_hash_find(ht, ZEND_STRS("file"), (void *) &zfile))
+       ) {
+               zval **val;
+               HashPosition pos;
+               php_http_array_hashkey_t key = php_http_array_hashkey_init(0);
+
+               if (!ht->nApplyCount) {
+                       ++ht->nApplyCount;
+                       FOREACH_HASH_KEYVAL(pos, ht, key, val) {
+                               char *str = format_key(key.type, key.str, key.num, name);
+                               if (SUCCESS != add_recursive_files(body, str, *val)) {
                                        efree(str);
+                                       --ht->nApplyCount;
+                                       return FAILURE;
                                }
-                               --HASH_OF(value)->nApplyCount;
+                               efree(str);
                        }
+                       --ht->nApplyCount;
                }
+               return SUCCESS;
        } else {
-               php_http_error(HE_WARNING, PHP_HTTP_E_MESSAGE_BODY, "Unrecognized array format for message body file to add");
-               return FAILURE;
-       }
+               php_stream *stream;
+               zval *zfc = php_http_ztyp(IS_STRING, *zfile);
 
-       return SUCCESS;
+               if (SUCCESS == zend_hash_find(ht, ZEND_STRS("data"), (void *) &zdata)) {
+                       if (Z_TYPE_PP(zdata) == IS_RESOURCE) {
+                               php_stream_from_zval_no_verify(stream, zdata);
+                       } else {
+                               zval *tmp = php_http_ztyp(IS_STRING, *zdata);
+
+                               if ((stream = php_stream_temp_new())) {
+                                       php_stream_write(stream, Z_STRVAL_P(tmp), Z_STRLEN_P(tmp));
+                               }
+                               zval_ptr_dtor(&tmp);
+                       }
+               } else {
+                       stream = php_stream_open_wrapper(Z_STRVAL_P(zfc), "r", REPORT_ERRORS|USE_PATH, NULL);
+               }
+
+               if (!stream) {
+                       zval_ptr_dtor(&zfc);
+                       return FAILURE;
+               } else {
+                       zval *znc = php_http_ztyp(IS_STRING, *zname), *ztc = php_http_ztyp(IS_STRING, *ztype);
+                       char *key = format_key(HASH_KEY_IS_STRING, Z_STRVAL_P(znc), 0, name);
+                       STATUS ret =  php_http_message_body_add_file(body, key, Z_STRVAL_P(ztc), Z_STRVAL_P(zfc), stream);
+
+                       efree(key);
+                       zval_ptr_dtor(&znc);
+                       zval_ptr_dtor(&zfc);
+                       if (!zdata || Z_TYPE_PP(zdata) != IS_RESOURCE) {
+                               php_stream_close(stream);
+                       }
+                       return ret;
+               }
+
+       }
 }
 
 /* PHP */
@@ -413,6 +453,11 @@ PHP_HTTP_BEGIN_ARGS(add, 0)
        PHP_HTTP_ARG_VAL(files, 0)
 PHP_HTTP_END_ARGS;
 
+PHP_HTTP_EMPTY_ARGS(etag);
+
+PHP_HTTP_BEGIN_ARGS(stat, 0)
+       PHP_HTTP_ARG_VAL(what, 0)
+PHP_HTTP_END_ARGS;
 
 zend_class_entry *php_http_message_body_class_entry;
 zend_function_entry php_http_message_body_method_entry[] = {
@@ -423,13 +468,15 @@ zend_function_entry php_http_message_body_method_entry[] = {
        PHP_HTTP_MESSAGE_BODY_ME(toCallback, ZEND_ACC_PUBLIC)
        PHP_HTTP_MESSAGE_BODY_ME(append, ZEND_ACC_PUBLIC)
        PHP_HTTP_MESSAGE_BODY_ME(add, ZEND_ACC_PUBLIC)
+       PHP_HTTP_MESSAGE_BODY_ME(etag, ZEND_ACC_PUBLIC)
+       PHP_HTTP_MESSAGE_BODY_ME(stat, ZEND_ACC_PUBLIC)
        EMPTY_FUNCTION_ENTRY
 };
 static zend_object_handlers php_http_message_body_object_handlers;
 
 PHP_MINIT_FUNCTION(http_message_body)
 {
-       PHP_HTTP_REGISTER_CLASS(http\\message, Body, http_message_body, php_http_object_class_entry, 0);
+       PHP_HTTP_REGISTER_CLASS(http\\Message, Body, http_message_body, php_http_object_class_entry, 0);
        php_http_message_body_class_entry->create_object = php_http_message_body_object_new;
        memcpy(&php_http_message_body_object_handlers, zend_get_std_object_handlers(), sizeof(zend_object_handlers));
        php_http_message_body_object_handlers.clone_obj = php_http_message_body_object_clone;
@@ -471,7 +518,7 @@ zend_object_value php_http_message_body_object_clone(zval *object TSRMLS_DC)
        php_http_message_body_object_t *new_obj = NULL;
        php_http_message_body_object_t *old_obj = zend_object_store_get_object(object TSRMLS_CC);
 
-       new_ov = php_http_message_body_object_new_ex(old_obj->zo.ce, php_http_message_body_copy(old_obj->body, NULL, 1), &new_obj);
+       new_ov = php_http_message_body_object_new_ex(old_obj->zo.ce, php_http_message_body_copy(old_obj->body, NULL, 1), &new_obj TSRMLS_CC);
        zend_objects_clone_members(&new_obj->zo, new_ov, &old_obj->zo, Z_OBJ_HANDLE_P(object) TSRMLS_CC);
 
        return new_ov;
@@ -545,20 +592,24 @@ PHP_METHOD(HttpMessageBody, toStream)
 
 struct fcd {
        zval *fcz;
-       zend_fcall_info *fci;
-       zend_fcall_info_cache *fcc;
+       zend_fcall_info fci;
+       zend_fcall_info_cache fcc;
+#ifdef ZTS
+       void ***ts;
+#endif
 };
 
-static size_t pass(void *cb_arg, const char *str, size_t len TSRMLS_DC)
+static size_t pass(void *cb_arg, const char *str, size_t len)
 {
        struct fcd *fcd = cb_arg;
        zval *zdata;
+       TSRMLS_FETCH_FROM_CTX(fcd->ts);
 
        MAKE_STD_ZVAL(zdata);
        ZVAL_STRINGL(zdata, str, len, 1);
-       if (SUCCESS == zend_fcall_info_argn(fcd->fci TSRMLS_CC, 2, fcd->fcz, zdata)) {
-               zend_fcall_info_call(fcd->fci, fcd->fcc, NULL, NULL TSRMLS_CC);
-               zend_fcall_info_args_clear(fcd->fci, 0);
+       if (SUCCESS == zend_fcall_info_argn(&fcd->fci TSRMLS_CC, 2, &fcd->fcz, &zdata)) {
+               zend_fcall_info_call(&fcd->fci, &fcd->fcc, NULL, NULL TSRMLS_CC);
+               zend_fcall_info_args_clear(&fcd->fci, 0);
        }
        zval_ptr_dtor(&zdata);
        return len;
@@ -566,14 +617,19 @@ static size_t pass(void *cb_arg, const char *str, size_t len TSRMLS_DC)
 
 PHP_METHOD(HttpMessageBody, toCallback)
 {
-       struct fcd fcd;
+       struct fcd fcd = {0};
        long offset = 0, forlen = 0;
 
        if (SUCCESS == zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "f|ll", &fcd.fci, &fcd.fcc, &offset, &forlen)) {
                php_http_message_body_object_t *obj = zend_object_store_get_object(getThis() TSRMLS_CC);
+
                fcd.fcz = getThis();
                Z_ADDREF_P(fcd.fcz);
+               TSRMLS_SET_CTX(fcd.ts);
+
                php_http_message_body_to_callback(obj->body, pass, &fcd, offset, forlen);
+               zend_fcall_info_args_clear(&fcd.fci, 1);
+
                zval_ptr_dtor(&fcd.fcz);
                RETURN_TRUE;
        }
@@ -604,6 +660,65 @@ PHP_METHOD(HttpMessageBody, add)
        }
        RETURN_FALSE;
 }
+
+PHP_METHOD(HttpMessageBody, etag)
+{
+       if (SUCCESS == zend_parse_parameters_none()) {
+               php_http_message_body_object_t *obj = zend_object_store_get_object(getThis() TSRMLS_CC);
+               char *etag = php_http_message_body_etag(obj->body);
+
+               if (etag) {
+                       RETURN_STRING(etag, 0);
+               }
+       }
+       RETURN_FALSE;
+}
+
+PHP_METHOD(HttpMessageBody, stat)
+{
+       char *field_str = NULL;
+       int field_len = 0;
+
+       if (SUCCESS == zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "|s", &field_str, &field_len)) {
+               php_http_message_body_object_t *obj = zend_object_store_get_object(getThis() TSRMLS_CC);
+               const php_stream_statbuf *sb = php_http_message_body_stat(obj->body);
+
+               if (sb) {
+                       if (field_str && field_len) {
+                                       switch (*field_str) {
+                                               case 's':
+                                               case 'S':
+                                                       RETURN_LONG(sb->sb.st_size);
+                                                       break;
+                                               case 'a':
+                                               case 'A':
+                                                       RETURN_LONG(sb->sb.st_atime);
+                                                       break;
+                                               case 'm':
+                                               case 'M':
+                                                       RETURN_LONG(sb->sb.st_mtime);
+                                                       break;
+                                               case 'c':
+                                               case 'C':
+                                                       RETURN_LONG(sb->sb.st_ctime);
+                                                       break;
+                                               default:
+                                                       php_http_error(HE_WARNING, PHP_HTTP_E_MESSAGE_BODY, "unknown stat field: '%s' (should be one of [s]ize, [a]time, [m]time or [c]time)", field_str);
+                                                       break;
+                                       }
+                       } else {
+                               array_init(return_value);
+                               add_assoc_long_ex(return_value, ZEND_STRS("size"), sb->sb.st_size);
+                               add_assoc_long_ex(return_value, ZEND_STRS("atime"), sb->sb.st_atime);
+                               add_assoc_long_ex(return_value, ZEND_STRS("mtime"), sb->sb.st_mtime);
+                               add_assoc_long_ex(return_value, ZEND_STRS("ctime"), sb->sb.st_ctime);
+                               return;
+                       }
+               }
+       }
+       RETURN_FALSE;
+}
+
 /*
  * Local variables:
  * tab-width: 4