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