/src/php-src/main/php_streams.h

Source (jump to first uncovered line)
/*
   +----------------------------------------------------------------------+
   | Copyright (c) The PHP Group                                          |
   +----------------------------------------------------------------------+
   | This source file is subject to version 3.01 of the PHP license,      |
   | that is bundled with this package in the file LICENSE, and is        |
   | available through the world-wide-web at the following url:           |
   | https://www.php.net/license/3_01.txt                                 |
   | If you did not receive a copy of the PHP license and are unable to   |
   | obtain it through the world-wide-web, please send a note to          |
   | license@php.net so we can mail you a copy immediately.               |
   +----------------------------------------------------------------------+
   | Author: Wez Furlong (wez@thebrainroom.com)                           |
   +----------------------------------------------------------------------+
 */

#ifndef PHP_STREAMS_H
#define PHP_STREAMS_H

#ifdef HAVE_SYS_TIME_H
#include <sys/time.h>
#endif
#include <sys/types.h>
#include <sys/stat.h>
#include "zend.h"
#include "zend_stream.h"

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

#if ZEND_DEBUG
/* these have more of a dependency on the definitions of the zend macros than
 * I would prefer, but doing it this way saves loads of idefs :-/ */
# define STREAMS_D      int __php_stream_call_depth ZEND_FILE_LINE_DC ZEND_FILE_LINE_ORIG_DC
# define STREAMS_C      0 ZEND_FILE_LINE_CC ZEND_FILE_LINE_EMPTY_CC
# define STREAMS_REL_C    __php_stream_call_depth + 1 ZEND_FILE_LINE_CC, \
  __php_stream_call_depth ? __zend_orig_filename : __zend_filename, \
  __php_stream_call_depth ? __zend_orig_lineno : __zend_lineno

# define STREAMS_DC   , STREAMS_D
# define STREAMS_CC   , STREAMS_C
# define STREAMS_REL_CC , STREAMS_REL_C

#else
# define STREAMS_D
# define STREAMS_C
# define STREAMS_REL_C
# define STREAMS_DC
# define STREAMS_CC
# define STREAMS_REL_CC
#endif

/* these functions relay the file/line number information. They are depth aware, so they will pass
 * the ultimate ancestor, which is useful, because there can be several layers of calls */
#define php_stream_alloc_rel(ops, thisptr, persistent, mode) _php_stream_alloc((ops), (thisptr), (persistent), (mode) STREAMS_REL_CC)

#define php_stream_copy_to_mem_rel(src, maxlen, persistent) _php_stream_copy_to_mem((src), (buf), (maxlen), (persistent) STREAMS_REL_CC)

#define php_stream_fopen_rel(filename, mode, opened, options) _php_stream_fopen((filename), (mode), (opened), (options) STREAMS_REL_CC)

#define php_stream_fopen_with_path_rel(filename, mode, path, opened, options) _php_stream_fopen_with_path((filename), (mode), (path), (opened), (options) STREAMS_REL_CC)

#define php_stream_fopen_from_fd_rel(fd, mode, persistent_id, zero_position)   _php_stream_fopen_from_fd((fd), (mode), (persistent_id), (zero_position) STREAMS_REL_CC)
#define php_stream_fopen_from_file_rel(file, mode)   _php_stream_fopen_from_file((file), (mode) STREAMS_REL_CC)

#define php_stream_fopen_from_pipe_rel(file, mode)   _php_stream_fopen_from_pipe((file), (mode) STREAMS_REL_CC)

#define php_stream_fopen_tmpfile_rel()  _php_stream_fopen_tmpfile(0 STREAMS_REL_CC)

#define php_stream_fopen_temporary_file_rel(dir, pfx, opened_path)  _php_stream_fopen_temporary_file((dir), (pfx), (opened_path) STREAMS_REL_CC)

#define php_stream_open_wrapper_rel(path, mode, options, opened) _php_stream_open_wrapper_ex((path), (mode), (options), (opened), NULL STREAMS_REL_CC)
#define php_stream_open_wrapper_ex_rel(path, mode, options, opened, context) _php_stream_open_wrapper_ex((path), (mode), (options), (opened), (context) STREAMS_REL_CC)

#define php_stream_make_seekable_rel(origstream, newstream, flags) _php_stream_make_seekable((origstream), (newstream), (flags) STREAMS_REL_CC)

/* }}} */

/* The contents of the php_stream_ops and php_stream should only be accessed
 * using the functions/macros in this header.
 * If you need to get at something that doesn't have an API,
 * drop me a line <wez@thebrainroom.com> and we can sort out a way to do
 * it properly.
 *
 * The only exceptions to this rule are that stream implementations can use
 * the php_stream->abstract pointer to hold their context, and streams
 * opened via stream_open_wrappers can use the zval ptr in
 * php_stream->wrapperdata to hold metadata for php scripts to
 * retrieve using file_get_wrapper_data(). */

typedef struct _php_stream php_stream;
typedef struct _php_stream_wrapper php_stream_wrapper;
typedef struct _php_stream_context php_stream_context;
typedef struct _php_stream_filter php_stream_filter;

#include "streams/php_stream_context.h"
#include "streams/php_stream_filter_api.h"

typedef struct _php_stream_statbuf {
  zend_stat_t sb; /* regular info */
  /* extended info to go here some day: content-type etc. etc. */
} php_stream_statbuf;

typedef struct _php_stream_dirent {
  char d_name[MAXPATHLEN];
  unsigned char d_type;
} php_stream_dirent;

/* operations on streams that are file-handles */
typedef struct _php_stream_ops  {
  /* stdio like functions - these are mandatory! */
  ssize_t (*write)(php_stream *stream, const char *buf, size_t count);
  ssize_t (*read)(php_stream *stream, char *buf, size_t count);
  int    (*close)(php_stream *stream, int close_handle);
  int    (*flush)(php_stream *stream);

  const char *label; /* label for this ops structure */

  /* these are optional */
  int (*seek)(php_stream *stream, zend_off_t offset, int whence, zend_off_t *newoffset);
  int (*cast)(php_stream *stream, int castas, void **ret);
  int (*stat)(php_stream *stream, php_stream_statbuf *ssb);
  int (*set_option)(php_stream *stream, int option, int value, void *ptrparam);
} php_stream_ops;

typedef struct _php_stream_wrapper_ops {
  /* open/create a wrapped stream */
  php_stream *(*stream_opener)(php_stream_wrapper *wrapper, const char *filename, const char *mode,
      int options, zend_string **opened_path, php_stream_context *context STREAMS_DC);
  /* close/destroy a wrapped stream */
  int (*stream_closer)(php_stream_wrapper *wrapper, php_stream *stream);
  /* stat a wrapped stream */
  int (*stream_stat)(php_stream_wrapper *wrapper, php_stream *stream, php_stream_statbuf *ssb);
  /* stat a URL */
  int (*url_stat)(php_stream_wrapper *wrapper, const char *url, int flags, php_stream_statbuf *ssb, php_stream_context *context);
  /* open a "directory" stream */
  php_stream *(*dir_opener)(php_stream_wrapper *wrapper, const char *filename, const char *mode,
      int options, zend_string **opened_path, php_stream_context *context STREAMS_DC);

  const char *label;

  /* delete a file */
  int (*unlink)(php_stream_wrapper *wrapper, const char *url, int options, php_stream_context *context);

  /* rename a file */
  int (*rename)(php_stream_wrapper *wrapper, const char *url_from, const char *url_to, int options, php_stream_context *context);

  /* Create/Remove directory */
  int (*stream_mkdir)(php_stream_wrapper *wrapper, const char *url, int mode, int options, php_stream_context *context);
  int (*stream_rmdir)(php_stream_wrapper *wrapper, const char *url, int options, php_stream_context *context);
  /* Metadata handling */
  int (*stream_metadata)(php_stream_wrapper *wrapper, const char *url, int options, void *value, php_stream_context *context);
} php_stream_wrapper_ops;

struct _php_stream_wrapper  {
  const php_stream_wrapper_ops *wops; /* operations the wrapper can perform */
  void *abstract;         /* context for the wrapper */
  int is_url;           /* so that PG(allow_url_fopen) can be respected */
};

#define PHP_STREAM_FLAG_NO_SEEK           0x1
#define PHP_STREAM_FLAG_NO_BUFFER         0x2

#define PHP_STREAM_FLAG_EOL_UNIX          0x0 /* also includes DOS */
#define PHP_STREAM_FLAG_DETECT_EOL          0x4
#define PHP_STREAM_FLAG_EOL_MAC           0x8

/* set this when the stream might represent "interactive" data.
 * When set, the read buffer will avoid certain operations that
 * might otherwise cause the read to block for much longer than
 * is strictly required. */
#define PHP_STREAM_FLAG_AVOID_BLOCKING          0x10

#define PHP_STREAM_FLAG_NO_CLOSE          0x20

#define PHP_STREAM_FLAG_IS_DIR            0x40

#define PHP_STREAM_FLAG_NO_FCLOSE         0x80

/* Suppress generation of PHP warnings on stream read/write errors.
 * Currently, for internal use only. */
#define PHP_STREAM_FLAG_SUPPRESS_ERRORS       0x100

/* Do not close handle except it is explicitly closed by user (e.g. fclose) */
#define PHP_STREAM_FLAG_NO_RSCR_DTOR_CLOSE      0x200

#define PHP_STREAM_FLAG_NO_IO           0x400

#define PHP_STREAM_FLAG_WAS_WRITTEN         0x80000000

struct _php_stream  {
  const php_stream_ops *ops;
  void *abstract;     /* convenience pointer for abstraction */

  php_stream_filter_chain readfilters, writefilters;

  php_stream_wrapper *wrapper; /* which wrapper was used to open the stream */
  void *wrapperthis;    /* convenience pointer for an instance of a wrapper */
  zval wrapperdata;   /* fgetwrapperdata retrieves this */

  uint16_t is_persistent:1;
  uint16_t in_free:2;     /* to prevent recursion during free */
  uint16_t eof:1;
  uint16_t __exposed:1; /* non-zero if exposed as a zval somewhere */

  /* so we know how to clean it up correctly.  This should be set to
   * PHP_STREAM_FCLOSE_XXX as appropriate */
  uint16_t fclose_stdiocast:2;


  /* flag to mark whether the stream has buffered data */
  uint16_t has_buffered_data:1;

  /* whether stdio cast flushing is in progress */
  uint16_t fclose_stdiocast_flush_in_progress:1;

  /* whether fatal error happened and all operations should terminates as soon as possible */
  uint16_t fatal_error:1;

  char mode[16];      /* "rwb" etc. ala stdio */

  uint32_t flags; /* PHP_STREAM_FLAG_XXX */

  zend_resource *res;   /* used for auto-cleanup */
  FILE *stdiocast;    /* cache this, otherwise we might leak! */
  char *orig_path;

  zend_resource *ctx;

  /* buffer */
  zend_off_t position; /* of underlying stream */
  unsigned char *readbuf;
  size_t readbuflen;
  zend_off_t readpos;
  zend_off_t writepos;

  /* how much data to read when filling buffer */
  size_t chunk_size;

#if ZEND_DEBUG
  const char *open_filename;
  uint32_t open_lineno;
#endif

  struct _php_stream *enclosing_stream; /* this is a private stream owned by enclosing_stream */
}; /* php_stream */

#define PHP_STREAM_CONTEXT(stream) \
  ((php_stream_context*) ((stream)->ctx ? ((stream)->ctx->ptr) : NULL))

/* state definitions when closing down; these are private to streams.c */
#define PHP_STREAM_FCLOSE_NONE 0
#define PHP_STREAM_FCLOSE_FDOPEN  1
#define PHP_STREAM_FCLOSE_FOPENCOOKIE 2

/* allocate a new stream for a particular ops */
BEGIN_EXTERN_C()
PHPAPI php_stream *_php_stream_alloc(const php_stream_ops *ops, void *abstract,
    const char *persistent_id, const char *mode STREAMS_DC);
END_EXTERN_C()
#define php_stream_alloc(ops, thisptr, persistent_id, mode) _php_stream_alloc((ops), (thisptr), (persistent_id), (mode) STREAMS_CC)

#define php_stream_get_resource_id(stream)    ((php_stream *)(stream))->res->handle
/* use this to tell the stream that it is OK if we don't explicitly close it */
#define php_stream_auto_cleanup(stream) { (stream)->__exposed = 1; }
/* use this to assign the stream to a zval and tell the stream that is
 * has been exported to the engine; it will expect to be closed automatically
 * when the resources are auto-destructed */
#define php_stream_to_zval(stream, zval)  { ZVAL_RES(zval, (stream)->res); (stream)->__exposed = 1; }

#define php_stream_from_zval(xstr, pzval) do { \
  if (((xstr) = (php_stream*)zend_fetch_resource2_ex((pzval), \
        "stream", php_file_le_stream(), php_file_le_pstream())) == NULL) { \
    return; \
  } \
} while (0)
#define php_stream_from_res(xstr, res)  do { \
  if (((xstr) = (php_stream*)zend_fetch_resource2((res), \
          "stream", php_file_le_stream(), php_file_le_pstream())) == NULL) { \
    return; \
  } \
} while (0)
#define php_stream_from_res_no_verify(xstr, pzval)  (xstr) = (php_stream*)zend_fetch_resource2((res), "stream", php_file_le_stream(), php_file_le_pstream())
#define php_stream_from_zval_no_verify(xstr, pzval) (xstr) = (php_stream*)zend_fetch_resource2_ex((pzval), "stream", php_file_le_stream(), php_file_le_pstream())

static zend_always_inline php_stream* php_stream_from_zval_no_verify_no_error(zval *zval) {
  return (php_stream*)zend_fetch_resource2_ex(zval, NULL, php_file_le_stream(), php_file_le_pstream());
}

BEGIN_EXTERN_C()

static zend_always_inline bool php_stream_zend_parse_arg_into_stream(
  zval *arg,
  php_stream **destination_stream_ptr,
  bool check_null,
  uint32_t arg_num
) {
  if (EXPECTED(Z_TYPE_P(arg) == IS_RESOURCE)) {
    zend_resource *res = Z_RES_P(arg);
    /* We do not use zend_fetch_resource2() API,
     * as we want to be able to specify the argument number in the type error */
    if (EXPECTED(res->type == php_file_le_stream() || res->type == php_file_le_pstream())) {
      *destination_stream_ptr = (php_stream*)res->ptr;
      return true;
    } else {
      zend_argument_type_error(arg_num, "must be an open stream resource");
      return false;
    }
  } else if (check_null && EXPECTED(Z_TYPE_P(arg) == IS_NULL)) {
    *destination_stream_ptr = NULL;
  } else {
    return false;
  }
  return true;
}

#define PHP_Z_PARAM_STREAM_EX(destination_stream_ptr, check_null) \
  Z_PARAM_PROLOGUE(0, 0); \
  if (UNEXPECTED(!php_stream_zend_parse_arg_into_stream(_arg, &destination_stream_ptr, check_null, _i))) { \
    _error_code = ZPP_ERROR_FAILURE; \
    if (!EG(exception)) { \
      _expected_type = check_null ? Z_EXPECTED_RESOURCE_OR_NULL : Z_EXPECTED_RESOURCE; \
      _error_code = ZPP_ERROR_WRONG_ARG; \
    } \
    break; \
  }
#define PHP_Z_PARAM_STREAM(dest) PHP_Z_PARAM_STREAM_EX(dest, false)
#define PHP_Z_PARAM_STREAM_OR_NULL(dest) PHP_Z_PARAM_STREAM_EX(dest, true)

PHPAPI php_stream *php_stream_encloses(php_stream *enclosing, php_stream *enclosed);
#define php_stream_free_enclosed(stream_enclosed, close_options) _php_stream_free_enclosed((stream_enclosed), (close_options))
PHPAPI int _php_stream_free_enclosed(php_stream *stream_enclosed, int close_options);

PHPAPI int php_stream_from_persistent_id(const char *persistent_id, php_stream **stream);
#define PHP_STREAM_PERSISTENT_SUCCESS 0 /* id exists */
#define PHP_STREAM_PERSISTENT_FAILURE 1 /* id exists but is not a stream! */
#define PHP_STREAM_PERSISTENT_NOT_EXIST 2 /* id does not exist */

#define PHP_STREAM_FREE_CALL_DTOR     1 /* call ops->close */
#define PHP_STREAM_FREE_RELEASE_STREAM    2 /* pefree(stream) */
#define PHP_STREAM_FREE_PRESERVE_HANDLE   4 /* tell ops->close to not close its underlying handle */
#define PHP_STREAM_FREE_RSRC_DTOR     8 /* called from the resource list dtor */
#define PHP_STREAM_FREE_PERSISTENT      16 /* manually freeing a persistent connection */
#define PHP_STREAM_FREE_IGNORE_ENCLOSING  32 /* don't close the enclosing stream instead */
#define PHP_STREAM_FREE_KEEP_RSRC     64 /* keep associated zend_resource */
#define PHP_STREAM_FREE_CLOSE       (PHP_STREAM_FREE_CALL_DTOR | PHP_STREAM_FREE_RELEASE_STREAM)
#define PHP_STREAM_FREE_CLOSE_CASTED    (PHP_STREAM_FREE_CLOSE | PHP_STREAM_FREE_PRESERVE_HANDLE)
#define PHP_STREAM_FREE_CLOSE_PERSISTENT  (PHP_STREAM_FREE_CLOSE | PHP_STREAM_FREE_PERSISTENT)

PHPAPI int _php_stream_free(php_stream *stream, int close_options);
#define php_stream_free(stream, close_options)  _php_stream_free((stream), (close_options))
#define php_stream_close(stream)  _php_stream_free((stream), PHP_STREAM_FREE_CLOSE)
#define php_stream_pclose(stream) _php_stream_free((stream), PHP_STREAM_FREE_CLOSE_PERSISTENT)

PHPAPI int _php_stream_seek(php_stream *stream, zend_off_t offset, int whence);
#define php_stream_rewind(stream) _php_stream_seek((stream), 0L, SEEK_SET)
#define php_stream_seek(stream, offset, whence) _php_stream_seek((stream), (offset), (whence))

PHPAPI zend_off_t _php_stream_tell(php_stream *stream);
#define php_stream_tell(stream) _php_stream_tell((stream))

PHPAPI ssize_t _php_stream_read(php_stream *stream, char *buf, size_t count);
#define php_stream_read(stream, buf, count)   _php_stream_read((stream), (buf), (count))

PHPAPI zend_string *php_stream_read_to_str(php_stream *stream, size_t len);

PHPAPI ssize_t _php_stream_write(php_stream *stream, const char *buf, size_t count);
#define php_stream_write_string(stream, str)  _php_stream_write(stream, str, strlen(str))
#define php_stream_write(stream, buf, count)  _php_stream_write(stream, (buf), (count))

PHPAPI zend_result _php_stream_fill_read_buffer(php_stream *stream, size_t size);
#define php_stream_fill_read_buffer(stream, size) _php_stream_fill_read_buffer((stream), (size))

PHPAPI ssize_t _php_stream_printf(php_stream *stream, const char *fmt, ...) PHP_ATTRIBUTE_FORMAT(printf, 2, 3);

/* php_stream_printf macro & function require */
#define php_stream_printf _php_stream_printf

PHPAPI bool _php_stream_eof(php_stream *stream);
#define php_stream_eof(stream)  _php_stream_eof((stream))

PHPAPI int _php_stream_getc(php_stream *stream);
#define php_stream_getc(stream) _php_stream_getc((stream))

PHPAPI int _php_stream_putc(php_stream *stream, int c);
#define php_stream_putc(stream, c)  _php_stream_putc((stream), (c))

PHPAPI int _php_stream_flush(php_stream *stream, int closing);
#define php_stream_flush(stream)  _php_stream_flush((stream), 0)

PHPAPI int _php_stream_sync(php_stream *stream, bool data_only);
#define php_stream_sync(stream, d)      _php_stream_sync((stream), (d))

PHPAPI char *_php_stream_get_line(php_stream *stream, char *buf, size_t maxlen, size_t *returned_len);
#define php_stream_gets(stream, buf, maxlen)  _php_stream_get_line((stream), (buf), (maxlen), NULL)

#define php_stream_get_line(stream, buf, maxlen, retlen) _php_stream_get_line((stream), (buf), (maxlen), (retlen))
PHPAPI zend_string *php_stream_get_record(php_stream *stream, size_t maxlen, const char *delim, size_t delim_len);

/* Returns true if buffer has been appended, false on error */
PHPAPI bool _php_stream_puts(php_stream *stream, const char *buf);
#define php_stream_puts(stream, buf)  _php_stream_puts((stream), (buf))

PHPAPI int _php_stream_stat(php_stream *stream, php_stream_statbuf *ssb);
#define php_stream_stat(stream, ssb)  _php_stream_stat((stream), (ssb))

PHPAPI int _php_stream_stat_path(const char *path, int flags, php_stream_statbuf *ssb, php_stream_context *context);
#define php_stream_stat_path(path, ssb) _php_stream_stat_path((path), 0, (ssb), NULL)
#define php_stream_stat_path_ex(path, flags, ssb, context)  _php_stream_stat_path((path), (flags), (ssb), (context))

PHPAPI int _php_stream_mkdir(const char *path, int mode, int options, php_stream_context *context);
#define php_stream_mkdir(path, mode, options, context)  _php_stream_mkdir(path, mode, options, context)

PHPAPI int _php_stream_rmdir(const char *path, int options, php_stream_context *context);
#define php_stream_rmdir(path, options, context)  _php_stream_rmdir(path, options, context)

PHPAPI php_stream *_php_stream_opendir(const char *path, int options, php_stream_context *context STREAMS_DC);
#define php_stream_opendir(path, options, context)  _php_stream_opendir((path), (options), (context) STREAMS_CC)
PHPAPI php_stream_dirent *_php_stream_readdir(php_stream *dirstream, php_stream_dirent *ent);
#define php_stream_readdir(dirstream, dirent) _php_stream_readdir((dirstream), (dirent))
#define php_stream_closedir(dirstream)  php_stream_close((dirstream))
#define php_stream_rewinddir(dirstream) php_stream_rewind((dirstream))

PHPAPI int php_stream_dirent_alphasort(const zend_string **a, const zend_string **b);
PHPAPI int php_stream_dirent_alphasortr(const zend_string **a, const zend_string **b);

PHPAPI int _php_stream_scandir(const char *dirname, zend_string **namelist[], int flags, php_stream_context *context,
      int (*compare) (const zend_string **a, const zend_string **b));
#define php_stream_scandir(dirname, namelist, context, compare) _php_stream_scandir((dirname), (namelist), 0, (context), (compare))

PHPAPI int _php_stream_set_option(php_stream *stream, int option, int value, void *ptrparam);
#define php_stream_set_option(stream, option, value, ptrvalue)  _php_stream_set_option((stream), (option), (value), (ptrvalue))

#define php_stream_set_chunk_size(stream, size) _php_stream_set_option((stream), PHP_STREAM_OPTION_SET_CHUNK_SIZE, (size), NULL)

END_EXTERN_C()


/* Flags for mkdir method in wrapper ops */
#define PHP_STREAM_MKDIR_RECURSIVE  1
/* define REPORT ERRORS 8 (below) */

/* Flags for rmdir method in wrapper ops */
/* define REPORT_ERRORS 8 (below) */

/* Flags for url_stat method in wrapper ops */
#define PHP_STREAM_URL_STAT_LINK  1
#define PHP_STREAM_URL_STAT_QUIET 2
#define PHP_STREAM_URL_STAT_IGNORE_OPEN_BASEDIR 4

/* change the blocking mode of stream: value == 1 => blocking, value == 0 => non-blocking. */
#define PHP_STREAM_OPTION_BLOCKING  1

/* change the buffering mode of stream. value is a PHP_STREAM_BUFFER_XXXX value, ptrparam is a ptr to a size_t holding
 * the required buffer size */
#define PHP_STREAM_OPTION_READ_BUFFER 2
#define PHP_STREAM_OPTION_WRITE_BUFFER  3

#define PHP_STREAM_BUFFER_NONE  0  /* unbuffered */
#define PHP_STREAM_BUFFER_LINE  1  /* line buffered */
#define PHP_STREAM_BUFFER_FULL  2  /* fully buffered */

/* set the timeout duration for reads on the stream. ptrparam is a pointer to a struct timeval * */
#define PHP_STREAM_OPTION_READ_TIMEOUT  4
#define PHP_STREAM_OPTION_SET_CHUNK_SIZE  5

/* set or release lock on a stream */
#define PHP_STREAM_OPTION_LOCKING   6

/* whether or not locking is supported */
#define PHP_STREAM_LOCK_SUPPORTED   1

#define php_stream_supports_lock(stream)  (_php_stream_set_option((stream), PHP_STREAM_OPTION_LOCKING, 0, (void *) PHP_STREAM_LOCK_SUPPORTED) == 0 ? 1 : 0)
#define php_stream_lock(stream, mode)   _php_stream_set_option((stream), PHP_STREAM_OPTION_LOCKING, (mode), (void *) NULL)

/* option code used by the php_stream_xport_XXX api */
#define PHP_STREAM_OPTION_XPORT_API     7 /* see php_stream_transport.h */
#define PHP_STREAM_OPTION_CRYPTO_API    8 /* see php_stream_transport.h */
#define PHP_STREAM_OPTION_MMAP_API      9 /* see php_stream_mmap.h */
#define PHP_STREAM_OPTION_TRUNCATE_API    10

#define PHP_STREAM_TRUNCATE_SUPPORTED 0
#define PHP_STREAM_TRUNCATE_SET_SIZE  1  /* ptrparam is a pointer to a size_t */

#define php_stream_truncate_supported(stream) (_php_stream_set_option((stream), PHP_STREAM_OPTION_TRUNCATE_API, PHP_STREAM_TRUNCATE_SUPPORTED, NULL) == PHP_STREAM_OPTION_RETURN_OK ? 1 : 0)

BEGIN_EXTERN_C()
PHPAPI int _php_stream_truncate_set_size(php_stream *stream, size_t newsize);
#define php_stream_truncate_set_size(stream, size)  _php_stream_truncate_set_size((stream), (size))
END_EXTERN_C()

#define PHP_STREAM_OPTION_META_DATA_API   11 /* ptrparam is a zval* to which to add metadata information */
#define php_stream_populate_meta_data(stream, zv) (_php_stream_set_option((stream), PHP_STREAM_OPTION_META_DATA_API, 0, zv) == PHP_STREAM_OPTION_RETURN_OK ? 1 : 0)

/* Check if the stream is still "live"; for sockets/pipes this means the socket
 * is still connected; for files, this does not really have meaning */
#define PHP_STREAM_OPTION_CHECK_LIVENESS  12 /* no parameters */

/* Enable/disable blocking reads on anonymous pipes on Windows. */
#define PHP_STREAM_OPTION_PIPE_BLOCKING 13

/* Stream can support fsync operation */
#define PHP_STREAM_OPTION_SYNC_API    14
#define PHP_STREAM_SYNC_SUPPORTED 0
#define PHP_STREAM_SYNC_FSYNC 1
#define PHP_STREAM_SYNC_FDSYNC 2

#define php_stream_sync_supported(stream) (_php_stream_set_option((stream), PHP_STREAM_OPTION_SYNC_API, PHP_STREAM_SYNC_SUPPORTED, NULL) == PHP_STREAM_OPTION_RETURN_OK ? 1 : 0)


#define PHP_STREAM_OPTION_RETURN_OK      0 /* option set OK */
#define PHP_STREAM_OPTION_RETURN_ERR    -1 /* problem setting option */
#define PHP_STREAM_OPTION_RETURN_NOTIMPL  -2 /* underlying stream does not implement; streams can handle it instead */

/* copy up to maxlen bytes from src to dest.  If maxlen is PHP_STREAM_COPY_ALL,
 * copy until eof(src). */
#define PHP_STREAM_COPY_ALL   ((size_t)-1)

BEGIN_EXTERN_C()
ZEND_ATTRIBUTE_DEPRECATED
PHPAPI size_t _php_stream_copy_to_stream(php_stream *src, php_stream *dest, size_t maxlen STREAMS_DC);
#define php_stream_copy_to_stream(src, dest, maxlen)  _php_stream_copy_to_stream((src), (dest), (maxlen) STREAMS_CC)
PHPAPI zend_result _php_stream_copy_to_stream_ex(php_stream *src, php_stream *dest, size_t maxlen, size_t *len STREAMS_DC);
#define php_stream_copy_to_stream_ex(src, dest, maxlen, len)  _php_stream_copy_to_stream_ex((src), (dest), (maxlen), (len) STREAMS_CC)


/* read all data from stream and put into a buffer. Caller must free buffer
 * when done. */
PHPAPI zend_string *_php_stream_copy_to_mem(php_stream *src, size_t maxlen, int persistent STREAMS_DC);
#define php_stream_copy_to_mem(src, maxlen, persistent) _php_stream_copy_to_mem((src), (maxlen), (persistent) STREAMS_CC)

/* output all data from a stream */
PHPAPI ssize_t _php_stream_passthru(php_stream * src STREAMS_DC);
#define php_stream_passthru(stream) _php_stream_passthru((stream) STREAMS_CC)
END_EXTERN_C()

#include "streams/php_stream_transport.h"
#include "streams/php_stream_plain_wrapper.h"
#include "streams/php_stream_glob_wrapper.h"
#include "streams/php_stream_userspace.h"
#include "streams/php_stream_mmap.h"

/* coerce the stream into some other form */
/* cast as a stdio FILE * */
#define PHP_STREAM_AS_STDIO     0
/* cast as a POSIX fd or socketd */
#define PHP_STREAM_AS_FD    1
/* cast as a socketd */
#define PHP_STREAM_AS_SOCKETD 2
/* cast as fd/socket for select purposes */
#define PHP_STREAM_AS_FD_FOR_SELECT 3

/* try really, really hard to make sure the cast happens (avoid using this flag if possible) */
#define PHP_STREAM_CAST_TRY_HARD  0x80000000
#define PHP_STREAM_CAST_RELEASE   0x40000000  /* stream becomes invalid on success */
#define PHP_STREAM_CAST_INTERNAL  0x20000000  /* stream cast for internal use */
#define PHP_STREAM_CAST_MASK    (PHP_STREAM_CAST_TRY_HARD | PHP_STREAM_CAST_RELEASE | PHP_STREAM_CAST_INTERNAL)
BEGIN_EXTERN_C()
PHPAPI int _php_stream_cast(php_stream *stream, int castas, void **ret, int show_err);
END_EXTERN_C()
/* use this to check if a stream can be cast into another form */
#define php_stream_can_cast(stream, as) _php_stream_cast((stream), (as), NULL, 0)
#define php_stream_cast(stream, as, ret, show_err)  _php_stream_cast((stream), (as), (ret), (show_err))

/* use this to check if a stream is of a particular type:
 * PHPAPI int php_stream_is(php_stream *stream, php_stream_ops *ops); */
#define php_stream_is(stream, anops)    ((stream)->ops == anops)
#define PHP_STREAM_IS_STDIO &php_stream_stdio_ops

#define php_stream_is_persistent(stream)  (stream)->is_persistent

/* Wrappers support */

#define IGNORE_PATH                     0x00000000
#define USE_PATH                        0x00000001
#define IGNORE_URL                      0x00000002
#define REPORT_ERRORS                   0x00000008

/* If you don't need to write to the stream, but really need to
 * be able to seek, use this flag in your options. */
#define STREAM_MUST_SEEK                0x00000010
/* If you are going to end up casting the stream into a FILE* or
 * a socket, pass this flag and the streams/wrappers will not use
 * buffering mechanisms while reading the headers, so that HTTP
 * wrapped streams will work consistently.
 * If you omit this flag, streams will use buffering and should end
 * up working more optimally.
 * */
#define STREAM_WILL_CAST                0x00000020

/* this flag applies to php_stream_locate_url_wrapper */
#define STREAM_LOCATE_WRAPPERS_ONLY     0x00000040

/* this flag is only used by include/require functions */
#define STREAM_OPEN_FOR_INCLUDE         0x00000080

/* this flag tells streams to ONLY open urls */
#define STREAM_USE_URL                  0x00000100

/* this flag is used when only the headers from HTTP request are to be fetched */
#define STREAM_ONLY_GET_HEADERS         0x00000200

/* don't apply open_basedir checks */
#define STREAM_DISABLE_OPEN_BASEDIR     0x00000400

/* get (or create) a persistent version of the stream */
#define STREAM_OPEN_PERSISTENT          0x00000800

/* use glob stream for directory open in plain files stream */
#define STREAM_USE_GLOB_DIR_OPEN        0x00001000

/* don't check allow_url_fopen and allow_url_include */
#define STREAM_DISABLE_URL_PROTECTION   0x00002000

/* assume the path passed in exists and is fully expanded, avoiding syscalls */
#define STREAM_ASSUME_REALPATH          0x00004000

/* Allow blocking reads on anonymous pipes on Windows. */
#define STREAM_USE_BLOCKING_PIPE        0x00008000

/* this flag is only used by include/require functions */
#define STREAM_OPEN_FOR_ZEND_STREAM     0x00010000

int php_init_stream_wrappers(int module_number);
void php_shutdown_stream_wrappers(int module_number);
void php_shutdown_stream_hashes(void);
PHP_RSHUTDOWN_FUNCTION(streams);

BEGIN_EXTERN_C()
PHPAPI zend_result php_register_url_stream_wrapper(const char *protocol, const php_stream_wrapper *wrapper);
PHPAPI zend_result php_unregister_url_stream_wrapper(const char *protocol);
PHPAPI zend_result php_register_url_stream_wrapper_volatile(zend_string *protocol, php_stream_wrapper *wrapper);
PHPAPI zend_result php_unregister_url_stream_wrapper_volatile(zend_string *protocol);
PHPAPI php_stream *_php_stream_open_wrapper_ex(const char *path, const char *mode, int options, zend_string **opened_path, php_stream_context *context STREAMS_DC);
PHPAPI php_stream_wrapper *php_stream_locate_url_wrapper(const char *path, const char **path_for_open, int options);
PHPAPI const char *php_stream_locate_eol(php_stream *stream, zend_string *buf);

#define php_stream_open_wrapper(path, mode, options, opened)  _php_stream_open_wrapper_ex((path), (mode), (options), (opened), NULL STREAMS_CC)
#define php_stream_open_wrapper_ex(path, mode, options, opened, context)  _php_stream_open_wrapper_ex((path), (mode), (options), (opened), (context) STREAMS_CC)

/* pushes an error message onto the stack for a wrapper instance */
PHPAPI void php_stream_wrapper_log_error(const php_stream_wrapper *wrapper, int options, const char *fmt, ...) PHP_ATTRIBUTE_FORMAT(printf, 3, 4);

#define PHP_STREAM_UNCHANGED  0 /* orig stream was seekable anyway */
#define PHP_STREAM_RELEASED   1 /* newstream should be used; origstream is no longer valid */
#define PHP_STREAM_FAILED   2 /* an error occurred while attempting conversion */
#define PHP_STREAM_CRITICAL   3 /* an error occurred; origstream is in an unknown state; you should close origstream */
#define PHP_STREAM_NO_PREFERENCE  0
#define PHP_STREAM_PREFER_STDIO   1
#define PHP_STREAM_FORCE_CONVERSION 2
/* DO NOT call this on streams that are referenced by resources! */
PHPAPI int _php_stream_make_seekable(php_stream *origstream, php_stream **newstream, int flags STREAMS_DC);
#define php_stream_make_seekable(origstream, newstream, flags)  _php_stream_make_seekable((origstream), (newstream), (flags) STREAMS_CC)

/* Give other modules access to the url_stream_wrappers_hash and stream_filters_hash */
PHPAPI HashTable *_php_stream_get_url_stream_wrappers_hash(void);
#define php_stream_get_url_stream_wrappers_hash() _php_stream_get_url_stream_wrappers_hash()
PHPAPI HashTable *php_stream_get_url_stream_wrappers_hash_global(void);
PHPAPI HashTable *_php_get_stream_filters_hash(void);
#define php_get_stream_filters_hash() _php_get_stream_filters_hash()
PHPAPI HashTable *php_get_stream_filters_hash_global(void);
extern const php_stream_wrapper_ops *php_stream_user_wrapper_ops;

static inline bool php_is_stream_path(const char *filename)
{
  const char *p;

  for (p = filename;
       (*p >= 'a' && *p <= 'z') ||
       (*p >= 'A' && *p <= 'Z') ||
       (*p >= '0' && *p <= '9') ||
       *p == '+' || *p == '-' || *p == '.';
       p++);
  return ((p != filename) && (p[0] == ':') && (p[1] == '/') && (p[2] == '/'));
}

END_EXTERN_C()
#endif

/* Definitions for user streams */
#define PHP_STREAM_IS_URL   1

/* Stream metadata definitions */
/* Create if referred resource does not exist */
#define PHP_STREAM_META_TOUCH   1
#define PHP_STREAM_META_OWNER_NAME  2
#define PHP_STREAM_META_OWNER   3
#define PHP_STREAM_META_GROUP_NAME  4
#define PHP_STREAM_META_GROUP   5
#define PHP_STREAM_META_ACCESS    6

Coverage Report

Created: 2025-07-23 06:33