Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100755 608 lines (477 sloc) 30.033 kb
5dbb3a7 @wez Added files for PHP streams
wez authored
1 /*
2 +----------------------------------------------------------------------+
ccfc46b - Happy new year and PHP 5 for rest of the files too..
foobar authored
3 | PHP Version 5 |
5dbb3a7 @wez Added files for PHP streams
wez authored
4 +----------------------------------------------------------------------+
8775a37 @felipensp - Year++
felipensp authored
5 | Copyright (c) 1997-2012 The PHP Group |
5dbb3a7 @wez Added files for PHP streams
wez authored
6 +----------------------------------------------------------------------+
5bd9322 bump year and license version
foobar authored
7 | This source file is subject to version 3.01 of the PHP license, |
5dbb3a7 @wez Added files for PHP streams
wez authored
8 | that is bundled with this package in the file LICENSE, and is |
f68c7ff updating license information in the headers.
James Cox authored
9 | available through the world-wide-web at the following url: |
5bd9322 bump year and license version
foobar authored
10 | http://www.php.net/license/3_01.txt |
5dbb3a7 @wez Added files for PHP streams
wez authored
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 +----------------------------------------------------------------------+
90613d2 Maintain headers.
Sebastian Bergmann authored
15 | Author: Wez Furlong (wez@thebrainroom.com) |
5dbb3a7 @wez Added files for PHP streams
wez authored
16 +----------------------------------------------------------------------+
17 */
18
ca58966 @wez Merge streams changes from branch.
wez authored
19 /* $Id$ */
20
5dbb3a7 @wez Added files for PHP streams
wez authored
21 #ifndef PHP_STREAMS_H
22 #define PHP_STREAMS_H
23
24 #ifdef HAVE_SYS_TIME_H
25 #include <sys/time.h>
26 #endif
2539cbc @wez Phase 3 of OO wrapper cleanup
wez authored
27 #include <sys/types.h>
28 #include <sys/stat.h>
5dbb3a7 @wez Added files for PHP streams
wez authored
29
b8f7d9f wrap all PHPAPI prototypes into BEGIN_EXTERN_C/END_EXTERN_C blocks
Hartmut Holzgraefe authored
30 BEGIN_EXTERN_C()
696e0a2 @wez Implement persistent streams. (for pfsockopen).
wez authored
31 PHPAPI int php_file_le_stream(void);
32 PHPAPI int php_file_le_pstream(void);
3455038 @sgolemon Added stream_filter_remove() to cancel a stream filter.
sgolemon authored
33 PHPAPI int php_file_le_stream_filter(void);
b8f7d9f wrap all PHPAPI prototypes into BEGIN_EXTERN_C/END_EXTERN_C blocks
Hartmut Holzgraefe authored
34 END_EXTERN_C()
5dbb3a7 @wez Added files for PHP streams
wez authored
35
d2d8762 @wez Streams now make more use of the memory manager, so tracking down
wez authored
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 :-/ */
e34f9a8 @lstrojny Cleanup: remove trailing whitespaces
lstrojny authored
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
d2d8762 @wez Streams now make more use of the memory manager, so tracking down
wez authored
43 # define STREAMS_REL_C __php_stream_call_depth + 1 ZEND_FILE_LINE_CC, \
44 __php_stream_call_depth ? __zend_orig_filename : __zend_filename, \
e34f9a8 @lstrojny Cleanup: remove trailing whitespaces
lstrojny authored
45 __php_stream_call_depth ? __zend_orig_lineno : __zend_lineno
d2d8762 @wez Streams now make more use of the memory manager, so tracking down
wez authored
46
47 # define STREAMS_DC , STREAMS_D
48 # define STREAMS_CC , STREAMS_C
49 # define STREAMS_REL_CC , STREAMS_REL_C
c9d5e13 @wez TSRMLS related work on streams, as discussed with Zeev.
wez authored
50
d2d8762 @wez Streams now make more use of the memory manager, so tracking down
wez authored
51 #else
16c9da0 @zsuraski Fix build under Release_TS
zsuraski authored
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
d2d8762 @wez Streams now make more use of the memory manager, so tracking down
wez authored
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 */
c9d5e13 @wez TSRMLS related work on streams, as discussed with Zeev.
wez authored
62 #define php_stream_alloc_rel(ops, thisptr, persistent, mode) _php_stream_alloc((ops), (thisptr), (persistent), (mode) STREAMS_REL_CC TSRMLS_CC)
d2d8762 @wez Streams now make more use of the memory manager, so tracking down
wez authored
63
c9d5e13 @wez TSRMLS related work on streams, as discussed with Zeev.
wez authored
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)
e34f9a8 @lstrojny Cleanup: remove trailing whitespaces
lstrojny authored
65
728eacb A better fix for bug #20110.
Ilia Alshanetsky authored
66 #define php_stream_fopen_rel(filename, mode, opened, options) _php_stream_fopen((filename), (mode), (opened), (options) STREAMS_REL_CC TSRMLS_CC)
d2d8762 @wez Streams now make more use of the memory manager, so tracking down
wez authored
67
728eacb A better fix for bug #20110.
Ilia Alshanetsky authored
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)
d2d8762 @wez Streams now make more use of the memory manager, so tracking down
wez authored
69
86fb577 @wez Implement persistent plain file streams.
wez authored
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)
c9d5e13 @wez TSRMLS related work on streams, as discussed with Zeev.
wez authored
71 #define php_stream_fopen_from_file_rel(file, mode) _php_stream_fopen_from_file((file), (mode) STREAMS_REL_CC TSRMLS_CC)
e34f9a8 @lstrojny Cleanup: remove trailing whitespaces
lstrojny authored
72
c9d5e13 @wez TSRMLS related work on streams, as discussed with Zeev.
wez authored
73 #define php_stream_fopen_from_pipe_rel(file, mode) _php_stream_fopen_from_pipe((file), (mode) STREAMS_REL_CC TSRMLS_CC)
e34f9a8 @lstrojny Cleanup: remove trailing whitespaces
lstrojny authored
74
16c9da0 @zsuraski Fix build under Release_TS
zsuraski authored
75 #define php_stream_fopen_tmpfile_rel() _php_stream_fopen_tmpfile(0 STREAMS_REL_CC TSRMLS_CC)
d2d8762 @wez Streams now make more use of the memory manager, so tracking down
wez authored
76
c9d5e13 @wez TSRMLS related work on streams, as discussed with Zeev.
wez authored
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)
e34f9a8 @lstrojny Cleanup: remove trailing whitespaces
lstrojny authored
78
e1d0a14 @wez Implement stream context and status notification system.
wez authored
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)
d2d8762 @wez Streams now make more use of the memory manager, so tracking down
wez authored
81
14a3911 @wez fix for bug #16168
wez authored
82 #define php_stream_make_seekable_rel(origstream, newstream, flags) _php_stream_make_seekable((origstream), (newstream), (flags) STREAMS_REL_CC TSRMLS_CC)
d2d8762 @wez Streams now make more use of the memory manager, so tracking down
wez authored
83
84 /* }}} */
e34f9a8 @lstrojny Cleanup: remove trailing whitespaces
lstrojny authored
85
29cb19a @wez some minor docu-in-header changes
wez authored
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.
e34f9a8 @lstrojny Cleanup: remove trailing whitespaces
lstrojny authored
91 *
29cb19a @wez some minor docu-in-header changes
wez authored
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
e1d0a14 @wez Implement stream context and status notification system.
wez authored
96 * retrieve using file_get_wrapper_data(). */
29cb19a @wez some minor docu-in-header changes
wez authored
97
5dbb3a7 @wez Added files for PHP streams
wez authored
98 typedef struct _php_stream php_stream;
5ee65bd @wez Phase 1 of wrapper OO cleanup.
wez authored
99 typedef struct _php_stream_wrapper php_stream_wrapper;
e1d0a14 @wez Implement stream context and status notification system.
wez authored
100 typedef struct _php_stream_context php_stream_context;
9d348ea @wez Implement filter API for streams.
wez authored
101 typedef struct _php_stream_filter php_stream_filter;
e1d0a14 @wez Implement stream context and status notification system.
wez authored
102
32165a5 @wez Implement new filter API, stage 1.
wez authored
103 #include "streams/php_stream_context.h"
104 #include "streams/php_stream_filter_api.h"
5dbb3a7 @wez Added files for PHP streams
wez authored
105
2539cbc @wez Phase 3 of OO wrapper cleanup
wez authored
106 typedef struct _php_stream_statbuf {
107 struct stat sb; /* regular info */
5f9a5a7 @wez Remove php_stream_sock_set_blocking and replace with
wez authored
108 /* extended info to go here some day: content-type etc. etc. */
2539cbc @wez Phase 3 of OO wrapper cleanup
wez authored
109 } php_stream_statbuf;
110
b10b24d @wez Always initialize wrappers, regardless of PG(allow_url_fopen).
wez authored
111 typedef struct _php_stream_dirent {
112 char d_name[MAXPATHLEN];
113 } php_stream_dirent;
114
115 /* operations on streams that are file-handles */
5dbb3a7 @wez Added files for PHP streams
wez authored
116 typedef struct _php_stream_ops {
3ffb8e3 @wez Nuke buffering from php_streams, move connect_nonb() from fsock.c to …
wez authored
117 /* stdio like functions - these are mandatory! */
c9d5e13 @wez TSRMLS related work on streams, as discussed with Zeev.
wez authored
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);
e34f9a8 @lstrojny Cleanup: remove trailing whitespaces
lstrojny authored
122
2539cbc @wez Phase 3 of OO wrapper cleanup
wez authored
123 const char *label; /* label for this ops structure */
e34f9a8 @lstrojny Cleanup: remove trailing whitespaces
lstrojny authored
124
3ffb8e3 @wez Nuke buffering from php_streams, move connect_nonb() from fsock.c to …
wez authored
125 /* these are optional */
4d8a07d @wez Implement read buffering in streams.
wez authored
126 int (*seek)(php_stream *stream, off_t offset, int whence, off_t *newoffset TSRMLS_DC);
c9d5e13 @wez TSRMLS related work on streams, as discussed with Zeev.
wez authored
127 int (*cast)(php_stream *stream, int castas, void **ret TSRMLS_DC);
2539cbc @wez Phase 3 of OO wrapper cleanup
wez authored
128 int (*stat)(php_stream *stream, php_stream_statbuf *ssb TSRMLS_DC);
5f9a5a7 @wez Remove php_stream_sock_set_blocking and replace with
wez authored
129 int (*set_option)(php_stream *stream, int option, int value, void *ptrparam TSRMLS_DC);
5dbb3a7 @wez Added files for PHP streams
wez authored
130 } php_stream_ops;
131
5ee65bd @wez Phase 1 of wrapper OO cleanup.
wez authored
132 typedef struct _php_stream_wrapper_ops {
2539cbc @wez Phase 3 of OO wrapper cleanup
wez authored
133 /* open/create a wrapped stream */
b10b24d @wez Always initialize wrappers, regardless of PG(allow_url_fopen).
wez authored
134 php_stream *(*stream_opener)(php_stream_wrapper *wrapper, char *filename, char *mode,
e1d0a14 @wez Implement stream context and status notification system.
wez authored
135 int options, char **opened_path, php_stream_context *context STREAMS_DC TSRMLS_DC);
2539cbc @wez Phase 3 of OO wrapper cleanup
wez authored
136 /* close/destroy a wrapped stream */
b10b24d @wez Always initialize wrappers, regardless of PG(allow_url_fopen).
wez authored
137 int (*stream_closer)(php_stream_wrapper *wrapper, php_stream *stream TSRMLS_DC);
2539cbc @wez Phase 3 of OO wrapper cleanup
wez authored
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 */
026d4c9 @sgolemon Route php_stat() via streams/url_stat API (php_stream_stat_path).
sgolemon authored
141 int (*url_stat)(php_stream_wrapper *wrapper, char *url, int flags, php_stream_statbuf *ssb, php_stream_context *context TSRMLS_DC);
b10b24d @wez Always initialize wrappers, regardless of PG(allow_url_fopen).
wez authored
142 /* open a "directory" stream */
143 php_stream *(*dir_opener)(php_stream_wrapper *wrapper, char *filename, char *mode,
144 int options, char **opened_path, php_stream_context *context STREAMS_DC TSRMLS_DC);
e34f9a8 @lstrojny Cleanup: remove trailing whitespaces
lstrojny authored
145
3a67c67 @wez Rename file_get_wrapper_data -> file_get_meta_data.
wez authored
146 const char *label;
5126fbe @sgolemon Setup unlink() method in wrapper_ops structure, implement unlink in p…
sgolemon authored
147
148 /* delete a file */
65d359d @sgolemon Fold 'options' parameter into wops->unlink method
sgolemon authored
149 int (*unlink)(php_stream_wrapper *wrapper, char *url, int options, php_stream_context *context TSRMLS_DC);
b1f8236 @sgolemon Route rename() via wrapper ops.
sgolemon authored
150
151 /* rename a file */
152 int (*rename)(php_stream_wrapper *wrapper, char *url_from, char *url_to, int options, php_stream_context *context TSRMLS_DC);
c566478 @sgolemon Route mkdir()/rmdir() via wrapper ops.
sgolemon authored
153
154 /* Create/Remove directory */
a67bf6e @sgolemon Fix Win32 Build. mkdir/rmdir are macros
sgolemon authored
155 int (*stream_mkdir)(php_stream_wrapper *wrapper, char *url, int mode, int options, php_stream_context *context TSRMLS_DC);
156 int (*stream_rmdir)(php_stream_wrapper *wrapper, char *url, int options, php_stream_context *context TSRMLS_DC);
f908815 @smalyshev implement streams metadata API per RFC
smalyshev authored
157 /* Metadata handling */
158 int (*stream_metadata)(php_stream_wrapper *wrapper, char *url, int options, void *value, php_stream_context *context TSRMLS_DC);
5ee65bd @wez Phase 1 of wrapper OO cleanup.
wez authored
159 } php_stream_wrapper_ops;
0f65280 @wez New PHP streams...
wez authored
160
5ee65bd @wez Phase 1 of wrapper OO cleanup.
wez authored
161 struct _php_stream_wrapper {
162 php_stream_wrapper_ops *wops; /* operations the wrapper can perform */
163 void *abstract; /* context for the wrapper */
b10b24d @wez Always initialize wrappers, regardless of PG(allow_url_fopen).
wez authored
164 int is_url; /* so that PG(allow_url_fopen) can be respected */
5ee65bd @wez Phase 1 of wrapper OO cleanup.
wez authored
165 };
0f65280 @wez New PHP streams...
wez authored
166
4d8a07d @wez Implement read buffering in streams.
wez authored
167 #define PHP_STREAM_FLAG_NO_SEEK 1
168 #define PHP_STREAM_FLAG_NO_BUFFER 2
9d348ea @wez Implement filter API for streams.
wez authored
169
4d8a07d @wez Implement read buffering in streams.
wez authored
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
9c5883b @wez replace dont_block with a flag.
wez authored
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
4a95928 @tony2001 MFH: implement PHP_STREAM_FLAG_NO_CLOSE and avoid hacks
tony2001 authored
179
180 #define PHP_STREAM_FLAG_NO_CLOSE 32
e34f9a8 @lstrojny Cleanup: remove trailing whitespaces
lstrojny authored
181
99933df closeder/readdir/rewinddir must work only with directories
Dmitry Stogov authored
182 #define PHP_STREAM_FLAG_IS_DIR 64
183
28a2239 @tony2001 MFH: invert the logics - FLAG_FCLOSE -> FLAG_NO_FCLOSE
tony2001 authored
184 #define PHP_STREAM_FLAG_NO_FCLOSE 128
fdfbfb9 @felipensp - MFH: Fixed bug #44246 (closedir() accepts a file resource opened by…
felipensp authored
185
5dbb3a7 @wez Added files for PHP streams
wez authored
186 struct _php_stream {
8dfe496 @andigutmans - More whitespace. I really can't do the other files though...
andigutmans authored
187 php_stream_ops *ops;
e34f9a8 @lstrojny Cleanup: remove trailing whitespaces
lstrojny authored
188 void *abstract; /* convenience pointer for abstraction */
0f65280 @wez New PHP streams...
wez authored
189
32165a5 @wez Implement new filter API, stage 1.
wez authored
190 php_stream_filter_chain readfilters, writefilters;
191
8dfe496 @andigutmans - More whitespace. I really can't do the other files though...
andigutmans authored
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 */
0f65280 @wez New PHP streams...
wez authored
195
3dbde95 @wez Make state parameter of php_strip_tags passed by reference.
wez authored
196 int fgetss_state; /* for fgetss to handle multiline tags */
5dbb3a7 @wez Added files for PHP streams
wez authored
197 int is_persistent;
198 char mode[16]; /* "rwb" etc. ala stdio */
659a071 @wez Streams are all tracked as resources now.
wez authored
199 int rsrc_id; /* used for auto-cleanup */
200 int in_free; /* to prevent recursion during free */
3ffb8e3 @wez Nuke buffering from php_streams, move connect_nonb() from fsock.c to …
wez authored
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;
8dfe496 @andigutmans - More whitespace. I really can't do the other files though...
andigutmans authored
204 FILE *stdiocast; /* cache this, otherwise we might leak! */
659a071 @wez Streams are all tracked as resources now.
wez authored
205 #if ZEND_DEBUG
206 int __exposed; /* non-zero if exposed as a zval somewhere */
207 #endif
3ab8d26 - Always store the URI path in the streams structure, and expose it with
Derick Rethans authored
208 char *orig_path;
e1d0a14 @wez Implement stream context and status notification system.
wez authored
209
210 php_stream_context *context;
4d8a07d @wez Implement read buffering in streams.
wez authored
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;
ad4afdf @wez fix some warnings.
wez authored
217 off_t readpos;
218 off_t writepos;
e34f9a8 @lstrojny Cleanup: remove trailing whitespaces
lstrojny authored
219
4d8a07d @wez Implement read buffering in streams.
wez authored
220 /* how much data to read when filling buffer */
221 size_t chunk_size;
e1d0a14 @wez Implement stream context and status notification system.
wez authored
222
077fe52 @wez This seems to resolve the issues with fgets.
wez authored
223 int eof;
224
6362476 MFH streams stuff
Marcus Boerger authored
225 #if ZEND_DEBUG
3a02cfb @cataphract - Added leak_variable() function.
cataphract authored
226 const char *open_filename;
6362476 MFH streams stuff
Marcus Boerger authored
227 uint open_lineno;
228 #endif
3a02cfb @cataphract - Added leak_variable() function.
cataphract authored
229
230 struct _php_stream *enclosing_stream; /* this is a private stream owned by enclosing_stream */
5dbb3a7 @wez Added files for PHP streams
wez authored
231 }; /* php_stream */
6362476 MFH streams stuff
Marcus Boerger authored
232
29cb19a @wez some minor docu-in-header changes
wez authored
233 /* state definitions when closing down; these are private to streams.c */
3ffb8e3 @wez Nuke buffering from php_streams, move connect_nonb() from fsock.c to …
wez authored
234 #define PHP_STREAM_FCLOSE_NONE 0
235 #define PHP_STREAM_FCLOSE_FDOPEN 1
236 #define PHP_STREAM_FCLOSE_FOPENCOOKIE 2
237
5dbb3a7 @wez Added files for PHP streams
wez authored
238 /* allocate a new stream for a particular ops */
b8f7d9f wrap all PHPAPI prototypes into BEGIN_EXTERN_C/END_EXTERN_C blocks
Hartmut Holzgraefe authored
239 BEGIN_EXTERN_C()
d2d8762 @wez Streams now make more use of the memory manager, so tracking down
wez authored
240 PHPAPI php_stream *_php_stream_alloc(php_stream_ops *ops, void *abstract,
696e0a2 @wez Implement persistent streams. (for pfsockopen).
wez authored
241 const char *persistent_id, const char *mode STREAMS_DC TSRMLS_DC);
b8f7d9f wrap all PHPAPI prototypes into BEGIN_EXTERN_C/END_EXTERN_C blocks
Hartmut Holzgraefe authored
242 END_EXTERN_C()
696e0a2 @wez Implement persistent streams. (for pfsockopen).
wez authored
243 #define php_stream_alloc(ops, thisptr, persistent_id, mode) _php_stream_alloc((ops), (thisptr), (persistent_id), (mode) STREAMS_CC TSRMLS_CC)
c9d5e13 @wez TSRMLS related work on streams, as discussed with Zeev.
wez authored
244
9d348ea @wez Implement filter API for streams.
wez authored
245 #define php_stream_get_resource_id(stream) (stream)->rsrc_id
659a071 @wez Streams are all tracked as resources now.
wez authored
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
60dcebd rename macro argument so that it does not partially match the string.
Sascha Schumann authored
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())
696e0a2 @wez Implement persistent streams. (for pfsockopen).
wez authored
260
b8f7d9f wrap all PHPAPI prototypes into BEGIN_EXTERN_C/END_EXTERN_C blocks
Hartmut Holzgraefe authored
261 BEGIN_EXTERN_C()
3a02cfb @cataphract - Added leak_variable() function.
cataphract authored
262 PHPAPI 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)
264 PHPAPI int _php_stream_free_enclosed(php_stream *stream_enclosed, int close_options TSRMLS_DC);
265
696e0a2 @wez Implement persistent streams. (for pfsockopen).
wez authored
266 PHPAPI 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 */
bcef712 @wez Properly implement TSRM parameters to the new log_error
wez authored
270
c9d5e13 @wez TSRMLS related work on streams, as discussed with Zeev.
wez authored
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 */
659a071 @wez Streams are all tracked as resources now.
wez authored
274 #define PHP_STREAM_FREE_RSRC_DTOR 8 /* called from the resource list dtor */
4d98e9e Finalize the closing process of persistent streams. The current
Ilia Alshanetsky authored
275 #define PHP_STREAM_FREE_PERSISTENT 16 /* manually freeing a persistent connection */
3a02cfb @cataphract - Added leak_variable() function.
cataphract authored
276 #define PHP_STREAM_FREE_IGNORE_ENCLOSING 32 /* don't close the enclosing stream instead */
c9d5e13 @wez TSRMLS related work on streams, as discussed with Zeev.
wez authored
277 #define PHP_STREAM_FREE_CLOSE (PHP_STREAM_FREE_CALL_DTOR | PHP_STREAM_FREE_RELEASE_STREAM)
ca58966 @wez Merge streams changes from branch.
wez authored
278 #define PHP_STREAM_FREE_CLOSE_CASTED (PHP_STREAM_FREE_CLOSE | PHP_STREAM_FREE_PRESERVE_HANDLE)
4d98e9e Finalize the closing process of persistent streams. The current
Ilia Alshanetsky authored
279 #define PHP_STREAM_FREE_CLOSE_PERSISTENT (PHP_STREAM_FREE_CLOSE | PHP_STREAM_FREE_PERSISTENT)
b8f7d9f wrap all PHPAPI prototypes into BEGIN_EXTERN_C/END_EXTERN_C blocks
Hartmut Holzgraefe authored
280
c9d5e13 @wez TSRMLS related work on streams, as discussed with Zeev.
wez authored
281 PHPAPI 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)
4d98e9e Finalize the closing process of persistent streams. The current
Ilia Alshanetsky authored
284 #define php_stream_pclose(stream) _php_stream_free((stream), PHP_STREAM_FREE_CLOSE_PERSISTENT TSRMLS_CC)
c9d5e13 @wez TSRMLS related work on streams, as discussed with Zeev.
wez authored
285
286 PHPAPI 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
290 PHPAPI off_t _php_stream_tell(php_stream *stream TSRMLS_DC);
291 #define php_stream_tell(stream) _php_stream_tell((stream) TSRMLS_CC)
292
293 PHPAPI 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
296 PHPAPI 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
9c30a33 Fixed bug #53541 (format string bug in ext/phar).
Ilia Alshanetsky authored
300 #ifdef ZTS
301 PHPAPI size_t _php_stream_printf(php_stream *stream TSRMLS_DC, const char *fmt, ...) PHP_ATTRIBUTE_FORMAT(printf, 3, 4);
302 #else
303 PHPAPI size_t _php_stream_printf(php_stream *stream TSRMLS_DC, const char *fmt, ...) PHP_ATTRIBUTE_FORMAT(printf, 2, 3);
304 #endif
305
1f0b200 php_stream replacement for fprintf
Marcus Boerger authored
306 /* php_stream_printf macro & function require TSRMLS_CC */
307 #define php_stream_printf _php_stream_printf
308
c9d5e13 @wez TSRMLS related work on streams, as discussed with Zeev.
wez authored
309 PHPAPI int _php_stream_eof(php_stream *stream TSRMLS_DC);
310 #define php_stream_eof(stream) _php_stream_eof((stream) TSRMLS_CC)
311
312 PHPAPI int _php_stream_getc(php_stream *stream TSRMLS_DC);
313 #define php_stream_getc(stream) _php_stream_getc((stream) TSRMLS_CC)
314
315 PHPAPI 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
c7be7b5 @wez Add a "closing" parameter for filters to determine if a flush is the …
wez authored
318 PHPAPI int _php_stream_flush(php_stream *stream, int closing TSRMLS_DC);
319 #define php_stream_flush(stream) _php_stream_flush((stream), 0 TSRMLS_CC)
c9d5e13 @wez TSRMLS related work on streams, as discussed with Zeev.
wez authored
320
829f185 @wez made fgets() binary safe.
wez authored
321 PHPAPI 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)
32165a5 @wez Implement new filter API, stage 1.
wez authored
325 PHPAPI char *php_stream_get_record(php_stream *stream, size_t maxlen, size_t *returned_len, char *delim, size_t delim_len TSRMLS_DC);
c9d5e13 @wez TSRMLS related work on streams, as discussed with Zeev.
wez authored
326
a662f01 @wez Convert the gzfile related functions into aliases for their equivalents
wez authored
327 /* CAREFUL! this is equivalent to puts NOT fputs! */
c9d5e13 @wez TSRMLS related work on streams, as discussed with Zeev.
wez authored
328 PHPAPI int _php_stream_puts(php_stream *stream, char *buf TSRMLS_DC);
329 #define php_stream_puts(stream, buf) _php_stream_puts((stream), (buf) TSRMLS_CC)
5dbb3a7 @wez Added files for PHP streams
wez authored
330
2539cbc @wez Phase 3 of OO wrapper cleanup
wez authored
331 PHPAPI 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
026d4c9 @sgolemon Route php_stat() via streams/url_stat API (php_stream_stat_path).
sgolemon authored
334 PHPAPI int _php_stream_stat_path(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)
b10b24d @wez Always initialize wrappers, regardless of PG(allow_url_fopen).
wez authored
337
c566478 @sgolemon Route mkdir()/rmdir() via wrapper ops.
sgolemon authored
338 PHPAPI int _php_stream_mkdir(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
341 PHPAPI int _php_stream_rmdir(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
b10b24d @wez Always initialize wrappers, regardless of PG(allow_url_fopen).
wez authored
344 PHPAPI php_stream *_php_stream_opendir(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)
346 PHPAPI 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
c7b931d Fixed bug #31515 (Improve performance of scandir() by factor of 10 or…
Ilia Alshanetsky authored
351 PHPAPI int php_stream_dirent_alphasort(const char **a, const char **b);
352 PHPAPI int php_stream_dirent_alphasortr(const char **a, const char **b);
6d10371 @sgolemon 'Bug Fix': scandir, being a new function in PHP5 should have always b…
sgolemon authored
353
c7b931d Fixed bug #31515 (Improve performance of scandir() by factor of 10 or…
Ilia Alshanetsky authored
354 PHPAPI int _php_stream_scandir(char *dirname, char **namelist[], int flags, php_stream_context *context,
355 int (*compare) (const char **a, const char **b) TSRMLS_DC);
6d10371 @sgolemon 'Bug Fix': scandir, being a new function in PHP5 should have always b…
sgolemon authored
356 #define php_stream_scandir(dirname, namelist, context, compare) _php_stream_scandir((dirname), (namelist), 0, (context), (compare) TSRMLS_CC)
357
5f9a5a7 @wez Remove php_stream_sock_set_blocking and replace with
wez authored
358 PHPAPI 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
a73e74c Make the macro use the function and not the other macro as discussed
Marcus Boerger authored
361 #define php_stream_set_chunk_size(stream, size) _php_stream_set_option((stream), PHP_STREAM_OPTION_SET_CHUNK_SIZE, (size), NULL TSRMLS_CC)
393d57d @wez Differentiate between write buffer and streams read buffer sizes.
wez authored
362
b8f7d9f wrap all PHPAPI prototypes into BEGIN_EXTERN_C/END_EXTERN_C blocks
Hartmut Holzgraefe authored
363 END_EXTERN_C()
364
365
c566478 @sgolemon Route mkdir()/rmdir() via wrapper ops.
sgolemon authored
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
026d4c9 @sgolemon Route php_stat() via streams/url_stat API (php_stream_stat_path).
sgolemon authored
373 /* Flags for url_stat method in wrapper ops */
374 #define PHP_STREAM_URL_STAT_LINK 1
681d18e @sgolemon Move safemode/basedir checks for url_stat to plain_wrapper.
sgolemon authored
375 #define PHP_STREAM_URL_STAT_QUIET 2
026d4c9 @sgolemon Route php_stat() via streams/url_stat API (php_stream_stat_path).
sgolemon authored
376
5f9a5a7 @wez Remove php_stream_sock_set_blocking and replace with
wez authored
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 */
393d57d @wez Differentiate between write buffer and streams read buffer sizes.
wez authored
382 #define PHP_STREAM_OPTION_READ_BUFFER 2
383 #define PHP_STREAM_OPTION_WRITE_BUFFER 3
5f9a5a7 @wez Remove php_stream_sock_set_blocking and replace with
wez authored
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 */
b10b24d @wez Always initialize wrappers, regardless of PG(allow_url_fopen).
wez authored
388
393d57d @wez Differentiate between write buffer and streams read buffer sizes.
wez authored
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
862634f Added locking to streams.
Ilia Alshanetsky authored
393 /* set or release lock on a stream */
394 #define PHP_STREAM_OPTION_LOCKING 6
395
396 /* whether or not locking is supported */
e34f9a8 @lstrojny Cleanup: remove trailing whitespaces
lstrojny authored
397 #define PHP_STREAM_LOCK_SUPPORTED 1
862634f Added locking to streams.
Ilia Alshanetsky authored
398
fd61f69 @wez Another big commit (tm).
wez authored
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
b8f7d9f wrap all PHPAPI prototypes into BEGIN_EXTERN_C/END_EXTERN_C blocks
Hartmut Holzgraefe authored
413 BEGIN_EXTERN_C()
fd61f69 @wez Another big commit (tm).
wez authored
414 PHPAPI 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)
b8f7d9f wrap all PHPAPI prototypes into BEGIN_EXTERN_C/END_EXTERN_C blocks
Hartmut Holzgraefe authored
416 END_EXTERN_C()
862634f Added locking to streams.
Ilia Alshanetsky authored
417
cfd8150 @wez Add a generic meta data api for streams.
wez authored
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
3ee72aa @wez port "liveness" checks and a couple of other things from the 4.3 branch.
wez authored
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
9e84b3d @wez Revise buffer/seek code a little.
wez authored
425 #define PHP_STREAM_OPTION_RETURN_OK 0 /* option set OK */
e34f9a8 @lstrojny Cleanup: remove trailing whitespaces
lstrojny authored
426 #define PHP_STREAM_OPTION_RETURN_ERR -1 /* problem setting option */
9e84b3d @wez Revise buffer/seek code a little.
wez authored
427 #define PHP_STREAM_OPTION_RETURN_NOTIMPL -2 /* underlying stream does not implement; streams can handle it instead */
428
2441ddf @LawnGnome Fix bug #52802 (Out-of-date comment for
LawnGnome authored
429 /* copy up to maxlen bytes from src to dest. If maxlen is PHP_STREAM_COPY_ALL,
430 * copy until eof(src). */
0569078 @wez Avoid bug where stream_copy_to_stream() call for precisely 2000000 by…
wez authored
431 #define PHP_STREAM_COPY_ALL ((size_t)-1)
d98a44d Fixed bug #29801 (Set limit on the size of mmapable data).
Ilia Alshanetsky authored
432
b8f7d9f wrap all PHPAPI prototypes into BEGIN_EXTERN_C/END_EXTERN_C blocks
Hartmut Holzgraefe authored
433 BEGIN_EXTERN_C()
14c717f @arnaud-lb Fixed bug #47997 (stream_copy_to_stream returns 1 on empty streams)
arnaud-lb authored
434 ZEND_ATTRIBUTE_DEPRECATED
c9d5e13 @wez TSRMLS related work on streams, as discussed with Zeev.
wez authored
435 PHPAPI 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)
d5c5bb0 @cataphract - Fixed borked refactoring in r307437 (using SUCCESS/FAILURE return i…
cataphract authored
437 PHPAPI int _php_stream_copy_to_stream_ex(php_stream *src, php_stream *dest, size_t maxlen, size_t *len STREAMS_DC TSRMLS_DC);
8ea9eb8 @arnaud-lb MFH: Better fix for #47997
arnaud-lb authored
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)
c9d5e13 @wez TSRMLS related work on streams, as discussed with Zeev.
wez authored
439
b10b24d @wez Always initialize wrappers, regardless of PG(allow_url_fopen).
wez authored
440
2441ddf @LawnGnome Fix bug #52802 (Out-of-date comment for
LawnGnome authored
441 /* read all data from stream and put into a buffer. Caller must free buffer
442 * when done. */
d2d8762 @wez Streams now make more use of the memory manager, so tracking down
wez authored
443 PHPAPI size_t _php_stream_copy_to_mem(php_stream *src, char **buf, size_t maxlen,
c9d5e13 @wez TSRMLS related work on streams, as discussed with Zeev.
wez authored
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)
d2d8762 @wez Streams now make more use of the memory manager, so tracking down
wez authored
446
a662f01 @wez Convert the gzfile related functions into aliases for their equivalents
wez authored
447 /* output all data from a stream */
448 PHPAPI 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)
b8f7d9f wrap all PHPAPI prototypes into BEGIN_EXTERN_C/END_EXTERN_C blocks
Hartmut Holzgraefe authored
450 END_EXTERN_C()
a662f01 @wez Convert the gzfile related functions into aliases for their equivalents
wez authored
451
fd61f69 @wez Another big commit (tm).
wez authored
452 #include "streams/php_stream_transport.h"
32165a5 @wez Implement new filter API, stage 1.
wez authored
453 #include "streams/php_stream_plain_wrapper.h"
6362476 MFH streams stuff
Marcus Boerger authored
454 #include "streams/php_stream_glob_wrapper.h"
32165a5 @wez Implement new filter API, stage 1.
wez authored
455 #include "streams/php_stream_userspace.h"
fd61f69 @wez Another big commit (tm).
wez authored
456 #include "streams/php_stream_mmap.h"
5dbb3a7 @wez Added files for PHP streams
wez authored
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
5ecc91c @wez Merge selectable descriptor casting from PHP_4_3 branch.
wez authored
465 /* cast as fd/socket for select purposes */
466 #define PHP_STREAM_AS_FD_FOR_SELECT 3
5dbb3a7 @wez Added files for PHP streams
wez authored
467
ca58966 @wez Merge streams changes from branch.
wez authored
468 /* try really, really hard to make sure the cast happens (avoid using this flag if possible) */
0f65280 @wez New PHP streams...
wez authored
469 #define PHP_STREAM_CAST_TRY_HARD 0x80000000
bed0427 @wez Hopefully fix resource usage so that we have no leaks and don't segfa…
wez authored
470 #define PHP_STREAM_CAST_RELEASE 0x40000000 /* stream becomes invalid on success */
dabf105 @wez Refine stream_select() to work with streams that have data in their read
wez authored
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)
b8f7d9f wrap all PHPAPI prototypes into BEGIN_EXTERN_C/END_EXTERN_C blocks
Hartmut Holzgraefe authored
473 BEGIN_EXTERN_C()
c9d5e13 @wez TSRMLS related work on streams, as discussed with Zeev.
wez authored
474 PHPAPI int _php_stream_cast(php_stream *stream, int castas, void **ret, int show_err TSRMLS_DC);
b8f7d9f wrap all PHPAPI prototypes into BEGIN_EXTERN_C/END_EXTERN_C blocks
Hartmut Holzgraefe authored
475 END_EXTERN_C()
5dbb3a7 @wez Added files for PHP streams
wez authored
476 /* use this to check if a stream can be cast into another form */
c9d5e13 @wez TSRMLS related work on streams, as discussed with Zeev.
wez authored
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)
5dbb3a7 @wez Added files for PHP streams
wez authored
479
3ffb8e3 @wez Nuke buffering from php_streams, move connect_nonb() from fsock.c to …
wez authored
480 /* use this to check if a stream is of a particular type:
28d6981 @wez more *'s
wez authored
481 * PHPAPI int php_stream_is(php_stream *stream, php_stream_ops *ops); */
0f65280 @wez New PHP streams...
wez authored
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 */
12a0092 @wez Fix for php_stream_gets when the implementation does not support it
wez authored
488
6362476 MFH streams stuff
Marcus Boerger authored
489 #define IGNORE_PATH 0x00000000
490 #define USE_PATH 0x00000001
491 #define IGNORE_URL 0x00000002
492 #define REPORT_ERRORS 0x00000008
cc4a178 @tony2001 add the constant back. quite a lot of code uses it.
tony2001 authored
493 #define ENFORCE_SAFE_MODE 0 /* for BC only */
6362476 MFH streams stuff
Marcus Boerger authored
494
12a0092 @wez Fix for php_stream_gets when the implementation does not support it
wez authored
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. */
6362476 MFH streams stuff
Marcus Boerger authored
497 #define STREAM_MUST_SEEK 0x00000010
37411dd @wez Implement context option setting API.
wez authored
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.
e34f9a8 @lstrojny Cleanup: remove trailing whitespaces
lstrojny authored
502 * If you omit this flag, streams will use buffering and should end
37411dd @wez Implement context option setting API.
wez authored
503 * up working more optimally.
504 * */
6362476 MFH streams stuff
Marcus Boerger authored
505 #define STREAM_WILL_CAST 0x00000020
12a0092 @wez Fix for php_stream_gets when the implementation does not support it
wez authored
506
c2cbae6 @wez Enhance Ilia's recent patch to query the wrapper subsystem to determine
wez authored
507 /* this flag applies to php_stream_locate_url_wrapper */
6362476 MFH streams stuff
Marcus Boerger authored
508 #define STREAM_LOCATE_WRAPPERS_ONLY 0x00000040
c2cbae6 @wez Enhance Ilia's recent patch to query the wrapper subsystem to determine
wez authored
509
728eacb A better fix for bug #20110.
Ilia Alshanetsky authored
510 /* this flag is only used by include/require functions */
6362476 MFH streams stuff
Marcus Boerger authored
511 #define STREAM_OPEN_FOR_INCLUDE 0x00000080
728eacb A better fix for bug #20110.
Ilia Alshanetsky authored
512
a592f3c Added missing definitions.
Ilia Alshanetsky authored
513 /* this flag tells streams to ONLY open urls */
6362476 MFH streams stuff
Marcus Boerger authored
514 #define STREAM_USE_URL 0x00000100
a592f3c Added missing definitions.
Ilia Alshanetsky authored
515
516 /* this flag is used when only the headers from HTTP request are to be fetched */
6362476 MFH streams stuff
Marcus Boerger authored
517 #define STREAM_ONLY_GET_HEADERS 0x00000200
a592f3c Added missing definitions.
Ilia Alshanetsky authored
518
088e269 @wez MFB: Bunch of streams related fixes.
wez authored
519 /* don't apply open_basedir checks */
6362476 MFH streams stuff
Marcus Boerger authored
520 #define STREAM_DISABLE_OPEN_BASEDIR 0x00000400
088e269 @wez MFB: Bunch of streams related fixes.
wez authored
521
86fb577 @wez Implement persistent plain file streams.
wez authored
522 /* get (or create) a persistent version of the stream */
6362476 MFH streams stuff
Marcus Boerger authored
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
86fb577 @wez Implement persistent plain file streams.
wez authored
527
539f67e Added ability to create local or remote (URL) user streams
Dmitry Stogov authored
528 /* don't check allow_url_fopen and allow_url_include */
529 #define STREAM_DISABLE_URL_PROTECTION 0x00002000
530
862f9ee Added ability to use stream wrappers in include_path
Dmitry Stogov authored
531 /* assume the path passed in exists and is fully expanded, avoiding syscalls */
532 #define STREAM_ASSUME_REALPATH 0x00004000
533
ca58966 @wez Merge streams changes from branch.
wez authored
534 /* Antique - no longer has meaning */
535 #define IGNORE_URL_WIN 0
12a0092 @wez Fix for php_stream_gets when the implementation does not support it
wez authored
536
696e0a2 @wez Implement persistent streams. (for pfsockopen).
wez authored
537 int php_init_stream_wrappers(int module_number TSRMLS_DC);
538 int php_shutdown_stream_wrappers(int module_number TSRMLS_DC);
d5bb03b @tony2001 fix bugs #32742 (segmentation fault when the stream with a wrapper is…
tony2001 authored
539 void php_shutdown_stream_hashes(TSRMLS_D);
696e0a2 @wez Implement persistent streams. (for pfsockopen).
wez authored
540 PHP_RSHUTDOWN_FUNCTION(streams);
541
b8f7d9f wrap all PHPAPI prototypes into BEGIN_EXTERN_C/END_EXTERN_C blocks
Hartmut Holzgraefe authored
542 BEGIN_EXTERN_C()
73e7932 @zsuraski Fix the build and all of the outstanding VC++ warnings
zsuraski authored
543 PHPAPI int php_register_url_stream_wrapper(char *protocol, php_stream_wrapper *wrapper TSRMLS_DC);
544 PHPAPI int php_unregister_url_stream_wrapper(char *protocol TSRMLS_DC);
7fcfa88 @sgolemon BugFix#28868: Wrapper hash not thread-safe.
sgolemon authored
545 PHPAPI int php_register_url_stream_wrapper_volatile(char *protocol, php_stream_wrapper *wrapper TSRMLS_DC);
955b43b @sgolemon Add stream_wrapper_unregister()
sgolemon authored
546 PHPAPI int php_unregister_url_stream_wrapper_volatile(char *protocol TSRMLS_DC);
e1d0a14 @wez Implement stream context and status notification system.
wez authored
547 PHPAPI php_stream *_php_stream_open_wrapper_ex(char *path, char *mode, int options, char **opened_path, php_stream_context *context STREAMS_DC TSRMLS_DC);
c2cbae6 @wez Enhance Ilia's recent patch to query the wrapper subsystem to determine
wez authored
548 PHPAPI php_stream_wrapper *php_stream_locate_url_wrapper(const char *path, char **path_for_open, int options TSRMLS_DC);
4b83b18 Fixed bug #19971 (optimized the file() function).
Ilia Alshanetsky authored
549 PHPAPI char *php_stream_locate_eol(php_stream *stream, char *buf, size_t buf_len TSRMLS_DC);
e1d0a14 @wez Implement stream context and status notification system.
wez authored
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)
81e2cf0 @rlerdorf Fix folding and clean up some extensions
rlerdorf authored
553
0c366c2 @sgolemon Macro: php_stream_get_from_zval(php_stream *stream, zval **zstream, c…
sgolemon authored
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
9d348ea @wez Implement filter API for streams.
wez authored
560 /* pushes an error message onto the stack for a wrapper instance */
9c30a33 Fixed bug #53541 (format string bug in ext/phar).
Ilia Alshanetsky authored
561 #ifdef ZTS
562 PHPAPI 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
564 PHPAPI 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
9d348ea @wez Implement filter API for streams.
wez authored
566
12a0092 @wez Fix for php_stream_gets when the implementation does not support it
wez authored
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 */
14a3911 @wez fix for bug #16168
wez authored
571 #define PHP_STREAM_NO_PREFERENCE 0
572 #define PHP_STREAM_PREFER_STDIO 1
ca58966 @wez Merge streams changes from branch.
wez authored
573 #define PHP_STREAM_FORCE_CONVERSION 2
9d348ea @wez Implement filter API for streams.
wez authored
574 /* DO NOT call this on streams that are referenced by resources! */
14a3911 @wez fix for bug #16168
wez authored
575 PHPAPI 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)
12a0092 @wez Fix for php_stream_gets when the implementation does not support it
wez authored
577
42e912d @sgolemon Expose stream_filters_hash so that it can be searched by stream_get_f…
sgolemon authored
578 /* Give other modules access to the url_stream_wrappers_hash and stream_filters_hash */
7fcfa88 @sgolemon BugFix#28868: Wrapper hash not thread-safe.
sgolemon authored
579 PHPAPI 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)
955b43b @sgolemon Add stream_wrapper_unregister()
sgolemon authored
581 PHPAPI HashTable *php_stream_get_url_stream_wrappers_hash_global(void);
a2c24ae @sgolemon BugFix#28868 (Part Two): This fixes thread unsafety in the userspace
sgolemon authored
582 PHPAPI HashTable *_php_get_stream_filters_hash(TSRMLS_D);
583 #define php_get_stream_filters_hash() _php_get_stream_filters_hash(TSRMLS_C)
d271071 MFH: Fixed compile warnings
Jani Taskinen authored
584 PHPAPI HashTable *php_get_stream_filters_hash_global(void);
6362476 MFH streams stuff
Marcus Boerger authored
585 extern php_stream_wrapper_ops *php_stream_user_wrapper_ops;
b8f7d9f wrap all PHPAPI prototypes into BEGIN_EXTERN_C/END_EXTERN_C blocks
Hartmut Holzgraefe authored
586 END_EXTERN_C()
81e2cf0 @rlerdorf Fix folding and clean up some extensions
rlerdorf authored
587 #endif
588
539f67e Added ability to create local or remote (URL) user streams
Dmitry Stogov authored
589 /* Definitions for user streams */
590 #define PHP_STREAM_IS_URL 1
f908815 @smalyshev implement streams metadata API per RFC
smalyshev authored
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
3ffb8e3 @wez Nuke buffering from php_streams, move connect_nonb() from fsock.c to …
wez authored
600 /*
601 * Local variables:
602 * tab-width: 4
603 * c-basic-offset: 4
604 * End:
78747bd - Don't wrap lines... this is annoying while coding.
Derick Rethans authored
605 * vim600: sw=4 ts=4 fdm=marker
606 * vim<600: sw=4 ts=4
3ffb8e3 @wez Nuke buffering from php_streams, move connect_nonb() from fsock.c to …
wez authored
607 */
Something went wrong with that request. Please try again.