badmanners/shimmie2
badmanners/shimmie2
Archived
1
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

[core] remove config->set_XXX("foo", null) -- use config->delete("foo") instead

Browse source
This commit is contained in:
Shish 2024-06-21 19:00:43 +01:00 committed by Shish
parent f84bcaec01
commit 17b0b4e94f
5 changed files with 74 additions and 61 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

77
core/config.php
View file

@ -15,22 +15,22 @@ interface Config
/** /**
* Set a configuration option to a new value, regardless of what the value is at the moment. * Set a configuration option to a new value, regardless of what the value is at the moment.
*/ */
public function set_int(string $name, ?int $value): void; public function set_int(string $name, int $value): void;
/** /**
* Set a configuration option to a new value, regardless of what the value is at the moment. * Set a configuration option to a new value, regardless of what the value is at the moment.
*/ */
public function set_float(string $name, ?float $value): void; public function set_float(string $name, float $value): void;
/** /**
* Set a configuration option to a new value, regardless of what the value is at the moment. * Set a configuration option to a new value, regardless of what the value is at the moment.
*/ */
public function set_string(string $name, ?string $value): void; public function set_string(string $name, string $value): void;
/** /**
* Set a configuration option to a new value, regardless of what the value is at the moment. * Set a configuration option to a new value, regardless of what the value is at the moment.
*/ */
public function set_bool(string $name, ?bool $value): void; public function set_bool(string $name, bool $value): void;
/** /**
* Set a configuration option to a new value, regardless of what the value is at the moment. * Set a configuration option to a new value, regardless of what the value is at the moment.
@ -38,6 +38,11 @@ interface Config
* @param mixed[] $value * @param mixed[] $value
*/ */
public function set_array(string $name, array $value): void; public function set_array(string $name, array $value): void;
/**
* Delete a configuration option.
*/
public function delete(string $name): void;
//@} /*--------------------------------------------------------------------------------------------*/ //@} /*--------------------------------------------------------------------------------------------*/
//@{ /*-------------------------------- SET DEFAULT -----------------------------------------------*/ //@{ /*-------------------------------- SET DEFAULT -----------------------------------------------*/
@ -134,7 +139,7 @@ interface Config
*/ */
abstract class BaseConfig implements Config abstract class BaseConfig implements Config
{ {
/** @var array<string, mixed> */ /** @var array<string, string> */
public array $values = []; public array $values = [];
/** /**
@ -144,51 +149,53 @@ abstract class BaseConfig implements Config
*/ */
abstract protected function save(string $name): void; abstract protected function save(string $name): void;
public function set_int(string $name, ?int $value): void public function set_int(string $name, int $value): void
{ {
$this->values[$name] = is_null($value) ? null : $value; $this->values[$name] = (string)$value;
$this->save($name); $this->save($name);
} }
public function set_float(string $name, ?float $value): void public function set_float(string $name, float $value): void
{
$this->values[$name] = (string)$value;
$this->save($name);
}
public function set_string(string $name, string $value): void
{ {
$this->values[$name] = $value; $this->values[$name] = $value;
$this->save($name); $this->save($name);
} }
public function set_string(string $name, ?string $value): void public function set_bool(string $name, bool $value): void
{
$this->values[$name] = $value;
$this->save($name);
}
public function set_bool(string $name, ?bool $value): void
{ {
$this->values[$name] = $value ? 'Y' : 'N'; $this->values[$name] = $value ? 'Y' : 'N';
$this->save($name); $this->save($name);
} }
public function set_array(string $name, ?array $value): void public function set_array(string $name, array $value): void
{ {
if ($value != null) { $this->values[$name] = implode(",", $value);
$this->values[$name] = implode(",", $value); $this->save($name);
} else { }
$this->values[$name] = null;
} public function delete(string $name): void
{
unset($this->values[$name]);
$this->save($name); $this->save($name);
} }
public function set_default_int(string $name, int $value): void public function set_default_int(string $name, int $value): void
{ {
if (is_null($this->get($name))) { if (is_null($this->get($name))) {
$this->values[$name] = $value; $this->values[$name] = (string)$value;
} }
} }
public function set_default_float(string $name, float $value): void public function set_default_float(string $name, float $value): void
{ {
if (is_null($this->get($name))) { if (is_null($this->get($name))) {
$this->values[$name] = $value; $this->values[$name] = (string)$value;
} }
} }
@ -240,11 +247,7 @@ abstract class BaseConfig implements Config
*/ */
public function get_string(string $name, ?string $default = null): ?string public function get_string(string $name, ?string $default = null): ?string
{ {
$val = $this->get($name, $default); return $this->get($name, $default);
if (!is_string($val) && !is_null($val)) {
throw new ServerError("$name is not a string: $val");
}
return $val;
} }
/** /**
@ -335,7 +338,11 @@ class DatabaseConfig extends BaseConfig
} }
foreach ($this->database->get_all($query, $args) as $row) { foreach ($this->database->get_all($query, $args) as $row) {
$values[$row["name"]] = $row["value"]; // versions prior to 2.12 would store null
// instead of deleting the row
if(!is_null($row["value"])) {
$values[$row["name"]] = $row["value"];
}
} }
return $values; return $values;
@ -358,11 +365,13 @@ class DatabaseConfig extends BaseConfig
$this->database->execute($query, $args); $this->database->execute($query, $args);
$args["value"] = $this->values[$name]; if(isset($this->values[$name])) {
$this->database->execute( $args["value"] = $this->values[$name];
"INSERT INTO {$this->table_name} (".join(",", $cols).") VALUES (".join(",", $params).")", $this->database->execute(
$args "INSERT INTO {$this->table_name} (".join(",", $cols).") VALUES (".join(",", $params).")",
); $args
);
}
// rather than deleting and having some other request(s) do a thundering // rather than deleting and having some other request(s) do a thundering
// herd of race-conditioned updates, just save the updated version once here // herd of race-conditioned updates, just save the updated version once here

2
ext/featured/main.php
View file

@ -72,7 +72,7 @@ class Featured extends Extension
{ {
global $config; global $config;
if ($event->image->id == $config->get_int("featured_id")) { if ($event->image->id == $config->get_int("featured_id")) {
$config->set_int("featured_id", 0); $config->delete("featured_id");
} }
} }

2
ext/image/main.php
View file

@ -74,7 +74,7 @@ class ImageIO extends Extension
$config->set_string(ImageConfig::THUMB_MIME, MimeType::JPEG); $config->set_string(ImageConfig::THUMB_MIME, MimeType::JPEG);
break; break;
} }
$config->set_string("thumb_type", null); $config->delete("thumb_type");
$this->set_version(ImageConfig::VERSION, 1); $this->set_version(ImageConfig::VERSION, 1);
} }

22
ext/res_limit/test.php
View file

@ -28,8 +28,8 @@ class ResolutionLimitTest extends ShimmiePHPUnitTestCase
global $config; global $config;
$config->set_int("upload_min_height", 900); $config->set_int("upload_min_height", 900);
$config->set_int("upload_min_width", 900); $config->set_int("upload_min_width", 900);
$config->set_int("upload_max_height", -1); $config->delete("upload_max_height");
$config->set_int("upload_max_width", -1); $config->delete("upload_max_width");
$config->set_string("upload_ratios", "4:3 16:9"); $config->set_string("upload_ratios", "4:3 16:9");
$this->log_in_as_user(); $this->log_in_as_user();
@ -57,10 +57,10 @@ class ResolutionLimitTest extends ShimmiePHPUnitTestCase
public function testResLimitRatio(): void public function testResLimitRatio(): void
{ {
global $config; global $config;
$config->set_int("upload_min_height", -1); $config->delete("upload_min_height");
$config->set_int("upload_min_width", -1); $config->delete("upload_min_width");
$config->set_int("upload_max_height", -1); $config->delete("upload_max_height");
$config->set_int("upload_max_width", -1); $config->delete("upload_max_width");
$config->set_string("upload_ratios", "16:9"); $config->set_string("upload_ratios", "16:9");
$e = $this->assertException(UploadException::class, function () { $e = $this->assertException(UploadException::class, function () {
@ -74,11 +74,11 @@ class ResolutionLimitTest extends ShimmiePHPUnitTestCase
public function tearDown(): void public function tearDown(): void
{ {
global $config; global $config;
$config->set_int("upload_min_height", -1); $config->delete("upload_min_height");
$config->set_int("upload_min_width", -1); $config->delete("upload_min_width");
$config->set_int("upload_max_height", -1); $config->delete("upload_max_height");
$config->set_int("upload_max_width", -1); $config->delete("upload_max_width");
$config->set_string("upload_ratios", ""); $config->delete("upload_ratios");
parent::tearDown(); parent::tearDown();
} }

32
ext/setup/main.php
View file

@ -389,20 +389,24 @@ class Setup extends Extension
if (substr($_name, 0, 6) == "_type_") { if (substr($_name, 0, 6) == "_type_") {
$name = substr($_name, 6); $name = substr($_name, 6);
$type = $event->values["_type_$name"]; $type = $event->values["_type_$name"];
$value = isset($event->values["_config_$name"]) ? $event->values["_config_$name"] : null; if(isset($event->values["_config_$name"])) {
switch ($type) { $value = $event->values["_config_$name"];
case "string": switch ($type) {
$config->set_string($name, $value); case "string":
break; $config->set_string($name, $value);
case "int": break;
$config->set_int($name, parse_shorthand_int((string)$value)); case "int":
break; $config->set_int($name, parse_shorthand_int((string)$value));
case "bool": break;
$config->set_bool($name, bool_escape($value)); case "bool":
break; $config->set_bool($name, bool_escape($value));
case "array": break;
$config->set_array($name, $value); case "array":
break; $config->set_array($name, $value);
break;
}
} else {
$config->delete($name);
} }
} }
} }