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