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