root/main/php_streams.h

INCLUDED FROM

   1 /*
   2    +----------------------------------------------------------------------+
   3    | PHP Version 7                                                        |
   4    +----------------------------------------------------------------------+
   5    | Copyright (c) 1997-2016 The PHP Group                                |
   6    +----------------------------------------------------------------------+
   7    | This source file is subject to version 3.01 of the PHP license,      |
   8    | that is bundled with this package in the file LICENSE, and is        |
   9    | available through the world-wide-web at the following url:           |
  10    | http://www.php.net/license/3_01.txt                                  |
  11    | If you did not receive a copy of the PHP license and are unable to   |
  12    | obtain it through the world-wide-web, please send a note to          |
  13    | license@php.net so we can mail you a copy immediately.               |
  14    +----------------------------------------------------------------------+
  15    | Author: Wez Furlong (wez@thebrainroom.com)                           |
  16    +----------------------------------------------------------------------+
  17  */
  18 
  19 /* $Id$ */
  20 
  21 #ifndef PHP_STREAMS_H
  22 #define PHP_STREAMS_H
  23 
  24 #ifdef HAVE_SYS_TIME_H
  25 #include <sys/time.h>
  26 #endif
  27 #include <sys/types.h>
  28 #include <sys/stat.h>
  29 #include "zend.h"
  30 #include "zend_stream.h"
  31 
  32 BEGIN_EXTERN_C()
  33 PHPAPI int php_file_le_stream(void);
  34 PHPAPI int php_file_le_pstream(void);
  35 PHPAPI int php_file_le_stream_filter(void);
  36 END_EXTERN_C()
  37 
  38 /* {{{ Streams memory debugging stuff */
  39 
  40 #if ZEND_DEBUG
  41 /* these have more of a dependency on the definitions of the zend macros than
  42  * I would prefer, but doing it this way saves loads of idefs :-/ */
  43 # define STREAMS_D                      int __php_stream_call_depth ZEND_FILE_LINE_DC ZEND_FILE_LINE_ORIG_DC
  44 # define STREAMS_C                      0 ZEND_FILE_LINE_CC ZEND_FILE_LINE_EMPTY_CC
  45 # define STREAMS_REL_C          __php_stream_call_depth + 1 ZEND_FILE_LINE_CC, \
  46         __php_stream_call_depth ? __zend_orig_filename : __zend_filename, \
  47         __php_stream_call_depth ? __zend_orig_lineno : __zend_lineno
  48 
  49 # define STREAMS_DC             , STREAMS_D
  50 # define STREAMS_CC             , STREAMS_C
  51 # define STREAMS_REL_CC , STREAMS_REL_C
  52 
  53 #else
  54 # define STREAMS_D
  55 # define STREAMS_C
  56 # define STREAMS_REL_C
  57 # define STREAMS_DC
  58 # define STREAMS_CC
  59 # define STREAMS_REL_CC
  60 #endif
  61 
  62 /* these functions relay the file/line number information. They are depth aware, so they will pass
  63  * the ultimate ancestor, which is useful, because there can be several layers of calls */
  64 #define php_stream_alloc_rel(ops, thisptr, persistent, mode) _php_stream_alloc((ops), (thisptr), (persistent), (mode) STREAMS_REL_CC)
  65 
  66 #define php_stream_copy_to_mem_rel(src, maxlen, persistent) _php_stream_copy_to_mem((src), (buf), (maxlen), (persistent) STREAMS_REL_CC)
  67 
  68 #define php_stream_fopen_rel(filename, mode, opened, options) _php_stream_fopen((filename), (mode), (opened), (options) STREAMS_REL_CC)
  69 
  70 #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)
  71 
  72 #define php_stream_fopen_from_fd_rel(fd, mode, persistent_id)    _php_stream_fopen_from_fd((fd), (mode), (persistent_id) STREAMS_REL_CC)
  73 #define php_stream_fopen_from_file_rel(file, mode)       _php_stream_fopen_from_file((file), (mode) STREAMS_REL_CC)
  74 
  75 #define php_stream_fopen_from_pipe_rel(file, mode)       _php_stream_fopen_from_pipe((file), (mode) STREAMS_REL_CC)
  76 
  77 #define php_stream_fopen_tmpfile_rel()  _php_stream_fopen_tmpfile(0 STREAMS_REL_CC)
  78 
  79 #define php_stream_fopen_temporary_file_rel(dir, pfx, opened_path)      _php_stream_fopen_temporary_file((dir), (pfx), (opened_path) STREAMS_REL_CC)
  80 
  81 #define php_stream_open_wrapper_rel(path, mode, options, opened) _php_stream_open_wrapper_ex((path), (mode), (options), (opened), NULL STREAMS_REL_CC)
  82 #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)
  83 
  84 #define php_stream_make_seekable_rel(origstream, newstream, flags) _php_stream_make_seekable((origstream), (newstream), (flags) STREAMS_REL_CC)
  85 
  86 /* }}} */
  87 
  88 /* The contents of the php_stream_ops and php_stream should only be accessed
  89  * using the functions/macros in this header.
  90  * If you need to get at something that doesn't have an API,
  91  * drop me a line <wez@thebrainroom.com> and we can sort out a way to do
  92  * it properly.
  93  *
  94  * The only exceptions to this rule are that stream implementations can use
  95  * the php_stream->abstract pointer to hold their context, and streams
  96  * opened via stream_open_wrappers can use the zval ptr in
  97  * php_stream->wrapperdata to hold meta data for php scripts to
  98  * retrieve using file_get_wrapper_data(). */
  99 
 100 typedef struct _php_stream php_stream;
 101 typedef struct _php_stream_wrapper php_stream_wrapper;
 102 typedef struct _php_stream_context php_stream_context;
 103 typedef struct _php_stream_filter php_stream_filter;
 104 
 105 #include "streams/php_stream_context.h"
 106 #include "streams/php_stream_filter_api.h"
 107 
 108 typedef struct _php_stream_statbuf {
 109         zend_stat_t sb; /* regular info */
 110         /* extended info to go here some day: content-type etc. etc. */
 111 } php_stream_statbuf;
 112 
 113 typedef struct _php_stream_dirent {
 114         char d_name[MAXPATHLEN];
 115 } php_stream_dirent;
 116 
 117 /* operations on streams that are file-handles */
 118 typedef struct _php_stream_ops  {
 119         /* stdio like functions - these are mandatory! */
 120         size_t (*write)(php_stream *stream, const char *buf, size_t count);
 121         size_t (*read)(php_stream *stream, char *buf, size_t count);
 122         int    (*close)(php_stream *stream, int close_handle);
 123         int    (*flush)(php_stream *stream);
 124 
 125         const char *label; /* label for this ops structure */
 126 
 127         /* these are optional */
 128         int (*seek)(php_stream *stream, zend_off_t offset, int whence, zend_off_t *newoffset);
 129         int (*cast)(php_stream *stream, int castas, void **ret);
 130         int (*stat)(php_stream *stream, php_stream_statbuf *ssb);
 131         int (*set_option)(php_stream *stream, int option, int value, void *ptrparam);
 132 } php_stream_ops;
 133 
 134 typedef struct _php_stream_wrapper_ops {
 135         /* open/create a wrapped stream */
 136         php_stream *(*stream_opener)(php_stream_wrapper *wrapper, const char *filename, const char *mode,
 137                         int options, zend_string **opened_path, php_stream_context *context STREAMS_DC);
 138         /* close/destroy a wrapped stream */
 139         int (*stream_closer)(php_stream_wrapper *wrapper, php_stream *stream);
 140         /* stat a wrapped stream */
 141         int (*stream_stat)(php_stream_wrapper *wrapper, php_stream *stream, php_stream_statbuf *ssb);
 142         /* stat a URL */
 143         int (*url_stat)(php_stream_wrapper *wrapper, const char *url, int flags, php_stream_statbuf *ssb, php_stream_context *context);
 144         /* open a "directory" stream */
 145         php_stream *(*dir_opener)(php_stream_wrapper *wrapper, const char *filename, const char *mode,
 146                         int options, zend_string **opened_path, php_stream_context *context STREAMS_DC);
 147 
 148         const char *label;
 149 
 150         /* delete a file */
 151         int (*unlink)(php_stream_wrapper *wrapper, const char *url, int options, php_stream_context *context);
 152 
 153         /* rename a file */
 154         int (*rename)(php_stream_wrapper *wrapper, const char *url_from, const char *url_to, int options, php_stream_context *context);
 155 
 156         /* Create/Remove directory */
 157         int (*stream_mkdir)(php_stream_wrapper *wrapper, const char *url, int mode, int options, php_stream_context *context);
 158         int (*stream_rmdir)(php_stream_wrapper *wrapper, const char *url, int options, php_stream_context *context);
 159         /* Metadata handling */
 160         int (*stream_metadata)(php_stream_wrapper *wrapper, const char *url, int options, void *value, php_stream_context *context);
 161 } php_stream_wrapper_ops;
 162 
 163 struct _php_stream_wrapper      {
 164         php_stream_wrapper_ops *wops;   /* operations the wrapper can perform */
 165         void *abstract;                                 /* context for the wrapper */
 166         int is_url;                                             /* so that PG(allow_url_fopen) can be respected */
 167 };
 168 
 169 #define PHP_STREAM_FLAG_NO_SEEK                                         0x1
 170 #define PHP_STREAM_FLAG_NO_BUFFER                                       0x2
 171 
 172 #define PHP_STREAM_FLAG_EOL_UNIX                                        0x0 /* also includes DOS */
 173 #define PHP_STREAM_FLAG_DETECT_EOL                                      0x4
 174 #define PHP_STREAM_FLAG_EOL_MAC                                         0x8
 175 
 176 /* set this when the stream might represent "interactive" data.
 177  * When set, the read buffer will avoid certain operations that
 178  * might otherwise cause the read to block for much longer than
 179  * is strictly required. */
 180 #define PHP_STREAM_FLAG_AVOID_BLOCKING                                  0x10
 181 
 182 #define PHP_STREAM_FLAG_NO_CLOSE                                        0x20
 183 
 184 #define PHP_STREAM_FLAG_IS_DIR                                          0x40
 185 
 186 #define PHP_STREAM_FLAG_NO_FCLOSE                                       0x80
 187 
 188 #define PHP_STREAM_FLAG_WAS_WRITTEN                                     0x80000000
 189 
 190 struct _php_stream  {
 191         php_stream_ops *ops;
 192         void *abstract;                 /* convenience pointer for abstraction */
 193 
 194         php_stream_filter_chain readfilters, writefilters;
 195 
 196         php_stream_wrapper *wrapper; /* which wrapper was used to open the stream */
 197         void *wrapperthis;              /* convenience pointer for a instance of a wrapper */
 198         zval wrapperdata;               /* fgetwrapperdata retrieves this */
 199 
 200         int fgetss_state;               /* for fgetss to handle multiline tags */
 201         int is_persistent;
 202         char mode[16];                  /* "rwb" etc. ala stdio */
 203         zend_resource *res;             /* used for auto-cleanup */
 204         int in_free;                    /* to prevent recursion during free */
 205         /* so we know how to clean it up correctly.  This should be set to
 206          * PHP_STREAM_FCLOSE_XXX as appropriate */
 207         int fclose_stdiocast;
 208         FILE *stdiocast;    /* cache this, otherwise we might leak! */
 209         int __exposed;  /* non-zero if exposed as a zval somewhere */
 210         char *orig_path;
 211 
 212         zend_resource *ctx;
 213         int flags;      /* PHP_STREAM_FLAG_XXX */
 214 
 215         int eof;
 216 
 217         /* buffer */
 218         zend_off_t position; /* of underlying stream */
 219         unsigned char *readbuf;
 220         size_t readbuflen;
 221         zend_off_t readpos;
 222         zend_off_t writepos;
 223 
 224         /* how much data to read when filling buffer */
 225         size_t chunk_size;
 226 
 227 #if ZEND_DEBUG
 228         const char *open_filename;
 229         uint open_lineno;
 230 #endif
 231 
 232         struct _php_stream *enclosing_stream; /* this is a private stream owned by enclosing_stream */
 233 }; /* php_stream */
 234 
 235 #define PHP_STREAM_CONTEXT(stream) \
 236         ((php_stream_context*) ((stream)->ctx ? ((stream)->ctx->ptr) : NULL))
 237 
 238 /* state definitions when closing down; these are private to streams.c */
 239 #define PHP_STREAM_FCLOSE_NONE 0
 240 #define PHP_STREAM_FCLOSE_FDOPEN        1
 241 #define PHP_STREAM_FCLOSE_FOPENCOOKIE 2
 242 
 243 /* allocate a new stream for a particular ops */
 244 BEGIN_EXTERN_C()
 245 PHPAPI php_stream *_php_stream_alloc(php_stream_ops *ops, void *abstract,
 246                 const char *persistent_id, const char *mode STREAMS_DC);
 247 END_EXTERN_C()
 248 #define php_stream_alloc(ops, thisptr, persistent_id, mode)     _php_stream_alloc((ops), (thisptr), (persistent_id), (mode) STREAMS_CC)
 249 
 250 #define php_stream_get_resource_id(stream)              ((php_stream *)(stream))->res->handle
 251 /* use this to tell the stream that it is OK if we don't explicitly close it */
 252 #define php_stream_auto_cleanup(stream) { (stream)->__exposed++; }
 253 /* use this to assign the stream to a zval and tell the stream that is
 254  * has been exported to the engine; it will expect to be closed automatically
 255  * when the resources are auto-destructed */
 256 #define php_stream_to_zval(stream, zval)        { ZVAL_RES(zval, (stream)->res); (stream)->__exposed++; }
 257 
 258 #define php_stream_from_zval(xstr, pzval)       do { \
 259         if (((xstr) = (php_stream*)zend_fetch_resource2_ex((pzval), \
 260                                 "stream", php_file_le_stream(), php_file_le_pstream())) == NULL) { \
 261                 RETURN_FALSE; \
 262         } \
 263 } while (0)
 264 #define php_stream_from_res(xstr, res)  do { \
 265         if (((xstr) = (php_stream*)zend_fetch_resource2((res), \
 266                                 "stream", php_file_le_stream(), php_file_le_pstream())) == NULL) { \
 267                 RETURN_FALSE; \
 268         } \
 269 } while (0)
 270 #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())
 271 #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())
 272 
 273 BEGIN_EXTERN_C()
 274 PHPAPI php_stream *php_stream_encloses(php_stream *enclosing, php_stream *enclosed);
 275 #define php_stream_free_enclosed(stream_enclosed, close_options) _php_stream_free_enclosed((stream_enclosed), (close_options))
 276 PHPAPI int _php_stream_free_enclosed(php_stream *stream_enclosed, int close_options);
 277 
 278 PHPAPI int php_stream_from_persistent_id(const char *persistent_id, php_stream **stream);
 279 #define PHP_STREAM_PERSISTENT_SUCCESS   0 /* id exists */
 280 #define PHP_STREAM_PERSISTENT_FAILURE   1 /* id exists but is not a stream! */
 281 #define PHP_STREAM_PERSISTENT_NOT_EXIST 2 /* id does not exist */
 282 
 283 #define PHP_STREAM_FREE_CALL_DTOR                       1 /* call ops->close */
 284 #define PHP_STREAM_FREE_RELEASE_STREAM          2 /* pefree(stream) */
 285 #define PHP_STREAM_FREE_PRESERVE_HANDLE         4 /* tell ops->close to not close it's underlying handle */
 286 #define PHP_STREAM_FREE_RSRC_DTOR                       8 /* called from the resource list dtor */
 287 #define PHP_STREAM_FREE_PERSISTENT                      16 /* manually freeing a persistent connection */
 288 #define PHP_STREAM_FREE_IGNORE_ENCLOSING        32 /* don't close the enclosing stream instead */
 289 #define PHP_STREAM_FREE_KEEP_RSRC                       64 /* keep associated zend_resource */
 290 #define PHP_STREAM_FREE_CLOSE                           (PHP_STREAM_FREE_CALL_DTOR | PHP_STREAM_FREE_RELEASE_STREAM)
 291 #define PHP_STREAM_FREE_CLOSE_CASTED            (PHP_STREAM_FREE_CLOSE | PHP_STREAM_FREE_PRESERVE_HANDLE)
 292 #define PHP_STREAM_FREE_CLOSE_PERSISTENT        (PHP_STREAM_FREE_CLOSE | PHP_STREAM_FREE_PERSISTENT)
 293 
 294 PHPAPI int _php_stream_free(php_stream *stream, int close_options);
 295 #define php_stream_free(stream, close_options)  _php_stream_free((stream), (close_options))
 296 #define php_stream_close(stream)        _php_stream_free((stream), PHP_STREAM_FREE_CLOSE)
 297 #define php_stream_pclose(stream)       _php_stream_free((stream), PHP_STREAM_FREE_CLOSE_PERSISTENT)
 298 
 299 PHPAPI int _php_stream_seek(php_stream *stream, zend_off_t offset, int whence);
 300 #define php_stream_rewind(stream)       _php_stream_seek((stream), 0L, SEEK_SET)
 301 #define php_stream_seek(stream, offset, whence) _php_stream_seek((stream), (offset), (whence))
 302 
 303 PHPAPI zend_off_t _php_stream_tell(php_stream *stream);
 304 #define php_stream_tell(stream) _php_stream_tell((stream))
 305 
 306 PHPAPI size_t _php_stream_read(php_stream *stream, char *buf, size_t count);
 307 #define php_stream_read(stream, buf, count)             _php_stream_read((stream), (buf), (count))
 308 
 309 PHPAPI size_t _php_stream_write(php_stream *stream, const char *buf, size_t count);
 310 #define php_stream_write_string(stream, str)    _php_stream_write(stream, str, strlen(str))
 311 #define php_stream_write(stream, buf, count)    _php_stream_write(stream, (buf), (count))
 312 
 313 PHPAPI void _php_stream_fill_read_buffer(php_stream *stream, size_t size);
 314 #define php_stream_fill_read_buffer(stream, size)       _php_stream_fill_read_buffer((stream), (size))
 315 
 316 PHPAPI size_t _php_stream_printf(php_stream *stream, const char *fmt, ...) PHP_ATTRIBUTE_FORMAT(printf, 2, 3);
 317 
 318 /* php_stream_printf macro & function require */
 319 #define php_stream_printf _php_stream_printf
 320 
 321 PHPAPI int _php_stream_eof(php_stream *stream);
 322 #define php_stream_eof(stream)  _php_stream_eof((stream))
 323 
 324 PHPAPI int _php_stream_getc(php_stream *stream);
 325 #define php_stream_getc(stream) _php_stream_getc((stream))
 326 
 327 PHPAPI int _php_stream_putc(php_stream *stream, int c);
 328 #define php_stream_putc(stream, c)      _php_stream_putc((stream), (c))
 329 
 330 PHPAPI int _php_stream_flush(php_stream *stream, int closing);
 331 #define php_stream_flush(stream)        _php_stream_flush((stream), 0)
 332 
 333 PHPAPI char *_php_stream_get_line(php_stream *stream, char *buf, size_t maxlen, size_t *returned_len);
 334 #define php_stream_gets(stream, buf, maxlen)    _php_stream_get_line((stream), (buf), (maxlen), NULL)
 335 
 336 #define php_stream_get_line(stream, buf, maxlen, retlen) _php_stream_get_line((stream), (buf), (maxlen), (retlen))
 337 PHPAPI zend_string *php_stream_get_record(php_stream *stream, size_t maxlen, const char *delim, size_t delim_len);
 338 
 339 /* CAREFUL! this is equivalent to puts NOT fputs! */
 340 PHPAPI int _php_stream_puts(php_stream *stream, const char *buf);
 341 #define php_stream_puts(stream, buf)    _php_stream_puts((stream), (buf))
 342 
 343 PHPAPI int _php_stream_stat(php_stream *stream, php_stream_statbuf *ssb);
 344 #define php_stream_stat(stream, ssb)    _php_stream_stat((stream), (ssb))
 345 
 346 PHPAPI int _php_stream_stat_path(const char *path, int flags, php_stream_statbuf *ssb, php_stream_context *context);
 347 #define php_stream_stat_path(path, ssb) _php_stream_stat_path((path), 0, (ssb), NULL)
 348 #define php_stream_stat_path_ex(path, flags, ssb, context)      _php_stream_stat_path((path), (flags), (ssb), (context))
 349 
 350 PHPAPI int _php_stream_mkdir(const char *path, int mode, int options, php_stream_context *context);
 351 #define php_stream_mkdir(path, mode, options, context)  _php_stream_mkdir(path, mode, options, context)
 352 
 353 PHPAPI int _php_stream_rmdir(const char *path, int options, php_stream_context *context);
 354 #define php_stream_rmdir(path, options, context)        _php_stream_rmdir(path, options, context)
 355 
 356 PHPAPI php_stream *_php_stream_opendir(const char *path, int options, php_stream_context *context STREAMS_DC);
 357 #define php_stream_opendir(path, options, context)      _php_stream_opendir((path), (options), (context) STREAMS_CC)
 358 PHPAPI php_stream_dirent *_php_stream_readdir(php_stream *dirstream, php_stream_dirent *ent);
 359 #define php_stream_readdir(dirstream, dirent)   _php_stream_readdir((dirstream), (dirent))
 360 #define php_stream_closedir(dirstream)  php_stream_close((dirstream))
 361 #define php_stream_rewinddir(dirstream) php_stream_rewind((dirstream))
 362 
 363 PHPAPI int php_stream_dirent_alphasort(const zend_string **a, const zend_string **b);
 364 PHPAPI int php_stream_dirent_alphasortr(const zend_string **a, const zend_string **b);
 365 
 366 PHPAPI int _php_stream_scandir(const char *dirname, zend_string **namelist[], int flags, php_stream_context *context,
 367                         int (*compare) (const zend_string **a, const zend_string **b));
 368 #define php_stream_scandir(dirname, namelist, context, compare) _php_stream_scandir((dirname), (namelist), 0, (context), (compare))
 369 
 370 PHPAPI int _php_stream_set_option(php_stream *stream, int option, int value, void *ptrparam);
 371 #define php_stream_set_option(stream, option, value, ptrvalue)  _php_stream_set_option((stream), (option), (value), (ptrvalue))
 372 
 373 #define php_stream_set_chunk_size(stream, size) _php_stream_set_option((stream), PHP_STREAM_OPTION_SET_CHUNK_SIZE, (size), NULL)
 374 
 375 END_EXTERN_C()
 376 
 377 
 378 /* Flags for mkdir method in wrapper ops */
 379 #define PHP_STREAM_MKDIR_RECURSIVE      1
 380 /* define REPORT ERRORS 8 (below) */
 381 
 382 /* Flags for rmdir method in wrapper ops */
 383 /* define REPORT_ERRORS 8 (below) */
 384 
 385 /* Flags for url_stat method in wrapper ops */
 386 #define PHP_STREAM_URL_STAT_LINK        1
 387 #define PHP_STREAM_URL_STAT_QUIET       2
 388 #define PHP_STREAM_URL_STAT_NOCACHE     4
 389 
 390 /* change the blocking mode of stream: value == 1 => blocking, value == 0 => non-blocking. */
 391 #define PHP_STREAM_OPTION_BLOCKING      1
 392 
 393 /* change the buffering mode of stream. value is a PHP_STREAM_BUFFER_XXXX value, ptrparam is a ptr to a size_t holding
 394  * the required buffer size */
 395 #define PHP_STREAM_OPTION_READ_BUFFER   2
 396 #define PHP_STREAM_OPTION_WRITE_BUFFER  3
 397 
 398 #define PHP_STREAM_BUFFER_NONE  0       /* unbuffered */
 399 #define PHP_STREAM_BUFFER_LINE  1       /* line buffered */
 400 #define PHP_STREAM_BUFFER_FULL  2       /* fully buffered */
 401 
 402 /* set the timeout duration for reads on the stream. ptrparam is a pointer to a struct timeval * */
 403 #define PHP_STREAM_OPTION_READ_TIMEOUT  4
 404 #define PHP_STREAM_OPTION_SET_CHUNK_SIZE        5
 405 
 406 /* set or release lock on a stream */
 407 #define PHP_STREAM_OPTION_LOCKING               6
 408 
 409 /* Enable/disable blocking reads on anonymous pipes on Windows. */
 410 #define PHP_STREAM_OPTION_PIPE_BLOCKING 7
 411 
 412 /* whether or not locking is supported */
 413 #define PHP_STREAM_LOCK_SUPPORTED               1
 414 
 415 #define php_stream_supports_lock(stream)        _php_stream_set_option((stream), PHP_STREAM_OPTION_LOCKING, 0, (void *) PHP_STREAM_LOCK_SUPPORTED) == 0 ? 1 : 0
 416 #define php_stream_lock(stream, mode)           _php_stream_set_option((stream), PHP_STREAM_OPTION_LOCKING, (mode), (void *) NULL)
 417 
 418 /* option code used by the php_stream_xport_XXX api */
 419 #define PHP_STREAM_OPTION_XPORT_API                     7 /* see php_stream_transport.h */
 420 #define PHP_STREAM_OPTION_CRYPTO_API            8 /* see php_stream_transport.h */
 421 #define PHP_STREAM_OPTION_MMAP_API                      9 /* see php_stream_mmap.h */
 422 #define PHP_STREAM_OPTION_TRUNCATE_API          10
 423 
 424 #define PHP_STREAM_TRUNCATE_SUPPORTED   0
 425 #define PHP_STREAM_TRUNCATE_SET_SIZE    1       /* ptrparam is a pointer to a size_t */
 426 
 427 #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)
 428 
 429 BEGIN_EXTERN_C()
 430 PHPAPI int _php_stream_truncate_set_size(php_stream *stream, size_t newsize);
 431 #define php_stream_truncate_set_size(stream, size)      _php_stream_truncate_set_size((stream), (size))
 432 END_EXTERN_C()
 433 
 434 #define PHP_STREAM_OPTION_META_DATA_API         11 /* ptrparam is a zval* to which to add meta data information */
 435 #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)
 436 
 437 /* Check if the stream is still "live"; for sockets/pipes this means the socket
 438  * is still connected; for files, this does not really have meaning */
 439 #define PHP_STREAM_OPTION_CHECK_LIVENESS        12 /* no parameters */
 440 
 441 #define PHP_STREAM_OPTION_RETURN_OK                      0 /* option set OK */
 442 #define PHP_STREAM_OPTION_RETURN_ERR            -1 /* problem setting option */
 443 #define PHP_STREAM_OPTION_RETURN_NOTIMPL        -2 /* underlying stream does not implement; streams can handle it instead */
 444 
 445 /* copy up to maxlen bytes from src to dest.  If maxlen is PHP_STREAM_COPY_ALL,
 446  * copy until eof(src). */
 447 #define PHP_STREAM_COPY_ALL             ((size_t)-1)
 448 
 449 BEGIN_EXTERN_C()
 450 ZEND_ATTRIBUTE_DEPRECATED
 451 PHPAPI size_t _php_stream_copy_to_stream(php_stream *src, php_stream *dest, size_t maxlen STREAMS_DC);
 452 #define php_stream_copy_to_stream(src, dest, maxlen)    _php_stream_copy_to_stream((src), (dest), (maxlen) STREAMS_CC)
 453 PHPAPI int _php_stream_copy_to_stream_ex(php_stream *src, php_stream *dest, size_t maxlen, size_t *len STREAMS_DC);
 454 #define php_stream_copy_to_stream_ex(src, dest, maxlen, len)    _php_stream_copy_to_stream_ex((src), (dest), (maxlen), (len) STREAMS_CC)
 455 
 456 
 457 /* read all data from stream and put into a buffer. Caller must free buffer
 458  * when done. */
 459 PHPAPI zend_string *_php_stream_copy_to_mem(php_stream *src, size_t maxlen, int persistent STREAMS_DC);
 460 #define php_stream_copy_to_mem(src, maxlen, persistent) _php_stream_copy_to_mem((src), (maxlen), (persistent) STREAMS_CC)
 461 
 462 /* output all data from a stream */
 463 PHPAPI size_t _php_stream_passthru(php_stream * src STREAMS_DC);
 464 #define php_stream_passthru(stream)     _php_stream_passthru((stream) STREAMS_CC)
 465 END_EXTERN_C()
 466 
 467 #include "streams/php_stream_transport.h"
 468 #include "streams/php_stream_plain_wrapper.h"
 469 #include "streams/php_stream_glob_wrapper.h"
 470 #include "streams/php_stream_userspace.h"
 471 #include "streams/php_stream_mmap.h"
 472 
 473 /* coerce the stream into some other form */
 474 /* cast as a stdio FILE * */
 475 #define PHP_STREAM_AS_STDIO     0
 476 /* cast as a POSIX fd or socketd */
 477 #define PHP_STREAM_AS_FD                1
 478 /* cast as a socketd */
 479 #define PHP_STREAM_AS_SOCKETD   2
 480 /* cast as fd/socket for select purposes */
 481 #define PHP_STREAM_AS_FD_FOR_SELECT 3
 482 
 483 /* try really, really hard to make sure the cast happens (avoid using this flag if possible) */
 484 #define PHP_STREAM_CAST_TRY_HARD        0x80000000
 485 #define PHP_STREAM_CAST_RELEASE         0x40000000      /* stream becomes invalid on success */
 486 #define PHP_STREAM_CAST_INTERNAL        0x20000000      /* stream cast for internal use */
 487 #define PHP_STREAM_CAST_MASK            (PHP_STREAM_CAST_TRY_HARD | PHP_STREAM_CAST_RELEASE | PHP_STREAM_CAST_INTERNAL)
 488 BEGIN_EXTERN_C()
 489 PHPAPI int _php_stream_cast(php_stream *stream, int castas, void **ret, int show_err);
 490 END_EXTERN_C()
 491 /* use this to check if a stream can be cast into another form */
 492 #define php_stream_can_cast(stream, as) _php_stream_cast((stream), (as), NULL, 0)
 493 #define php_stream_cast(stream, as, ret, show_err)      _php_stream_cast((stream), (as), (ret), (show_err))
 494 
 495 /* use this to check if a stream is of a particular type:
 496  * PHPAPI int php_stream_is(php_stream *stream, php_stream_ops *ops); */
 497 #define php_stream_is(stream, anops)            ((stream)->ops == anops)
 498 #define PHP_STREAM_IS_STDIO &php_stream_stdio_ops
 499 
 500 #define php_stream_is_persistent(stream)        (stream)->is_persistent
 501 
 502 /* Wrappers support */
 503 
 504 #define IGNORE_PATH                     0x00000000
 505 #define USE_PATH                        0x00000001
 506 #define IGNORE_URL                      0x00000002
 507 #define REPORT_ERRORS                   0x00000008
 508 
 509 /* If you don't need to write to the stream, but really need to
 510  * be able to seek, use this flag in your options. */
 511 #define STREAM_MUST_SEEK                0x00000010
 512 /* If you are going to end up casting the stream into a FILE* or
 513  * a socket, pass this flag and the streams/wrappers will not use
 514  * buffering mechanisms while reading the headers, so that HTTP
 515  * wrapped streams will work consistently.
 516  * If you omit this flag, streams will use buffering and should end
 517  * up working more optimally.
 518  * */
 519 #define STREAM_WILL_CAST                0x00000020
 520 
 521 /* this flag applies to php_stream_locate_url_wrapper */
 522 #define STREAM_LOCATE_WRAPPERS_ONLY     0x00000040
 523 
 524 /* this flag is only used by include/require functions */
 525 #define STREAM_OPEN_FOR_INCLUDE         0x00000080
 526 
 527 /* this flag tells streams to ONLY open urls */
 528 #define STREAM_USE_URL                  0x00000100
 529 
 530 /* this flag is used when only the headers from HTTP request are to be fetched */
 531 #define STREAM_ONLY_GET_HEADERS         0x00000200
 532 
 533 /* don't apply open_basedir checks */
 534 #define STREAM_DISABLE_OPEN_BASEDIR     0x00000400
 535 
 536 /* get (or create) a persistent version of the stream */
 537 #define STREAM_OPEN_PERSISTENT          0x00000800
 538 
 539 /* use glob stream for directory open in plain files stream */
 540 #define STREAM_USE_GLOB_DIR_OPEN        0x00001000
 541 
 542 /* don't check allow_url_fopen and allow_url_include */
 543 #define STREAM_DISABLE_URL_PROTECTION   0x00002000
 544 
 545 /* assume the path passed in exists and is fully expanded, avoiding syscalls */
 546 #define STREAM_ASSUME_REALPATH          0x00004000
 547 
 548 /* Allow blocking reads on anonymous pipes on Windows. */
 549 #define STREAM_USE_BLOCKING_PIPE        0x00008000
 550 
 551 /* Antique - no longer has meaning */
 552 #define IGNORE_URL_WIN 0
 553 
 554 int php_init_stream_wrappers(int module_number);
 555 int php_shutdown_stream_wrappers(int module_number);
 556 void php_shutdown_stream_hashes(void);
 557 PHP_RSHUTDOWN_FUNCTION(streams);
 558 
 559 BEGIN_EXTERN_C()
 560 PHPAPI int php_register_url_stream_wrapper(const char *protocol, php_stream_wrapper *wrapper);
 561 PHPAPI int php_unregister_url_stream_wrapper(const char *protocol);
 562 PHPAPI int php_register_url_stream_wrapper_volatile(const char *protocol, php_stream_wrapper *wrapper);
 563 PHPAPI int php_unregister_url_stream_wrapper_volatile(const char *protocol);
 564 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);
 565 PHPAPI php_stream_wrapper *php_stream_locate_url_wrapper(const char *path, const char **path_for_open, int options);
 566 PHPAPI const char *php_stream_locate_eol(php_stream *stream, zend_string *buf);
 567 
 568 #define php_stream_open_wrapper(path, mode, options, opened)    _php_stream_open_wrapper_ex((path), (mode), (options), (opened), NULL STREAMS_CC)
 569 #define php_stream_open_wrapper_ex(path, mode, options, opened, context)        _php_stream_open_wrapper_ex((path), (mode), (options), (opened), (context) STREAMS_CC)
 570 
 571 /* pushes an error message onto the stack for a wrapper instance */
 572 PHPAPI void php_stream_wrapper_log_error(php_stream_wrapper *wrapper, int options, const char *fmt, ...) PHP_ATTRIBUTE_FORMAT(printf, 3, 4);
 573 
 574 #define PHP_STREAM_UNCHANGED    0 /* orig stream was seekable anyway */
 575 #define PHP_STREAM_RELEASED             1 /* newstream should be used; origstream is no longer valid */
 576 #define PHP_STREAM_FAILED               2 /* an error occurred while attempting conversion */
 577 #define PHP_STREAM_CRITICAL             3 /* an error occurred; origstream is in an unknown state; you should close origstream */
 578 #define PHP_STREAM_NO_PREFERENCE        0
 579 #define PHP_STREAM_PREFER_STDIO         1
 580 #define PHP_STREAM_FORCE_CONVERSION     2
 581 /* DO NOT call this on streams that are referenced by resources! */
 582 PHPAPI int _php_stream_make_seekable(php_stream *origstream, php_stream **newstream, int flags STREAMS_DC);
 583 #define php_stream_make_seekable(origstream, newstream, flags)  _php_stream_make_seekable((origstream), (newstream), (flags) STREAMS_CC)
 584 
 585 /* Give other modules access to the url_stream_wrappers_hash and stream_filters_hash */
 586 PHPAPI HashTable *_php_stream_get_url_stream_wrappers_hash(void);
 587 #define php_stream_get_url_stream_wrappers_hash()       _php_stream_get_url_stream_wrappers_hash()
 588 PHPAPI HashTable *php_stream_get_url_stream_wrappers_hash_global(void);
 589 PHPAPI HashTable *_php_get_stream_filters_hash(void);
 590 #define php_get_stream_filters_hash()   _php_get_stream_filters_hash()
 591 PHPAPI HashTable *php_get_stream_filters_hash_global(void);
 592 extern php_stream_wrapper_ops *php_stream_user_wrapper_ops;
 593 END_EXTERN_C()
 594 #endif
 595 
 596 /* Definitions for user streams */
 597 #define PHP_STREAM_IS_URL               1
 598 
 599 /* Stream metadata definitions */
 600 /* Create if referred resource does not exist */
 601 #define PHP_STREAM_META_TOUCH           1
 602 #define PHP_STREAM_META_OWNER_NAME      2
 603 #define PHP_STREAM_META_OWNER           3
 604 #define PHP_STREAM_META_GROUP_NAME      4
 605 #define PHP_STREAM_META_GROUP           5
 606 #define PHP_STREAM_META_ACCESS          6
 607 /*
 608  * Local variables:
 609  * tab-width: 4
 610  * c-basic-offset: 4
 611  * End:
 612  * vim600: sw=4 ts=4 fdm=marker
 613  * vim<600: sw=4 ts=4
 614  */