1
1
Fork 0
mirror of https://code.mensbeam.com/MensBeam/Arsse.git synced 2024-12-22 21:22:40 +00:00

Simplify the creation of arbitrary UPDATEs

The type parameters of Db\Driver::prepare() and the parameters of Db\Statement::run() can now be arrays, which will be iterated over recursively to bind scalar values to the SQL statement.

This simplifies the construction of arbitrary UPDATE statements (the WHERE clause no longer needs to be taken into account) and should make it clearer what is happening in these cases.

It should also simplify the creation of IN() clauses down the road if they become necessary.
This commit is contained in:
J. King 2017-04-06 11:02:47 -04:00
parent 25aeaf4801
commit 929d763981
6 changed files with 55 additions and 42 deletions

View file

@ -14,26 +14,19 @@ class Database {
public $db;
private $driver;
protected function processUpdate(array $props, array $valid, array $where): array {
protected function generateSet(array $props, array $valid): array {
$out = [
'values' => [],
'types' => [],
'setValues' => [],
'setTypes' => [],
'set' => [],
'where' => [],
];
foreach($valid as $prop => $type) {
if(!array_key_exists($prop, $props)) continue;
$out['values'][] = $props[$prop];
$out['types'][] = $type;
$out['setValues'][] = $props[$prop];
$out['setTypes'][] = $type;
$out['set'][] = "$prop = ?";
}
foreach($where as $field => $value) {
$out['values'][] = $value[0];
$out['types'][] = $value[1];
$out['where'][] = "$field is ?";
}
$out['set'] = implode(", ", $out['set']);
$out['where'] = implode(" and ", $out['where']);
return $out;
}
@ -256,9 +249,9 @@ class Database {
$valid = [ // FIXME: add future properties
"name" => "str",
];
$data = $this->processUpdate($properties, $valid, ['id' => [$user, "str"]]);
$data = $this->generateSet($properties, $valid);
extract($data);
$this->db->prepareArray("UPDATE arsse_users set $set where $where", $types)->runArray($values);
$this->db->prepare("UPDATE arsse_users set $set where id is ?", $setTypes, "str")->run($setValues, $user);
return $this->userPropertiesGet($user);
}
@ -389,9 +382,9 @@ class Database {
'name' => "str",
'parent' => "int",
];
$data = $this->processUpdate($data, $valid, ['owner' => [$user, "str"], 'id' => [$id, "int"]]);
$data = $this->generateSet($data, $valid);
extract($data);
$this->db->prepareArray("UPDATE arsse_folders set $set where $where", $types)->runArray($values);
$this->db->prepare("UPDATE arsse_folders set $set where owner is ? and id is ?", $setTypes, "str", "int")->run($setValues, $user, $id);
return true;
}

View file

@ -67,7 +67,7 @@ abstract class AbstractDriver implements Driver {
return ($this->query("SELECT count(*) from arsse_settings where key is 'lock'")->getValue() > 0);
}
public function prepare(string $query, string ...$paramType): Statement {
public function prepare(string $query, ...$paramType): Statement {
return $this->prepareArray($query, $paramType);
}
}

View file

@ -15,13 +15,18 @@ abstract class AbstractStatement implements Statement {
return $this->rebindArray($bindings);
}
public function rebindArray(array $bindings): bool {
$this->types = [];
public function rebindArray(array $bindings, bool $append = false): bool {
if(!$append) $this->types = [];
foreach($bindings as $binding) {
if(is_array($binding)) {
// recursively flatten any arrays, which may be provided for SET or IN() clauses
$this->rebindArray($binding, true);
} else {
$binding = trim(strtolower($binding));
if(!array_key_exists($binding, self::TYPES)) throw new Exception("paramTypeInvalid", $binding);
$this->types[] = self::TYPES[$binding];
}
}
return true;
}

View file

@ -25,5 +25,5 @@ interface Driver {
// perform a single unsanitized query and return a result set
function query(string $query): Result;
// ready a prepared statement for later execution
function prepare(string $query, string ...$paramType): Statement;
function prepare(string $query, ...$paramType): Statement;
}

View file

@ -48,24 +48,7 @@ class Statement extends \JKingWeb\Arsse\Db\AbstractStatement {
public function runArray(array $values = null): \JKingWeb\Arsse\Db\Result {
$this->st->clear();
$l = sizeof($values);
for($a = 0; $a < $l; $a++) {
// find the right SQLite binding type for the value/specified type
if($values[$a]===null) {
$type = \SQLITE3_NULL;
} else if(array_key_exists($a,$this->types)) {
if(!array_key_exists($this->types[$a], self::BINDINGS)) throw new Exception("paramTypeUnknown", $this->types[$a]);
$type = self::BINDINGS[$this->types[$a]];
} else {
throw new Exception("paramTypeMissing", $a+1);
}
// cast value if necessary
$values[$a] = $this->cast($values[$a], $this->types[$a]);
// re-adjust for null casts
if($values[$a]===null) $type = \SQLITE3_NULL;
// perform binding
$this->st->bindValue($a+1, $values[$a], $type);
}
if(!is_null($values)) $this->bindValues($values);
try {
$r = $this->st->execute();
} catch(\Exception $e) {
@ -76,4 +59,32 @@ class Statement extends \JKingWeb\Arsse\Db\AbstractStatement {
$lastId = $this->db->lastInsertRowID();
return new Result($r, [$changes, $lastId], $this);
}
protected function bindValues(array $values, int $offset = 0): int {
$a = $offset;
foreach($values as $value) {
if(is_array($value)) {
// recursively flatten any arrays, which may be provided for SET or IN() clauses
$a += $this->bindValues($value, $a);
} else {
// find the right SQLite binding type for the value/specified type
if($value===null) {
$type = \SQLITE3_NULL;
} else if(array_key_exists($a,$this->types)) {
if(!array_key_exists($this->types[$a], self::BINDINGS)) throw new Exception("paramTypeUnknown", $this->types[$a]);
$type = self::BINDINGS[$this->types[$a]];
} else {
throw new Exception("paramTypeMissing", $a+1);
}
// cast value if necessary
$value = $this->cast($value, $this->types[$a]);
// re-adjust for null casts
if($value===null) $type = \SQLITE3_NULL;
// perform binding
$this->st->bindValue($a+1, $value, $type);
$a++;
}
}
return $a;
}
}

View file

@ -132,24 +132,28 @@ class V1_2 extends \JKingWeb\Arsse\REST\AbstractHandler {
return new Response(204);
}
// return the server version
protected function versionGET(array $url, array $data): Response {
// if URL is more than '/version' this is an error
if(sizeof($url)) return new Response(404);
return new Response(200, ['version' => \JKingWeb\Arsse\VERSION]);
}
// invalid function
protected function versionPOST(array $url, array $data): Response {
// if URL is more than '/version' this is an error
if(sizeof($url)) return new Response(404);
return new Response(405, "", "", ['Allow: GET']);
}
// invalid function
protected function versionPUT(array $url, array $data): Response {
// if URL is more than '/version' this is an error
if(sizeof($url)) return new Response(404);
return new Response(405, "", "", ['Allow: GET']);
}
// invalid function
protected function versionDELETE(array $url, array $data): Response {
// if URL is more than '/version' this is an error
if(sizeof($url)) return new Response(404);