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