Back to index

php5  5.3.10
php_streams.h
Go to the documentation of this file.
00001 /*
00002    +----------------------------------------------------------------------+
00003    | PHP Version 5                                                        |
00004    +----------------------------------------------------------------------+
00005    | Copyright (c) 1997-2012 The PHP Group                                |
00006    +----------------------------------------------------------------------+
00007    | This source file is subject to version 3.01 of the PHP license,      |
00008    | that is bundled with this package in the file LICENSE, and is        |
00009    | available through the world-wide-web at the following url:           |
00010    | http://www.php.net/license/3_01.txt                                  |
00011    | If you did not receive a copy of the PHP license and are unable to   |
00012    | obtain it through the world-wide-web, please send a note to          |
00013    | license@php.net so we can mail you a copy immediately.               |
00014    +----------------------------------------------------------------------+
00015    | Author: Wez Furlong (wez@thebrainroom.com)                           |
00016    +----------------------------------------------------------------------+
00017  */
00018 
00019 /* $Id: php_streams.h 321634 2012-01-01 13:15:04Z felipe $ */
00020 
00021 #ifndef PHP_STREAMS_H
00022 #define PHP_STREAMS_H
00023 
00024 #ifdef HAVE_SYS_TIME_H
00025 #include <sys/time.h>
00026 #endif
00027 #include <sys/types.h>
00028 #include <sys/stat.h>
00029 
00030 BEGIN_EXTERN_C()
00031 PHPAPI int php_file_le_stream(void);
00032 PHPAPI int php_file_le_pstream(void);
00033 PHPAPI int php_file_le_stream_filter(void);
00034 END_EXTERN_C()
00035 
00036 /* {{{ Streams memory debugging stuff */
00037 
00038 #if ZEND_DEBUG
00039 /* these have more of a dependency on the definitions of the zend macros than
00040  * I would prefer, but doing it this way saves loads of idefs :-/ */
00041 # define STREAMS_D                 int __php_stream_call_depth ZEND_FILE_LINE_DC ZEND_FILE_LINE_ORIG_DC
00042 # define STREAMS_C                 0 ZEND_FILE_LINE_CC ZEND_FILE_LINE_EMPTY_CC
00043 # define STREAMS_REL_C             __php_stream_call_depth + 1 ZEND_FILE_LINE_CC, \
00044        __php_stream_call_depth ? __zend_orig_filename : __zend_filename, \
00045        __php_stream_call_depth ? __zend_orig_lineno : __zend_lineno
00046 
00047 # define STREAMS_DC         , STREAMS_D
00048 # define STREAMS_CC         , STREAMS_C
00049 # define STREAMS_REL_CC     , STREAMS_REL_C
00050 
00051 #else
00052 # define STREAMS_D
00053 # define STREAMS_C
00054 # define STREAMS_REL_C
00055 # define STREAMS_DC
00056 # define STREAMS_CC
00057 # define STREAMS_REL_CC
00058 #endif
00059 
00060 /* these functions relay the file/line number information. They are depth aware, so they will pass
00061  * the ultimate ancestor, which is useful, because there can be several layers of calls */
00062 #define php_stream_alloc_rel(ops, thisptr, persistent, mode) _php_stream_alloc((ops), (thisptr), (persistent), (mode) STREAMS_REL_CC TSRMLS_CC)
00063 
00064 #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)
00065 
00066 #define php_stream_fopen_rel(filename, mode, opened, options) _php_stream_fopen((filename), (mode), (opened), (options) STREAMS_REL_CC TSRMLS_CC)
00067 
00068 #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)
00069 
00070 #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)
00071 #define php_stream_fopen_from_file_rel(file, mode)       _php_stream_fopen_from_file((file), (mode) STREAMS_REL_CC TSRMLS_CC)
00072 
00073 #define php_stream_fopen_from_pipe_rel(file, mode)       _php_stream_fopen_from_pipe((file), (mode) STREAMS_REL_CC TSRMLS_CC)
00074 
00075 #define php_stream_fopen_tmpfile_rel()    _php_stream_fopen_tmpfile(0 STREAMS_REL_CC TSRMLS_CC)
00076 
00077 #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)
00078 
00079 #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)
00080 #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)
00081 
00082 #define php_stream_make_seekable_rel(origstream, newstream, flags) _php_stream_make_seekable((origstream), (newstream), (flags) STREAMS_REL_CC TSRMLS_CC)
00083 
00084 /* }}} */
00085 
00086 /* The contents of the php_stream_ops and php_stream should only be accessed
00087  * using the functions/macros in this header.
00088  * If you need to get at something that doesn't have an API,
00089  * drop me a line <wez@thebrainroom.com> and we can sort out a way to do
00090  * it properly.
00091  *
00092  * The only exceptions to this rule are that stream implementations can use
00093  * the php_stream->abstract pointer to hold their context, and streams
00094  * opened via stream_open_wrappers can use the zval ptr in
00095  * php_stream->wrapperdata to hold meta data for php scripts to
00096  * retrieve using file_get_wrapper_data(). */
00097 
00098 typedef struct _php_stream php_stream;
00099 typedef struct _php_stream_wrapper php_stream_wrapper;
00100 typedef struct _php_stream_context php_stream_context;
00101 typedef struct _php_stream_filter php_stream_filter;
00102 
00103 #include "streams/php_stream_context.h"
00104 #include "streams/php_stream_filter_api.h"
00105 
00106 typedef struct _php_stream_statbuf {
00107        struct stat sb; /* regular info */
00108        /* extended info to go here some day: content-type etc. etc. */
00109 } php_stream_statbuf;
00110 
00111 typedef struct _php_stream_dirent {
00112        char d_name[MAXPATHLEN];
00113 } php_stream_dirent;
00114 
00115 /* operations on streams that are file-handles */
00116 typedef struct _php_stream_ops  {
00117        /* stdio like functions - these are mandatory! */
00118        size_t (*write)(php_stream *stream, const char *buf, size_t count TSRMLS_DC);
00119        size_t (*read)(php_stream *stream, char *buf, size_t count TSRMLS_DC);
00120        int    (*close)(php_stream *stream, int close_handle TSRMLS_DC);
00121        int    (*flush)(php_stream *stream TSRMLS_DC);
00122 
00123        const char *label; /* label for this ops structure */
00124 
00125        /* these are optional */
00126        int (*seek)(php_stream *stream, off_t offset, int whence, off_t *newoffset TSRMLS_DC);
00127        int (*cast)(php_stream *stream, int castas, void **ret TSRMLS_DC);
00128        int (*stat)(php_stream *stream, php_stream_statbuf *ssb TSRMLS_DC);
00129        int (*set_option)(php_stream *stream, int option, int value, void *ptrparam TSRMLS_DC);
00130 } php_stream_ops;
00131 
00132 typedef struct _php_stream_wrapper_ops {
00133        /* open/create a wrapped stream */
00134        php_stream *(*stream_opener)(php_stream_wrapper *wrapper, char *filename, char *mode,
00135                      int options, char **opened_path, php_stream_context *context STREAMS_DC TSRMLS_DC);
00136        /* close/destroy a wrapped stream */
00137        int (*stream_closer)(php_stream_wrapper *wrapper, php_stream *stream TSRMLS_DC);
00138        /* stat a wrapped stream */
00139        int (*stream_stat)(php_stream_wrapper *wrapper, php_stream *stream, php_stream_statbuf *ssb TSRMLS_DC);
00140        /* stat a URL */
00141        int (*url_stat)(php_stream_wrapper *wrapper, char *url, int flags, php_stream_statbuf *ssb, php_stream_context *context TSRMLS_DC);
00142        /* open a "directory" stream */
00143        php_stream *(*dir_opener)(php_stream_wrapper *wrapper, char *filename, char *mode,
00144                      int options, char **opened_path, php_stream_context *context STREAMS_DC TSRMLS_DC);
00145 
00146        const char *label;
00147 
00148        /* delete a file */
00149        int (*unlink)(php_stream_wrapper *wrapper, char *url, int options, php_stream_context *context TSRMLS_DC);
00150 
00151        /* rename a file */
00152        int (*rename)(php_stream_wrapper *wrapper, char *url_from, char *url_to, int options, php_stream_context *context TSRMLS_DC);
00153 
00154        /* Create/Remove directory */
00155        int (*stream_mkdir)(php_stream_wrapper *wrapper, char *url, int mode, int options, php_stream_context *context TSRMLS_DC);
00156        int (*stream_rmdir)(php_stream_wrapper *wrapper, char *url, int options, php_stream_context *context TSRMLS_DC);
00157 } php_stream_wrapper_ops;
00158 
00159 struct _php_stream_wrapper  {
00160        php_stream_wrapper_ops *wops;      /* operations the wrapper can perform */
00161        void *abstract;                                  /* context for the wrapper */
00162        int is_url;                                      /* so that PG(allow_url_fopen) can be respected */
00163 
00164        /* support for wrappers to return (multiple) error messages to the stream opener */
00165        int err_count;
00166        char **err_stack;
00167 };
00168 
00169 #define PHP_STREAM_FLAG_NO_SEEK                                       1
00170 #define PHP_STREAM_FLAG_NO_BUFFER                              2
00171 
00172 #define PHP_STREAM_FLAG_EOL_UNIX                               0 /* also includes DOS */
00173 #define PHP_STREAM_FLAG_DETECT_EOL                             4
00174 #define PHP_STREAM_FLAG_EOL_MAC                                       8
00175 
00176 /* set this when the stream might represent "interactive" data.
00177  * When set, the read buffer will avoid certain operations that
00178  * might otherwise cause the read to block for much longer than
00179  * is strictly required. */
00180 #define PHP_STREAM_FLAG_AVOID_BLOCKING                         16
00181 
00182 #define PHP_STREAM_FLAG_NO_CLOSE                               32
00183 
00184 #define PHP_STREAM_FLAG_IS_DIR                                        64
00185 
00186 #define PHP_STREAM_FLAG_NO_FCLOSE                              128
00187 
00188 struct _php_stream  {
00189        php_stream_ops *ops;
00190        void *abstract;                    /* convenience pointer for abstraction */
00191 
00192        php_stream_filter_chain readfilters, writefilters;
00193 
00194        php_stream_wrapper *wrapper; /* which wrapper was used to open the stream */
00195        void *wrapperthis;          /* convenience pointer for a instance of a wrapper */
00196        zval *wrapperdata;          /* fgetwrapperdata retrieves this */
00197 
00198        int fgetss_state;           /* for fgetss to handle multiline tags */
00199        int is_persistent;
00200        char mode[16];                     /* "rwb" etc. ala stdio */
00201        int rsrc_id;                /* used for auto-cleanup */
00202        int in_free;                /* to prevent recursion during free */
00203        /* so we know how to clean it up correctly.  This should be set to
00204         * PHP_STREAM_FCLOSE_XXX as appropriate */
00205        int fclose_stdiocast;
00206        FILE *stdiocast;    /* cache this, otherwise we might leak! */
00207 #if ZEND_DEBUG
00208        int __exposed;       /* non-zero if exposed as a zval somewhere */
00209 #endif
00210        char *orig_path;
00211 
00212        php_stream_context *context;
00213        int flags;    /* PHP_STREAM_FLAG_XXX */
00214 
00215        /* buffer */
00216        off_t position; /* of underlying stream */
00217        unsigned char *readbuf;
00218        size_t readbuflen;
00219        off_t readpos;
00220        off_t writepos;
00221 
00222        /* how much data to read when filling buffer */
00223        size_t chunk_size;
00224 
00225        int eof;
00226 
00227 #if ZEND_DEBUG
00228        char *open_filename;
00229        uint open_lineno;
00230 #endif
00231 }; /* php_stream */
00232 
00233 /* state definitions when closing down; these are private to streams.c */
00234 #define PHP_STREAM_FCLOSE_NONE 0
00235 #define PHP_STREAM_FCLOSE_FDOPEN   1
00236 #define PHP_STREAM_FCLOSE_FOPENCOOKIE 2
00237 
00238 /* allocate a new stream for a particular ops */
00239 BEGIN_EXTERN_C()
00240 PHPAPI php_stream *_php_stream_alloc(php_stream_ops *ops, void *abstract,
00241               const char *persistent_id, const char *mode STREAMS_DC TSRMLS_DC);
00242 END_EXTERN_C()
00243 #define php_stream_alloc(ops, thisptr, persistent_id, mode)    _php_stream_alloc((ops), (thisptr), (persistent_id), (mode) STREAMS_CC TSRMLS_CC)
00244 
00245 #define php_stream_get_resource_id(stream)              (stream)->rsrc_id
00246 #if ZEND_DEBUG
00247 /* use this to tell the stream that it is OK if we don't explicitly close it */
00248 # define php_stream_auto_cleanup(stream)  { (stream)->__exposed++; }
00249 /* use this to assign the stream to a zval and tell the stream that is
00250  * has been exported to the engine; it will expect to be closed automatically
00251  * when the resources are auto-destructed */
00252 # define php_stream_to_zval(stream, zval) { ZVAL_RESOURCE(zval, (stream)->rsrc_id); (stream)->__exposed++; }
00253 #else
00254 # define php_stream_auto_cleanup(stream)  /* nothing */
00255 # define php_stream_to_zval(stream, zval) { ZVAL_RESOURCE(zval, (stream)->rsrc_id); }
00256 #endif
00257 
00258 #define php_stream_from_zval(xstr, ppzval)       ZEND_FETCH_RESOURCE2((xstr), php_stream *, (ppzval), -1, "stream", php_file_le_stream(), php_file_le_pstream())
00259 #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())
00260 
00261 BEGIN_EXTERN_C()
00262 PHPAPI int php_stream_from_persistent_id(const char *persistent_id, php_stream **stream TSRMLS_DC);
00263 #define PHP_STREAM_PERSISTENT_SUCCESS     0 /* id exists */
00264 #define PHP_STREAM_PERSISTENT_FAILURE     1 /* id exists but is not a stream! */
00265 #define PHP_STREAM_PERSISTENT_NOT_EXIST   2 /* id does not exist */
00266 
00267 #define PHP_STREAM_FREE_CALL_DTOR                1 /* call ops->close */
00268 #define PHP_STREAM_FREE_RELEASE_STREAM           2 /* pefree(stream) */
00269 #define PHP_STREAM_FREE_PRESERVE_HANDLE          4 /* tell ops->close to not close it's underlying handle */
00270 #define PHP_STREAM_FREE_RSRC_DTOR                8 /* called from the resource list dtor */
00271 #define PHP_STREAM_FREE_PERSISTENT               16 /* manually freeing a persistent connection */
00272 #define PHP_STREAM_FREE_CLOSE                           (PHP_STREAM_FREE_CALL_DTOR | PHP_STREAM_FREE_RELEASE_STREAM)
00273 #define PHP_STREAM_FREE_CLOSE_CASTED             (PHP_STREAM_FREE_CLOSE | PHP_STREAM_FREE_PRESERVE_HANDLE)
00274 #define PHP_STREAM_FREE_CLOSE_PERSISTENT  (PHP_STREAM_FREE_CLOSE | PHP_STREAM_FREE_PERSISTENT)
00275 
00276 PHPAPI int _php_stream_free(php_stream *stream, int close_options TSRMLS_DC);
00277 #define php_stream_free(stream, close_options)   _php_stream_free((stream), (close_options) TSRMLS_CC)
00278 #define php_stream_close(stream)   _php_stream_free((stream), PHP_STREAM_FREE_CLOSE TSRMLS_CC)
00279 #define php_stream_pclose(stream)  _php_stream_free((stream), PHP_STREAM_FREE_CLOSE_PERSISTENT TSRMLS_CC)
00280 
00281 PHPAPI int _php_stream_seek(php_stream *stream, off_t offset, int whence TSRMLS_DC);
00282 #define php_stream_rewind(stream)  _php_stream_seek((stream), 0L, SEEK_SET TSRMLS_CC)
00283 #define php_stream_seek(stream, offset, whence)  _php_stream_seek((stream), (offset), (whence) TSRMLS_CC)
00284 
00285 PHPAPI off_t _php_stream_tell(php_stream *stream TSRMLS_DC);
00286 #define php_stream_tell(stream)    _php_stream_tell((stream) TSRMLS_CC)
00287 
00288 PHPAPI size_t _php_stream_read(php_stream *stream, char *buf, size_t count TSRMLS_DC);
00289 #define php_stream_read(stream, buf, count)             _php_stream_read((stream), (buf), (count) TSRMLS_CC)
00290 
00291 PHPAPI size_t _php_stream_write(php_stream *stream, const char *buf, size_t count TSRMLS_DC);
00292 #define php_stream_write_string(stream, str)     _php_stream_write(stream, str, strlen(str) TSRMLS_CC)
00293 #define php_stream_write(stream, buf, count)     _php_stream_write(stream, (buf), (count) TSRMLS_CC)
00294 
00295 #ifdef ZTS
00296 PHPAPI size_t _php_stream_printf(php_stream *stream TSRMLS_DC, const char *fmt, ...) PHP_ATTRIBUTE_FORMAT(printf, 3, 4);
00297 #else
00298 PHPAPI size_t _php_stream_printf(php_stream *stream TSRMLS_DC, const char *fmt, ...) PHP_ATTRIBUTE_FORMAT(printf, 2, 3);
00299 #endif
00300 
00301 /* php_stream_printf macro & function require TSRMLS_CC */
00302 #define php_stream_printf _php_stream_printf
00303 
00304 PHPAPI int _php_stream_eof(php_stream *stream TSRMLS_DC);
00305 #define php_stream_eof(stream)     _php_stream_eof((stream) TSRMLS_CC)
00306 
00307 PHPAPI int _php_stream_getc(php_stream *stream TSRMLS_DC);
00308 #define php_stream_getc(stream)    _php_stream_getc((stream) TSRMLS_CC)
00309 
00310 PHPAPI int _php_stream_putc(php_stream *stream, int c TSRMLS_DC);
00311 #define php_stream_putc(stream, c) _php_stream_putc((stream), (c) TSRMLS_CC)
00312 
00313 PHPAPI int _php_stream_flush(php_stream *stream, int closing TSRMLS_DC);
00314 #define php_stream_flush(stream)   _php_stream_flush((stream), 0 TSRMLS_CC)
00315 
00316 PHPAPI char *_php_stream_get_line(php_stream *stream, char *buf, size_t maxlen, size_t *returned_len TSRMLS_DC);
00317 #define php_stream_gets(stream, buf, maxlen)     _php_stream_get_line((stream), (buf), (maxlen), NULL TSRMLS_CC)
00318 
00319 #define php_stream_get_line(stream, buf, maxlen, retlen) _php_stream_get_line((stream), (buf), (maxlen), (retlen) TSRMLS_CC)
00320 PHPAPI char *php_stream_get_record(php_stream *stream, size_t maxlen, size_t *returned_len, char *delim, size_t delim_len TSRMLS_DC);
00321 
00322 /* CAREFUL! this is equivalent to puts NOT fputs! */
00323 PHPAPI int _php_stream_puts(php_stream *stream, char *buf TSRMLS_DC);
00324 #define php_stream_puts(stream, buf)      _php_stream_puts((stream), (buf) TSRMLS_CC)
00325 
00326 PHPAPI int _php_stream_stat(php_stream *stream, php_stream_statbuf *ssb TSRMLS_DC);
00327 #define php_stream_stat(stream, ssb)      _php_stream_stat((stream), (ssb) TSRMLS_CC)
00328 
00329 PHPAPI int _php_stream_stat_path(char *path, int flags, php_stream_statbuf *ssb, php_stream_context *context TSRMLS_DC);
00330 #define php_stream_stat_path(path, ssb)   _php_stream_stat_path((path), 0, (ssb), NULL TSRMLS_CC)
00331 #define php_stream_stat_path_ex(path, flags, ssb, context)     _php_stream_stat_path((path), (flags), (ssb), (context) TSRMLS_CC)
00332 
00333 PHPAPI int _php_stream_mkdir(char *path, int mode, int options, php_stream_context *context TSRMLS_DC);
00334 #define php_stream_mkdir(path, mode, options, context)  _php_stream_mkdir(path, mode, options, context TSRMLS_CC)
00335 
00336 PHPAPI int _php_stream_rmdir(char *path, int options, php_stream_context *context TSRMLS_DC);
00337 #define php_stream_rmdir(path, options, context) _php_stream_rmdir(path, options, context TSRMLS_CC)
00338 
00339 PHPAPI php_stream *_php_stream_opendir(char *path, int options, php_stream_context *context STREAMS_DC TSRMLS_DC);
00340 #define php_stream_opendir(path, options, context)      _php_stream_opendir((path), (options), (context) STREAMS_CC TSRMLS_CC)
00341 PHPAPI php_stream_dirent *_php_stream_readdir(php_stream *dirstream, php_stream_dirent *ent TSRMLS_DC);
00342 #define php_stream_readdir(dirstream, dirent)    _php_stream_readdir((dirstream), (dirent) TSRMLS_CC)
00343 #define php_stream_closedir(dirstream)    php_stream_close((dirstream))
00344 #define php_stream_rewinddir(dirstream)   php_stream_rewind((dirstream))
00345 
00346 PHPAPI int php_stream_dirent_alphasort(const char **a, const char **b);
00347 PHPAPI int php_stream_dirent_alphasortr(const char **a, const char **b);
00348 
00349 PHPAPI int _php_stream_scandir(char *dirname, char **namelist[], int flags, php_stream_context *context,
00350                      int (*compare) (const char **a, const char **b) TSRMLS_DC);
00351 #define php_stream_scandir(dirname, namelist, context, compare) _php_stream_scandir((dirname), (namelist), 0, (context), (compare) TSRMLS_CC)
00352 
00353 PHPAPI int _php_stream_set_option(php_stream *stream, int option, int value, void *ptrparam TSRMLS_DC);
00354 #define php_stream_set_option(stream, option, value, ptrvalue) _php_stream_set_option((stream), (option), (value), (ptrvalue) TSRMLS_CC)
00355 
00356 #define php_stream_set_chunk_size(stream, size) _php_stream_set_option((stream), PHP_STREAM_OPTION_SET_CHUNK_SIZE, (size), NULL TSRMLS_CC)
00357 
00358 END_EXTERN_C()
00359 
00360 
00361 /* Flags for mkdir method in wrapper ops */
00362 #define PHP_STREAM_MKDIR_RECURSIVE 1
00363 /* define REPORT ERRORS 8 (below) */
00364 
00365 /* Flags for rmdir method in wrapper ops */
00366 /* define REPORT_ERRORS 8 (below) */
00367 
00368 /* Flags for url_stat method in wrapper ops */
00369 #define PHP_STREAM_URL_STAT_LINK   1
00370 #define PHP_STREAM_URL_STAT_QUIET  2
00371 
00372 /* change the blocking mode of stream: value == 1 => blocking, value == 0 => non-blocking. */
00373 #define PHP_STREAM_OPTION_BLOCKING 1
00374 
00375 /* change the buffering mode of stream. value is a PHP_STREAM_BUFFER_XXXX value, ptrparam is a ptr to a size_t holding
00376  * the required buffer size */
00377 #define PHP_STREAM_OPTION_READ_BUFFER     2
00378 #define PHP_STREAM_OPTION_WRITE_BUFFER    3
00379 
00380 #define PHP_STREAM_BUFFER_NONE     0      /* unbuffered */
00381 #define PHP_STREAM_BUFFER_LINE     1      /* line buffered */
00382 #define PHP_STREAM_BUFFER_FULL     2      /* fully buffered */
00383 
00384 /* set the timeout duration for reads on the stream. ptrparam is a pointer to a struct timeval * */
00385 #define PHP_STREAM_OPTION_READ_TIMEOUT    4
00386 #define PHP_STREAM_OPTION_SET_CHUNK_SIZE  5
00387 
00388 /* set or release lock on a stream */
00389 #define PHP_STREAM_OPTION_LOCKING         6
00390 
00391 /* whether or not locking is supported */
00392 #define PHP_STREAM_LOCK_SUPPORTED         1
00393 
00394 #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
00395 #define php_stream_lock(stream, mode)            _php_stream_set_option((stream), PHP_STREAM_OPTION_LOCKING, (mode), (void *) NULL TSRMLS_CC)
00396 
00397 /* option code used by the php_stream_xport_XXX api */
00398 #define PHP_STREAM_OPTION_XPORT_API                     7 /* see php_stream_transport.h */
00399 #define PHP_STREAM_OPTION_CRYPTO_API             8 /* see php_stream_transport.h */
00400 #define PHP_STREAM_OPTION_MMAP_API               9 /* see php_stream_mmap.h */
00401 #define PHP_STREAM_OPTION_TRUNCATE_API           10
00402 
00403 #define PHP_STREAM_TRUNCATE_SUPPORTED     0
00404 #define PHP_STREAM_TRUNCATE_SET_SIZE      1      /* ptrparam is a pointer to a size_t */
00405 
00406 #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)
00407 
00408 BEGIN_EXTERN_C()
00409 PHPAPI int _php_stream_truncate_set_size(php_stream *stream, size_t newsize TSRMLS_DC);
00410 #define php_stream_truncate_set_size(stream, size)      _php_stream_truncate_set_size((stream), (size) TSRMLS_CC)
00411 END_EXTERN_C()
00412 
00413 #define PHP_STREAM_OPTION_META_DATA_API          11 /* ptrparam is a zval* to which to add meta data information */
00414 #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)
00415 
00416 /* Check if the stream is still "live"; for sockets/pipes this means the socket
00417  * is still connected; for files, this does not really have meaning */
00418 #define PHP_STREAM_OPTION_CHECK_LIVENESS  12 /* no parameters */
00419 
00420 #define PHP_STREAM_OPTION_RETURN_OK                      0 /* option set OK */
00421 #define PHP_STREAM_OPTION_RETURN_ERR             -1 /* problem setting option */
00422 #define PHP_STREAM_OPTION_RETURN_NOTIMPL  -2 /* underlying stream does not implement; streams can handle it instead */
00423 
00424 /* copy up to maxlen bytes from src to dest.  If maxlen is PHP_STREAM_COPY_ALL,
00425  * copy until eof(src). */
00426 #define PHP_STREAM_COPY_ALL        ((size_t)-1)
00427 
00428 BEGIN_EXTERN_C()
00429 ZEND_ATTRIBUTE_DEPRECATED
00430 PHPAPI size_t _php_stream_copy_to_stream(php_stream *src, php_stream *dest, size_t maxlen STREAMS_DC TSRMLS_DC);
00431 #define php_stream_copy_to_stream(src, dest, maxlen)    _php_stream_copy_to_stream((src), (dest), (maxlen) STREAMS_CC TSRMLS_CC)
00432 PHPAPI size_t _php_stream_copy_to_stream_ex(php_stream *src, php_stream *dest, size_t maxlen, size_t *len STREAMS_DC TSRMLS_DC);
00433 #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)
00434 
00435 
00436 /* read all data from stream and put into a buffer. Caller must free buffer
00437  * when done. */
00438 PHPAPI size_t _php_stream_copy_to_mem(php_stream *src, char **buf, size_t maxlen,
00439               int persistent STREAMS_DC TSRMLS_DC);
00440 #define php_stream_copy_to_mem(src, buf, maxlen, persistent) _php_stream_copy_to_mem((src), (buf), (maxlen), (persistent) STREAMS_CC TSRMLS_CC)
00441 
00442 /* output all data from a stream */
00443 PHPAPI size_t _php_stream_passthru(php_stream * src STREAMS_DC TSRMLS_DC);
00444 #define php_stream_passthru(stream)       _php_stream_passthru((stream) STREAMS_CC TSRMLS_CC)
00445 END_EXTERN_C()
00446 
00447 #include "streams/php_stream_transport.h"
00448 #include "streams/php_stream_plain_wrapper.h"
00449 #include "streams/php_stream_glob_wrapper.h"
00450 #include "streams/php_stream_userspace.h"
00451 #include "streams/php_stream_mmap.h"
00452 
00453 /* coerce the stream into some other form */
00454 /* cast as a stdio FILE * */
00455 #define PHP_STREAM_AS_STDIO     0
00456 /* cast as a POSIX fd or socketd */
00457 #define PHP_STREAM_AS_FD           1
00458 /* cast as a socketd */
00459 #define PHP_STREAM_AS_SOCKETD      2
00460 /* cast as fd/socket for select purposes */
00461 #define PHP_STREAM_AS_FD_FOR_SELECT 3
00462 
00463 /* try really, really hard to make sure the cast happens (avoid using this flag if possible) */
00464 #define PHP_STREAM_CAST_TRY_HARD   0x80000000
00465 #define PHP_STREAM_CAST_RELEASE           0x40000000    /* stream becomes invalid on success */
00466 #define PHP_STREAM_CAST_INTERNAL   0x20000000    /* stream cast for internal use */
00467 #define PHP_STREAM_CAST_MASK              (PHP_STREAM_CAST_TRY_HARD | PHP_STREAM_CAST_RELEASE | PHP_STREAM_CAST_INTERNAL)
00468 BEGIN_EXTERN_C()
00469 PHPAPI int _php_stream_cast(php_stream *stream, int castas, void **ret, int show_err TSRMLS_DC);
00470 END_EXTERN_C()
00471 /* use this to check if a stream can be cast into another form */
00472 #define php_stream_can_cast(stream, as)   _php_stream_cast((stream), (as), NULL, 0 TSRMLS_CC)
00473 #define php_stream_cast(stream, as, ret, show_err)      _php_stream_cast((stream), (as), (ret), (show_err) TSRMLS_CC)
00474 
00475 /* use this to check if a stream is of a particular type:
00476  * PHPAPI int php_stream_is(php_stream *stream, php_stream_ops *ops); */
00477 #define php_stream_is(stream, anops)             ((stream)->ops == anops)
00478 #define PHP_STREAM_IS_STDIO &php_stream_stdio_ops
00479 
00480 #define php_stream_is_persistent(stream)  (stream)->is_persistent
00481 
00482 /* Wrappers support */
00483 
00484 #define IGNORE_PATH                     0x00000000
00485 #define USE_PATH                        0x00000001
00486 #define IGNORE_URL                      0x00000002
00487 #define ENFORCE_SAFE_MODE               0x00000004
00488 #define REPORT_ERRORS                   0x00000008
00489 
00490 /* If you don't need to write to the stream, but really need to
00491  * be able to seek, use this flag in your options. */
00492 #define STREAM_MUST_SEEK                0x00000010
00493 /* If you are going to end up casting the stream into a FILE* or
00494  * a socket, pass this flag and the streams/wrappers will not use
00495  * buffering mechanisms while reading the headers, so that HTTP
00496  * wrapped streams will work consistently.
00497  * If you omit this flag, streams will use buffering and should end
00498  * up working more optimally.
00499  * */
00500 #define STREAM_WILL_CAST                0x00000020
00501 
00502 /* this flag applies to php_stream_locate_url_wrapper */
00503 #define STREAM_LOCATE_WRAPPERS_ONLY     0x00000040
00504 
00505 /* this flag is only used by include/require functions */
00506 #define STREAM_OPEN_FOR_INCLUDE         0x00000080
00507 
00508 /* this flag tells streams to ONLY open urls */
00509 #define STREAM_USE_URL                  0x00000100
00510 
00511 /* this flag is used when only the headers from HTTP request are to be fetched */
00512 #define STREAM_ONLY_GET_HEADERS         0x00000200
00513 
00514 /* don't apply open_basedir checks */
00515 #define STREAM_DISABLE_OPEN_BASEDIR     0x00000400
00516 
00517 /* get (or create) a persistent version of the stream */
00518 #define STREAM_OPEN_PERSISTENT          0x00000800
00519 
00520 /* use glob stream for directory open in plain files stream */
00521 #define STREAM_USE_GLOB_DIR_OPEN        0x00001000
00522 
00523 /* don't check allow_url_fopen and allow_url_include */
00524 #define STREAM_DISABLE_URL_PROTECTION   0x00002000
00525 
00526 /* assume the path passed in exists and is fully expanded, avoiding syscalls */
00527 #define STREAM_ASSUME_REALPATH          0x00004000
00528 
00529 /* Antique - no longer has meaning */
00530 #define IGNORE_URL_WIN 0
00531 
00532 int php_init_stream_wrappers(int module_number TSRMLS_DC);
00533 int php_shutdown_stream_wrappers(int module_number TSRMLS_DC);
00534 void php_shutdown_stream_hashes(TSRMLS_D);
00535 PHP_RSHUTDOWN_FUNCTION(streams);
00536 
00537 BEGIN_EXTERN_C()
00538 PHPAPI int php_register_url_stream_wrapper(char *protocol, php_stream_wrapper *wrapper TSRMLS_DC);
00539 PHPAPI int php_unregister_url_stream_wrapper(char *protocol TSRMLS_DC);
00540 PHPAPI int php_register_url_stream_wrapper_volatile(char *protocol, php_stream_wrapper *wrapper TSRMLS_DC);
00541 PHPAPI int php_unregister_url_stream_wrapper_volatile(char *protocol TSRMLS_DC);
00542 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);
00543 PHPAPI php_stream_wrapper *php_stream_locate_url_wrapper(const char *path, char **path_for_open, int options TSRMLS_DC);
00544 PHPAPI char *php_stream_locate_eol(php_stream *stream, char *buf, size_t buf_len TSRMLS_DC);
00545 
00546 #define php_stream_open_wrapper(path, mode, options, opened)   _php_stream_open_wrapper_ex((path), (mode), (options), (opened), NULL STREAMS_CC TSRMLS_CC)
00547 #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)
00548 
00549 #define php_stream_get_from_zval(stream, zstream, mode, options, opened, context) \
00550               if (Z_TYPE_PP((zstream)) == IS_RESOURCE) { \
00551                      php_stream_from_zval((stream), (zstream)); \
00552               } else (stream) = Z_TYPE_PP((zstream)) == IS_STRING ?  \
00553                      php_stream_open_wrapper_ex(Z_STRVAL_PP((zstream)), (mode), (options), (opened), (context)) : NULL
00554 
00555 /* pushes an error message onto the stack for a wrapper instance */
00556 #ifdef ZTS
00557 PHPAPI void php_stream_wrapper_log_error(php_stream_wrapper *wrapper, int options TSRMLS_DC, const char *fmt, ...) PHP_ATTRIBUTE_FORMAT(printf, 4, 5);
00558 #else
00559 PHPAPI void php_stream_wrapper_log_error(php_stream_wrapper *wrapper, int options TSRMLS_DC, const char *fmt, ...) PHP_ATTRIBUTE_FORMAT(printf, 3, 4);
00560 #endif
00561 
00562 #define PHP_STREAM_UNCHANGED       0 /* orig stream was seekable anyway */
00563 #define PHP_STREAM_RELEASED        1 /* newstream should be used; origstream is no longer valid */
00564 #define PHP_STREAM_FAILED          2 /* an error occurred while attempting conversion */
00565 #define PHP_STREAM_CRITICAL        3 /* an error occurred; origstream is in an unknown state; you should close origstream */
00566 #define PHP_STREAM_NO_PREFERENCE   0
00567 #define PHP_STREAM_PREFER_STDIO           1
00568 #define PHP_STREAM_FORCE_CONVERSION       2
00569 /* DO NOT call this on streams that are referenced by resources! */
00570 PHPAPI int _php_stream_make_seekable(php_stream *origstream, php_stream **newstream, int flags STREAMS_DC TSRMLS_DC);
00571 #define php_stream_make_seekable(origstream, newstream, flags) _php_stream_make_seekable((origstream), (newstream), (flags) STREAMS_CC TSRMLS_CC)
00572 
00573 /* Give other modules access to the url_stream_wrappers_hash and stream_filters_hash */
00574 PHPAPI HashTable *_php_stream_get_url_stream_wrappers_hash(TSRMLS_D);
00575 #define php_stream_get_url_stream_wrappers_hash()       _php_stream_get_url_stream_wrappers_hash(TSRMLS_C)
00576 PHPAPI HashTable *php_stream_get_url_stream_wrappers_hash_global(void);
00577 PHPAPI HashTable *_php_get_stream_filters_hash(TSRMLS_D);
00578 #define php_get_stream_filters_hash()     _php_get_stream_filters_hash(TSRMLS_C)
00579 PHPAPI HashTable *php_get_stream_filters_hash_global(void);
00580 extern php_stream_wrapper_ops *php_stream_user_wrapper_ops;
00581 END_EXTERN_C()
00582 #endif
00583 
00584 /* Definitions for user streams */
00585 #define PHP_STREAM_IS_URL          1
00586 /*
00587  * Local variables:
00588  * tab-width: 4
00589  * c-basic-offset: 4
00590  * End:
00591  * vim600: sw=4 ts=4 fdm=marker
00592  * vim<600: sw=4 ts=4
00593  */