xref: /PHP-8.4/ext/pdo_mysql/pdo_mysql.c (revision 8044db12)
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   | https://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: George Schlossnagle <george@omniti.com>                      |
14   |         Johannes Schlueter <johannes@mysql.com>                      |
15   +----------------------------------------------------------------------+
16 */
17 
18 #ifdef HAVE_CONFIG_H
19 #include <config.h>
20 #endif
21 
22 #include "php.h"
23 #include "php_ini.h"
24 #include "ext/standard/info.h"
25 #include "ext/pdo/php_pdo.h"
26 #include "ext/pdo/php_pdo_driver.h"
27 #include "php_pdo_mysql.h"
28 #include "php_pdo_mysql_int.h"
29 #include "pdo_mysql_arginfo.h"
30 
31 static zend_class_entry *pdo_mysql_ce;
32 
33 #ifdef COMPILE_DL_PDO_MYSQL
34 #ifdef ZTS
35 ZEND_TSRMLS_CACHE_DEFINE()
36 #endif
ZEND_GET_MODULE(pdo_mysql)37 ZEND_GET_MODULE(pdo_mysql)
38 #endif
39 
40 ZEND_DECLARE_MODULE_GLOBALS(pdo_mysql)
41 
42 /*
43  The default socket location is sometimes defined by configure.
44  With libmysql `mysql_config --socket` will fill PDO_MYSQL_UNIX_ADDR
45  and the user can use --with-mysql-sock=SOCKET which will fill
46  PHP_MYSQL_UNIX_SOCK_ADDR. If both aren't set we're using mysqlnd and use
47  /tmp/mysql.sock as default on *nix and NULL for Windows (default
48  named pipe name is set in mysqlnd).
49 */
50 #ifndef PDO_MYSQL_UNIX_ADDR
51 # ifdef PHP_MYSQL_UNIX_SOCK_ADDR
52 #  define PDO_MYSQL_UNIX_ADDR PHP_MYSQL_UNIX_SOCK_ADDR
53 # else
54 #  ifndef PHP_WIN32
55 #   define PDO_MYSQL_UNIX_ADDR "/tmp/mysql.sock"
56 #  else
57 #   define PDO_MYSQL_UNIX_ADDR NULL
58 #  endif
59 # endif
60 #endif
61 
62 #ifdef PDO_USE_MYSQLND
63 #include "ext/mysqlnd/mysqlnd_reverse_api.h"
64 static MYSQLND * pdo_mysql_convert_zv_to_mysqlnd(zval * zv)
65 {
66 	if (Z_TYPE_P(zv) == IS_OBJECT && instanceof_function(Z_OBJCE_P(zv), php_pdo_get_dbh_ce())) {
67 		pdo_dbh_t * dbh = Z_PDO_DBH_P(zv);
68 
69 		ZEND_ASSERT(dbh);
70 
71 		if (dbh->driver != &pdo_mysql_driver) {
72 			php_error_docref(NULL, E_WARNING, "Provided PDO instance is not using MySQL but %s", dbh->driver->driver_name);
73 			return NULL;
74 		}
75 
76 		return ((pdo_mysql_db_handle *)dbh->driver_data)->server;
77 	}
78 	return NULL;
79 }
80 
81 static const MYSQLND_REVERSE_API pdo_mysql_reverse_api = {
82 	&pdo_mysql_module_entry,
83 	pdo_mysql_convert_zv_to_mysqlnd
84 };
85 #endif
86 
87 /* Returns the number of SQL warnings during the execution of the last statement */
PHP_METHOD(Pdo_Mysql,getWarningCount)88 PHP_METHOD(Pdo_Mysql, getWarningCount)
89 {
90 	pdo_dbh_t *dbh;
91 	pdo_mysql_db_handle *H;
92 
93 	ZEND_PARSE_PARAMETERS_NONE();
94 
95 	dbh = Z_PDO_DBH_P(ZEND_THIS);
96 	PDO_CONSTRUCT_CHECK;
97 
98 	H = (pdo_mysql_db_handle *)dbh->driver_data;
99 	RETURN_LONG(mysql_warning_count(H->server));
100 }
101 
102 /* {{{ PHP_INI_BEGIN */
103 PHP_INI_BEGIN()
104 #ifndef PHP_WIN32
105 	STD_PHP_INI_ENTRY("pdo_mysql.default_socket", PDO_MYSQL_UNIX_ADDR, PHP_INI_SYSTEM, OnUpdateStringUnempty, default_socket, zend_pdo_mysql_globals, pdo_mysql_globals)
106 #endif
107 #if PDO_DBG_ENABLED
108 	STD_PHP_INI_ENTRY("pdo_mysql.debug",	NULL, PHP_INI_SYSTEM, OnUpdateString, debug, zend_pdo_mysql_globals, pdo_mysql_globals)
109 #endif
PHP_INI_END()110 PHP_INI_END()
111 /* }}} */
112 
113 /* true global environment */
114 
115 /* {{{ PHP_MINIT_FUNCTION */
116 static PHP_MINIT_FUNCTION(pdo_mysql)
117 {
118 	REGISTER_INI_ENTRIES();
119 
120 	REGISTER_PDO_CLASS_CONST_LONG("MYSQL_ATTR_USE_BUFFERED_QUERY", (zend_long)PDO_MYSQL_ATTR_USE_BUFFERED_QUERY);
121 	REGISTER_PDO_CLASS_CONST_LONG("MYSQL_ATTR_LOCAL_INFILE", (zend_long)PDO_MYSQL_ATTR_LOCAL_INFILE);
122 	REGISTER_PDO_CLASS_CONST_LONG("MYSQL_ATTR_INIT_COMMAND", (zend_long)PDO_MYSQL_ATTR_INIT_COMMAND);
123 #ifndef PDO_USE_MYSQLND
124 	REGISTER_PDO_CLASS_CONST_LONG("MYSQL_ATTR_MAX_BUFFER_SIZE", (zend_long)PDO_MYSQL_ATTR_MAX_BUFFER_SIZE);
125 	REGISTER_PDO_CLASS_CONST_LONG("MYSQL_ATTR_READ_DEFAULT_FILE", (zend_long)PDO_MYSQL_ATTR_READ_DEFAULT_FILE);
126 	REGISTER_PDO_CLASS_CONST_LONG("MYSQL_ATTR_READ_DEFAULT_GROUP", (zend_long)PDO_MYSQL_ATTR_READ_DEFAULT_GROUP);
127 #endif
128 	REGISTER_PDO_CLASS_CONST_LONG("MYSQL_ATTR_COMPRESS", (zend_long)PDO_MYSQL_ATTR_COMPRESS);
129 	REGISTER_PDO_CLASS_CONST_LONG("MYSQL_ATTR_DIRECT_QUERY", (zend_long)PDO_MYSQL_ATTR_DIRECT_QUERY);
130 	REGISTER_PDO_CLASS_CONST_LONG("MYSQL_ATTR_FOUND_ROWS", (zend_long)PDO_MYSQL_ATTR_FOUND_ROWS);
131 	REGISTER_PDO_CLASS_CONST_LONG("MYSQL_ATTR_IGNORE_SPACE", (zend_long)PDO_MYSQL_ATTR_IGNORE_SPACE);
132 	REGISTER_PDO_CLASS_CONST_LONG("MYSQL_ATTR_SSL_KEY", (zend_long)PDO_MYSQL_ATTR_SSL_KEY);
133 	REGISTER_PDO_CLASS_CONST_LONG("MYSQL_ATTR_SSL_CERT", (zend_long)PDO_MYSQL_ATTR_SSL_CERT);
134 	REGISTER_PDO_CLASS_CONST_LONG("MYSQL_ATTR_SSL_CA", (zend_long)PDO_MYSQL_ATTR_SSL_CA);
135 	REGISTER_PDO_CLASS_CONST_LONG("MYSQL_ATTR_SSL_CAPATH", (zend_long)PDO_MYSQL_ATTR_SSL_CAPATH);
136 	REGISTER_PDO_CLASS_CONST_LONG("MYSQL_ATTR_SSL_CIPHER", (zend_long)PDO_MYSQL_ATTR_SSL_CIPHER);
137 #if MYSQL_VERSION_ID > 50605 || defined(PDO_USE_MYSQLND)
138 	REGISTER_PDO_CLASS_CONST_LONG("MYSQL_ATTR_SERVER_PUBLIC_KEY", (zend_long)PDO_MYSQL_ATTR_SERVER_PUBLIC_KEY);
139 #endif
140 	REGISTER_PDO_CLASS_CONST_LONG("MYSQL_ATTR_MULTI_STATEMENTS", (zend_long)PDO_MYSQL_ATTR_MULTI_STATEMENTS);
141 #ifdef PDO_USE_MYSQLND
142 	REGISTER_PDO_CLASS_CONST_LONG("MYSQL_ATTR_SSL_VERIFY_SERVER_CERT", (zend_long)PDO_MYSQL_ATTR_SSL_VERIFY_SERVER_CERT);
143 #endif
144 #if MYSQL_VERSION_ID >= 80021 || defined(PDO_USE_MYSQLND)
145 	REGISTER_PDO_CLASS_CONST_LONG("MYSQL_ATTR_LOCAL_INFILE_DIRECTORY", (zend_long)PDO_MYSQL_ATTR_LOCAL_INFILE_DIRECTORY);
146 #endif
147 
148 #ifdef PDO_USE_MYSQLND
149 	mysqlnd_reverse_api_register_api(&pdo_mysql_reverse_api);
150 #endif
151 
152 	pdo_mysql_ce = register_class_Pdo_Mysql(pdo_dbh_ce);
153 	pdo_mysql_ce->create_object = pdo_dbh_new;
154 
155 	if (php_pdo_register_driver(&pdo_mysql_driver) == FAILURE) {
156 		return FAILURE;
157 	}
158 
159 	return php_pdo_register_driver_specific_ce(&pdo_mysql_driver, pdo_mysql_ce);
160 }
161 /* }}} */
162 
163 /* {{{ PHP_MSHUTDOWN_FUNCTION */
PHP_MSHUTDOWN_FUNCTION(pdo_mysql)164 static PHP_MSHUTDOWN_FUNCTION(pdo_mysql)
165 {
166 	php_pdo_unregister_driver(&pdo_mysql_driver);
167 #ifdef PDO_USE_MYSQLND
168 	UNREGISTER_INI_ENTRIES();
169 #endif
170 
171 	return SUCCESS;
172 }
173 /* }}} */
174 
175 /* {{{ PHP_MINFO_FUNCTION */
PHP_MINFO_FUNCTION(pdo_mysql)176 static PHP_MINFO_FUNCTION(pdo_mysql)
177 {
178 	php_info_print_table_start();
179 
180 	php_info_print_table_row(2, "PDO Driver for MySQL", "enabled");
181 	php_info_print_table_row(2, "Client API version", mysql_get_client_info());
182 
183 	php_info_print_table_end();
184 
185 #ifndef PHP_WIN32
186 	DISPLAY_INI_ENTRIES();
187 #endif
188 }
189 /* }}} */
190 
191 
192 #if defined(PDO_USE_MYSQLND) && PDO_DBG_ENABLED
193 /* {{{ PHP_RINIT_FUNCTION */
PHP_RINIT_FUNCTION(pdo_mysql)194 static PHP_RINIT_FUNCTION(pdo_mysql)
195 {
196 	if (PDO_MYSQL_G(debug)) {
197 		MYSQLND_DEBUG *dbg = mysqlnd_debug_init(mysqlnd_debug_std_no_trace_funcs);
198 		if (!dbg) {
199 			return FAILURE;
200 		}
201 		dbg->m->set_mode(dbg, PDO_MYSQL_G(debug));
202 		PDO_MYSQL_G(dbg) = dbg;
203 	}
204 
205 	return SUCCESS;
206 }
207 /* }}} */
208 
209 /* {{{ PHP_RSHUTDOWN_FUNCTION */
PHP_RSHUTDOWN_FUNCTION(pdo_mysql)210 static PHP_RSHUTDOWN_FUNCTION(pdo_mysql)
211 {
212 	MYSQLND_DEBUG *dbg = PDO_MYSQL_G(dbg);
213 	PDO_DBG_ENTER("RSHUTDOWN");
214 	if (dbg) {
215 		dbg->m->close(dbg);
216 		dbg->m->free_handle(dbg);
217 		PDO_MYSQL_G(dbg) = NULL;
218 	}
219 
220 	return SUCCESS;
221 }
222 /* }}} */
223 #endif
224 
225 /* {{{ PHP_GINIT_FUNCTION */
PHP_GINIT_FUNCTION(pdo_mysql)226 static PHP_GINIT_FUNCTION(pdo_mysql)
227 {
228 #if defined(COMPILE_DL_PDO_MYSQL) && defined(ZTS)
229 ZEND_TSRMLS_CACHE_UPDATE();
230 #endif
231 #ifndef PHP_WIN32
232 	pdo_mysql_globals->default_socket = NULL;
233 #endif
234 #if PDO_DBG_ENABLED
235 	pdo_mysql_globals->debug = NULL;	/* The actual string */
236 	pdo_mysql_globals->dbg = NULL;	/* The DBG object*/
237 #endif
238 }
239 /* }}} */
240 
241 /* {{{ pdo_mysql_deps[] */
242 static const zend_module_dep pdo_mysql_deps[] = {
243 	ZEND_MOD_REQUIRED("pdo")
244 #ifdef PDO_USE_MYSQLND
245 	ZEND_MOD_REQUIRED("mysqlnd")
246 #endif
247 	ZEND_MOD_END
248 };
249 /* }}} */
250 
251 /* {{{ pdo_mysql_module_entry */
252 zend_module_entry pdo_mysql_module_entry = {
253 	STANDARD_MODULE_HEADER_EX, NULL,
254 	pdo_mysql_deps,
255 	"pdo_mysql",
256 	NULL,
257 	PHP_MINIT(pdo_mysql),
258 	PHP_MSHUTDOWN(pdo_mysql),
259 #if defined(PDO_USE_MYSQLND) && PDO_DBG_ENABLED
260 	PHP_RINIT(pdo_mysql),
261 	PHP_RSHUTDOWN(pdo_mysql),
262 #else
263 	NULL,
264 	NULL,
265 #endif
266 	PHP_MINFO(pdo_mysql),
267 	PHP_PDO_MYSQL_VERSION,
268 	PHP_MODULE_GLOBALS(pdo_mysql),
269 	PHP_GINIT(pdo_mysql),
270 	NULL,
271 	NULL,
272 	STANDARD_MODULE_PROPERTIES_EX
273 };
274 /* }}} */
275