xref: /PHP-7.4/ext/pdo_mysql/php_pdo_mysql_int.h (revision c9abb0c0)
1 /*
2   +----------------------------------------------------------------------+
3   | PHP Version 7                                                        |
4   +----------------------------------------------------------------------+
5   | Copyright (c) The PHP Group                                          |
6   +----------------------------------------------------------------------+
7   | This source file is subject to version 3.01 of the PHP license,      |
8   | that is bundled with this package in the file LICENSE, and is        |
9   | available through the world-wide-web at the following url:           |
10   | http://www.php.net/license/3_01.txt                                  |
11   | If you did not receive a copy of the PHP license and are unable to   |
12   | obtain it through the world-wide-web, please send a note to          |
13   | license@php.net so we can mail you a copy immediately.               |
14   +----------------------------------------------------------------------+
15   | Author: George Schlossnagle <george@omniti.com>                      |
16   |         Wez Furlong <wez@php.net>                                    |
17   |         Johannes Schlueter <johannes@mysql.com>                      |
18   +----------------------------------------------------------------------+
19 */
20 
21 #ifndef PHP_PDO_MYSQL_INT_H
22 #define PHP_PDO_MYSQL_INT_H
23 
24 #if defined(PDO_USE_MYSQLND)
25 #	include "ext/mysqlnd/mysqlnd.h"
26 #	include "ext/mysqlnd/mysqlnd_libmysql_compat.h"
27 #	define PDO_MYSQL_PARAM_BIND MYSQLND_PARAM_BIND
28 #else
29 #	include <mysql.h>
30 #if MYSQL_VERSION_ID >= 80000 &&  MYSQL_VERSION_ID < 100000
31 typedef _Bool       my_bool;
32 #endif
33 #	define PDO_MYSQL_PARAM_BIND MYSQL_BIND
34 #endif
35 
36 #if (MYSQL_VERSION_ID >= 40113 && MYSQL_VERSION_ID < 50000) || MYSQL_VERSION_ID >= 50007 || defined(MYSQL_USE_MYSQLND)
37 # define PDO_MYSQL_HAS_CHARSET
38 #endif
39 
40 #if defined(PDO_USE_MYSQLND) && PHP_DEBUG && !defined(PHP_WIN32)
41 #define PDO_DBG_ENABLED 1
42 
43 #define PDO_DBG_INF(msg) do { if (dbg_skip_trace == FALSE) PDO_MYSQL_G(dbg)->m->log(PDO_MYSQL_G(dbg), __LINE__, __FILE__, -1, "info : ", (msg)); } while (0)
44 #define PDO_DBG_ERR(msg) do { if (dbg_skip_trace == FALSE) PDO_MYSQL_G(dbg)->m->log(PDO_MYSQL_G(dbg), __LINE__, __FILE__, -1, "error: ", (msg)); } while (0)
45 #define PDO_DBG_INF_FMT(...) do { if (dbg_skip_trace == FALSE) PDO_MYSQL_G(dbg)->m->log_va(PDO_MYSQL_G(dbg), __LINE__, __FILE__, -1, "info : ", __VA_ARGS__); } while (0)
46 #define PDO_DBG_ERR_FMT(...) do { if (dbg_skip_trace == FALSE) PDO_MYSQL_G(dbg)->m->log_va(PDO_MYSQL_G(dbg), __LINE__, __FILE__, -1, "error: ", __VA_ARGS__); } while (0)
47 #define PDO_DBG_ENTER(func_name) \
48 	zend_bool dbg_skip_trace = TRUE; \
49 	((void) dbg_skip_trace); \
50 	if (PDO_MYSQL_G(dbg)) \
51 		dbg_skip_trace = !PDO_MYSQL_G(dbg)->m->func_enter(PDO_MYSQL_G(dbg), __LINE__, __FILE__, func_name, strlen(func_name));
52 
53 #define PDO_DBG_RETURN(value)	do { if (PDO_MYSQL_G(dbg)) PDO_MYSQL_G(dbg)->m->func_leave(PDO_MYSQL_G(dbg), __LINE__, __FILE__, 0); return (value); } while (0)
54 #define PDO_DBG_VOID_RETURN		do { if (PDO_MYSQL_G(dbg)) PDO_MYSQL_G(dbg)->m->func_leave(PDO_MYSQL_G(dbg), __LINE__, __FILE__, 0); return; } while (0)
55 
56 #else
57 #define PDO_DBG_ENABLED 0
58 
PDO_DBG_INF(char * msg)59 static inline void PDO_DBG_INF(char *msg) {}
PDO_DBG_ERR(char * msg)60 static inline void PDO_DBG_ERR(char *msg) {}
PDO_DBG_INF_FMT(char * format,...)61 static inline void PDO_DBG_INF_FMT(char *format, ...) {}
PDO_DBG_ERR_FMT(char * format,...)62 static inline void PDO_DBG_ERR_FMT(char *format, ...) {}
PDO_DBG_ENTER(char * func_name)63 static inline void PDO_DBG_ENTER(char *func_name) {}
64 #define PDO_DBG_RETURN(value)	return (value)
65 #define PDO_DBG_VOID_RETURN		return;
66 
67 #endif
68 
69 #if defined(PDO_USE_MYSQLND)
70 #include "ext/mysqlnd/mysqlnd_debug.h"
71 #endif
72 
73 ZEND_BEGIN_MODULE_GLOBALS(pdo_mysql)
74 #ifndef PHP_WIN32
75 	char          *default_socket;
76 #endif
77 #if PDO_DBG_ENABLED
78 	char          *debug; /* The actual string */
79 	MYSQLND_DEBUG *dbg;	/* The DBG object */
80 #endif
81 #if defined(PHP_WIN32) && !PDO_DBG_ENABLED
82 	/* dummy member so we get at least one member in the struct
83 	 * and avoids build errors.
84 	 */
85 	void *dummymemmber;
86 #endif
87 ZEND_END_MODULE_GLOBALS(pdo_mysql)
88 
89 ZEND_EXTERN_MODULE_GLOBALS(pdo_mysql)
90 #define PDO_MYSQL_G(v) ZEND_MODULE_GLOBALS_ACCESSOR(pdo_mysql, v)
91 
92 #if defined(ZTS) && defined(COMPILE_DL_PDO_MYSQL)
93 ZEND_TSRMLS_CACHE_EXTERN()
94 #endif
95 
96 
97 typedef struct {
98 	const char *file;
99 	int line;
100 	unsigned int errcode;
101 	char *errmsg;
102 } pdo_mysql_error_info;
103 
104 /* stuff we use in a mySQL database handle */
105 typedef struct {
106 	MYSQL 		*server;
107 
108 	unsigned assume_national_character_set_strings:1;
109 	unsigned attached:1;
110 	unsigned buffered:1;
111 	unsigned emulate_prepare:1;
112 	unsigned fetch_table_names:1;
113 #if !PDO_USE_MYSQLND
114 	zend_ulong max_buffer_size;
115 #endif
116 
117 	pdo_mysql_error_info einfo;
118 } pdo_mysql_db_handle;
119 
120 typedef struct {
121 	MYSQL_FIELD		*def;
122 } pdo_mysql_column;
123 
124 typedef struct {
125 	pdo_mysql_db_handle 	*H;
126 	MYSQL_RES				*result;
127 	const MYSQL_FIELD		*fields;
128 	MYSQL_ROW				current_data;
129 #if PDO_USE_MYSQLND
130 	const size_t			*current_lengths;
131 #else
132 	zend_long				*current_lengths;
133 #endif
134 	pdo_mysql_error_info 	einfo;
135 #if PDO_USE_MYSQLND
136 	MYSQLND_STMT 			*stmt;
137 #else
138 	MYSQL_STMT				*stmt;
139 #endif
140 	int 					num_params;
141 	PDO_MYSQL_PARAM_BIND	*params;
142 #ifndef PDO_USE_MYSQLND
143 	my_bool					*in_null;
144 	zend_ulong			*in_length;
145 #endif
146 	PDO_MYSQL_PARAM_BIND	*bound_result;
147 	my_bool					*out_null;
148 	zend_ulong				*out_length;
149 	unsigned int			params_given;
150 	unsigned				max_length:1;
151 } pdo_mysql_stmt;
152 
153 extern const pdo_driver_t pdo_mysql_driver;
154 
155 extern int _pdo_mysql_error(pdo_dbh_t *dbh, pdo_stmt_t *stmt, const char *file, int line);
156 #define pdo_mysql_error(s) _pdo_mysql_error(s, NULL, __FILE__, __LINE__)
157 #define pdo_mysql_error_stmt(s) _pdo_mysql_error(stmt->dbh, stmt, __FILE__, __LINE__)
158 
159 extern const struct pdo_stmt_methods mysql_stmt_methods;
160 
161 enum {
162 	PDO_MYSQL_ATTR_USE_BUFFERED_QUERY = PDO_ATTR_DRIVER_SPECIFIC,
163 	PDO_MYSQL_ATTR_LOCAL_INFILE,
164 	PDO_MYSQL_ATTR_INIT_COMMAND,
165 #ifndef PDO_USE_MYSQLND
166 	PDO_MYSQL_ATTR_READ_DEFAULT_FILE,
167 	PDO_MYSQL_ATTR_READ_DEFAULT_GROUP,
168 	PDO_MYSQL_ATTR_MAX_BUFFER_SIZE,
169 #endif
170 	PDO_MYSQL_ATTR_COMPRESS,
171 	PDO_MYSQL_ATTR_DIRECT_QUERY,
172 	PDO_MYSQL_ATTR_FOUND_ROWS,
173 	PDO_MYSQL_ATTR_IGNORE_SPACE,
174 	PDO_MYSQL_ATTR_SSL_KEY,
175 	PDO_MYSQL_ATTR_SSL_CERT,
176 	PDO_MYSQL_ATTR_SSL_CA,
177 	PDO_MYSQL_ATTR_SSL_CAPATH,
178 	PDO_MYSQL_ATTR_SSL_CIPHER,
179 #if MYSQL_VERSION_ID > 50605 || defined(PDO_USE_MYSQLND)
180 	PDO_MYSQL_ATTR_SERVER_PUBLIC_KEY,
181 #endif
182 	PDO_MYSQL_ATTR_MULTI_STATEMENTS,
183 #ifdef PDO_USE_MYSQLND
184 	PDO_MYSQL_ATTR_SSL_VERIFY_SERVER_CERT,
185 #endif
186 };
187 
188 #endif
189