xref: /PHP-8.0/ext/standard/file.h (revision 7805b977)
1 /*
2    +----------------------------------------------------------------------+
3    | Copyright (c) The PHP Group                                          |
4    +----------------------------------------------------------------------+
5    | This source file is subject to version 3.01 of the PHP license,      |
6    | that is bundled with this package in the file LICENSE, and is        |
7    | available through the world-wide-web at the following url:           |
8    | http://www.php.net/license/3_01.txt                                  |
9    | If you did not receive a copy of the PHP license and are unable to   |
10    | obtain it through the world-wide-web, please send a note to          |
11    | license@php.net so we can mail you a copy immediately.               |
12    +----------------------------------------------------------------------+
13    | Author: Rasmus Lerdorf <rasmus@lerdorf.on.ca>                        |
14    +----------------------------------------------------------------------+
15 */
16 
17 #ifndef FILE_H
18 #define FILE_H
19 
20 #include "php_network.h"
21 
22 PHP_MINIT_FUNCTION(file);
23 PHP_MSHUTDOWN_FUNCTION(file);
24 
25 PHPAPI PHP_FUNCTION(fclose);
26 PHPAPI PHP_FUNCTION(feof);
27 PHPAPI PHP_FUNCTION(fread);
28 PHPAPI PHP_FUNCTION(fgetc);
29 PHPAPI PHP_FUNCTION(fgets);
30 PHPAPI PHP_FUNCTION(fwrite);
31 PHPAPI PHP_FUNCTION(fflush);
32 PHPAPI PHP_FUNCTION(rewind);
33 PHPAPI PHP_FUNCTION(ftell);
34 PHPAPI PHP_FUNCTION(fseek);
35 PHPAPI PHP_FUNCTION(fpassthru);
36 
37 PHP_MINIT_FUNCTION(user_streams);
38 
39 PHPAPI int php_le_stream_context(void);
40 PHPAPI int php_set_sock_blocking(php_socket_t socketd, int block);
41 PHPAPI int php_copy_file(const char *src, const char *dest);
42 PHPAPI int php_copy_file_ex(const char *src, const char *dest, int src_chk);
43 PHPAPI int php_copy_file_ctx(const char *src, const char *dest, int src_chk, php_stream_context *ctx);
44 PHPAPI int php_mkdir_ex(const char *dir, zend_long mode, int options);
45 PHPAPI int php_mkdir(const char *dir, zend_long mode);
46 PHPAPI void php_fstat(php_stream *stream, zval *return_value);
47 PHPAPI void php_flock_common(php_stream *stream, zend_long operation, uint32_t operation_arg_num,
48 	zval *wouldblock, zval *return_value);
49 
50 #define PHP_CSV_NO_ESCAPE EOF
51 PHPAPI void php_fgetcsv(php_stream *stream, char delimiter, char enclosure, int escape_char, size_t buf_len, char *buf, zval *return_value);
52 PHPAPI ssize_t php_fputcsv(php_stream *stream, zval *fields, char delimiter, char enclosure, int escape_char);
53 
54 #define META_DEF_BUFSIZE 8192
55 
56 #define PHP_FILE_USE_INCLUDE_PATH 1
57 #define PHP_FILE_IGNORE_NEW_LINES 2
58 #define PHP_FILE_SKIP_EMPTY_LINES 4
59 #define PHP_FILE_APPEND 8
60 #define PHP_FILE_NO_DEFAULT_CONTEXT 16
61 
62 typedef enum _php_meta_tags_token {
63 	TOK_EOF = 0,
64 	TOK_OPENTAG,
65 	TOK_CLOSETAG,
66 	TOK_SLASH,
67 	TOK_EQUAL,
68 	TOK_SPACE,
69 	TOK_ID,
70 	TOK_STRING,
71 	TOK_OTHER
72 } php_meta_tags_token;
73 
74 typedef struct _php_meta_tags_data {
75 	php_stream *stream;
76 	int ulc;
77 	int lc;
78 	char *input_buffer;
79 	char *token_data;
80 	int token_len;
81 	int in_meta;
82 } php_meta_tags_data;
83 
84 php_meta_tags_token php_next_meta_token(php_meta_tags_data *);
85 
86 typedef struct {
87 	int pclose_ret;
88 	size_t def_chunk_size;
89 	zend_bool auto_detect_line_endings;
90 	zend_long default_socket_timeout;
91 	char *user_agent; /* for the http wrapper */
92 	char *from_address; /* for the ftp and http wrappers */
93 	const char *user_stream_current_filename; /* for simple recursion protection */
94 	php_stream_context *default_context;
95 	HashTable *stream_wrappers;			/* per-request copy of url_stream_wrappers_hash */
96 	HashTable *stream_filters;			/* per-request copy of stream_filters_hash */
97 	HashTable *wrapper_errors;			/* key: wrapper address; value: linked list of char* */
98 	int pclose_wait;
99 #if defined(HAVE_GETHOSTBYNAME_R)
100 	struct hostent tmp_host_info;
101 	char *tmp_host_buf;
102 	size_t tmp_host_buf_len;
103 #endif
104 } php_file_globals;
105 
106 #ifdef ZTS
107 #define FG(v) ZEND_TSRMG(file_globals_id, php_file_globals *, v)
108 extern PHPAPI int file_globals_id;
109 #else
110 #define FG(v) (file_globals.v)
111 extern PHPAPI php_file_globals file_globals;
112 #endif
113 
114 
115 #endif /* FILE_H */
116