stream: break current streams API for cleaner design

Author: bukka

main/streams/filter.c

@@ -216,7 +216,7 @@ PHPAPI void php_stream_bucket_unlink(php_stream_bucket *bucket)
  * match. If that fails, we try "convert.charset.*", then "convert.*"
  * This means that we don't need to clog up the hashtable with a zillion
  * charsets (for example) but still be able to provide them all as filters */
-PHPAPI php_stream_filter *php_stream_filter_create(const char *filtername, zval *filterparams, uint8_t persistent)
+PHPAPI php_stream_filter *php_stream_filter_create(const char *filtername, zval *filterparams, bool persistent)
 {
 	HashTable *filter_hash = (FG(stream_filters) ? FG(stream_filters) : &stream_filters_hash);
 	const php_stream_filter_factory *factory = NULL;
@@ -260,37 +260,22 @@ PHPAPI php_stream_filter *php_stream_filter_create(const char *filtername, zval
 	return filter;
 }
 
-PHPAPI php_stream_filter *_php_stream_filter_alloc_ex(const php_stream_filter_ops *fops,
-		const php_stream_filter_extra_ops *feops, void *abstract, uint8_t persistent, uint16_t flags STREAMS_DC)
+PHPAPI php_stream_filter *_php_stream_filter_alloc(const php_stream_filter_ops *fops,
+		void *abstract, bool persistent, uint32_t flags STREAMS_DC)
 {
 	php_stream_filter *filter;
 
 	filter = (php_stream_filter*) pemalloc_rel_orig(sizeof(php_stream_filter), persistent);
 	memset(filter, 0, sizeof(php_stream_filter));
 
 	filter->fops = fops;
-	filter->feops = feops;
 	filter->seekable = flags & PHP_STREAM_FILTER_SEEKABLE_MASK;
 	Z_PTR(filter->abstract) = abstract;
 	filter->is_persistent = persistent;
 
 	return filter;
 }
 
-PHPAPI php_stream_filter *_php_stream_filter_alloc(const php_stream_filter_ops *fops, void *abstract, uint8_t persistent STREAMS_DC)
-{
-	php_stream_filter *filter;
-
-	filter = (php_stream_filter*) pemalloc_rel_orig(sizeof(php_stream_filter), persistent);
-	memset(filter, 0, sizeof(php_stream_filter));
-
-	filter->fops = fops;
-	Z_PTR(filter->abstract) = abstract;
-	filter->is_persistent = persistent;
-
-	return filter;
-}
-
 PHPAPI void php_stream_filter_free(php_stream_filter *filter)
 {
 	if (filter->fops->dtor)

main/streams/php_stream_filter_api.h

@@ -36,7 +36,8 @@
 
 #define PHP_STREAM_FILTER_SEEKABLE_NEVER  0
 #define PHP_STREAM_FILTER_SEEKABLE_START  1
-#define PHP_STREAM_FILTER_SEEKABLE_ALWAYS 2
+#define PHP_STREAM_FILTER_SEEKABLE_CHECK  2
+#define PHP_STREAM_FILTER_SEEKABLE_ALWAYS 3
 #define PHP_STREAM_FILTER_SEEKABLE_MASK   3
 
 typedef struct _php_stream_bucket			php_stream_bucket;
@@ -93,31 +94,18 @@ typedef struct _php_stream_filter_ops {
 			int flags
 			);
 
-	void (*dtor)(php_stream_filter *thisfilter);
-
-	const char *label;
-
-} php_stream_filter_ops;
-
-typedef struct _php_stream_filter_extra_ops {
-	/* it should indicate whether seeking is supported and possibly modify internal state */
 	zend_result (*seek)(
 			php_stream *stream,
 			php_stream_filter *thisfilter,
 			zend_off_t offset,
 			int whence
 	);
 
-	/* this is a generic interface for possible further extensions */
-	zend_result (*set_option)(
-			php_stream *stream,
-			php_stream_filter *thisfilter,
-			int option,
-			void *value,
-			size_t size
-	);
+	void (*dtor)(php_stream_filter *thisfilter);
 
-} php_stream_filter_extra_ops;
+	const char *label;
+
+} php_stream_filter_ops;
 
 typedef struct _php_stream_filter_chain {
 	php_stream_filter *head, *tail;
@@ -128,7 +116,6 @@ typedef struct _php_stream_filter_chain {
 
 struct _php_stream_filter {
 	const php_stream_filter_ops *fops;
-	const php_stream_filter_extra_ops *feops;
 	zval abstract; /* for use by filter implementation */
 	php_stream_filter *next;
 	php_stream_filter *prev;
@@ -154,27 +141,27 @@ PHPAPI zend_result php_stream_filter_append_ex(php_stream_filter_chain *chain, p
 PHPAPI zend_result _php_stream_filter_flush(php_stream_filter *filter, bool finish);
 PHPAPI php_stream_filter *php_stream_filter_remove(php_stream_filter *filter, bool call_dtor);
 PHPAPI void php_stream_filter_free(php_stream_filter *filter);
-PHPAPI php_stream_filter *_php_stream_filter_alloc(const php_stream_filter_ops *fops, void *abstract, uint8_t persistent STREAMS_DC);
-PHPAPI php_stream_filter *_php_stream_filter_alloc_ex(const php_stream_filter_ops *fops,
-		const php_stream_filter_extra_ops *feops, void *abstract, uint8_t persistent, uint16_t flags STREAMS_DC);
+PHPAPI php_stream_filter *_php_stream_filter_alloc(const php_stream_filter_ops *fops,
+		void *abstract, bool persistent, uint32_t flags STREAMS_DC);
+
 END_EXTERN_C()
-#define php_stream_filter_alloc(fops, thisptr, persistent) _php_stream_filter_alloc((fops), (thisptr), (persistent) STREAMS_CC)
-#define php_stream_filter_alloc_ex(fops, feops, thisptr, persistent) \
-	_php_stream_filter_alloc_ex((fops), (feops), (thisptr), (persistent) STREAMS_CC)
-#define php_stream_filter_alloc_rel(fops, thisptr, persistent) _php_stream_filter_alloc((fops), (thisptr), (persistent) STREAMS_REL_CC)
+#define php_stream_filter_alloc(fops, thisptr, persistent, flags) \
+		_php_stream_filter_alloc((fops), (thisptr), (persistent), (flags) STREAMS_CC)
+#define php_stream_filter_alloc_rel(fops, thisptr, persistent, flags) \
+	_php_stream_filter_alloc((fops), (thisptr), (persistent), (flags) STREAMS_REL_CC)
 #define php_stream_filter_prepend(chain, filter) _php_stream_filter_prepend((chain), (filter))
 #define php_stream_filter_append(chain, filter) _php_stream_filter_append((chain), (filter))
 #define php_stream_filter_flush(filter, finish) _php_stream_filter_flush((filter), (finish))
 
 #define php_stream_is_filtered(stream)	((stream)->readfilters.head || (stream)->writefilters.head)
 
 typedef struct _php_stream_filter_factory {
-	php_stream_filter *(*create_filter)(const char *filtername, zval *filterparams, uint8_t persistent);
+	php_stream_filter *(*create_filter)(const char *filtername, zval *filterparams, bool persistent);
 } php_stream_filter_factory;
 
 BEGIN_EXTERN_C()
 PHPAPI zend_result php_stream_filter_register_factory(const char *filterpattern, const php_stream_filter_factory *factory);
 PHPAPI zend_result php_stream_filter_unregister_factory(const char *filterpattern);
 PHPAPI zend_result php_stream_filter_register_factory_volatile(zend_string *filterpattern, const php_stream_filter_factory *factory);
-PHPAPI php_stream_filter *php_stream_filter_create(const char *filtername, zval *filterparams, uint8_t persistent);
+PHPAPI php_stream_filter *php_stream_filter_create(const char *filtername, zval *filterparams, bool persistent);
 END_EXTERN_C()

main/streams/streams.c

@@ -1377,8 +1377,9 @@ static bool php_stream_are_filters_seekable(php_stream_filter *filter, bool is_s
 static zend_result php_stream_filters_seek(php_stream *stream, php_stream_filter *filter, bool is_start_seeking)
 {
 	while (filter) {
-		if ((filter->seekable == PHP_STREAM_FILTER_SEEKABLE_START && is_start_seeking &&
-				filter->feops->seek(stream, filter, 0, SEEK_SET))) {
+		if (((filter->seekable == PHP_STREAM_FILTER_SEEKABLE_START && is_start_seeking) ||
+				filter->seekable == PHP_STREAM_FILTER_SEEKABLE_CHECK) &&
+				filter->fops->seek(stream, filter, 0, SEEK_SET)) {
 			php_error_docref(NULL, E_WARNING, "Stream filter seeking for %s failed", filter->fops->label);
 			return FAILURE;
 		}