xref: /php-src/ext/pdo_mysql/pdo_mysql.c (revision d6a0b3af)
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 "pdo/php_pdo.h"
26 #include "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  PDO_MYSQL_UNIX_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 /* proto string PDO::mysqlGetWarningCount()
88  * Returns the number of SQL warnings during the execution of the last statement
89  */
PHP_METHOD(PdoMysql,getWarningCount)90 PHP_METHOD(PdoMysql, getWarningCount)
91 {
92 	pdo_dbh_t *dbh;
93 	pdo_mysql_db_handle *H;
94 
95 	ZEND_PARSE_PARAMETERS_NONE();
96 
97 	dbh = Z_PDO_DBH_P(ZEND_THIS);
98 	PDO_CONSTRUCT_CHECK;
99 
100 	H = (pdo_mysql_db_handle *)dbh->driver_data;
101 	RETURN_LONG(mysql_warning_count(H->server));
102 }
103 
104 /* {{{ PHP_INI_BEGIN */
105 PHP_INI_BEGIN()
106 #ifndef PHP_WIN32
107 	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)
108 #endif
109 #if PDO_DBG_ENABLED
110 	STD_PHP_INI_ENTRY("pdo_mysql.debug",	NULL, PHP_INI_SYSTEM, OnUpdateString, debug, zend_pdo_mysql_globals, pdo_mysql_globals)
111 #endif
PHP_INI_END()112 PHP_INI_END()
113 /* }}} */
114 
115 /* true global environment */
116 
117 /* {{{ PHP_MINIT_FUNCTION */
118 static PHP_MINIT_FUNCTION(pdo_mysql)
119 {
120 	REGISTER_INI_ENTRIES();
121 
122 	REGISTER_PDO_CLASS_CONST_LONG("MYSQL_ATTR_USE_BUFFERED_QUERY", (zend_long)PDO_MYSQL_ATTR_USE_BUFFERED_QUERY);
123 	REGISTER_PDO_CLASS_CONST_LONG("MYSQL_ATTR_LOCAL_INFILE", (zend_long)PDO_MYSQL_ATTR_LOCAL_INFILE);
124 	REGISTER_PDO_CLASS_CONST_LONG("MYSQL_ATTR_INIT_COMMAND", (zend_long)PDO_MYSQL_ATTR_INIT_COMMAND);
125 #ifndef PDO_USE_MYSQLND
126 	REGISTER_PDO_CLASS_CONST_LONG("MYSQL_ATTR_MAX_BUFFER_SIZE", (zend_long)PDO_MYSQL_ATTR_MAX_BUFFER_SIZE);
127 	REGISTER_PDO_CLASS_CONST_LONG("MYSQL_ATTR_READ_DEFAULT_FILE", (zend_long)PDO_MYSQL_ATTR_READ_DEFAULT_FILE);
128 	REGISTER_PDO_CLASS_CONST_LONG("MYSQL_ATTR_READ_DEFAULT_GROUP", (zend_long)PDO_MYSQL_ATTR_READ_DEFAULT_GROUP);
129 #endif
130 	REGISTER_PDO_CLASS_CONST_LONG("MYSQL_ATTR_COMPRESS", (zend_long)PDO_MYSQL_ATTR_COMPRESS);
131 	REGISTER_PDO_CLASS_CONST_LONG("MYSQL_ATTR_DIRECT_QUERY", (zend_long)PDO_MYSQL_ATTR_DIRECT_QUERY);
132 	REGISTER_PDO_CLASS_CONST_LONG("MYSQL_ATTR_FOUND_ROWS", (zend_long)PDO_MYSQL_ATTR_FOUND_ROWS);
133 	REGISTER_PDO_CLASS_CONST_LONG("MYSQL_ATTR_IGNORE_SPACE", (zend_long)PDO_MYSQL_ATTR_IGNORE_SPACE);
134 	REGISTER_PDO_CLASS_CONST_LONG("MYSQL_ATTR_SSL_KEY", (zend_long)PDO_MYSQL_ATTR_SSL_KEY);
135 	REGISTER_PDO_CLASS_CONST_LONG("MYSQL_ATTR_SSL_CERT", (zend_long)PDO_MYSQL_ATTR_SSL_CERT);
136 	REGISTER_PDO_CLASS_CONST_LONG("MYSQL_ATTR_SSL_CA", (zend_long)PDO_MYSQL_ATTR_SSL_CA);
137 	REGISTER_PDO_CLASS_CONST_LONG("MYSQL_ATTR_SSL_CAPATH", (zend_long)PDO_MYSQL_ATTR_SSL_CAPATH);
138 	REGISTER_PDO_CLASS_CONST_LONG("MYSQL_ATTR_SSL_CIPHER", (zend_long)PDO_MYSQL_ATTR_SSL_CIPHER);
139 #if MYSQL_VERSION_ID > 50605 || defined(PDO_USE_MYSQLND)
140 	REGISTER_PDO_CLASS_CONST_LONG("MYSQL_ATTR_SERVER_PUBLIC_KEY", (zend_long)PDO_MYSQL_ATTR_SERVER_PUBLIC_KEY);
141 #endif
142 	REGISTER_PDO_CLASS_CONST_LONG("MYSQL_ATTR_MULTI_STATEMENTS", (zend_long)PDO_MYSQL_ATTR_MULTI_STATEMENTS);
143 #ifdef PDO_USE_MYSQLND
144 	REGISTER_PDO_CLASS_CONST_LONG("MYSQL_ATTR_SSL_VERIFY_SERVER_CERT", (zend_long)PDO_MYSQL_ATTR_SSL_VERIFY_SERVER_CERT);
145 #endif
146 #if MYSQL_VERSION_ID >= 80021 || defined(PDO_USE_MYSQLND)
147 	REGISTER_PDO_CLASS_CONST_LONG("MYSQL_ATTR_LOCAL_INFILE_DIRECTORY", (zend_long)PDO_MYSQL_ATTR_LOCAL_INFILE_DIRECTORY);
148 #endif
149 
150 #ifdef PDO_USE_MYSQLND
151 	mysqlnd_reverse_api_register_api(&pdo_mysql_reverse_api);
152 #endif
153 
154 	pdo_mysql_ce = register_class_PdoMysql(pdo_dbh_ce);
155 	pdo_mysql_ce->create_object = pdo_dbh_new;
156 
157 	if (php_pdo_register_driver(&pdo_mysql_driver) == FAILURE) {
158 		return FAILURE;
159 	}
160 
161 	return php_pdo_register_driver_specific_ce(&pdo_mysql_driver, pdo_mysql_ce);
162 }
163 /* }}} */
164 
165 /* {{{ PHP_MSHUTDOWN_FUNCTION */
PHP_MSHUTDOWN_FUNCTION(pdo_mysql)166 static PHP_MSHUTDOWN_FUNCTION(pdo_mysql)
167 {
168 	php_pdo_unregister_driver(&pdo_mysql_driver);
169 #ifdef PDO_USE_MYSQLND
170 	UNREGISTER_INI_ENTRIES();
171 #endif
172 
173 	return SUCCESS;
174 }
175 /* }}} */
176 
177 /* {{{ PHP_MINFO_FUNCTION */
PHP_MINFO_FUNCTION(pdo_mysql)178 static PHP_MINFO_FUNCTION(pdo_mysql)
179 {
180 	php_info_print_table_start();
181 
182 	php_info_print_table_row(2, "PDO Driver for MySQL", "enabled");
183 	php_info_print_table_row(2, "Client API version", mysql_get_client_info());
184 
185 	php_info_print_table_end();
186 
187 #ifndef PHP_WIN32
188 	DISPLAY_INI_ENTRIES();
189 #endif
190 }
191 /* }}} */
192 
193 
194 #if defined(PDO_USE_MYSQLND) && PDO_DBG_ENABLED
195 /* {{{ PHP_RINIT_FUNCTION */
PHP_RINIT_FUNCTION(pdo_mysql)196 static PHP_RINIT_FUNCTION(pdo_mysql)
197 {
198 	if (PDO_MYSQL_G(debug)) {
199 		MYSQLND_DEBUG *dbg = mysqlnd_debug_init(mysqlnd_debug_std_no_trace_funcs);
200 		if (!dbg) {
201 			return FAILURE;
202 		}
203 		dbg->m->set_mode(dbg, PDO_MYSQL_G(debug));
204 		PDO_MYSQL_G(dbg) = dbg;
205 	}
206 
207 	return SUCCESS;
208 }
209 /* }}} */
210 
211 /* {{{ PHP_RSHUTDOWN_FUNCTION */
PHP_RSHUTDOWN_FUNCTION(pdo_mysql)212 static PHP_RSHUTDOWN_FUNCTION(pdo_mysql)
213 {
214 	MYSQLND_DEBUG *dbg = PDO_MYSQL_G(dbg);
215 	PDO_DBG_ENTER("RSHUTDOWN");
216 	if (dbg) {
217 		dbg->m->close(dbg);
218 		dbg->m->free_handle(dbg);
219 		PDO_MYSQL_G(dbg) = NULL;
220 	}
221 
222 	return SUCCESS;
223 }
224 /* }}} */
225 #endif
226 
227 /* {{{ PHP_GINIT_FUNCTION */
PHP_GINIT_FUNCTION(pdo_mysql)228 static PHP_GINIT_FUNCTION(pdo_mysql)
229 {
230 #if defined(COMPILE_DL_PDO_MYSQL) && defined(ZTS)
231 ZEND_TSRMLS_CACHE_UPDATE();
232 #endif
233 #ifndef PHP_WIN32
234 	pdo_mysql_globals->default_socket = NULL;
235 #endif
236 #if PDO_DBG_ENABLED
237 	pdo_mysql_globals->debug = NULL;	/* The actual string */
238 	pdo_mysql_globals->dbg = NULL;	/* The DBG object*/
239 #endif
240 }
241 /* }}} */
242 
243 /* {{{ pdo_mysql_deps[] */
244 static const zend_module_dep pdo_mysql_deps[] = {
245 	ZEND_MOD_REQUIRED("pdo")
246 #ifdef PDO_USE_MYSQLND
247 	ZEND_MOD_REQUIRED("mysqlnd")
248 #endif
249 	ZEND_MOD_END
250 };
251 /* }}} */
252 
253 /* {{{ pdo_mysql_module_entry */
254 zend_module_entry pdo_mysql_module_entry = {
255 	STANDARD_MODULE_HEADER_EX, NULL,
256 	pdo_mysql_deps,
257 	"pdo_mysql",
258 	NULL,
259 	PHP_MINIT(pdo_mysql),
260 	PHP_MSHUTDOWN(pdo_mysql),
261 #if defined(PDO_USE_MYSQLND) && PDO_DBG_ENABLED
262 	PHP_RINIT(pdo_mysql),
263 	PHP_RSHUTDOWN(pdo_mysql),
264 #else
265 	NULL,
266 	NULL,
267 #endif
268 	PHP_MINFO(pdo_mysql),
269 	PHP_PDO_MYSQL_VERSION,
270 	PHP_MODULE_GLOBALS(pdo_mysql),
271 	PHP_GINIT(pdo_mysql),
272 	NULL,
273 	NULL,
274 	STANDARD_MODULE_PROPERTIES_EX
275 };
276 /* }}} */
277