Support SQLite3 @name notation

Besides the common `:param` notation to designate named parameters in
prepared statements, SQLite3 also supports `@param` and `$param`.
While the latter is mostly to support the Tcl programming language, and
would be confusing for PHP's sqlite3 binding due to the similarity with
string interpolation, the former is common under .NET and raises no
such issue.  Therefore we add support for it.

This patch has been developed in cooperation with @BohwaZ.

diff --git a/NEWS b/NEWS
index 8c6dc34ee75edc1b18640f9ed1cae18ba07e5acc..c143a3bc72d5292e8bf89b817510501ef150eff4 100644 (file)
--- a/NEWS
+++ b/NEWS
@@ -33,6 +33,7 @@ PHP                                                                        NEWS
 - SQLite3:
   . Unbundled libsqlite. (cmb)
   . Lifted requirements to SQLite 3.5.0. (cmb)
+  . Added support for the SQLite @name notation. (cmb, BohwaZ)
 
 - Standard:
   . Fixed bug #74764 (Bindto IPv6 works with file_get_contents but fails with

diff --git a/UPGRADING b/UPGRADING
index beb350afe2dcd704eb4ca1b1549bd4d3c799056a..88d48b38c931fcee443230427cf37c8133c26aed 100644 (file)
--- a/UPGRADING
+++ b/UPGRADING
@@ -119,6 +119,7 @@ PHP 7.4 UPGRADE NOTES
 - SQLite3:
   . The bundled libsqlite has been removed.  To build the SQLite3 and/or
     PDO_SQLite extensions a system libsqlite3 ≥ 3.5.0 is now required.
+  . The @param notation can now also be used to denote SQL query parameters.
 
 - Zip:
   . The bundled libzip library has been removed. A system libzip >= 0.11 is now

diff --git a/ext/sqlite3/sqlite3.c b/ext/sqlite3/sqlite3.c
index 1b24af074f399f4c585490dd12743f5828e59f51..31f062dd224dccf4ffd5ee5f9ac754a368fcd676 100644 (file)
--- a/ext/sqlite3/sqlite3.c
+++ b/ext/sqlite3/sqlite3.c
@@ -1408,7 +1408,7 @@ static int register_bound_parameter_to_sqlite(struct php_sqlite3_bound_param *pa
 
        /* We need a : prefix to resolve a name to a parameter number */
        if (param->name) {
-               if (ZSTR_VAL(param->name)[0] != ':') {
+               if (ZSTR_VAL(param->name)[0] != ':' && ZSTR_VAL(param->name)[0] != '@') {
                        /* pre-increment for character + 1 for null */
                        zend_string *temp = zend_string_alloc(ZSTR_LEN(param->name) + 1, 0);
                        ZSTR_VAL(temp)[0] = ':';

diff --git a/ext/sqlite3/tests/sqlite3_bound_value_at_name.phpt b/ext/sqlite3/tests/sqlite3_bound_value_at_name.phpt
new file mode 100644 (file)
index 0000000..d0eec87
--- /dev/null
+++ b/ext/sqlite3/tests/sqlite3_bound_value_at_name.phpt
@@ -0,0 +1,51 @@
+--TEST--
+SQLite3::prepare Bound Value test
+--SKIPIF--
+<?php require_once(__DIR__ . '/skipif.inc'); ?>
+--FILE--
+<?php
+
+require_once(__DIR__ . '/new_db.inc');
+define('TIMENOW', time());
+
+echo "Creating Table\n";
+var_dump($db->exec('CREATE TABLE test (time INTEGER, id STRING)'));
+
+echo "INSERT into table\n";
+var_dump($db->exec("INSERT INTO test (time, id) VALUES (" . TIMENOW . ", 'a')"));
+var_dump($db->exec("INSERT INTO test (time, id) VALUES (" . TIMENOW . ", 'b')"));
+
+echo "SELECTING results\n";
+$stmt = $db->prepare("SELECT * FROM test WHERE id = @id ORDER BY id ASC");
+$foo = 'a';
+echo "BINDING Value\n";
+var_dump($stmt->bindValue('@id', $foo, SQLITE3_TEXT));
+$results = $stmt->execute();
+while ($result = $results->fetchArray(SQLITE3_NUM))
+{
+       var_dump($result);
+}
+$results->finalize();
+
+echo "Closing database\n";
+var_dump($db->close());
+echo "Done\n";
+?>
+--EXPECTF--
+Creating Table
+bool(true)
+INSERT into table
+bool(true)
+bool(true)
+SELECTING results
+BINDING Value
+bool(true)
+array(2) {
+  [0]=>
+  int(%d)
+  [1]=>
+  string(1) "a"
+}
+Closing database
+bool(true)
+Done