Skip to content

Commit d58231d

Browse files
adambaratzadambaratz
committed
Add "Sent SQL" to debug dump for emulated prepares
1 parent 6c69231 commit d58231d

5 files changed

Lines changed: 141 additions & 8 deletions

File tree

‎NEWS‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,9 @@ PHP NEWS
5858
- Mcrypt:
5959
. The deprecated mcrypt extension has been moved to PECL. (leigh)
6060

61+
- PDO:
62+
. Add "Sent SQL" to debug dump for emulated prepares. (Adam Baratz)
63+
6164
- PDO_DBlib:
6265
. Fixed bug #73234 (Emulated statements let value dictate parameter type).
6366
(Adam Baratz)

‎ext/pdo/pdo_stmt.c‎

Lines changed: 17 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -486,6 +486,12 @@ static PHP_METHOD(PDOStatement, execute)
486486
* quoted.
487487
*/
488488

489+
/* string is leftover from previous calls so PDOStatement::debugDumpParams() can access */
490+
if (stmt->active_query_string && stmt->active_query_string != stmt->query_string) {
491+
efree(stmt->active_query_string);
492+
}
493+
stmt->active_query_string = NULL;
494+
489495
ret = pdo_parse_params(stmt, stmt->query_string, stmt->query_stringlen,
490496
&stmt->active_query_string, &stmt->active_query_stringlen);
491497

@@ -504,10 +510,6 @@ static PHP_METHOD(PDOStatement, execute)
504510
RETURN_FALSE;
505511
}
506512
if (stmt->methods->executer(stmt)) {
507-
if (stmt->active_query_string && stmt->active_query_string != stmt->query_string) {
508-
efree(stmt->active_query_string);
509-
}
510-
stmt->active_query_string = NULL;
511513
if (!stmt->executed) {
512514
/* this is the first execute */
513515

@@ -526,10 +528,6 @@ static PHP_METHOD(PDOStatement, execute)
526528

527529
RETURN_BOOL(ret);
528530
}
529-
if (stmt->active_query_string && stmt->active_query_string != stmt->query_string) {
530-
efree(stmt->active_query_string);
531-
}
532-
stmt->active_query_string = NULL;
533531
PDO_HANDLE_STMT_ERR();
534532
RETURN_FALSE;
535533
}
@@ -2108,6 +2106,14 @@ static PHP_METHOD(PDOStatement, debugDumpParams)
21082106
stmt->query_stringlen,
21092107
(int) stmt->query_stringlen, stmt->query_string);
21102108

2109+
/* show parsed SQL if emulated prepares enabled */
2110+
/* pointers will be equal if PDO::query() was invoked */
2111+
if (stmt->active_query_string != NULL && stmt->active_query_string != stmt->query_string) {
2112+
php_stream_printf(out, "Sent SQL: [%zd] %.*s\n",
2113+
stmt->active_query_stringlen,
2114+
(int) stmt->active_query_stringlen, stmt->active_query_string);
2115+
}
2116+
21112117
php_stream_printf(out, "Params: %d\n",
21122118
stmt->bound_params ? zend_hash_num_elements(stmt->bound_params) : 0);
21132119

@@ -2317,6 +2323,9 @@ PDO_API void php_pdo_free_statement(pdo_stmt_t *stmt)
23172323
if (stmt->methods && stmt->methods->dtor) {
23182324
stmt->methods->dtor(stmt);
23192325
}
2326+
if (stmt->active_query_string && stmt->active_query_string != stmt->query_string) {
2327+
efree(stmt->active_query_string);
2328+
}
23202329
if (stmt->query_string) {
23212330
efree(stmt->query_string);
23222331
}

‎ext/pdo/tests/debug_emulated_prepares.phpt‎

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
--TEST--
2+
PDO Common: PDOStatement::debugDumpParams() with emulated prepares
3+
--SKIPIF--
4+
<?php
5+
if (!extension_loaded('pdo')) die('skip');
6+
$dir = getenv('REDIR_TEST_DIR');
7+
if (false == $dir) die('skip no driver');
8+
require_once $dir . 'pdo_test.inc';
9+
PDOTest::skip();
10+
11+
$db = PDOTest::factory();
12+
if ($db->getAttribute(PDO::ATTR_DRIVER_NAME) == 'pgsql') die('skip pgsql has its own test for this feature');
13+
if (!$db->getAttribute(PDO::ATTR_EMULATE_PREPARES) && !$db->setAttribute(PDO::ATTR_EMULATE_PREPARES, true)) die('skip driver cannot emulate prepared statements');
14+
?>
15+
--FILE--
16+
<?php
17+
if (getenv('REDIR_TEST_DIR') === false) putenv('REDIR_TEST_DIR='.dirname(__FILE__) . '/../../pdo/tests/');
18+
require_once getenv('REDIR_TEST_DIR') . 'pdo_test.inc';
19+
20+
$db = PDOTest::factory();
21+
$db->setAttribute(PDO::ATTR_EMULATE_PREPARES, true);
22+
23+
$stmt = $db->query('SELECT 1');
24+
25+
// "Sent SQL" shouldn't display
26+
var_dump($stmt->debugDumpParams());
27+
28+
$stmt = $db->prepare('SELECT :bool, :int, :string, :null');
29+
$stmt->bindValue(':bool', true, PDO::PARAM_BOOL);
30+
$stmt->bindValue(':int', 123, PDO::PARAM_INT);
31+
$stmt->bindValue(':string', 'foo', PDO::PARAM_STR);
32+
$stmt->bindValue(':null', null, PDO::PARAM_NULL);
33+
$stmt->execute();
34+
35+
// "Sent SQL" should display
36+
var_dump($stmt->debugDumpParams());
37+
38+
?>
39+
--EXPECT--
40+
SQL: [8] SELECT 1
41+
Params: 0
42+
NULL
43+
SQL: [34] SELECT :bool, :int, :string, :null
44+
Sent SQL: [26] SELECT 1, 123, 'foo', NULL
45+
Params: 4
46+
Key: Name: [5] :bool
47+
paramno=-1
48+
name=[5] ":bool"
49+
is_param=1
50+
param_type=5
51+
Key: Name: [4] :int
52+
paramno=-1
53+
name=[4] ":int"
54+
is_param=1
55+
param_type=1
56+
Key: Name: [7] :string
57+
paramno=-1
58+
name=[7] ":string"
59+
is_param=1
60+
param_type=2
61+
Key: Name: [5] :null
62+
paramno=-1
63+
name=[5] ":null"
64+
is_param=1
65+
param_type=0
66+
NULL

‎ext/pdo_dblib/dblib_driver.c‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -272,6 +272,11 @@ static int dblib_set_attr(pdo_dbh_t *dbh, zend_long attr, zval *val)
272272
static int dblib_get_attribute(pdo_dbh_t *dbh, zend_long attr, zval *return_value)
273273
{
274274
switch (attr) {
275+
case PDO_ATTR_EMULATE_PREPARES:
276+
/* this is the only option available, but expose it so common tests and whatever else can introspect */
277+
ZVAL_TRUE(return_value);
278+
break;
279+
275280
case PDO_DBLIB_ATTR_STRINGIFY_UNIQUEIDENTIFIER:
276281
ZVAL_BOOL(return_value, ((pdo_dblib_db_handle *)dbh->driver_data)->stringify_uniqueidentifier);
277282
break;

‎ext/pdo_pgsql/tests/debug_emulated_prepares.phpt‎

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
--TEST--
2+
PDO PgSQL PDOStatement::debugDumpParams() with emulated prepares
3+
--SKIPIF--
4+
<?php
5+
if (!extension_loaded('pdo') || !extension_loaded('pdo_pgsql')) die('skip not loaded');
6+
require dirname(__FILE__) . '/config.inc';
7+
require dirname(__FILE__) . '/../../../ext/pdo/tests/pdo_test.inc';
8+
PDOTest::skip();
9+
?>
10+
--FILE--
11+
<?php
12+
require dirname(__FILE__) . '/../../../ext/pdo/tests/pdo_test.inc';
13+
$db = PDOTest::test_factory(dirname(__FILE__) . '/common.phpt');
14+
$db->setAttribute(PDO::ATTR_EMULATE_PREPARES, true);
15+
16+
$stmt = $db->prepare('SELECT :bool, :int, :string, :null');
17+
$stmt->bindValue(':bool', true, PDO::PARAM_BOOL);
18+
$stmt->bindValue(':int', 123, PDO::PARAM_INT);
19+
$stmt->bindValue(':string', 'foo', PDO::PARAM_STR);
20+
$stmt->bindValue(':null', null, PDO::PARAM_NULL);
21+
$stmt->execute();
22+
23+
var_dump($stmt->debugDumpParams());
24+
25+
?>
26+
--EXPECT--
27+
SQL: [34] SELECT :bool, :int, :string, :null
28+
Sent SQL: [28] SELECT 't', 123, 'foo', NULL
29+
Params: 4
30+
Key: Name: [5] :bool
31+
paramno=-1
32+
name=[5] ":bool"
33+
is_param=1
34+
param_type=2
35+
Key: Name: [4] :int
36+
paramno=-1
37+
name=[4] ":int"
38+
is_param=1
39+
param_type=1
40+
Key: Name: [7] :string
41+
paramno=-1
42+
name=[7] ":string"
43+
is_param=1
44+
param_type=2
45+
Key: Name: [5] :null
46+
paramno=-1
47+
name=[5] ":null"
48+
is_param=1
49+
param_type=0
50+
NULL

0 commit comments

Comments
 (0)