Added stream_filter_remove() to cancel a stream filter.

Register filters as resources when
instantiated by stream_filter_(ap|pre)pend().

Export php_stream_filter_flush() internal function to wind buffered data
out of a particular filter until consumed by a later filter or sent to
stream->readbuffer or stream->ops->write()

diff --git a/NEWS b/NEWS
index eaa7887c1a5616632e94c9b29aac02fbedb8337f..1a010b0581a233761d926a9c4f8c57ee76f7a428 100644 (file)
--- a/NEWS
+++ b/NEWS
@@ -16,6 +16,7 @@ PHP                                                                        NEWS
   . stream_socket_enable_crypto() (Wez)
   . stream_wrapper_unregister() (Sara)
   . stream_wrapper_restore() (Sara)
+  . stream_filter_remove() (Sara)
   . DomDocumentFragment->appendXML() (Christian)
   . SimpleXMLElement->registerXPathNamespace() (Christian)
   . mysqli->client_info property (Georg)
@@ -31,6 +32,7 @@ PHP                                                                        NEWS
 - Added HTTP/1.1 and chunked encoding support to http:// wrapper. (Sara)
 - Added support of parameter->value arrays to xsl_xsltprocessor_set_parameter() 
   (Tony)
+- Changed stream_filter_(ap|pre)pend() to return resource. (Sara)
 - Fixed bug with raw_post_data not getting set. (Brian)
 - Fixed bug in mysql->client_version. (Georg)
 - Fixed ZTS destruction. (Marcus)

diff --git a/ext/standard/basic_functions.c b/ext/standard/basic_functions.c
index 3aa0eb25e49432f97156f678a671a600d2630195..08e7578601cd74d44c66ec641d30f58d461433fc 100644 (file)
--- a/ext/standard/basic_functions.c
+++ b/ext/standard/basic_functions.c
@@ -600,6 +600,7 @@ function_entry basic_functions[] = {
        PHP_FE(stream_context_get_default,                                                                              NULL)
        PHP_FE(stream_filter_prepend,                                                                                   NULL)
        PHP_FE(stream_filter_append,                                                                                    NULL)
+       PHP_FE(stream_filter_remove,                                                                                    NULL)
        PHP_FE(stream_socket_client,                             second_and_third_args_force_ref)
        PHP_FE(stream_socket_server,                             second_and_third_args_force_ref)
        PHP_FE(stream_socket_accept,                                               third_arg_force_ref)

diff --git a/ext/standard/streamsfuncs.c b/ext/standard/streamsfuncs.c
index 75b7014e47cd743cfda152494efed583be82667c..d26d6174c273176cd1e0f3747d6747e80c11c575 100644 (file)
--- a/ext/standard/streamsfuncs.c
+++ b/ext/standard/streamsfuncs.c
@@ -987,7 +987,7 @@ static void apply_filter_to_stream(int append, INTERNAL_FUNCTION_PARAMETERS)
        int filternamelen;
        long read_write = 0;
        zval *filterparams = NULL;
-       php_stream_filter *filter;
+       php_stream_filter *filter = NULL;
 
        if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "rs|lz", &zstream,
                                &filtername, &filternamelen, &read_write, &filterparams) == FAILURE) {
@@ -1036,10 +1036,14 @@ static void apply_filter_to_stream(int append, INTERNAL_FUNCTION_PARAMETERS)
                }
        }
 
-       RETURN_TRUE;
+       if (filter) {
+               RETURN_RESOURCE(ZEND_REGISTER_RESOURCE(NULL, filter, php_file_le_stream_filter()));
+       } else {
+               RETURN_FALSE;
+       }
 }
 
-/* {{{ proto bool stream_filter_prepend(resource stream, string filtername[, int read_write[, string filterparams]])
+/* {{{ proto resource stream_filter_prepend(resource stream, string filtername[, int read_write[, string filterparams]])
    Prepend a filter to a stream */
 PHP_FUNCTION(stream_filter_prepend)
 {
@@ -1047,7 +1051,7 @@ PHP_FUNCTION(stream_filter_prepend)
 }
 /* }}} */
 
-/* {{{ proto bool stream_filter_append(resource stream, string filtername[, int read_write[, string filterparams]])
+/* {{{ proto resource stream_filter_append(resource stream, string filtername[, int read_write[, string filterparams]])
    Append a filter to a stream */
 PHP_FUNCTION(stream_filter_append)
 {
@@ -1055,6 +1059,36 @@ PHP_FUNCTION(stream_filter_append)
 }
 /* }}} */
 
+/* {{{ proto bool stream_filter_remove(resource stream_filter)
+       Flushes any data in the filter's internal buffer, removes it from the chain, and frees the resource */
+PHP_FUNCTION(stream_filter_remove)
+{
+       zval *zfilter;
+       php_stream_filter *filter;
+
+       if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "r", &zfilter) == FAILURE) {
+               RETURN_FALSE;
+       }
+
+       filter = zend_fetch_resource(&zfilter TSRMLS_CC, -1, NULL, NULL, 1, php_file_le_stream_filter());
+       if (!filter) {
+               php_error_docref(NULL TSRMLS_CC, E_WARNING, "Invalid resource given, not a stream filter");
+               RETURN_FALSE;
+       }
+
+       if (php_stream_filter_flush(filter, 1) == FAILURE) {
+               php_error_docref(NULL TSRMLS_CC, E_WARNING, "Unable to flush filter, not removing");
+               RETURN_FALSE;
+       }
+
+       if (zend_list_delete(Z_LVAL_P(zfilter)) == FAILURE) {
+               php_error_docref(NULL TSRMLS_CC, E_WARNING, "Could not invalidate filter, not removing");
+               RETURN_FALSE;
+       } else {
+               php_stream_filter_remove(filter, 1 TSRMLS_CC);
+               RETURN_TRUE;
+       }
+}
 /* }}} */
 
 /* {{{ proto string stream_get_line(resource stream, int maxlen, string ending)

diff --git a/ext/standard/streamsfuncs.h b/ext/standard/streamsfuncs.h
index 9b391b0c4795e600c7dc949b564457c0d519a2c4..afe36c384e9c94bfe0ff41788dbf007e325dc437 100644 (file)
--- a/ext/standard/streamsfuncs.h
+++ b/ext/standard/streamsfuncs.h
@@ -52,6 +52,7 @@ PHP_FUNCTION(stream_context_get_options);
 PHP_FUNCTION(stream_context_get_default);
 PHP_FUNCTION(stream_filter_prepend);
 PHP_FUNCTION(stream_filter_append);
+PHP_FUNCTION(stream_filter_remove);
 PHP_FUNCTION(stream_socket_enable_crypto);
 
 /*

diff --git a/main/php_streams.h b/main/php_streams.h
index 290ec14e32af400cd69460ddab2b7db5a77924e4..1c9802f93a2228590efd9fed5da8ce87485d7d3d 100755 (executable)
--- a/main/php_streams.h
+++ b/main/php_streams.h
@@ -30,6 +30,7 @@
 BEGIN_EXTERN_C()
 PHPAPI int php_file_le_stream(void);
 PHPAPI int php_file_le_pstream(void);
+PHPAPI int php_file_le_stream_filter(void);
 END_EXTERN_C()
 
 /* {{{ Streams memory debugging stuff */

diff --git a/main/streams/filter.c b/main/streams/filter.c
index da61c714fac8a5977d09f4ac61193c1c1ef4935c..37ab4c14d568255f89b93bc256937d31d0ba92ec 100644 (file)
--- a/main/streams/filter.c
+++ b/main/streams/filter.c
@@ -405,6 +405,88 @@ PHPAPI void _php_stream_filter_append(php_stream_filter_chain *chain, php_stream
 
 }
 
+PHPAPI int _php_stream_filter_flush(php_stream_filter *filter, int finish TSRMLS_DC)
+{
+       php_stream_bucket_brigade brig_a = { NULL, NULL }, brig_b = { NULL, NULL }, *inp = &brig_a, *outp = &brig_b, *brig_temp;
+       php_stream_bucket *bucket;
+       php_stream_filter_chain *chain;
+       php_stream_filter *current;
+       php_stream *stream;
+       size_t flushed_size = 0;
+       long flags = (finish ? PSFS_FLAG_FLUSH_CLOSE : PSFS_FLAG_FLUSH_INC);
+
+       if (!filter->chain || !filter->chain->stream) {
+               /* Filter is not attached to a chain, or chain is somehow not part of a stream */
+               return FAILURE;
+       }
+
+       chain = filter->chain;
+       stream = chain->stream;
+
+       for(current = filter; current; current = current->next) {
+               php_stream_filter_status_t status;
+
+               status = filter->fops->filter(stream, filter, inp, outp, NULL, flags TSRMLS_CC);
+               if (status == PSFS_FEED_ME) {
+                       /* We've flushed the data far enough */
+                       return SUCCESS;
+               }
+               if (status == PSFS_ERR_FATAL) {
+                       return FAILURE;
+               }
+               /* Otherwise we have data available to PASS_ON
+                       Swap the brigades and continue */
+               brig_temp = inp;
+               inp = outp;
+               outp = brig_temp;
+               outp->head = NULL;
+               outp->tail = NULL;
+
+               flags = PSFS_FLAG_NORMAL;
+       }
+
+       /* Last filter returned data via PSFS_PASS_ON
+               Do something with it */
+
+       for(bucket = inp->head; bucket; bucket = bucket->next) {
+               flushed_size += bucket->buflen;
+       }
+
+       if (flushed_size == 0) {
+               /* Unlikely, but possible */
+               return SUCCESS;
+       }
+
+       if (chain == &(stream->readfilters)) {
+               /* Dump any newly flushed data to the read buffer */
+               if (stream->readpos > 0) {
+                       /* Back the buffer up */
+                       memcpy(stream->readbuf, stream->readbuf + stream->readpos, stream->writepos - stream->readpos);
+                       stream->readpos = 0;
+                       stream->writepos -= stream->readpos;
+               }
+               if (flushed_size > (stream->readbuflen - stream->writepos)) {
+                       /* Grow the buffer */
+                       stream->readbuf = perealloc(stream->readbuf, stream->writepos + flushed_size + stream->chunk_size, stream->is_persistent);
+               }
+               while ((bucket = inp->head)) {
+                       memcpy(stream->readbuf + stream->writepos, bucket->buf, bucket->buflen);
+                       stream->writepos += bucket->buflen;
+                       php_stream_bucket_unlink(bucket TSRMLS_CC);
+                       php_stream_bucket_delref(bucket TSRMLS_CC);
+               }
+       } else if (chain == &(stream->writefilters)) {
+               /* Send flushed data to the stream */
+               while ((bucket = inp->head)) {
+                       stream->ops->write(stream, bucket->buf, bucket->buflen TSRMLS_CC);
+                       php_stream_bucket_unlink(bucket TSRMLS_CC);
+                       php_stream_bucket_delref(bucket TSRMLS_CC);
+               }
+       }
+
+       return SUCCESS;
+}
+
 PHPAPI php_stream_filter *php_stream_filter_remove(php_stream_filter *filter, int call_dtor TSRMLS_DC)
 {
        if (filter->prev) {

diff --git a/main/streams/php_stream_filter_api.h b/main/streams/php_stream_filter_api.h
index 733d1c52211efa21831d7c07802367443babe5d6..6ee8192923a5222ff697e3f7ffc11c4043a467a5 100644 (file)
--- a/main/streams/php_stream_filter_api.h
+++ b/main/streams/php_stream_filter_api.h
@@ -123,6 +123,7 @@ struct _php_stream_filter {
 BEGIN_EXTERN_C()
 PHPAPI void _php_stream_filter_prepend(php_stream_filter_chain *chain, php_stream_filter *filter TSRMLS_DC);
 PHPAPI void _php_stream_filter_append(php_stream_filter_chain *chain, php_stream_filter *filter TSRMLS_DC);
+PHPAPI int _php_stream_filter_flush(php_stream_filter *filter, int finish TSRMLS_DC);
 PHPAPI php_stream_filter *php_stream_filter_remove(php_stream_filter *filter, int call_dtor TSRMLS_DC);
 PHPAPI void php_stream_filter_free(php_stream_filter *filter TSRMLS_DC);
 PHPAPI php_stream_filter *_php_stream_filter_alloc(php_stream_filter_ops *fops, void *abstract, int persistent STREAMS_DC TSRMLS_DC);
@@ -131,6 +132,7 @@ END_EXTERN_C()
 #define php_stream_filter_alloc_rel(fops, thisptr, persistent) _php_stream_filter_alloc((fops), (thisptr), (persistent) STREAMS_REL_CC TSRMLS_CC)
 #define php_stream_filter_prepend(chain, filter) _php_stream_filter_prepend((chain), (filter) TSRMLS_CC)
 #define php_stream_filter_append(chain, filter) _php_stream_filter_append((chain), (filter) TSRMLS_CC)
+#define php_stream_filter_flush(filter, finish) _php_stream_filter_flush((filter), (finish) TSRMLS_CC)
 
 #define php_stream_is_filtered(stream) ((stream)->readfilters.head || (stream)->writefilters.head)
 

diff --git a/main/streams/streams.c b/main/streams/streams.c
index bb2b137c3281799e57852cc939221d30f28114f6..6242afcf82773cddb0e8f131cd0150fb8fa410bb 100755 (executable)
--- a/main/streams/streams.c
+++ b/main/streams/streams.c
@@ -38,6 +38,7 @@
 static HashTable url_stream_wrappers_hash;
 static int le_stream = FAILURE; /* true global */
 static int le_pstream = FAILURE; /* true global */
+static int le_stream_filter = FAILURE; /* true global */
 
 PHPAPI int php_file_le_stream(void)
 {
@@ -49,6 +50,11 @@ PHPAPI int php_file_le_pstream(void)
        return le_pstream;
 }
 
+PHPAPI int php_file_le_stream_filter(void)
+{
+       return le_stream_filter;
+}
+
 PHPAPI HashTable *_php_stream_get_url_stream_wrappers_hash(TSRMLS_D)
 {
        return (FG(stream_wrappers) ? FG(stream_wrappers) : &url_stream_wrappers_hash);
@@ -1370,6 +1376,9 @@ int php_init_stream_wrappers(int module_number TSRMLS_DC)
        le_stream = zend_register_list_destructors_ex(stream_resource_regular_dtor, NULL, "stream", module_number);
        le_pstream = zend_register_list_destructors_ex(NULL, stream_resource_persistent_dtor, "persistent stream", module_number);
 
+       /* Filters are cleaned up by the streams they're attached to */
+       le_stream_filter = zend_register_list_destructors_ex(NULL, NULL, "stream filter", module_number);
+
        return (
                        zend_hash_init(&url_stream_wrappers_hash, 0, NULL, NULL, 1) == SUCCESS
                        &&