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