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