/src/php-src/ext/standard/streamsfuncs.c

Source
/*
  +----------------------------------------------------------------------+
  | Copyright © The PHP Group and Contributors.                          |
  +----------------------------------------------------------------------+
  | This source file is subject to the Modified BSD License that is      |
  | bundled with this package in the file LICENSE, and is available      |
  | through the World Wide Web at <https://www.php.net/license/>.        |
  |                                                                      |
  | SPDX-License-Identifier: BSD-3-Clause                                |
  +----------------------------------------------------------------------+
  | Authors: Wez Furlong <wez@thebrainroom.com>                          |
  |          Sara Golemon <pollita@php.net>                              |
  +----------------------------------------------------------------------+
*/

#include "php.h"
#include "ext/standard/flock_compat.h"
#include "ext/standard/file.h"
#include "ext/standard/basic_functions.h"
#include "php_ini.h"
#include "streamsfuncs.h"
#include "php_network.h"
#include "php_string.h"
#ifdef HAVE_UNISTD_H
#include <unistd.h>
#endif

#ifndef PHP_WIN32
#define php_select(m, r, w, e, t) select(m, r, w, e, t)
typedef unsigned long long php_timeout_ull;
#else
#include "win32/select.h"
#include "win32/sockets.h"
#include "win32/console.h"
typedef unsigned __int64 php_timeout_ull;
#endif

#define GET_CTX_OPT(stream, wrapper, name, val) (PHP_STREAM_CONTEXT(stream) && NULL != (val = php_stream_context_get_option(PHP_STREAM_CONTEXT(stream), wrapper, name)))

static php_stream_context *decode_context_param(zval *contextresource);

/* Streams based network functions */

#ifdef HAVE_SOCKETPAIR
/* {{{ Creates a pair of connected, indistinguishable socket streams */
PHP_FUNCTION(stream_socket_pair)
{
  zend_long domain, type, protocol;
  php_stream *s1, *s2;
  php_socket_t pair[2];
  zval *zcontext = NULL;
  php_stream_context *context = NULL;

  ZEND_PARSE_PARAMETERS_START(3, 4)
    Z_PARAM_LONG(domain)
    Z_PARAM_LONG(type)
    Z_PARAM_LONG(protocol)
    Z_PARAM_OPTIONAL
    Z_PARAM_RESOURCE_OR_NULL(zcontext)
  ZEND_PARSE_PARAMETERS_END();

  if (0 != socketpair((int)domain, (int)type, (int)protocol, pair)) {
    char errbuf[256];
    php_error_docref(NULL, E_WARNING, "Failed to create sockets: [%d]: %s",
      php_socket_errno(), php_socket_strerror(php_socket_errno(), errbuf, sizeof(errbuf)));
    RETURN_FALSE;
  }

  php_stream_error_operation_begin();
  context = php_stream_context_from_zval(zcontext, 0);

    s1 = php_stream_sock_open_from_socket(pair[0], 0);
    if (s1 == NULL) {
        close(pair[0]);
        close(pair[1]);
    php_stream_error_operation_end(context);
        php_error_docref(NULL, E_WARNING, "Failed to open stream from socketpair");
        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_stream_error_operation_end(context);
        php_error_docref(NULL, E_WARNING, "Failed to open stream from socketpair");
        RETURN_FALSE;
    }

    array_init(return_value);

  /* set the __exposed flag.
   * php_stream_to_zval() does, add_next_index_resource() does not */
  php_stream_auto_cleanup(s1);
  php_stream_auto_cleanup(s2);

  add_next_index_resource(return_value, s1->res);
  add_next_index_resource(return_value, s2->res);

  php_stream_error_operation_end(context);
}
/* }}} */
#endif

/* {{{ Open a client connection to a remote address */
PHP_FUNCTION(stream_socket_client)
{
  zend_string *host;
  zval *zerrno = NULL, *zerrstr = NULL, *zcontext = NULL;
  double timeout;
  bool timeout_is_null = 1;
  struct timeval tv;
  char *hashkey = NULL;
  php_stream *stream = NULL;
  int err;
  zend_long flags = PHP_STREAM_CLIENT_CONNECT;
  zend_string *errstr = NULL;
  php_stream_context *context = NULL;

  ZEND_PARSE_PARAMETERS_START(1, 6)
    Z_PARAM_STR(host)
    Z_PARAM_OPTIONAL
    Z_PARAM_ZVAL(zerrno)
    Z_PARAM_ZVAL(zerrstr)
    Z_PARAM_DOUBLE_OR_NULL(timeout, timeout_is_null)
    Z_PARAM_LONG(flags)
    Z_PARAM_RESOURCE_OR_NULL(zcontext)
  ZEND_PARSE_PARAMETERS_END();

  RETVAL_FALSE;

  if (timeout_is_null) {
    timeout = (double)FG(default_socket_timeout);
  } else if (!zend_finite(timeout)) {
    zend_argument_value_error(4, "must be a finite value");
    RETURN_THROWS();
  }

  php_stream_error_operation_begin();
  context = php_stream_context_from_zval(zcontext, flags & PHP_FILE_NO_DEFAULT_CONTEXT);

  if (flags & PHP_STREAM_CLIENT_PERSISTENT) {
    spprintf(&hashkey, 0, "stream_socket_client__%s", ZSTR_VAL(host));
  }

  /* prepare the timeout value for use */
  struct timeval *tv_pointer;
  if (timeout < 0.0 || timeout >= (double) PHP_TIMEOUT_ULL_MAX / 1000000.0) {
    tv_pointer = NULL;
  } else {
    php_timeout_ull conv = (php_timeout_ull) (timeout * 1000000.0);
#ifdef PHP_WIN32
    tv.tv_sec = (long)(conv / 1000000);
    tv.tv_usec = (long)(conv % 1000000);
#else
    tv.tv_sec = conv / 1000000;
    tv.tv_usec = conv % 1000000;
#endif
    tv_pointer = &tv;
  }

  if (zerrno) {
    ZEND_TRY_ASSIGN_REF_LONG(zerrno, 0);
  }
  if (zerrstr) {
    ZEND_TRY_ASSIGN_REF_EMPTY_STRING(zerrstr);
  }

  stream = php_stream_xport_create(ZSTR_VAL(host), ZSTR_LEN(host), REPORT_ERRORS,
      STREAM_XPORT_CLIENT | (flags & PHP_STREAM_CLIENT_CONNECT ? STREAM_XPORT_CONNECT : 0) |
      (flags & PHP_STREAM_CLIENT_ASYNC_CONNECT ? STREAM_XPORT_CONNECT_ASYNC : 0),
      hashkey, tv_pointer, context, &errstr, &err);

  php_stream_error_operation_end(context);

  if (stream == NULL) {
    /* host might contain binary characters */
    zend_string *quoted_host = php_addslashes(host);

    php_error_docref(NULL, E_WARNING, "Unable to connect to %s (%s)", ZSTR_VAL(quoted_host), errstr == NULL ? "Unknown error" : ZSTR_VAL(errstr));
    zend_string_release_ex(quoted_host, 0);
  }

  if (hashkey) {
    efree(hashkey);
  }

  if (stream == NULL) {
    if (zerrno) {
      ZEND_TRY_ASSIGN_REF_LONG(zerrno, err);
    }
    if (zerrstr && errstr) {
      ZEND_TRY_ASSIGN_REF_STR(zerrstr, errstr);
    } else if (errstr) {
      zend_string_release_ex(errstr, 0);
    }
    RETURN_FALSE;
  }

  if (errstr) {
    zend_string_release_ex(errstr, 0);
  }

  php_stream_to_zval(stream, return_value);

}
/* }}} */

/* {{{ Create a server socket bound to localaddress */
PHP_FUNCTION(stream_socket_server)
{
  char *host;
  size_t host_len;
  zval *zerrno = NULL, *zerrstr = NULL, *zcontext = NULL;
  php_stream *stream = NULL;
  int err = 0;
  zend_long flags = STREAM_XPORT_BIND | STREAM_XPORT_LISTEN;
  zend_string *errstr = NULL;
  php_stream_context *context = NULL;

  RETVAL_FALSE;

  ZEND_PARSE_PARAMETERS_START(1, 5)
    Z_PARAM_STRING(host, host_len)
    Z_PARAM_OPTIONAL
    Z_PARAM_ZVAL(zerrno)
    Z_PARAM_ZVAL(zerrstr)
    Z_PARAM_LONG(flags)
    Z_PARAM_RESOURCE_OR_NULL(zcontext)
  ZEND_PARSE_PARAMETERS_END();

  php_stream_error_operation_begin();
  context = php_stream_context_from_zval(zcontext, flags & PHP_FILE_NO_DEFAULT_CONTEXT);

  if (zerrno) {
    ZEND_TRY_ASSIGN_REF_LONG(zerrno, 0);
  }
  if (zerrstr) {
    ZEND_TRY_ASSIGN_REF_EMPTY_STRING(zerrstr);
  }

  stream = php_stream_xport_create(host, host_len, REPORT_ERRORS,
      STREAM_XPORT_SERVER | (int)flags,
      NULL, NULL, context, &errstr, &err);

  php_stream_error_operation_end(context);

  if (stream == NULL) {
    php_error_docref(NULL, E_WARNING, "Unable to connect to %s (%s)", host, errstr == NULL ? "Unknown error" : ZSTR_VAL(errstr));
  }

  if (stream == NULL) {
    if (zerrno) {
      ZEND_TRY_ASSIGN_REF_LONG(zerrno, err);
    }
    if (zerrstr && errstr) {
      ZEND_TRY_ASSIGN_REF_STR(zerrstr, errstr);
    } else if (errstr) {
      zend_string_release_ex(errstr, 0);
    }
    RETURN_FALSE;
  }

  if (errstr) {
    zend_string_release_ex(errstr, 0);
  }

  php_stream_to_zval(stream, return_value);
}
/* }}} */

/* {{{ Accept a client connection from a server socket */
PHP_FUNCTION(stream_socket_accept)
{
  double timeout;
  bool timeout_is_null = 1;
  zval *zpeername = NULL;
  zend_string *peername = NULL;
  struct timeval tv;
  php_stream *stream = NULL, *clistream = NULL;
  zend_string *errstr = NULL;

  ZEND_PARSE_PARAMETERS_START(1, 3)
    PHP_Z_PARAM_STREAM(stream)
    Z_PARAM_OPTIONAL
    Z_PARAM_DOUBLE_OR_NULL(timeout, timeout_is_null)
    Z_PARAM_ZVAL(zpeername)
  ZEND_PARSE_PARAMETERS_END();

  if (timeout_is_null) {
    timeout = (double)FG(default_socket_timeout);
  } else if (!zend_finite(timeout)) {
    zend_argument_value_error(2, "must be a finite value");
    RETURN_THROWS();
  }

  /* prepare the timeout value for use */
  struct timeval *tv_pointer;
  if (timeout < 0.0 || timeout >= (double) PHP_TIMEOUT_ULL_MAX / 1000000.0) {
    tv_pointer = NULL;
  } else {
    php_timeout_ull conv = (php_timeout_ull) (timeout * 1000000.0);
#ifdef PHP_WIN32
    tv.tv_sec = (long)(conv / 1000000);
    tv.tv_usec = (long)(conv % 1000000);
#else
    tv.tv_sec = conv / 1000000;
    tv.tv_usec = conv % 1000000;
#endif
    tv_pointer = &tv;
  }

  php_stream_error_operation_begin();

  if (0 == php_stream_xport_accept(stream, &clistream,
        zpeername ? &peername : NULL,
        NULL, NULL,
        tv_pointer, &errstr
        ) && clistream) {

    if (peername) {
      ZEND_TRY_ASSIGN_REF_STR(zpeername, peername);
    }
    php_stream_to_zval(clistream, return_value);
  } else {
    if (peername) {
      zend_string_release(peername);
    }
    php_error_docref(NULL, E_WARNING, "Accept failed: %s", errstr ? ZSTR_VAL(errstr) : "Unknown error");
    RETVAL_FALSE;
  }

  php_stream_error_operation_end_for_stream(stream);

  if (errstr) {
    zend_string_release_ex(errstr, 0);
  }
}
/* }}} */

/* {{{ Returns either the locally bound or remote name for a socket stream */
PHP_FUNCTION(stream_socket_get_name)
{
  php_stream *stream;
  bool want_peer;
  zend_string *name = NULL;

  ZEND_PARSE_PARAMETERS_START(2, 2)
    PHP_Z_PARAM_STREAM(stream)
    Z_PARAM_BOOL(want_peer)
  ZEND_PARSE_PARAMETERS_END();

  php_stream_error_operation_begin();
  int ret = php_stream_xport_get_name(stream, want_peer, &name, NULL, NULL);
  php_stream_error_operation_end_for_stream(stream);

  if (0 != ret || !name) {
    RETURN_FALSE;
  }

  if ((ZSTR_LEN(name) == 0) || (ZSTR_VAL(name)[0] == 0)) {
    zend_string_release_ex(name, 0);
    RETURN_FALSE;
  }

  RETVAL_STR(name);
}
/* }}} */

/* {{{ Send data to a socket stream.  If target_addr is specified it must be in dotted quad (or [ipv6]) format */
PHP_FUNCTION(stream_socket_sendto)
{
  php_stream *stream;
  zend_long flags = 0;
  char *data, *target_addr = NULL;
  size_t datalen, target_addr_len = 0;
  php_sockaddr_storage sa;
  socklen_t sl = 0;

  ZEND_PARSE_PARAMETERS_START(2, 4)
    PHP_Z_PARAM_STREAM(stream)
    Z_PARAM_STRING(data, datalen)
    Z_PARAM_OPTIONAL
    Z_PARAM_LONG(flags)
    Z_PARAM_STRING(target_addr, target_addr_len)
  ZEND_PARSE_PARAMETERS_END();

  php_stream_error_operation_begin();
  if (target_addr_len) {
    /* parse the address */
    if (FAILURE == php_network_parse_network_address_with_port(target_addr, target_addr_len, (struct sockaddr*)&sa, &sl)) {
      php_stream_error_operation_end_for_stream(stream);
      php_error_docref(NULL, E_WARNING, "Failed to parse `%s' into a valid network address", target_addr);
      RETURN_FALSE;
    }
  }

  RETVAL_LONG(php_stream_xport_sendto(stream, data, datalen, (int)flags, target_addr_len ? &sa : NULL, sl));
  php_stream_error_operation_end_for_stream(stream);
}
/* }}} */

/* {{{ Receives data from a socket stream */
PHP_FUNCTION(stream_socket_recvfrom)
{
  php_stream *stream;
  zval *zremote = NULL;
  zend_string *remote_addr = NULL;
  zend_long to_read = 0;
  zend_string *read_buf;
  zend_long flags = 0;
  int recvd;

  ZEND_PARSE_PARAMETERS_START(2, 4)
    PHP_Z_PARAM_STREAM(stream)
    Z_PARAM_LONG(to_read)
    Z_PARAM_OPTIONAL
    Z_PARAM_LONG(flags)
    Z_PARAM_ZVAL(zremote)
  ZEND_PARSE_PARAMETERS_END();

  if (zremote) {
    ZEND_TRY_ASSIGN_REF_NULL(zremote);
  }

  if (to_read <= 0) {
    zend_argument_value_error(2, "must be greater than 0");
    RETURN_THROWS();
  }

  read_buf = zend_string_alloc(to_read, 0);

  php_stream_error_operation_begin();
  recvd = php_stream_xport_recvfrom(stream, ZSTR_VAL(read_buf), to_read, (int)flags, NULL, NULL,
      zremote ? &remote_addr : NULL);
  php_stream_error_operation_end_for_stream(stream);

  if (recvd >= 0) {
    if (zremote && remote_addr) {
      ZEND_TRY_ASSIGN_REF_STR(zremote, remote_addr);
    }
    ZSTR_VAL(read_buf)[recvd] = '\0';
    ZSTR_LEN(read_buf) = recvd;
    RETURN_NEW_STR(read_buf);
  }

  zend_string_efree(read_buf);
  RETURN_FALSE;
}
/* }}} */

/* {{{ Reads all remaining bytes (or up to maxlen bytes) from a stream and returns them as a string. */
PHP_FUNCTION(stream_get_contents)
{
  php_stream *stream;
  zend_long maxlen, desiredpos = -1L;
  bool maxlen_is_null = 1;
  zend_string *contents;

  ZEND_PARSE_PARAMETERS_START(1, 3)
    PHP_Z_PARAM_STREAM(stream)
    Z_PARAM_OPTIONAL
    Z_PARAM_LONG_OR_NULL(maxlen, maxlen_is_null)
    Z_PARAM_LONG(desiredpos)
  ZEND_PARSE_PARAMETERS_END();

  if (maxlen_is_null) {
    maxlen = (ssize_t) PHP_STREAM_COPY_ALL;
  } else if (maxlen < 0 && maxlen != (ssize_t)PHP_STREAM_COPY_ALL) {
    zend_argument_value_error(2, "must be greater than or equal to -1");
    RETURN_THROWS();
  }

  php_stream_error_operation_begin();

  if (desiredpos >= 0) {
    int   seek_res = 0;
    zend_off_t  position;

    position = php_stream_tell(stream);
    if (position >= 0 && desiredpos > position) {
      /* use SEEK_CUR to allow emulation in streams that don't support seeking */
      seek_res = php_stream_seek(stream, desiredpos - position, SEEK_CUR);
    } else if (desiredpos < position)  {
      /* desired position before position or error on tell */
      seek_res = php_stream_seek(stream, desiredpos, SEEK_SET);
    }

    if (seek_res != 0) {
      php_stream_error_operation_end_for_stream(stream);
      php_error_docref(NULL, E_WARNING,
        "Failed to seek to position " ZEND_LONG_FMT " in the stream", desiredpos);
      RETURN_FALSE;
    }
  }

  if ((contents = php_stream_copy_to_mem(stream, maxlen, 0))) {
    RETVAL_STR(contents);
  } else {
    RETVAL_EMPTY_STRING();
  }
  php_stream_error_operation_end_for_stream(stream);
}
/* }}} */

/* {{{ Reads up to maxlen bytes from source stream and writes them to dest stream. */
PHP_FUNCTION(stream_copy_to_stream)
{
  php_stream *src, *dest;
  zend_long maxlen, pos = 0;
  bool maxlen_is_null = 1;
  size_t len;
  zval *zcontext = NULL;
  php_stream_context *context = NULL;

  ZEND_PARSE_PARAMETERS_START(2, 5)
    PHP_Z_PARAM_STREAM(src)
    PHP_Z_PARAM_STREAM(dest)
    Z_PARAM_OPTIONAL
    Z_PARAM_LONG_OR_NULL(maxlen, maxlen_is_null)
    Z_PARAM_LONG(pos)
    Z_PARAM_RESOURCE_OR_NULL(zcontext)
  ZEND_PARSE_PARAMETERS_END();

  if (maxlen_is_null) {
    maxlen = PHP_STREAM_COPY_ALL;
  }

  php_stream_error_operation_begin();
  context = php_stream_context_from_zval(zcontext, 0);

  if (pos > 0 && php_stream_seek(src, pos, SEEK_SET) < 0) {
    php_stream_error_operation_end(context);
    php_error_docref(NULL, E_WARNING, "Failed to seek to position " ZEND_LONG_FMT " in the stream", pos);
    RETURN_FALSE;
  }

  if (php_stream_copy_to_stream_ex(src, dest, maxlen, &len) != SUCCESS) {
    RETVAL_FALSE;
  } else {
    RETVAL_LONG(len);
  }
  php_stream_error_operation_end(context);
}
/* }}} */

/* {{{ Retrieves header/meta data from streams/file pointers */
PHP_FUNCTION(stream_get_meta_data)
{
  php_stream *stream;

  ZEND_PARSE_PARAMETERS_START(1, 1)
    PHP_Z_PARAM_STREAM(stream)
  ZEND_PARSE_PARAMETERS_END();

  array_init(return_value);

  php_stream_error_operation_begin();
  if (!php_stream_populate_meta_data(stream, return_value)) {
    add_assoc_bool(return_value, "timed_out", 0);
    add_assoc_bool(return_value, "blocked", 1);
    add_assoc_bool(return_value, "eof", php_stream_eof(stream));
  }
  php_stream_error_operation_end_for_stream(stream);

  if (!Z_ISUNDEF(stream->wrapperdata)) {
    Z_ADDREF_P(&stream->wrapperdata);
    add_assoc_zval(return_value, "wrapper_data", &stream->wrapperdata);
  }
  if (stream->wrapper) {
    add_assoc_string(return_value, "wrapper_type", stream->wrapper->wops->label);
  }
  add_assoc_string(return_value, "stream_type", stream->ops->label);

  add_assoc_string(return_value, "mode", stream->mode);

#if 0 /* TODO: needs updating for new filter API */
  if (stream->filterhead) {
    php_stream_filter *filter;

    MAKE_STD_ZVAL(newval);
    array_init(newval);

    for (filter = stream->filterhead; filter != NULL; filter = filter->next) {
      add_next_index_string(newval, filter->fops->label);
    }

    add_assoc_zval(return_value, "filters", newval);
  }
#endif

  add_assoc_long(return_value, "unread_bytes", stream->writepos - stream->readpos);

  add_assoc_bool(return_value, "seekable", (stream->ops->seek) && (stream->flags & PHP_STREAM_FLAG_NO_SEEK) == 0);
  if (stream->orig_path) {
    add_assoc_string(return_value, "uri", stream->orig_path);
  }

}
/* }}} */

/* {{{ Retrieves list of registered socket transports */
PHP_FUNCTION(stream_get_transports)
{

  ZEND_PARSE_PARAMETERS_NONE();

  array_init(return_value);

  const HashTable *stream_xport_hash = php_stream_xport_get_hash();
  zend_string *stream_xport;
  ZEND_HASH_MAP_FOREACH_STR_KEY(stream_xport_hash, stream_xport) {
    add_next_index_str(return_value, zend_string_copy(stream_xport));
  } ZEND_HASH_FOREACH_END();
}
/* }}} */

/* {{{ Retrieves list of registered stream wrappers */
PHP_FUNCTION(stream_get_wrappers)
{
  ZEND_PARSE_PARAMETERS_NONE();

  array_init(return_value);

  const HashTable *url_stream_wrappers_hash = php_stream_get_url_stream_wrappers_hash();
  zend_string *stream_protocol;
  ZEND_HASH_MAP_FOREACH_STR_KEY(url_stream_wrappers_hash, stream_protocol) {
    if (stream_protocol) {
      add_next_index_str(return_value, zend_string_copy(stream_protocol));
    }
  } ZEND_HASH_FOREACH_END();

}
/* }}} */

PHP_FUNCTION(stream_last_errors)
{
  ZEND_PARSE_PARAMETERS_NONE();
  php_stream_error_get_last(return_value);
}

PHP_FUNCTION(stream_clear_errors)
{
  ZEND_PARSE_PARAMETERS_NONE();
  php_stream_error_clear_stored();
}

/* {{{ stream_select related functions */
static int stream_array_to_fd_set(const HashTable *stream_array, fd_set *fds, php_socket_t *max_fd)
{
  zval *elem;
  php_stream *stream;
  int cnt = 0;

  ZEND_HASH_FOREACH_VAL(stream_array, elem) {
    /* Temporary int fd is needed for the STREAM data type on windows, passing this_fd directly to php_stream_cast()
      would eventually bring a wrong result on x64. php_stream_cast() casts to int internally, and this will leave
      the higher bits of a SOCKET variable uninitialized on systems with little endian. */
    php_socket_t this_fd;

    ZVAL_DEREF(elem);
    php_stream_from_zval_no_verify(stream, elem);
    if (stream == NULL) {
      continue;
    }
    /* get the fd.
     * NB: Most other code will NOT use the PHP_STREAM_CAST_INTERNAL flag
     * when casting.  It is only used here so that the buffered data warning
     * is not displayed.
     * */
    if (SUCCESS == php_stream_cast(stream, PHP_STREAM_AS_FD_FOR_SELECT | PHP_STREAM_CAST_INTERNAL, (void*)&this_fd, 1) && this_fd != -1) {

      PHP_SAFE_FD_SET(this_fd, fds);

      if (this_fd > *max_fd) {
        *max_fd = this_fd;
      }
      cnt++;
    }
  } ZEND_HASH_FOREACH_END();
  return cnt ? 1 : 0;
}

static int stream_array_from_fd_set(zval *stream_array, const fd_set *fds)
{
  zval *elem, *dest_elem;
  HashTable *ht;
  php_stream *stream;
  int ret = 0;
  zend_string *key;
  zend_ulong num_ind;

  ZEND_ASSERT(Z_TYPE_P(stream_array) == IS_ARRAY);
  ht = zend_new_array(zend_hash_num_elements(Z_ARRVAL_P(stream_array)));

  ZEND_HASH_FOREACH_KEY_VAL(Z_ARRVAL_P(stream_array), num_ind, key, elem) {
    php_socket_t this_fd;

    ZVAL_DEREF(elem);
    php_stream_from_zval_no_verify(stream, elem);
    if (stream == NULL) {
      continue;
    }
    /* get the fd
     * NB: Most other code will NOT use the PHP_STREAM_CAST_INTERNAL flag
     * when casting.  It is only used here so that the buffered data warning
     * is not displayed.
     */
    if (SUCCESS == php_stream_cast(stream, PHP_STREAM_AS_FD_FOR_SELECT | PHP_STREAM_CAST_INTERNAL, (void*)&this_fd, 1) && this_fd != SOCK_ERR) {
      if (PHP_SAFE_FD_ISSET(this_fd, fds)) {
        if (!key) {
          dest_elem = zend_hash_index_update(ht, num_ind, elem);
        } else {
          dest_elem = zend_hash_update(ht, key, elem);
        }

        zval_add_ref(dest_elem);
        ret++;
      }
    }
  } ZEND_HASH_FOREACH_END();

  /* destroy old array and add new one */
  zval_ptr_dtor(stream_array);
  ZVAL_ARR(stream_array, ht);

  return ret;
}

static int stream_array_emulate_read_fd_set(zval *stream_array)
{
  zval *elem, *dest_elem;
  HashTable *ht;
  php_stream *stream;
  int ret = 0;
  zend_ulong num_ind;
  zend_string *key;

  ZEND_ASSERT(Z_TYPE_P(stream_array) == IS_ARRAY);
  ht = zend_new_array(zend_hash_num_elements(Z_ARRVAL_P(stream_array)));

  ZEND_HASH_FOREACH_KEY_VAL(Z_ARRVAL_P(stream_array), num_ind, key, elem) {
    ZVAL_DEREF(elem);
    php_stream_from_zval_no_verify(stream, elem);
    if (stream == NULL) {
      continue;
    }
    if ((stream->writepos - stream->readpos) > 0) {
      /* allow readable non-descriptor based streams to participate in stream_select.
       * Non-descriptor streams will only "work" if they have previously buffered the
       * data.  Not ideal, but better than nothing.
       * This branch of code also allows blocking streams with buffered data to
       * operate correctly in stream_select.
       * */
      if (!key) {
        dest_elem = zend_hash_index_update(ht, num_ind, elem);
      } else {
        dest_elem = zend_hash_update(ht, key, elem);
      }
      zval_add_ref(dest_elem);
      ret++;
    }
  } ZEND_HASH_FOREACH_END();

  if (ret > 0) {
    /* destroy old array and add new one */
    zval_ptr_dtor(stream_array);
    ZVAL_ARR(stream_array, ht);
  } else {
    zend_array_destroy(ht);
  }

  return ret;
}
/* }}} */

/* {{{ Runs the select() system call on the sets of streams with a timeout specified by tv_sec and tv_usec */
PHP_FUNCTION(stream_select)
{
  zval *r_array, *w_array, *e_array, *zcontext = NULL;
  struct timeval tv, *tv_p = NULL;
  fd_set rfds, wfds, efds;
  php_socket_t max_fd = 0;
  int retval, sets = 0;
  zend_long sec, usec = 0;
  bool secnull;
  bool usecnull = 1;
  int set_count, max_set_count = 0;
  php_stream_context *context = NULL;

  ZEND_PARSE_PARAMETERS_START(4, 6)
    Z_PARAM_ARRAY_EX2(r_array, 1, 1, 0)
    Z_PARAM_ARRAY_EX2(w_array, 1, 1, 0)
    Z_PARAM_ARRAY_EX2(e_array, 1, 1, 0)
    Z_PARAM_LONG_OR_NULL(sec, secnull)
    Z_PARAM_OPTIONAL
    Z_PARAM_LONG_OR_NULL(usec, usecnull)
    Z_PARAM_RESOURCE_OR_NULL(zcontext)
  ZEND_PARSE_PARAMETERS_END();

  FD_ZERO(&rfds);
  FD_ZERO(&wfds);
  FD_ZERO(&efds);

  php_stream_error_operation_begin();
  context = php_stream_context_from_zval(zcontext, 0);

  if (r_array != NULL) {
    set_count = stream_array_to_fd_set(Z_ARR_P(r_array), &rfds, &max_fd);
    if (set_count > max_set_count)
      max_set_count = set_count;
    sets += set_count;
  }

  if (w_array != NULL) {
    set_count = stream_array_to_fd_set(Z_ARR_P(w_array), &wfds, &max_fd);
    if (set_count > max_set_count)
      max_set_count = set_count;
    sets += set_count;
  }

  if (e_array != NULL) {
    set_count = stream_array_to_fd_set(Z_ARR_P(e_array), &efds, &max_fd);
    if (set_count > max_set_count)
      max_set_count = set_count;
    sets += set_count;
  }

  if (!sets) {
    php_stream_error_operation_end(context);
    zend_value_error("No stream arrays were passed");
    RETURN_THROWS();
  }

  if (!PHP_SAFE_MAX_FD(max_fd, max_set_count)) {
    RETURN_FALSE;
  }

  if (secnull && !usecnull) {
    if (usec != 0) {
      php_stream_error_operation_end(context);
      zend_argument_value_error(5, "must be null when argument #4 ($seconds) is null");
      RETURN_THROWS();
    }
  }

  /* If seconds is not set to null, build the timeval, else we wait indefinitely */
  if (!secnull) {
    if (sec < 0) {
      php_stream_error_operation_end(context);
      zend_argument_value_error(4, "must be greater than or equal to 0");
      RETURN_THROWS();
    } else if (usec < 0) {
      php_stream_error_operation_end(context);
      zend_argument_value_error(5, "must be greater than or equal to 0");
      RETURN_THROWS();
    }

    /* Windows, Solaris and BSD do not like microsecond values which are >= 1 sec */
    tv.tv_sec = (long)(sec + (usec / 1000000));
    tv.tv_usec = (long)(usec % 1000000);
    tv_p = &tv;
  }

  /* slight hack to support buffered data; if there is data sitting in the
   * read buffer of any of the streams in the read array, let's pretend
   * that we selected, but return only the readable sockets */
  if (r_array != NULL) {
    retval = stream_array_emulate_read_fd_set(r_array);
    if (retval > 0) {
      php_stream_error_operation_end(context);
      if (w_array != NULL) {
        zval_ptr_dtor(w_array);
        ZVAL_EMPTY_ARRAY(w_array);
      }
      if (e_array != NULL) {
        zval_ptr_dtor(e_array);
        ZVAL_EMPTY_ARRAY(e_array);
      }
      RETURN_LONG(retval);
    }
  }

  retval = php_select(max_fd+1, &rfds, &wfds, &efds, tv_p);
  php_stream_error_operation_end(context);

  if (retval == -1) {
    php_error_docref(NULL, E_WARNING, "Unable to select [%d]: %s (max_fd=" PHP_SOCKET_FMT ")",
        errno, strerror(errno), max_fd);
    RETURN_FALSE;
  }

  if (r_array != NULL) stream_array_from_fd_set(r_array, &rfds);
  if (w_array != NULL) stream_array_from_fd_set(w_array, &wfds);
  if (e_array != NULL) stream_array_from_fd_set(e_array, &efds);

  RETURN_LONG(retval);
}
/* }}} */

/* {{{ stream_context related functions */
static void user_space_stream_notifier(php_stream_context *context, int notifycode, int severity,
    char *xmsg, int xcode, size_t bytes_sofar, size_t bytes_max, void * ptr)
{
  zval zvs[6];

  ZVAL_LONG(&zvs[0], notifycode);
  ZVAL_LONG(&zvs[1], severity);
  if (xmsg) {
    ZVAL_STRING(&zvs[2], xmsg);
  } else {
    ZVAL_NULL(&zvs[2]);
  }
  ZVAL_LONG(&zvs[3], xcode);
  ZVAL_LONG(&zvs[4], bytes_sofar);
  ZVAL_LONG(&zvs[5], bytes_max);

  zend_call_known_fcc(context->notifier->ptr, NULL, 6, zvs, NULL);
  /* Free refcounted string parameter */
  zval_ptr_dtor_str(&zvs[2]);
}

static void user_space_stream_notifier_dtor(php_stream_notifier *notifier)
{
  zend_fcall_info_cache *fcc = notifier->ptr;
  zend_fcc_dtor(fcc);
  efree(notifier->ptr);
  notifier->ptr = NULL;
}

static zend_result parse_context_options(php_stream_context *context, const HashTable *options)
{
  zval *wval, *oval;
  zend_string *wkey, *okey;

  ZEND_HASH_FOREACH_STR_KEY_VAL(options, wkey, wval) {
    ZVAL_DEREF(wval);
    if (wkey && Z_TYPE_P(wval) == IS_ARRAY) {
      if (!HT_IS_PACKED(Z_ARRVAL_P(wval))) {
        ZEND_HASH_MAP_FOREACH_STR_KEY_VAL(Z_ARRVAL_P(wval), okey, oval) {
          if (okey) {
            php_stream_context_set_option(context, ZSTR_VAL(wkey), ZSTR_VAL(okey), oval);
          }
        } ZEND_HASH_FOREACH_END();
      }
    } else {
      zend_value_error("Options should have the form [\"wrappername\"][\"optionname\"] = $value");
      return FAILURE;
    }
  } ZEND_HASH_FOREACH_END();

  return SUCCESS;
}

static zend_result parse_context_params(php_stream_context *context, const HashTable *params)
{
  zval *tmp;

  if (NULL != (tmp = zend_hash_str_find(params, "notification", sizeof("notification")-1))) {

    if (context->notifier) {
      php_stream_notification_free(context->notifier);
      context->notifier = NULL;
    }

    zend_fcall_info_cache *fcc = emalloc(sizeof(*fcc));
    char *error;
    if (!zend_is_callable_ex(tmp, NULL, 0, NULL, fcc, &error)) {
      zend_argument_type_error(1, "must be an array with valid callbacks as values, %s", error);
      efree(fcc);
      efree(error);
      return FAILURE;
    }
    zend_fcc_addref(fcc);

    context->notifier = php_stream_notification_alloc();
    context->notifier->func = user_space_stream_notifier;
    context->notifier->ptr = fcc;
    context->notifier->dtor = user_space_stream_notifier_dtor;
  }
  if (NULL != (tmp = zend_hash_str_find(params, "options", sizeof("options")-1))) {
    if (Z_TYPE_P(tmp) == IS_ARRAY) {
      return parse_context_options(context, Z_ARRVAL_P(tmp));
    } else {
      zend_type_error("Invalid stream/context parameter");
      return FAILURE;
    }
  }

  return SUCCESS;
}

/* given a zval which is either a stream or a context, return the underlying
 * stream_context.  If it is a stream that does not have a context assigned, it
 * will create and assign a context and return that.  */
static php_stream_context *decode_context_param(zval *contextresource)
{
  php_stream_context *context = NULL;

  context = zend_fetch_resource_ex(contextresource, NULL, php_le_stream_context());
  if (context == NULL) {
    php_stream *stream;

    stream = zend_fetch_resource2_ex(contextresource, NULL, php_file_le_stream(), php_file_le_pstream());

    if (stream) {
      context = PHP_STREAM_CONTEXT(stream);
      if (context == NULL) {
        /* Only way this happens is if file is opened with NO_DEFAULT_CONTEXT
           param, but then something is called which requires a context.
           Don't give them the default one though since they already said they
           didn't want it. */
        context = php_stream_context_alloc();
        stream->ctx = context->res;
      }
    }
  }

  return context;
}
/* }}} */

/* {{{ Retrieve options for a stream/wrapper/context */
PHP_FUNCTION(stream_context_get_options)
{
  zval *zcontext;
  php_stream_context *context;

  ZEND_PARSE_PARAMETERS_START(1, 1)
    Z_PARAM_RESOURCE(zcontext)
  ZEND_PARSE_PARAMETERS_END();

  context = decode_context_param(zcontext);
  if (!context) {
    zend_argument_type_error(1, "must be a valid stream/context");
    RETURN_THROWS();
  }

  ZVAL_COPY(return_value, &context->options);
}
/* }}} */

/* {{{ Set an option for a wrapper */
PHP_FUNCTION(stream_context_set_option)
{
  zval *zcontext = NULL;
  php_stream_context *context;
  zend_string *wrappername;
  HashTable *options;
  char *optionname = NULL;
  size_t optionname_len;
  zval *zvalue = NULL;

  if (ZEND_NUM_ARGS() == 2) {
    zend_error(E_DEPRECATED, "Calling stream_context_set_option() with 2 arguments is deprecated, "
      "use stream_context_set_options() instead"
    );
    if (UNEXPECTED(EG(exception))) {
      RETURN_THROWS();
    }
  }

  ZEND_PARSE_PARAMETERS_START(2, 4)
    Z_PARAM_RESOURCE(zcontext)
    Z_PARAM_ARRAY_HT_OR_STR(options, wrappername)
    Z_PARAM_OPTIONAL
    Z_PARAM_STRING_OR_NULL(optionname, optionname_len)
    Z_PARAM_ZVAL(zvalue)
  ZEND_PARSE_PARAMETERS_END();

  /* figure out where the context is coming from exactly */
  if (!(context = decode_context_param(zcontext))) {
    zend_argument_type_error(1, "must be a valid stream/context");
    RETURN_THROWS();
  }

  if (options) {
    if (optionname) {
      zend_argument_value_error(3, "must be null when argument #2 ($wrapper_or_options) is an array");
      RETURN_THROWS();
    }

    if (zvalue) {
      zend_argument_value_error(4, "cannot be provided when argument #2 ($wrapper_or_options) is an array");
      RETURN_THROWS();
    }

    if (parse_context_options(context, options) == FAILURE) {
      RETURN_THROWS();
    }

    RETURN_TRUE;
  } else {
    if (!optionname) {
      zend_argument_value_error(3, "cannot be null when argument #2 ($wrapper_or_options) is a string");
      RETURN_THROWS();
    }
    if (!zvalue) {
      zend_argument_value_error(4, "must be provided when argument #2 ($wrapper_or_options) is a string");
      RETURN_THROWS();
    }
    php_stream_context_set_option(context, ZSTR_VAL(wrappername), optionname, zvalue);
    RETURN_TRUE;
  }
}
/* }}} */

PHP_FUNCTION(stream_context_set_options)
{
  zval *zcontext = NULL;
  php_stream_context *context;
  HashTable *options;

  ZEND_PARSE_PARAMETERS_START(2, 2)
    Z_PARAM_RESOURCE(zcontext)
    Z_PARAM_ARRAY_HT(options)
  ZEND_PARSE_PARAMETERS_END();

  /* figure out where the context is coming from exactly */
  if (!(context = decode_context_param(zcontext))) {
    zend_argument_type_error(1, "must be a valid stream/context");
    RETURN_THROWS();
  }

  if (parse_context_options(context, options) == FAILURE) {
    RETURN_THROWS();
  }

  RETURN_TRUE;
}

/* {{{ Set parameters for a file context */
PHP_FUNCTION(stream_context_set_params)
{
  HashTable *params;
  zval *zcontext;
  php_stream_context *context;

  ZEND_PARSE_PARAMETERS_START(2, 2)
    Z_PARAM_RESOURCE(zcontext)
    Z_PARAM_ARRAY_HT(params)
  ZEND_PARSE_PARAMETERS_END();

  context = decode_context_param(zcontext);
  if (!context) {
    zend_argument_type_error(1, "must be a valid stream/context");
    RETURN_THROWS();
  }

  if (parse_context_params(context, params) == FAILURE) {
    RETURN_THROWS();
  }

  RETURN_TRUE;
}
/* }}} */

/* {{{ Get parameters of a file context */
PHP_FUNCTION(stream_context_get_params)
{
  zval *zcontext;
  php_stream_context *context;

  ZEND_PARSE_PARAMETERS_START(1, 1)
    Z_PARAM_RESOURCE(zcontext)
  ZEND_PARSE_PARAMETERS_END();

  context = decode_context_param(zcontext);
  if (!context) {
    zend_argument_type_error(1, "must be a valid stream/context");
    RETURN_THROWS();
  }

  array_init(return_value);
  if (context->notifier && context->notifier->func == user_space_stream_notifier) {
    zend_fcall_info_cache *fcc = context->notifier->ptr;
    zval fn;
    zend_get_callable_zval_from_fcc(fcc, &fn);
    add_assoc_zval_ex(return_value, ZEND_STRL("notification"), &fn);
  }
  Z_TRY_ADDREF(context->options);
  add_assoc_zval_ex(return_value, "options", sizeof("options")-1, &context->options);
}
/* }}} */

/* {{{ Get a handle on the default file/stream context and optionally set parameters */
PHP_FUNCTION(stream_context_get_default)
{
  HashTable *params = NULL;
  php_stream_context *context;

  ZEND_PARSE_PARAMETERS_START(0, 1)
    Z_PARAM_OPTIONAL
    Z_PARAM_ARRAY_HT_OR_NULL(params)
  ZEND_PARSE_PARAMETERS_END();

  if (FG(default_context) == NULL) {
    FG(default_context) = php_stream_context_alloc();
  }
  context = FG(default_context);

  if (params) {
    if (parse_context_options(context, params) == FAILURE) {
      RETURN_THROWS();
    }
  }

  php_stream_context_to_zval(context, return_value);
}
/* }}} */

/* Check if options contain stream error handling settings */
static bool php_stream_context_options_has_error_settings(const HashTable *options)
{
  zval *stream_options = zend_hash_str_find(options, ZEND_STRL("stream"));
  if (!stream_options) {
    return false;
  }

  ZVAL_DEREF(stream_options);
  if (Z_TYPE_P(stream_options) != IS_ARRAY) {
    return false;
  }

  return zend_hash_str_exists(Z_ARRVAL_P(stream_options), ZEND_STRL("error_mode"))
      || zend_hash_str_exists(Z_ARRVAL_P(stream_options), ZEND_STRL("error_store"))
      || zend_hash_str_exists(Z_ARRVAL_P(stream_options), ZEND_STRL("error_handler"));
}

/* {{{ Set default file/stream context, returns the context as a resource */
PHP_FUNCTION(stream_context_set_default)
{
  HashTable *options;
  php_stream_context *context;

  ZEND_PARSE_PARAMETERS_START(1, 1)
    Z_PARAM_ARRAY_HT(options)
  ZEND_PARSE_PARAMETERS_END();

  if (FG(default_context) == NULL) {
    FG(default_context) = php_stream_context_alloc();
  }
  context = FG(default_context);

  if (php_stream_context_options_has_error_settings(options)) {
    zend_value_error("Stream error handling options cannot be set on the default context");
    RETURN_THROWS();
  }

  if (parse_context_options(context, options) == FAILURE) {
    RETURN_THROWS();
  }

  php_stream_context_to_zval(context, return_value);
}
/* }}} */

/* {{{ Create a file context and optionally set parameters */
PHP_FUNCTION(stream_context_create)
{
  HashTable *options = NULL;
  HashTable *params = NULL;
  php_stream_context *context;

  ZEND_PARSE_PARAMETERS_START(0, 2)
    Z_PARAM_OPTIONAL
    Z_PARAM_ARRAY_HT_OR_NULL(options)
    Z_PARAM_ARRAY_HT_OR_NULL(params)
  ZEND_PARSE_PARAMETERS_END();

  context = php_stream_context_alloc();

  if (options) {
    if (parse_context_options(context, options) == FAILURE) {
      RETURN_THROWS();
    }
  }

  if (params) {
    if (parse_context_params(context, params) == FAILURE) {
      RETURN_THROWS();
    }
  }

  RETURN_RES(context->res);
}
/* }}} */

/* {{{ streams filter functions */
static void apply_filter_to_stream(bool append, INTERNAL_FUNCTION_PARAMETERS)
{
  php_stream *stream;
  char *filtername;
  size_t filternamelen;
  zend_long read_write = 0;
  zval *filterparams = NULL;
  php_stream_filter *filter = NULL;

  ZEND_PARSE_PARAMETERS_START(2, 4)
    PHP_Z_PARAM_STREAM(stream)
    Z_PARAM_STRING(filtername, filternamelen)
    Z_PARAM_OPTIONAL
    Z_PARAM_LONG(read_write)
    Z_PARAM_ZVAL(filterparams)
  ZEND_PARSE_PARAMETERS_END();

  if ((read_write & PHP_STREAM_FILTER_ALL) == 0) {
    /* Chain not specified.
     * Examine stream->mode to determine which filters are needed
     * There's no harm in attaching a filter to an unused chain,
     * but why waste the memory and clock cycles?
     */
    if (strchr(stream->mode, 'r') || strchr(stream->mode, '+')) {
      read_write |= PHP_STREAM_FILTER_READ;
    }
    if (strchr(stream->mode, 'w') || strchr(stream->mode, '+') || strchr(stream->mode, 'a')) {
      read_write |= PHP_STREAM_FILTER_WRITE;
    }
  }

  if (read_write & PHP_STREAM_FILTER_READ) {
    filter = php_stream_filter_create(filtername, filterparams, php_stream_is_persistent(stream));
    if (filter == NULL) {
      RETURN_FALSE;
    }

    if (append) {
      zend_result ret = php_stream_filter_append_ex(&stream->readfilters, filter);
      if (ret != SUCCESS) {
        php_stream_filter_remove(filter, 1);
        RETURN_FALSE;
      }
    } else {
      php_stream_filter_prepend_ex(&stream->readfilters, filter);
    }
  }

  if (read_write & PHP_STREAM_FILTER_WRITE) {
    filter = php_stream_filter_create(filtername, filterparams, php_stream_is_persistent(stream));
    if (filter == NULL) {
      RETURN_FALSE;
    }

    if (append) {
      zend_result ret = php_stream_filter_append_ex(&stream->writefilters, filter);
      if (ret != SUCCESS) {
        php_stream_filter_remove(filter, 1);
        RETURN_FALSE;
      }
    } else {
      php_stream_filter_prepend_ex(&stream->writefilters, filter);
    }
  }

  if (filter) {
    filter->res = zend_register_resource(filter, php_file_le_stream_filter());
    GC_ADDREF(filter->res);
    RETURN_RES(filter->res);
  } else {
    RETURN_FALSE;
  }
}
/* }}} */

/* {{{ Prepend a filter to a stream */
PHP_FUNCTION(stream_filter_prepend)
{
  apply_filter_to_stream(0, INTERNAL_FUNCTION_PARAM_PASSTHRU);
}
/* }}} */

/* {{{ Append a filter to a stream */
PHP_FUNCTION(stream_filter_append)
{
  apply_filter_to_stream(1, INTERNAL_FUNCTION_PARAM_PASSTHRU);
}
/* }}} */

/* {{{ 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;

  ZEND_PARSE_PARAMETERS_START(1, 1)
    Z_PARAM_RESOURCE(zfilter)
  ZEND_PARSE_PARAMETERS_END();

  filter = zend_fetch_resource(Z_RES_P(zfilter), "stream filter", php_file_le_stream_filter());
  if (!filter) {
    RETURN_THROWS();
  }

  if (php_stream_filter_flush(filter, 1) == FAILURE) {
    php_error_docref(NULL, E_WARNING, "Unable to flush filter, not removing");
    RETURN_FALSE;
  }

  zend_list_close(Z_RES_P(zfilter));
  php_stream_filter_remove(filter, 1);
  RETURN_TRUE;
}
/* }}} */

/* {{{ Read up to maxlen bytes from a stream or until the ending string is found */
PHP_FUNCTION(stream_get_line)
{
  char *str = NULL;
  size_t str_len = 0;
  zend_long max_length;
  zend_string *buf;
  php_stream *stream;

  ZEND_PARSE_PARAMETERS_START(2, 3)
    PHP_Z_PARAM_STREAM(stream)
    Z_PARAM_LONG(max_length)
    Z_PARAM_OPTIONAL
    Z_PARAM_STRING(str, str_len)
  ZEND_PARSE_PARAMETERS_END();

  if (max_length < 0) {
    zend_argument_value_error(2, "must be greater than or equal to 0");
    RETURN_THROWS();
  }
  if (!max_length) {
    max_length = PHP_SOCK_CHUNK_SIZE;
  }

  php_stream_error_operation_begin();
  if ((buf = php_stream_get_record(stream, max_length, str, str_len))) {
    RETVAL_STR(buf);
  } else {
    RETVAL_FALSE;
  }
  php_stream_error_operation_end_for_stream(stream);
}

/* }}} */

/* {{{ Set blocking/non-blocking mode on a socket or stream */
PHP_FUNCTION(stream_set_blocking)
{
  bool block;
  php_stream *stream;

  ZEND_PARSE_PARAMETERS_START(2, 2)
    PHP_Z_PARAM_STREAM(stream)
    Z_PARAM_BOOL(block)
  ZEND_PARSE_PARAMETERS_END();

  php_stream_error_operation_begin();
  RETVAL_BOOL(-1 != php_stream_set_option(stream, PHP_STREAM_OPTION_BLOCKING, block, NULL));
  php_stream_error_operation_end_for_stream(stream);
}

/* }}} */

/* {{{ Set timeout on stream read to seconds + microseonds */
#if defined(HAVE_SYS_TIME_H) || defined(PHP_WIN32)
PHP_FUNCTION(stream_set_timeout)
{
  zend_long seconds, microseconds = 0;
  struct timeval t;
  php_stream *stream;
  int argc = ZEND_NUM_ARGS();

  ZEND_PARSE_PARAMETERS_START(2, 3)
    PHP_Z_PARAM_STREAM(stream)
    Z_PARAM_LONG(seconds)
    Z_PARAM_OPTIONAL
    Z_PARAM_LONG(microseconds)
  ZEND_PARSE_PARAMETERS_END();

#ifdef PHP_WIN32
  t.tv_sec = (long)seconds;

  if (argc == 3) {
    t.tv_usec = (long)(microseconds % 1000000);
    t.tv_sec +=(long)(microseconds / 1000000);
  } else {
    t.tv_usec = 0;
  }
#else
  t.tv_sec = seconds;

  if (argc == 3) {
    t.tv_usec = microseconds % 1000000;
    t.tv_sec += microseconds / 1000000;
  } else {
    t.tv_usec = 0;
  }
#endif

  php_stream_error_operation_begin();
  RETVAL_BOOL(PHP_STREAM_OPTION_RETURN_OK == php_stream_set_option(stream, PHP_STREAM_OPTION_READ_TIMEOUT, 0, &t));
  php_stream_error_operation_end_for_stream(stream);
}
#endif /* HAVE_SYS_TIME_H || defined(PHP_WIN32) */
/* }}} */

/* {{{ Set file write buffer */
PHP_FUNCTION(stream_set_write_buffer)
{
  int ret;
  zend_long arg2;
  size_t buff;
  php_stream *stream;

  ZEND_PARSE_PARAMETERS_START(2, 2)
    PHP_Z_PARAM_STREAM(stream)
    Z_PARAM_LONG(arg2)
  ZEND_PARSE_PARAMETERS_END();

  buff = arg2;

  php_stream_error_operation_begin();
  /* if buff is 0 then set to non-buffered */
  if (buff == 0) {
    ret = php_stream_set_option(stream, PHP_STREAM_OPTION_WRITE_BUFFER, PHP_STREAM_BUFFER_NONE, NULL);
  } else {
    ret = php_stream_set_option(stream, PHP_STREAM_OPTION_WRITE_BUFFER, PHP_STREAM_BUFFER_FULL, &buff);
  }
  php_stream_error_operation_end_for_stream(stream);

  RETURN_LONG(ret == 0 ? 0 : EOF);
}
/* }}} */

/* {{{ Set the stream chunk size */
PHP_FUNCTION(stream_set_chunk_size)
{
  int     ret;
  zend_long   csize;
  php_stream  *stream;

  ZEND_PARSE_PARAMETERS_START(2, 2)
    PHP_Z_PARAM_STREAM(stream)
    Z_PARAM_LONG(csize)
  ZEND_PARSE_PARAMETERS_END();

  if (csize <= 0) {
    zend_argument_value_error(2, "must be greater than 0");
    RETURN_THROWS();
  }
  /* stream.chunk_size is actually a size_t, but php_stream_set_option
   * can only use an int to accept the new value and return the old one.
   * In any case, values larger than INT_MAX for a chunk size make no sense.
   */
  if (csize > INT_MAX) {
    zend_argument_value_error(2, "is too large");
    RETURN_THROWS();
  }

  php_stream_error_operation_begin();
  ret = php_stream_set_option(stream, PHP_STREAM_OPTION_SET_CHUNK_SIZE, (int)csize, NULL);
  php_stream_error_operation_end_for_stream(stream);

  RETURN_LONG(ret > 0 ? (zend_long)ret : (zend_long)EOF);
}
/* }}} */

/* {{{ Set file read buffer */
PHP_FUNCTION(stream_set_read_buffer)
{
  int ret;
  zend_long arg2;
  size_t buff;
  php_stream *stream;

  ZEND_PARSE_PARAMETERS_START(2, 2)
    PHP_Z_PARAM_STREAM(stream)
    Z_PARAM_LONG(arg2)
  ZEND_PARSE_PARAMETERS_END();

  buff = arg2;

  php_stream_error_operation_begin();
  /* if buff is 0 then set to non-buffered */
  if (buff == 0) {
    ret = php_stream_set_option(stream, PHP_STREAM_OPTION_READ_BUFFER, PHP_STREAM_BUFFER_NONE, NULL);
  } else {
    ret = php_stream_set_option(stream, PHP_STREAM_OPTION_READ_BUFFER, PHP_STREAM_BUFFER_FULL, &buff);
  }
  php_stream_error_operation_end_for_stream(stream);

  RETURN_LONG(ret == 0 ? 0 : EOF);
}
/* }}} */

/* {{{ Enable or disable a specific kind of crypto on the stream */
PHP_FUNCTION(stream_socket_enable_crypto)
{
  zend_long cryptokind = 0;
  php_stream *stream, *sessstream = NULL;
  bool enable, cryptokindnull = 1;
  int ret;

  ZEND_PARSE_PARAMETERS_START(2, 4)
    PHP_Z_PARAM_STREAM(stream)
    Z_PARAM_BOOL(enable)
    Z_PARAM_OPTIONAL
    Z_PARAM_LONG_OR_NULL(cryptokind, cryptokindnull)
    PHP_Z_PARAM_STREAM_OR_NULL(sessstream)
  ZEND_PARSE_PARAMETERS_END();

  php_stream_error_operation_begin();

  if (enable) {
    if (cryptokindnull) {
      zval *val;

      if (!GET_CTX_OPT(stream, "ssl", "crypto_method", val)) {
        php_stream_error_operation_end_for_stream(stream);
        zend_argument_value_error(3, "must be specified when enabling encryption");
        RETURN_THROWS();
      }

      cryptokind = Z_LVAL_P(val);
    }

    if (php_stream_xport_crypto_setup(stream, cryptokind, sessstream) < 0) {
      php_stream_error_operation_end_for_stream(stream);
      RETURN_FALSE;
    }
  }

  ret = php_stream_xport_crypto_enable(stream, enable);
  php_stream_error_operation_end_for_stream(stream);
  switch (ret) {
    case -1:
      RETURN_FALSE;

    case 0:
      RETURN_LONG(0);

    default:
      RETURN_TRUE;
  }
}
/* }}} */

/* {{{ Determine what file will be opened by calls to fopen() with a relative path */
PHP_FUNCTION(stream_resolve_include_path)
{
  zend_string *filename;
  zend_string *resolved_path;

  ZEND_PARSE_PARAMETERS_START(1, 1)
    Z_PARAM_PATH_STR(filename)
  ZEND_PARSE_PARAMETERS_END();

  resolved_path = zend_resolve_path(filename);

  if (resolved_path) {
    RETURN_STR(resolved_path);
  }
  RETURN_FALSE;
}
/* }}} */

/* {{{ */
PHP_FUNCTION(stream_is_local)
{
  zval *zstream, *zcontext = NULL;
  php_stream *stream = NULL;
  php_stream_wrapper *wrapper = NULL;
  php_stream_context *context = NULL;

  ZEND_PARSE_PARAMETERS_START(1, 2)
    Z_PARAM_ZVAL(zstream)
    Z_PARAM_OPTIONAL
    Z_PARAM_RESOURCE_OR_NULL(zcontext)
  ZEND_PARSE_PARAMETERS_END();

  if (Z_TYPE_P(zstream) == IS_RESOURCE) {
    php_stream_from_zval(stream, zstream);
    wrapper = stream->wrapper;
  } else {
    if (!try_convert_to_string(zstream)) {
      RETURN_THROWS();
    }

    php_stream_error_operation_begin();
    context = php_stream_context_from_zval(zcontext, 0);
    wrapper = php_stream_locate_url_wrapper(Z_STRVAL_P(zstream), NULL, 0);
    php_stream_error_operation_end(context);
  }

  RETURN_BOOL(wrapper && wrapper->is_url == 0);
}
/* }}} */

/* {{{ Tells whether the stream supports locking through flock(). */
PHP_FUNCTION(stream_supports_lock)
{
  php_stream *stream;

  ZEND_PARSE_PARAMETERS_START(1, 1)
    PHP_Z_PARAM_STREAM(stream)
  ZEND_PARSE_PARAMETERS_END();

  php_stream_error_operation_begin();
  RETVAL_BOOL(php_stream_supports_lock(stream));
  php_stream_error_operation_end_for_stream(stream);
}

/* {{{ Check if a stream is a TTY. */
PHP_FUNCTION(stream_isatty)
{
  php_stream *stream;
  php_socket_t fileno;

  ZEND_PARSE_PARAMETERS_START(1, 1)
    PHP_Z_PARAM_STREAM(stream)
  ZEND_PARSE_PARAMETERS_END();

  php_stream_error_operation_begin();

  /* get the fd.
   * NB: Most other code will NOT use the PHP_STREAM_CAST_INTERNAL flag when casting.
   * It is only used here so that the buffered data warning is not displayed.
   */
  if (php_stream_can_cast(stream, PHP_STREAM_AS_FD_FOR_SELECT | PHP_STREAM_CAST_INTERNAL) == SUCCESS) {
    php_stream_cast(stream, PHP_STREAM_AS_FD_FOR_SELECT | PHP_STREAM_CAST_INTERNAL, (void*)&fileno, 0);
  } else if (php_stream_can_cast(stream, PHP_STREAM_AS_FD | PHP_STREAM_CAST_INTERNAL) == SUCCESS) {
    php_stream_cast(stream, PHP_STREAM_AS_FD | PHP_STREAM_CAST_INTERNAL, (void*)&fileno, 0);
  } else {
    php_stream_error_operation_end_for_stream(stream);
    RETURN_FALSE;
  }
  php_stream_error_operation_end_for_stream(stream);

#ifdef PHP_WIN32
  /* Check if the Windows standard handle is redirected to file */
  RETURN_BOOL(php_win32_console_fileno_is_console(fileno));
#elif defined(HAVE_UNISTD_H)
  /* Check if the file descriptor identifier is a terminal */
  RETURN_BOOL(isatty(fileno));
#else
  zend_stat_t stat = {0};
  RETURN_BOOL(zend_fstat(fileno, &stat) == 0 && (stat.st_mode & /*S_IFMT*/0170000) == /*S_IFCHR*/0020000);
#endif
}

#ifdef PHP_WIN32
/* {{{ Get or set VT100 support for the specified stream associated to an
   output buffer of a Windows console.
*/
PHP_FUNCTION(sapi_windows_vt100_support)
{
  php_stream *stream;
  bool enable, enable_is_null = 1;
  zend_long fileno;

  ZEND_PARSE_PARAMETERS_START(1, 2)
    PHP_Z_PARAM_STREAM(stream)
    Z_PARAM_OPTIONAL
    Z_PARAM_BOOL_OR_NULL(enable, enable_is_null)
  ZEND_PARSE_PARAMETERS_END();

  php_stream_error_operation_begin();

  /* get the fd.
   * NB: Most other code will NOT use the PHP_STREAM_CAST_INTERNAL flag when casting.
   * It is only used here so that the buffered data warning is not displayed.
   */
  if (php_stream_can_cast(stream, PHP_STREAM_AS_FD_FOR_SELECT | PHP_STREAM_CAST_INTERNAL) == SUCCESS) {
    php_stream_cast(stream, PHP_STREAM_AS_FD_FOR_SELECT | PHP_STREAM_CAST_INTERNAL, (void*)&fileno, 0);
  } else if (php_stream_can_cast(stream, PHP_STREAM_AS_FD | PHP_STREAM_CAST_INTERNAL) == SUCCESS) {
    php_stream_cast(stream, PHP_STREAM_AS_FD | PHP_STREAM_CAST_INTERNAL, (void*)&fileno, 0);
  } else {
    php_stream_error_operation_end_for_stream(stream);
    if (!enable_is_null) {
      php_error_docref(
        NULL,
        E_WARNING,
        "not able to analyze the specified stream"
      );
    }
    RETURN_FALSE;
  }
  php_stream_error_operation_end_for_stream(stream);

  /* Check if the file descriptor is a console */
  if (!php_win32_console_fileno_is_console(fileno)) {
    RETURN_FALSE;
  }

  if (enable_is_null) {
    /* Check if the Windows standard handle has VT100 control codes enabled */
    RETURN_BOOL(php_win32_console_fileno_has_vt100(fileno));
  } else {
    /* Enable/disable VT100 control codes support for the specified Windows standard handle */
    RETURN_BOOL(php_win32_console_fileno_set_vt100(fileno, enable ? TRUE : FALSE));
  }
}
#endif

#ifdef HAVE_SHUTDOWN
/* {{{ causes all or part of a full-duplex connection on the socket associated
  with stream to be shut down.  If how is SHUT_RD,  further receptions will
  be disallowed. If how is SHUT_WR, further transmissions will be disallowed.
  If how is SHUT_RDWR,  further  receptions and transmissions will be
  disallowed. */
PHP_FUNCTION(stream_socket_shutdown)
{
  zend_long how;
  php_stream *stream;

  ZEND_PARSE_PARAMETERS_START(2, 2)
    PHP_Z_PARAM_STREAM(stream)
    Z_PARAM_LONG(how)
  ZEND_PARSE_PARAMETERS_END();

  if (how != STREAM_SHUT_RD &&
      how != STREAM_SHUT_WR &&
      how != STREAM_SHUT_RDWR) {
      zend_argument_value_error(2, "must be one of STREAM_SHUT_RD, STREAM_SHUT_WR, or STREAM_SHUT_RDWR");
    RETURN_THROWS();
  }

  php_stream_error_operation_begin();
  RETVAL_BOOL(php_stream_xport_shutdown(stream, (stream_shutdown_t)how) == 0);
  php_stream_error_operation_end_for_stream(stream);
}
/* }}} */
#endif

Coverage Report

Created: 2026-06-02 06:36