ext/pdo_sqlite: add ATTR_SQL and ATTR_EXPANDED_SQL statement attributes

Add support for retrieving the SQL text of a prepared statement via
PDOStatement::getAttribute(), mirroring SQLite3Stmt::getSQL().

  Pdo\Sqlite::ATTR_SQL          - original SQL text (sqlite3_sql)
  Pdo\Sqlite::ATTR_EXPANDED_SQL - SQL with bound parameters expanded
                                   (sqlite3_expanded_sql)

Closes GH-21322

Author: iliaal

ext/pdo_sqlite/config.m4

@@ -17,6 +17,13 @@ if test "$PHP_PDO_SQLITE" != "no"; then
     [],
     [$PDO_SQLITE_SHARED_LIBADD])
 
+  PHP_CHECK_LIBRARY([sqlite3], [sqlite3_expanded_sql],
+    [AC_DEFINE([HAVE_SQLITE3_EXPANDED_SQL], [1],
+      [Define to 1 if SQLite library has the 'sqlite3_expanded_sql'
+      function.])],
+    [],
+    [$PDO_SQLITE_SHARED_LIBADD])
+
   PHP_CHECK_LIBRARY([sqlite3], [sqlite3_load_extension],
     [],
     [AC_DEFINE([PDO_SQLITE_OMIT_LOAD_EXTENSION], [1],

ext/pdo_sqlite/config.w32

@@ -8,6 +8,7 @@ if (PHP_PDO_SQLITE != "no") {
 
 		ADD_EXTENSION_DEP('pdo_sqlite', 'pdo');
 		AC_DEFINE("HAVE_SQLITE3_COLUMN_TABLE_NAME", 1, "Define to 1 if SQLite library was compiled with the SQLITE_ENABLE_COLUMN_METADATA and has the 'sqlite3_column_table_name' function.");
+		AC_DEFINE("HAVE_SQLITE3_EXPANDED_SQL", 1, "Define to 1 if SQLite library has the 'sqlite3_expanded_sql' function.");
 		ADD_MAKEFILE_FRAGMENT();
 	} else {
 		WARNING("pdo_sqlite not enabled; libraries and/or headers not found");

ext/pdo_sqlite/pdo_sqlite.stub.php

@@ -42,6 +42,14 @@ class Sqlite extends \PDO
     /** @cvalue PDO_SQLITE_ATTR_TRANSACTION_MODE */
     public const int ATTR_TRANSACTION_MODE = UNKNOWN;
 
+    /** @cvalue PDO_SQLITE_ATTR_SQL */
+    public const int ATTR_SQL = UNKNOWN;
+
+#ifdef HAVE_SQLITE3_EXPANDED_SQL
+    /** @cvalue PDO_SQLITE_ATTR_EXPANDED_SQL */
+    public const int ATTR_EXPANDED_SQL = UNKNOWN;
+#endif
+
     public const int TRANSACTION_MODE_DEFERRED = 0;
     public const int TRANSACTION_MODE_IMMEDIATE = 1;
     public const int TRANSACTION_MODE_EXCLUSIVE = 2;

ext/pdo_sqlite/pdo_sqlite_arginfo.h

@@ -77,7 +77,9 @@ enum {
 	PDO_SQLITE_ATTR_EXTENDED_RESULT_CODES,
 	PDO_SQLITE_ATTR_BUSY_STATEMENT,
 	PDO_SQLITE_ATTR_EXPLAIN_STATEMENT,
-	PDO_SQLITE_ATTR_TRANSACTION_MODE
+	PDO_SQLITE_ATTR_TRANSACTION_MODE,
+	PDO_SQLITE_ATTR_SQL,
+	PDO_SQLITE_ATTR_EXPANDED_SQL
 };
 
 typedef int pdo_sqlite_create_collation_callback(void*, int, const void*, int, const void*);

ext/pdo_sqlite/php_pdo_sqlite_int.h

@@ -408,6 +408,32 @@ static int pdo_sqlite_stmt_get_attribute(pdo_stmt_t *stmt, zend_long attr, zval
 			zend_value_error("explain statement unsupported");
 			return 0;
 #endif
+		case PDO_SQLITE_ATTR_SQL: {
+			const char *sql = sqlite3_sql(S->stmt);
+			if (sql) {
+				ZVAL_STRING(val, sql);
+			} else {
+				ZVAL_NULL(val);
+			}
+			return 1;
+		}
+
+		case PDO_SQLITE_ATTR_EXPANDED_SQL: {
+#ifdef HAVE_SQLITE3_EXPANDED_SQL
+			char *sql = sqlite3_expanded_sql(S->stmt);
+			if (sql) {
+				ZVAL_STRING(val, sql);
+				sqlite3_free(sql);
+			} else {
+				ZVAL_NULL(val);
+			}
+			return 1;
+#else
+			zend_value_error("expanded sql unsupported");
+			return -1;
+#endif
+		}
+
 		default:
 			return 0;
 	}

ext/pdo_sqlite/sqlite_statement.c

@@ -14,6 +14,7 @@ var_dump(Pdo\Sqlite::OPEN_CREATE);
 var_dump(Pdo\Sqlite::ATTR_READONLY_STATEMENT);
 var_dump(Pdo\Sqlite::ATTR_EXTENDED_RESULT_CODES);
 var_dump(Pdo\Sqlite::ATTR_BUSY_STATEMENT);
+var_dump(Pdo\Sqlite::ATTR_SQL);
 
 ?>
 --EXPECTF--
@@ -26,3 +27,4 @@ int(%d)
 int(%d)
 int(%d)
 int(%d)
+int(%d)

ext/pdo_sqlite/tests/subclasses/pdo_sqlite_constants.phpt

@@ -0,0 +1,29 @@
+--TEST--
+Pdo\Sqlite::ATTR_SQL and Pdo\Sqlite::ATTR_EXPANDED_SQL usage
+--EXTENSIONS--
+pdo_sqlite
+--SKIPIF--
+<?php
+if (!defined('Pdo\Sqlite::ATTR_EXPANDED_SQL')) die('skip sqlite3_expanded_sql not available');
+?>
+--FILE--
+<?php
+
+$db = new Pdo\Sqlite('sqlite::memory:');
+
+$stmt = $db->prepare('SELECT :name AS greeting, :num AS number');
+var_dump($stmt->getAttribute(Pdo\Sqlite::ATTR_SQL));
+var_dump($stmt->getAttribute(Pdo\Sqlite::ATTR_EXPANDED_SQL));
+
+$stmt->bindValue(':name', 'hello world');
+$stmt->bindValue(':num', 42, PDO::PARAM_INT);
+$stmt->execute();
+
+var_dump($stmt->getAttribute(Pdo\Sqlite::ATTR_SQL));
+var_dump($stmt->getAttribute(Pdo\Sqlite::ATTR_EXPANDED_SQL));
+?>
+--EXPECT--
+string(40) "SELECT :name AS greeting, :num AS number"
+string(39) "SELECT NULL AS greeting, NULL AS number"
+string(40) "SELECT :name AS greeting, :num AS number"
+string(46) "SELECT 'hello world' AS greeting, 42 AS number"