Do not warn that user stream does not implement cast when checking for a cast

Author: Girgias

ext/standard/streamsfuncs.c

@@ -72,14 +72,14 @@ PHP_FUNCTION(stream_socket_pair)
         close(pair[0]);
         close(pair[1]);
         php_error_docref(NULL, E_WARNING, "Failed to open stream from socketpair");
-        RETURN_FALSE;        
+        RETURN_FALSE;
     }
     s2 = php_stream_sock_open_from_socket(pair[1], 0);
     if (s2 == NULL) {
         php_stream_free(s1, PHP_STREAM_FREE_CLOSE);
         close(pair[1]);
         php_error_docref(NULL, E_WARNING, "Failed to open stream from socketpair");
-        RETURN_FALSE;        
+        RETURN_FALSE;
     }
 
     array_init(return_value);

main/streams/cast.c

@@ -187,6 +187,12 @@ void php_stream_mode_sanitize_fdopen_fopencookie(php_stream *stream, char *resul
 }
 /* }}} */
 
+static inline bool is_stream_user_stream(const php_stream *stream)
+{
+	return (strlen(stream->ops->label) == strlen("user-space"))
+		&& strncmp(stream->ops->label, "user-space", strlen("user-space")) == 0;
+}
+
 /* {{{ php_stream_cast */
 PHPAPI int _php_stream_cast(php_stream *stream, int castas, void **ret, int show_err)
 {
@@ -196,6 +202,10 @@ PHPAPI int _php_stream_cast(php_stream *stream, int castas, void **ret, int show
 	/* synchronize our buffer (if possible) */
 	if (ret && castas != PHP_STREAM_AS_FD_FOR_SELECT) {
 		php_stream_flush(stream);
+		/* Do special handling for user streams as they may not implement the cast method */
+		if (!show_err && is_stream_user_stream(stream)) {
+			castas |= PHP_STREAM_FLAG_SUPPRESS_ERRORS;
+		}
 		if (stream->ops->seek && (stream->flags & PHP_STREAM_FLAG_NO_SEEK) == 0) {
 			zend_off_t dummy;
 
@@ -214,6 +224,11 @@ PHPAPI int _php_stream_cast(php_stream *stream, int castas, void **ret, int show
 			goto exit_success;
 		}
 
+		/* Do special handling for user streams as they may not implement the cast method */
+		if (!show_err && is_stream_user_stream(stream)) {
+			castas |= PHP_STREAM_FLAG_SUPPRESS_ERRORS;
+		}
+
 		/* if the stream is a stdio stream let's give it a chance to respond
 		 * first, to avoid doubling up the layers of stdio with an fopencookie */
 		if (php_stream_is(stream, PHP_STREAM_IS_STDIO) &&
@@ -299,8 +314,14 @@ PHPAPI int _php_stream_cast(php_stream *stream, int castas, void **ret, int show
 			php_error_docref(NULL, E_WARNING, "Cannot cast a filtered stream on this system");
 		}
 		return FAILURE;
-	} else if (stream->ops->cast && stream->ops->cast(stream, castas, ret) == SUCCESS) {
-		goto exit_success;
+	} else if (stream->ops->cast) {
+		/* Do special handling for user streams as they may not implement the cast method */
+		if (!show_err && is_stream_user_stream(stream)) {
+			castas |= PHP_STREAM_FLAG_SUPPRESS_ERRORS;
+		}
+		if (stream->ops->cast(stream, castas, ret) == SUCCESS) {
+			goto exit_success;
+		}
 	}
 
 	if (show_err) {

main/streams/userspace.c

@@ -1373,6 +1373,8 @@ static int php_userstreamop_rewinddir(php_stream *stream, zend_off_t offset, int
 
 }
 
+/* The user stream overloads the castas parameter by accepting PHP_STREAM_FLAG_SUPPRESS_ERRORS as a bitmask
+ * If present the call is silent, otherwise it will report errors  */
 static int php_userstreamop_cast(php_stream *stream, int castas, void **retptr)
 {
 	php_userstream_data_t *us = (php_userstream_data_t *)stream->abstract;
@@ -1382,6 +1384,8 @@ static int php_userstreamop_cast(php_stream *stream, int castas, void **retptr)
 	php_stream * intstream = NULL;
 	int call_result;
 	int ret = FAILURE;
+	bool report_errors = !(castas & PHP_STREAM_FLAG_SUPPRESS_ERRORS);
+	castas &= ~PHP_STREAM_FLAG_SUPPRESS_ERRORS;
 
 	ZVAL_STRINGL(&func_name, USERSTREAM_CAST, sizeof(USERSTREAM_CAST)-1);
 
@@ -1398,22 +1402,28 @@ static int php_userstreamop_cast(php_stream *stream, int castas, void **retptr)
 
 	do {
 		if (call_result == FAILURE) {
-			php_error_docref(NULL, E_WARNING, "%s::" USERSTREAM_CAST " is not implemented!",
+			if (report_errors) {
+				php_error_docref(NULL, E_WARNING, "%s::" USERSTREAM_CAST " is not implemented!",
 					ZSTR_VAL(us->wrapper->ce->name));
+			}
 			break;
 		}
 		if (!zend_is_true(&retval)) {
 			break;
 		}
 		php_stream_from_zval_no_verify(intstream, &retval);
 		if (!intstream) {
-			php_error_docref(NULL, E_WARNING, "%s::" USERSTREAM_CAST " must return a stream resource",
+			if (report_errors) {
+				php_error_docref(NULL, E_WARNING, "%s::" USERSTREAM_CAST " must return a stream resource",
 					ZSTR_VAL(us->wrapper->ce->name));
+			}
 			break;
 		}
 		if (intstream == stream) {
-			php_error_docref(NULL, E_WARNING, "%s::" USERSTREAM_CAST " must not return itself",
+			if (report_errors) {
+				php_error_docref(NULL, E_WARNING, "%s::" USERSTREAM_CAST " must not return itself",
 					ZSTR_VAL(us->wrapper->ce->name));
+			}
 			intstream = NULL;
 			break;
 		}

tests/output/stream_isatty_non_castable_userwrapper.phpt

@@ -18,8 +18,5 @@ $fd = fopen("test://foo","r");
 var_dump(stream_isatty($fd));
 
 ?>
---EXPECTF--
-Warning: stream_isatty(): test_wrapper::stream_cast is not implemented! in %s on line %d
-
-Warning: stream_isatty(): test_wrapper::stream_cast is not implemented! in %s on line %d
+--EXPECT--
 bool(false)