Skip to content

Commit 36ff68d

Browse files
KentarouTakedaKentarouTakeda
committed
ext/pdo_pgsql: Expanding COPY input from an array to an iterable
1 parent 274ae05 commit 36ff68d

File tree

5 files changed

+182
-26
lines changed

5 files changed

+182
-26
lines changed

‎ext/pdo_pgsql/pgsql_driver.c‎

Lines changed: 63 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@
3131
#include "php_pdo_pgsql.h"
3232
#include "php_pdo_pgsql_int.h"
3333
#include "zend_exceptions.h"
34+
#include "zend_interfaces.h"
3435
#include "zend_smart_str.h"
3536
#include "pgsql_driver_arginfo.h"
3637

@@ -620,14 +621,14 @@ void pgsqlCopyFromArray_internal(INTERNAL_FUNCTION_PARAMETERS)
620621
PGresult *pgsql_result;
621622
ExecStatusType status;
622623

623-
if (zend_parse_parameters(ZEND_NUM_ARGS(), "sa|sss!",
624+
if (zend_parse_parameters(ZEND_NUM_ARGS(), "sA|sss!",
624625
&table_name, &table_name_len, &pg_rows,
625626
&pg_delim, &pg_delim_len, &pg_null_as, &pg_null_as_len, &pg_fields, &pg_fields_len) == FAILURE) {
626627
RETURN_THROWS();
627628
}
628629

629-
if (!zend_hash_num_elements(Z_ARRVAL_P(pg_rows))) {
630-
zend_argument_must_not_be_empty_error(2);
630+
if ((Z_TYPE_P(pg_rows) != IS_ARRAY && !instanceof_function(Z_OBJCE_P(pg_rows), zend_ce_traversable))) {
631+
zend_argument_type_error(2, "must be of type array or Traversable");
631632
RETURN_THROWS();
632633
}
633634

@@ -663,32 +664,71 @@ void pgsqlCopyFromArray_internal(INTERNAL_FUNCTION_PARAMETERS)
663664
int command_failed = 0;
664665
size_t buffer_len = 0;
665666
zval *tmp;
667+
zend_object_iterator *iter;
666668

667669
PQclear(pgsql_result);
668-
ZEND_HASH_FOREACH_VAL(Z_ARRVAL_P(pg_rows), tmp) {
669-
size_t query_len;
670-
if (!try_convert_to_string(tmp)) {
671-
efree(query);
670+
671+
if (Z_TYPE_P(pg_rows) == IS_ARRAY) {
672+
ZEND_HASH_FOREACH_VAL(Z_ARRVAL_P(pg_rows), tmp) {
673+
size_t query_len;
674+
if (!try_convert_to_string(tmp)) {
675+
efree(query);
676+
RETURN_THROWS();
677+
}
678+
679+
if (buffer_len < Z_STRLEN_P(tmp)) {
680+
buffer_len = Z_STRLEN_P(tmp);
681+
query = erealloc(query, buffer_len + 2); /* room for \n\0 */
682+
}
683+
query_len = Z_STRLEN_P(tmp);
684+
memcpy(query, Z_STRVAL_P(tmp), query_len);
685+
if (query[query_len - 1] != '\n') {
686+
query[query_len++] = '\n';
687+
}
688+
query[query_len] = '\0';
689+
if (PQputCopyData(H->server, query, query_len) != 1) {
690+
efree(query);
691+
pdo_pgsql_error(dbh, PGRES_FATAL_ERROR, NULL);
692+
PDO_HANDLE_DBH_ERR();
693+
RETURN_FALSE;
694+
}
695+
} ZEND_HASH_FOREACH_END();
696+
} else {
697+
iter = Z_OBJ_P(pg_rows)->ce->get_iterator(Z_OBJCE_P(pg_rows), pg_rows, 0);
698+
if (iter == NULL || EG(exception)) {
672699
RETURN_THROWS();
673700
}
674701

675-
if (buffer_len < Z_STRLEN_P(tmp)) {
676-
buffer_len = Z_STRLEN_P(tmp);
677-
query = erealloc(query, buffer_len + 2); /* room for \n\0 */
678-
}
679-
query_len = Z_STRLEN_P(tmp);
680-
memcpy(query, Z_STRVAL_P(tmp), query_len);
681-
if (query[query_len - 1] != '\n') {
682-
query[query_len++] = '\n';
683-
}
684-
query[query_len] = '\0';
685-
if (PQputCopyData(H->server, query, query_len) != 1) {
686-
efree(query);
687-
pdo_pgsql_error(dbh, PGRES_FATAL_ERROR, NULL);
688-
PDO_HANDLE_DBH_ERR();
689-
RETURN_FALSE;
702+
for (; iter->funcs->valid(iter) == SUCCESS && EG(exception) == NULL; iter->funcs->move_forward(iter)) {
703+
size_t query_len;
704+
tmp = iter->funcs->get_current_data(iter);
705+
if (!try_convert_to_string(tmp)) {
706+
efree(query);
707+
zend_iterator_dtor(iter);
708+
RETURN_THROWS();
709+
}
710+
711+
if (buffer_len < Z_STRLEN_P(tmp)) {
712+
buffer_len = Z_STRLEN_P(tmp);
713+
query = erealloc(query, buffer_len + 2); /* room for \n\0 */
714+
}
715+
query_len = Z_STRLEN_P(tmp);
716+
memcpy(query, Z_STRVAL_P(tmp), query_len);
717+
if (query[query_len - 1] != '\n') {
718+
query[query_len++] = '\n';
719+
}
720+
query[query_len] = '\0';
721+
if (PQputCopyData(H->server, query, query_len) != 1) {
722+
efree(query);
723+
zend_iterator_dtor(iter);
724+
pdo_pgsql_error(dbh, PGRES_FATAL_ERROR, NULL);
725+
PDO_HANDLE_DBH_ERR();
726+
RETURN_FALSE;
727+
}
690728
}
691-
} ZEND_HASH_FOREACH_END();
729+
zend_iterator_dtor(iter);
730+
}
731+
692732
if (query) {
693733
efree(query);
694734
}

‎ext/pdo_pgsql/pgsql_driver.stub.php‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
*/
99
class PDO_PGSql_Ext {
1010
/** @tentative-return-type */
11-
public function pgsqlCopyFromArray(string $tableName, array $rows, string $separator = "\t", string $nullAs = "\\\\N", ?string $fields = null): bool {}
11+
public function pgsqlCopyFromArray(string $tableName, array | Traversable $rows, string $separator = "\t", string $nullAs = "\\\\N", ?string $fields = null): bool {}
1212

1313
/** @tentative-return-type */
1414
public function pgsqlCopyFromFile(string $tableName, string $filename, string $separator = "\t", string $nullAs = "\\\\N", ?string $fields = null): bool {}

‎ext/pdo_pgsql/pgsql_driver_arginfo.h‎

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎ext/pdo_pgsql/tests/copy_from_generator.phpt‎

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
--TEST--
2+
PDO PgSQL pgsqlCopyFromArray using Generator
3+
--EXTENSIONS--
4+
pdo_pgsql
5+
--SKIPIF--
6+
<?php
7+
require __DIR__ . '/config.inc';
8+
require __DIR__ . '/../../../ext/pdo/tests/pdo_test.inc';
9+
PDOTest::skip();
10+
?>
11+
--FILE--
12+
<?php
13+
require __DIR__ . '/../../../ext/pdo/tests/pdo_test.inc';
14+
$db = PDOTest::test_factory(__DIR__ . '/common.phpt');
15+
$db->setAttribute(PDO::ATTR_ERRMODE, PDO::ERRMODE_EXCEPTION);
16+
$db->setAttribute(PDO::ATTR_STRINGIFY_FETCHES, false);
17+
18+
$db->exec('CREATE TABLE test_copy_from_generator (v int)');
19+
20+
$generator = (function(){
21+
$position = 0;
22+
$values = [1, 1, 2, 3, 5];
23+
24+
while(isset($values[$position])){
25+
yield $values[$position];
26+
++$position;
27+
}
28+
})();
29+
30+
31+
$db->pgsqlCopyFromArray('test_copy_from_generator',$generator);
32+
33+
$stmt = $db->query("select * from test_copy_from_generator order by 1");
34+
$result = $stmt->fetchAll(PDO::FETCH_COLUMN, 0);
35+
var_export($result);
36+
37+
?>
38+
--CLEAN--
39+
<?php
40+
require __DIR__ . '/../../../ext/pdo/tests/pdo_test.inc';
41+
$db = PDOTest::test_factory(__DIR__ . '/common.phpt');
42+
$db->query('DROP TABLE IF EXISTS test_copy_from_generator CASCADE');
43+
?>
44+
--EXPECT--
45+
array (
46+
0 => 1,
47+
1 => 1,
48+
2 => 2,
49+
3 => 3,
50+
4 => 5,
51+
)

‎ext/pdo_pgsql/tests/copy_from_iterator.phpt‎

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
--TEST--
2+
PDO PgSQL pgsqlCopyFromArray using Iterator
3+
--EXTENSIONS--
4+
pdo_pgsql
5+
--SKIPIF--
6+
<?php
7+
require __DIR__ . '/config.inc';
8+
require __DIR__ . '/../../../ext/pdo/tests/pdo_test.inc';
9+
PDOTest::skip();
10+
?>
11+
--FILE--
12+
<?php
13+
require __DIR__ . '/../../../ext/pdo/tests/pdo_test.inc';
14+
$db = PDOTest::test_factory(__DIR__ . '/common.phpt');
15+
$db->setAttribute(PDO::ATTR_ERRMODE, PDO::ERRMODE_EXCEPTION);
16+
$db->setAttribute(PDO::ATTR_STRINGIFY_FETCHES, false);
17+
18+
$db->exec('CREATE TABLE test_copy_from_traversable (v int)');
19+
20+
$iterator = new class implements Iterator{
21+
private $position = 0;
22+
private $values = [1, 1, 2, 3, 5];
23+
24+
public function rewind(): void {
25+
$this->position = 0;
26+
}
27+
28+
public function current(): int {
29+
return $this->values[$this->position];
30+
}
31+
32+
public function key(): int {
33+
return $this->position;
34+
}
35+
36+
public function next(): void {
37+
++$this->position;
38+
}
39+
40+
public function valid(): bool {
41+
return isset($this->values[$this->position]);
42+
}
43+
};
44+
45+
$db->pgsqlCopyFromArray('test_copy_from_traversable',$iterator);
46+
47+
$stmt = $db->query("select * from test_copy_from_traversable order by 1");
48+
$result = $stmt->fetchAll(PDO::FETCH_COLUMN, 0);
49+
var_export($result);
50+
51+
?>
52+
--CLEAN--
53+
<?php
54+
require __DIR__ . '/../../../ext/pdo/tests/pdo_test.inc';
55+
$db = PDOTest::test_factory(__DIR__ . '/common.phpt');
56+
$db->query('DROP TABLE IF EXISTS test_copy_from_traversable CASCADE');
57+
?>
58+
--EXPECT--
59+
array (
60+
0 => 1,
61+
1 => 1,
62+
2 => 2,
63+
3 => 3,
64+
4 => 5,
65+
)

0 commit comments

Comments
 (0)